/orders
GET {{baseUrl}}/orders?embed=<string>&fields=<string>&ids=<string>&sort=<string>&archived=<integer>&status=<integer>&from=<string>&to=<string>&count=<integer>&offset=<integer>
Returns all orders. By default the first 50 regular orders are returned, sorted by creation date
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
embed | string | Comma seperated list of properties to embed | |
fields | string | Comma seperated list of properties to include | |
ids | string | Used to return specific orders (limited to 50 orders) | |
sort | string | If not included, results are sorted by creation date | |
archived | string | 0 if the results should contain regular orders, 1 if the results should contain archived orders | |
status | string | The ID of the order status | |
from | string | The date that returned orders should be after. This should be a UNIX timestamp | |
to | string | The date that returned orders should be before. This should be a UNIX timestamp | |
count | string | The maximum number of results to be returned | |
offset | string | The starting position for the returned values |
RESPONSES
status: OK
[{"id":"\u003cinteger\u003e","reference":"\u003cinteger\u003e","created":"\u003cstring\u003e","archived":"\u003cboolean\u003e","trackingUrl":"\u003cstring\u003e","status":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"},"billingAddress":{"name":"\u003cstring\u003e","emailAddress":"\u003cstring\u003e","telephone":"\u003cstring\u003e","companyName":"\u003cstring\u003e","addressLine1":"\u003cstring\u003e","addressLine2":"\u003cstring\u003e","addressLine3":"\u003cstring\u003e","city":"\u003cstring\u003e","postcode":"\u003cstring\u003e","province":"\u003cstring\u003e","state":"\u003cstring\u003e","country":"\u003cstring\u003e"},"shippingAddress":{"name":"\u003cstring\u003e","emailAddress":"\u003cstring\u003e","telephone":"\u003cstring\u003e","companyName":"\u003cstring\u003e","addressLine1":"\u003cstring\u003e","addressLine2":"\u003cstring\u003e","addressLine3":"\u003cstring\u003e","city":"\u003cstring\u003e","postcode":"\u003cstring\u003e","province":"\u003cstring\u003e","state":"\u003cstring\u003e","country":"\u003cstring\u003e"},"paymentMethod":"\u003cstring\u003e","total":"\u003cnumber\u003e","subTotal":"\u003cnumber\u003e","shippingTotal":"\u003cnumber\u003e","originalShippingTotal":"\u003cnumber\u003e","partialPaymentTotal":"\u003cnumber\u003e","tax":{"type":"\u003cstring\u003e","value":"\u003cnumber\u003e"},"discounts":[{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e","type":"\u003cstring\u003e","code":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e","type":"\u003cstring\u003e","code":"\u003cstring\u003e"}],"fees":[{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e","type":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e","type":"\u003cstring\u003e"}],"shipping":[{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e","id":"\u003cinteger\u003e","vatRate":"\u003cnumber\u003e"},{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e","id":"\u003cinteger\u003e","vatRate":"\u003cnumber\u003e"}],"refunds":[{"id":"\u003cnumber\u003e","created":"\u003cstring\u003e","name":"\u003cstring\u003e","value":"\u003cnumber\u003e"},{"id":"\u003cnumber\u003e","created":"\u003cstring\u003e","name":"\u003cstring\u003e","value":"\u003cnumber\u003e"}],"products":[{"id":"\u003cinteger\u003e","itemId":"\u003cinteger\u003e","title":"\u003cstring\u003e","sku":"\u003cstring\u003e","gtin":"\u003cstring\u003e","mpn":"\u003cstring\u003e","price":"\u003cnumber\u003e","originalPrice":"\u003cnumber\u003e","costPrice":"\u003cnumber\u003e","quantity":"\u003cinteger\u003e","extras":[{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e"},{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e"}],"variation":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"choices":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"vatRate":"\u003cnumber\u003e","comments":"\u003cstring\u003e","giftVoucher":"\u003cboolean\u003e","weight":"\u003cnumber\u003e","warehouseNotes":"\u003cstring\u003e","preOrder":"\u003cboolean\u003e","giftVoucherDetails":{"code":"\u003cstring\u003e","type":"\u003cstring\u003e","customerName":"\u003cstring\u003e","recipientName":"\u003cstring\u003e","message":"\u003cstring\u003e"},"hsCode":"\u003cstring\u003e","bundleProducts":[{"title":"\u003cstring\u003e","sku":"\u003cstring\u003e"},{"title":"\u003cstring\u003e","sku":"\u003cstring\u003e"}]},{"id":"\u003cinteger\u003e","itemId":"\u003cinteger\u003e","title":"\u003cstring\u003e","sku":"\u003cstring\u003e","gtin":"\u003cstring\u003e","mpn":"\u003cstring\u003e","price":"\u003cnumber\u003e","originalPrice":"\u003cnumber\u003e","costPrice":"\u003cnumber\u003e","quantity":"\u003cinteger\u003e","extras":[{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e"},{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e"}],"variation":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"choices":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"vatRate":"\u003cnumber\u003e","comments":"\u003cstring\u003e","giftVoucher":"\u003cboolean\u003e","weight":"\u003cnumber\u003e","warehouseNotes":"\u003cstring\u003e","preOrder":"\u003cboolean\u003e","giftVoucherDetails":{"code":"\u003cstring\u003e","type":"\u003cstring\u003e","customerName":"\u003cstring\u003e","recipientName":"\u003cstring\u003e","message":"\u003cstring\u003e"},"hsCode":"\u003cstring\u003e","bundleProducts":[{"title":"\u003cstring\u003e","sku":"\u003cstring\u003e"},{"title":"\u003cstring\u003e","sku":"\u003cstring\u003e"}]}],"totalWeight":"\u003cstring\u003e","marketing":"\u003cboolean\u003e","comments":"\u003cstring\u003e","adminComments":[{"id":"\u003cinteger\u003e","created":"\u003cstring\u003e","content":"\u003cstring\u003e","status_id":"\u003cinteger\u003e"},{"id":"\u003cinteger\u003e","created":"\u003cstring\u003e","content":"\u003cstring\u003e","status_id":"\u003cinteger\u003e"}],"customer":{"id":"\u003cinteger\u003e"},"deliveryDate":"\u003cstring\u003e","transactionId":"\u003cstring\u003e","earnedRewardPoints":"\u003cinteger\u003e","fileArchives":[{"title":"\u003cstring\u003e","url":"\u003cstring\u003e"},{"title":"\u003cstring\u003e","url":"\u003cstring\u003e"}]},{"id":"\u003cinteger\u003e","reference":"\u003cinteger\u003e","created":"\u003cstring\u003e","archived":"\u003cboolean\u003e","trackingUrl":"\u003cstring\u003e","status":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"},"billingAddress":{"name":"\u003cstring\u003e","emailAddress":"\u003cstring\u003e","telephone":"\u003cstring\u003e","companyName":"\u003cstring\u003e","addressLine1":"\u003cstring\u003e","addressLine2":"\u003cstring\u003e","addressLine3":"\u003cstring\u003e","city":"\u003cstring\u003e","postcode":"\u003cstring\u003e","province":"\u003cstring\u003e","state":"\u003cstring\u003e","country":"\u003cstring\u003e"},"shippingAddress":{"name":"\u003cstring\u003e","emailAddress":"\u003cstring\u003e","telephone":"\u003cstring\u003e","companyName":"\u003cstring\u003e","addressLine1":"\u003cstring\u003e","addressLine2":"\u003cstring\u003e","addressLine3":"\u003cstring\u003e","city":"\u003cstring\u003e","postcode":"\u003cstring\u003e","province":"\u003cstring\u003e","state":"\u003cstring\u003e","country":"\u003cstring\u003e"},"paymentMethod":"\u003cstring\u003e","total":"\u003cnumber\u003e","subTotal":"\u003cnumber\u003e","shippingTotal":"\u003cnumber\u003e","originalShippingTotal":"\u003cnumber\u003e","partialPaymentTotal":"\u003cnumber\u003e","tax":{"type":"\u003cstring\u003e","value":"\u003cnumber\u003e"},"discounts":[{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e","type":"\u003cstring\u003e","code":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e","type":"\u003cstring\u003e","code":"\u003cstring\u003e"}],"fees":[{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e","type":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e","type":"\u003cstring\u003e"}],"shipping":[{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e","id":"\u003cinteger\u003e","vatRate":"\u003cnumber\u003e"},{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e","id":"\u003cinteger\u003e","vatRate":"\u003cnumber\u003e"}],"refunds":[{"id":"\u003cnumber\u003e","created":"\u003cstring\u003e","name":"\u003cstring\u003e","value":"\u003cnumber\u003e"},{"id":"\u003cnumber\u003e","created":"\u003cstring\u003e","name":"\u003cstring\u003e","value":"\u003cnumber\u003e"}],"products":[{"id":"\u003cinteger\u003e","itemId":"\u003cinteger\u003e","title":"\u003cstring\u003e","sku":"\u003cstring\u003e","gtin":"\u003cstring\u003e","mpn":"\u003cstring\u003e","price":"\u003cnumber\u003e","originalPrice":"\u003cnumber\u003e","costPrice":"\u003cnumber\u003e","quantity":"\u003cinteger\u003e","extras":[{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e"},{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e"}],"variation":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"choices":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"vatRate":"\u003cnumber\u003e","comments":"\u003cstring\u003e","giftVoucher":"\u003cboolean\u003e","weight":"\u003cnumber\u003e","warehouseNotes":"\u003cstring\u003e","preOrder":"\u003cboolean\u003e","giftVoucherDetails":{"code":"\u003cstring\u003e","type":"\u003cstring\u003e","customerName":"\u003cstring\u003e","recipientName":"\u003cstring\u003e","message":"\u003cstring\u003e"},"hsCode":"\u003cstring\u003e","bundleProducts":[{"title":"\u003cstring\u003e","sku":"\u003cstring\u003e"},{"title":"\u003cstring\u003e","sku":"\u003cstring\u003e"}]},{"id":"\u003cinteger\u003e","itemId":"\u003cinteger\u003e","title":"\u003cstring\u003e","sku":"\u003cstring\u003e","gtin":"\u003cstring\u003e","mpn":"\u003cstring\u003e","price":"\u003cnumber\u003e","originalPrice":"\u003cnumber\u003e","costPrice":"\u003cnumber\u003e","quantity":"\u003cinteger\u003e","extras":[{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e"},{"name":"\u003cstring\u003e","value":"\u003cnumber\u003e"}],"variation":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"choices":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"vatRate":"\u003cnumber\u003e","comments":"\u003cstring\u003e","giftVoucher":"\u003cboolean\u003e","weight":"\u003cnumber\u003e","warehouseNotes":"\u003cstring\u003e","preOrder":"\u003cboolean\u003e","giftVoucherDetails":{"code":"\u003cstring\u003e","type":"\u003cstring\u003e","customerName":"\u003cstring\u003e","recipientName":"\u003cstring\u003e","message":"\u003cstring\u003e"},"hsCode":"\u003cstring\u003e","bundleProducts":[{"title":"\u003cstring\u003e","sku":"\u003cstring\u003e"},{"title":"\u003cstring\u003e","sku":"\u003cstring\u003e"}]}],"totalWeight":"\u003cstring\u003e","marketing":"\u003cboolean\u003e","comments":"\u003cstring\u003e","adminComments":[{"id":"\u003cinteger\u003e","created":"\u003cstring\u003e","content":"\u003cstring\u003e","status_id":"\u003cinteger\u003e"},{"id":"\u003cinteger\u003e","created":"\u003cstring\u003e","content":"\u003cstring\u003e","status_id":"\u003cinteger\u003e"}],"customer":{"id":"\u003cinteger\u003e"},"deliveryDate":"\u003cstring\u003e","transactionId":"\u003cstring\u003e","earnedRewardPoints":"\u003cinteger\u003e","fileArchives":[{"title":"\u003cstring\u003e","url":"\u003cstring\u003e"},{"title":"\u003cstring\u003e","url":"\u003cstring\u003e"}]}]