v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Create Order

post/order

Query parameters

echoboolean

Request body

merchantIdinteger
orderStatusstring

Values: Active, Completed, Draft, Cancelled

sourceTypestring

POS, Web, Telephone

fulfillmentStatusstring
paymentStatusstring
orderedDatestring date
totalAmountstring
taxAmountstring
balancestring
subtotalAmountstring
customerNamestring
customerIdstring
contactEmailstring
notesstring
shippedDatestring
lineItemCountinteger

Response

201

idinteger
merchantIdinteger
createdstring
modifiedstring
sourceTypestring
shippedDatestring
referencestring
accessCodestring
orderStatusstring
invoiceStatusstring
paymentStatusstring
packingStatusstring
fulfillmentStatusstring
returnStatusstring
salesOrderboolean
deletedboolean
subtotalAmountstring
discountAmountstring
taxAmountstring
totalAmountstring
balancestring
invoicedAmountstring
paidAmountstring
lineItemCountinteger
saleQuantityinteger
returnQuantityinteger
netQuantityinteger
invoiceQuantityinteger
customerIdinteger
taxExemptboolean
customerNamestring
contactEmailstring
billingAddressobject
shippingAddressobject
shippingIsSameAsBillingboolean
shippingLineItemsobject[]
orderNumberinteger
barCodestring
taxesobject[]

Example response

