Examples

List of Objects and Definitions returned when sending a GET request to the Orders API

Navigate to the /orders API Endpoint page to acquire the cURL.

Field	Description
createdBy	Id of the Retailer who created the order
createdDate	Date when the order was created
expectedDate	Date when the order is expected to arrive
id	The internal id for the order
modifiedDate	The last date the order was modified
orderDate	Date of when the order is submitted to the supplier
orderDeliveries	A list of objects representing a deliver
orderStatus	The current status of the order
orderedItems	The itemized list for the Order
otherCost	A one time cost adjustment placed on the order
percentageDiscount	Any discount applied to the order
publicNote	An informational field to communicate something of importance or note
reference	A field used to track the supplier’s referenced id of the order
shippingCost	Total cost of shipping for the order
shippingNote	Notes for shipping
subtotal	Total sum of the order minus the taxes
supplierNote	Internal note known only to the supplier
supplierInfoID	An internal id used to reference the retail - supplier connection
totalCost	Subtotal plus taxes
totalQuantity	Total number of the items on the order

Additional Endpoints can be found in the API Endpoints Section linked at the top of the page.