StateSet One API Documentation
Orders
- GETList Orders
- GETRetrieve Order
- POSTAdd Item to Order
- POSTRemove Item from Order
- POSTRemove Discount
- POSTApply Promotion
- POSTRemove Promotion
- POSTCreate Order
- POSTCancel Order
- POSTHold Order
- POSTRelease Order
- POSTShip Order
- POSTReturn Order
- POSTRefund Order
- POSTExchange Order
- POSTSplit Order
- POSTMerge Order
- POSTTag Order
- POSTUpdate Order
Returns
Return Line Items
Warranty Line Items
Wholesale Orders
Inventory Items
Packing List
Packing List Items
Purchase Orders
Bill of Materials
Bill of Materials Line Item
Work Orders
Work Order Line Items
Cycle Counts
Manufacture Orders
Manufacture Order Line Items
Leads
Cases
List Orders
This endpoint retrieves a list of orders.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The maximum number of orders to return. Default is 10.
The number of orders to skip before starting to return results. Default is 0.
The field to sort the results by. Can be ‘created_date’, ‘updated_date’, ‘order_number’, etc. Default is ‘created_date’.
The order of sorting. Can be ‘asc’ or ‘desc’. Default is ‘desc’.
Filter orders by status.
Filter orders by customer email.
Filter orders created on or after this date (format: YYYY-MM-DD).
Filter orders created on or before this date (format: YYYY-MM-DD).
Query Parameters
The maximum number of orders to return. Default is 10.
The number of orders to skip before starting to return results. Default is 0.
The field to sort the results by. Can be ‘created_date’, ‘updated_date’, ‘order_number’, etc. Default is ‘created_date’.
The order of sorting. Can be ‘asc’ or ‘desc’. Default is ‘desc’.
Filter orders by status.
Filter orders by customer email.
Filter orders created on or after this date (format: YYYY-MM-DD).
Filter orders created on or before this date (format: YYYY-MM-DD).
Response
An array of order objects.
This is the id of the order.
This is the name of the order.
This is the order number.
This is the date the order was created.
This is the date the order was last updated.
This is the status of the order.
This is the imported status of the order.
This is the delivery date of the order.
This is the person who ordered.
This is the delivery address for the order.
These are additional notes for the order.
This is the date the order was imported.
This is the customer number associated with the order.
This is the name of the customer.
This indicates if the order was imported.
This is the email of the customer.
This is the source of the order.
This is the email of the buyer.
This is a message from the buyer.
This is the SLA time for cancelling the order.
This is the reason for cancellation, if applicable.
This is who initiated the cancellation, if applicable.
This is the type of fulfillment for the order.
This is the type of delivery for the order.
This indicates if the order is cash on delivery.
This indicates if this is a replacement order.
This is a note from the seller.
This is the current status of the order.
This is the tracking number for the order.
This is the id of the warehouse handling the order.
These are the line items associated with the order.
This is the id of the order line item.
This is the id of the associated wholesale order.
This is the name of the product.
This is the quantity of the product ordered.
This is the date the line item was created.
This is the date the line item was last updated.
This is the unit of measurement for the product.
This is the id of the product.
This is the brand of the product.
This is the stock code of the product.
This is the size of the product.
This is the status of the line item.
This is the sale price of the product.
This is the discount offered by the seller.
This is the seller’s SKU for the product.
This is the SKU id of the product.
This is the image URL for the product SKU.
This is the name of the product SKU.
This is the type of the product SKU.
This is the original price of the product.
The total number of orders matching the query parameters.