/orders

POST {{baseUrl}}/orders

Creates a new order

Request Body

{"billingAddress"=>{"name"=>"<string>", "emailAddress"=>"<string>", "telephone"=>"<string>", "companyName"=>"<string>", "addressLine1"=>"<string>", "addressLine2"=>"<string>", "addressLine3"=>"<string>", "city"=>"<string>", "postcode"=>"<string>", "province"=>"<string>", "country"=>"<string>"}, "shippingAddress"=>{"name"=>"<string>", "emailAddress"=>"<string>", "telephone"=>"<string>", "companyName"=>"<string>", "addressLine1"=>"<string>", "addressLine2"=>"<string>", "addressLine3"=>"<string>", "city"=>"<string>", "postcode"=>"<string>", "province"=>"<string>", "country"=>"<string>"}, "products"=>[{"id"=>"<integer>", "quantity"=>"<integer>", "variation"=>"<integer>", "extras"=>["<integer>", "<integer>"], "choices"=>["<integer>", "<integer>"], "comments"=>"<string>"}, {"id"=>"<integer>", "quantity"=>"<integer>", "variation"=>"<integer>", "extras"=>["<integer>", "<integer>"], "choices"=>["<integer>", "<integer>"], "comments"=>"<string>"}], "status"=>"<integer>", "shippingRate"=>"<integer>", "reference"=>"<integer>", "archived"=>"<boolean>", "trackingUrl"=>"<string>", "paymentMethod"=>"<string>", "total"=>"<number>", "subTotal"=>"<number>", "shippingTotal:"=>"<number>", "originalShippingTotal"=>"<number>", "partialPaymentTotal"=>"<number>", "tax"=>{"type"=>"<string>", "value"=>"<number>"}, "discounts"=>[{"name"=>"<string>", "value"=>"<number>", "type"=>"<string>", "code"=>"<string>"}, {"name"=>"<string>", "value"=>"<number>", "type"=>"<string>", "code"=>"<string>"}], "fees"=>[{"name"=>"<string>", "value"=>"<number>", "type"=>"<string>"}, {"name"=>"<string>", "value"=>"<number>", "type"=>"<string>"}], "refunds"=>[{"name"=>"<string>", "value"=>"<number>"}, {"name"=>"<string>", "value"=>"<number>"}], "totalWeight"=>"<string>", "acceptsMarketing"=>"<boolean>", "comments"=>"<string>", "customer"=>{"id"=>"<integer>"}, "deliveryDate"=>"<string>", "transactionId"=>"<string>", "earnedRewardPoints"=>"<integer>", "sendEmail"=>"<boolean>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: Created

{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;reference&quot;:&quot;\u003cinteger\u003e&quot;,&quot;created&quot;:&quot;\u003cstring\u003e&quot;,&quot;archived&quot;:&quot;\u003cboolean\u003e&quot;,&quot;trackingUrl&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;},&quot;billingAddress&quot;:{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;emailAddress&quot;:&quot;\u003cstring\u003e&quot;,&quot;telephone&quot;:&quot;\u003cstring\u003e&quot;,&quot;companyName&quot;:&quot;\u003cstring\u003e&quot;,&quot;addressLine1&quot;:&quot;\u003cstring\u003e&quot;,&quot;addressLine2&quot;:&quot;\u003cstring\u003e&quot;,&quot;addressLine3&quot;:&quot;\u003cstring\u003e&quot;,&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;postcode&quot;:&quot;\u003cstring\u003e&quot;,&quot;province&quot;:&quot;\u003cstring\u003e&quot;,&quot;state&quot;:&quot;\u003cstring\u003e&quot;,&quot;country&quot;:&quot;\u003cstring\u003e&quot;},&quot;shippingAddress&quot;:{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;emailAddress&quot;:&quot;\u003cstring\u003e&quot;,&quot;telephone&quot;:&quot;\u003cstring\u003e&quot;,&quot;companyName&quot;:&quot;\u003cstring\u003e&quot;,&quot;addressLine1&quot;:&quot;\u003cstring\u003e&quot;,&quot;addressLine2&quot;:&quot;\u003cstring\u003e&quot;,&quot;addressLine3&quot;:&quot;\u003cstring\u003e&quot;,&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;postcode&quot;:&quot;\u003cstring\u003e&quot;,&quot;province&quot;:&quot;\u003cstring\u003e&quot;,&quot;state&quot;:&quot;\u003cstring\u003e&quot;,&quot;country&quot;:&quot;\u003cstring\u003e&quot;},&quot;paymentMethod&quot;:&quot;\u003cstring\u003e&quot;,&quot;total&quot;:&quot;\u003cnumber\u003e&quot;,&quot;subTotal&quot;:&quot;\u003cnumber\u003e&quot;,&quot;shippingTotal&quot;:&quot;\u003cnumber\u003e&quot;,&quot;originalShippingTotal&quot;:&quot;\u003cnumber\u003e&quot;,&quot;partialPaymentTotal&quot;:&quot;\u003cnumber\u003e&quot;,&quot;tax&quot;:{&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;},&quot;discounts&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;}],&quot;fees&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;}],&quot;shipping&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;,&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;vatRate&quot;:&quot;\u003cnumber\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;,&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;vatRate&quot;:&quot;\u003cnumber\u003e&quot;}],&quot;refunds&quot;:[{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;created&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;},{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;created&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;}],&quot;products&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;itemId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;sku&quot;:&quot;\u003cstring\u003e&quot;,&quot;gtin&quot;:&quot;\u003cstring\u003e&quot;,&quot;mpn&quot;:&quot;\u003cstring\u003e&quot;,&quot;price&quot;:&quot;\u003cnumber\u003e&quot;,&quot;originalPrice&quot;:&quot;\u003cnumber\u003e&quot;,&quot;costPrice&quot;:&quot;\u003cnumber\u003e&quot;,&quot;quantity&quot;:&quot;\u003cinteger\u003e&quot;,&quot;extras&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;}],&quot;variation&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;}],&quot;choices&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;}],&quot;vatRate&quot;:&quot;\u003cnumber\u003e&quot;,&quot;comments&quot;:&quot;\u003cstring\u003e&quot;,&quot;giftVoucher&quot;:&quot;\u003cboolean\u003e&quot;,&quot;weight&quot;:&quot;\u003cnumber\u003e&quot;,&quot;warehouseNotes&quot;:&quot;\u003cstring\u003e&quot;,&quot;preOrder&quot;:&quot;\u003cboolean\u003e&quot;,&quot;giftVoucherDetails&quot;:{&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;customerName&quot;:&quot;\u003cstring\u003e&quot;,&quot;recipientName&quot;:&quot;\u003cstring\u003e&quot;,&quot;message&quot;:&quot;\u003cstring\u003e&quot;},&quot;hsCode&quot;:&quot;\u003cstring\u003e&quot;,&quot;bundleProducts&quot;:[{&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;sku&quot;:&quot;\u003cstring\u003e&quot;},{&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;sku&quot;:&quot;\u003cstring\u003e&quot;}]},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;itemId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;sku&quot;:&quot;\u003cstring\u003e&quot;,&quot;gtin&quot;:&quot;\u003cstring\u003e&quot;,&quot;mpn&quot;:&quot;\u003cstring\u003e&quot;,&quot;price&quot;:&quot;\u003cnumber\u003e&quot;,&quot;originalPrice&quot;:&quot;\u003cnumber\u003e&quot;,&quot;costPrice&quot;:&quot;\u003cnumber\u003e&quot;,&quot;quantity&quot;:&quot;\u003cinteger\u003e&quot;,&quot;extras&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;}],&quot;variation&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;}],&quot;choices&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;}],&quot;vatRate&quot;:&quot;\u003cnumber\u003e&quot;,&quot;comments&quot;:&quot;\u003cstring\u003e&quot;,&quot;giftVoucher&quot;:&quot;\u003cboolean\u003e&quot;,&quot;weight&quot;:&quot;\u003cnumber\u003e&quot;,&quot;warehouseNotes&quot;:&quot;\u003cstring\u003e&quot;,&quot;preOrder&quot;:&quot;\u003cboolean\u003e&quot;,&quot;giftVoucherDetails&quot;:{&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;customerName&quot;:&quot;\u003cstring\u003e&quot;,&quot;recipientName&quot;:&quot;\u003cstring\u003e&quot;,&quot;message&quot;:&quot;\u003cstring\u003e&quot;},&quot;hsCode&quot;:&quot;\u003cstring\u003e&quot;,&quot;bundleProducts&quot;:[{&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;sku&quot;:&quot;\u003cstring\u003e&quot;},{&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;sku&quot;:&quot;\u003cstring\u003e&quot;}]}],&quot;totalWeight&quot;:&quot;\u003cstring\u003e&quot;,&quot;marketing&quot;:&quot;\u003cboolean\u003e&quot;,&quot;comments&quot;:&quot;\u003cstring\u003e&quot;,&quot;adminComments&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;created&quot;:&quot;\u003cstring\u003e&quot;,&quot;content&quot;:&quot;\u003cstring\u003e&quot;,&quot;status_id&quot;:&quot;\u003cinteger\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;created&quot;:&quot;\u003cstring\u003e&quot;,&quot;content&quot;:&quot;\u003cstring\u003e&quot;,&quot;status_id&quot;:&quot;\u003cinteger\u003e&quot;}],&quot;customer&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;},&quot;deliveryDate&quot;:&quot;\u003cstring\u003e&quot;,&quot;transactionId&quot;:&quot;\u003cstring\u003e&quot;,&quot;earnedRewardPoints&quot;:&quot;\u003cinteger\u003e&quot;,&quot;fileArchives&quot;:[{&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;url&quot;:&quot;\u003cstring\u003e&quot;},{&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;url&quot;:&quot;\u003cstring\u003e&quot;}]}