{
  "id": 351126,
  "merchantId": 516167953,
  "created": "2022-02-17T19:17:49.547Z",
  "modified": "2022-02-17T19:17:49.547Z",
  "sourceType": "POS",
  "shippedDate": "2022-02-16T05:00:00Z",
  "reference": "O2QPUJF3RMFT",
  "accessCode": "YWPVPJ",
  "orderStatus": "Draft",
  "invoiceStatus": "Draft",
  "paymentStatus": "Unpaid",
  "packingStatus": "Unpacked",
  "fulfillmentStatus": "Unfulfilled",
  "returnStatus": "None",
  "subtotalAmount": "11.11",
  "discountAmount": "8.33",
  "taxAmount": "0",
  "totalAmount": "2.78",
  "balance": "2.78",
  "invoicedAmount": "0",
  "paidAmount": "0",
  "lineItemCount": 1,
  "saleQuantity": 1,
  "netQuantity": 1,
  "customerId": 10000000828021,
  "customerName": "API Customer",
  "contactEmail": "apihelp@pps.io",
  "lineItems": [
    {
      "quantityReturned": "0",
      "quantityInvoiced": "0",
      "created": "2022-02-17T19:17:49.97Z",
      "modified": "2022-02-17T19:17:49.97Z",
      "id": 661308,
      "name": "Test Item",
      "price": "11.11",
      "discountRate": "0",
      "discountAmount": "8.33",
      "priceDiscountAmount": "0",
      "taxRate": "0",
      "taxAmount": "0",
      "quantity": "1",
      "amount": "11.11"
    }
  ],
  "discounts": [
    {
      "id": 23906,
      "discountRateType": "Percent",
      "name": "Test 3",
      "rate": "0.75",
      "amount": "8.33",
      "code": "DA4DNW6NIVR2MHVJ",
      "discountId": 10000000004137
    }
  ],
  "orderNumber": 1036,
  "barCode": "iVBORw0KGgoAAAANSUhEUgAAAKoAAAAgCAYAAACCXeM8AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAbGSURBVHhe7dLBCuVaDkPR+v+frsaBBYqwLxm+hhIEaUvHs/z5+0//9H+g50f98+fP88mt7Hp3q7/yCHfHM6dsuX/hK/9i3hnTxteb3rrvLXmEbcm8e5k2vt7kJmPKnTpvN1enT5dHT9oepl4HtbvVX3mEu+OZU7bcv/CVfzHvjGnj601v3feWPMK2ZN69TBtfb3KTMeVOnbebq9Ony6MnbQ9Tr4Pa3eqvPMLd8cwpW+5f+Mq/mHfGtPH1prfue0seYVsy716mja83ucmYcqfO283V6dPl0ZO2h6nXQe1u9Vce4e545pQt9y985V/MO2Pa+HrTW/e9JY+wLZl3L9PG15vcZEy5U+ft5ur06fLoSdvD1Ougdrf6K49wdzxzypb7F77yL+adMW18vemt+96SR9iWzLuXaePrTW4yptyp83Zzdfp0efSk7WHqdVC7W/2VR7g7njlly/0LX/kX886YNr7e9NZ9b8kjbEvm3cu08fUmNxlT7tR5u7k6fbo8etL2MPU6qN2t/soj3B3PnLLl/oWv/It5Z0wbX29667635BG2JfPuZdr4epObjCl36rzdXJ0+XR49aXuYeh3U7lZ/5RHujmdO2XL/wlf+xbwzpo2vN71131vyCNuSefcybXy9yU3GlDt13m6uTp8uj560PUy9Dmp3q7/yCHfHM6dsuX/hK/9i3hnTxteb3rrvLXmEbcm8e5k2vt7kJmPKnTpvN1enT5dHT9oepl4HtbvVX3mEu+OZU7bcv/CVfzHvjGnj601v3feWPMK2ZN69TBtfb3KTMeVOnbebq9Ony6MnbQ9Tr4Pa3eqvPMLd8cwpW+5f+Mq/mHfGtPH1prfue0seYVsy716mja83ucmYcqfO283V6dPl0ZO2h6nXQe1u9Vce4e545pQt9y985V/MO2Pa+HrTW/e9JY+wLZl3L9PG15vcZEy5U+ft5ur06fLoSdvD1Ougdrf6K49wdzxzypb7F77yL+adMW18vemt+96SR9iWzLuXaePrTW4yptyp83Zzdfp0efSk7WHqdVC7W/2VR7g7njlly/0LX/kX886YNr7e9NZ9b8kjbEvm3cu08fUmNxlT7tR5u7k6fbo8etL2MPU6qN2t/soj3B3PnLLl/oWv/It5Z0wbX29667635BG2JfPuZdr4epObjCl36rzdXJ0+XR49aXuYeh3U7lZ/5RHujmdO2XL/wlf+xbwzpo2vN71131vyCNuSefcybXy9yU3GlDt13m6uTp8uj560PUy9Dmp3q7/yCHfHM6dsuX/hK/9i3hnTxteb3rrvLXmEbcm8e5k2vt7kJmPKnTpvN1enT5dHT9oepl4HtbvVX3mEu+OZU7bcv/CVfzHvjGnj601v3feWPMK2ZN69TBtfb3KTMeVOnbebq9Ony6MnbQ9Tr4Pa3eqvPMLd8cwpW+5f+Mq/mHfGtPH1prfue0seYVsy716mja83ucmYcqfO283V6dPl0ZO2h6nXQe1u9Vce4e545pQt9y985V/MO2Pa+HrTW/e9JY+wLZl3L9PG15vcZEy5U+ft5ur06fLoSdvD1Ougdrf6K49wdzxzypb7F77yL+adMW18vemt+96SR9iWzLuXaePrTW4yptyp83Zzdfp0efSk7WHqdVC7W/2VR7g7njlly/0LX/kX886YNr7e9NZ9b8kjbEvm3cu08fUmNxlT7tR5u7k6fbo8etL2MPU6qN2t/soj3B3PnLLl/oWv/It5Z0wbX29667635BG2JfPuZdr4epObjCl36rzdXJ0+XR49aXuYeh3U7lZ/5RHujmdO2XL/wlf+xbwzpo2vN71131vyCNuSefcybXy9yU3GlDt13m6uTp8uj560PUy9Dmp3q7/yCHfHM6dsuX/hK/9i3hnTxteb3rrvLXmEbcm8e5k2vt7kJmPKnTpvN1enT5dHT9oepl4HtbvVX3mEu+OZU7bcv/CVfzHvjGnj601v3feWPMK2ZN69TBtfb3KTMeVOnbebq9Ony6MnbQ9Tr4Pa3eqvPMLd8cwpW+5f+Mq/mHfGtPH1prfue0seYVsy716mja83ucmYcqfO283V6dPl0ZO2h6nXQe1u9Vce4e545pQt9y985V/MO2Pa+HrTW/e9JY+wLZl3L9PG15vcZEy5U+ft5ur06fLoSdvD1Ougdrf6K49wdzxzypb7F77yL+adMW18vemt+96SR9iWzLuXaePrTW4yptyp83Zzdfp0efSk7WHqdVC7W/2VR7g7njlly/0LX/kX886YNr7e9NZ9b8kjbEvm3cu08fUmNxlT7tR5u7k6fbo8el/90z/9J/X37/8AZsTdDEzWqxgAAAAASUVORK5CYII="
}