ZEzentail
SalesOrder

Retrieve detailed Sales Order information for a list of orders

Returns very detailed information about a sales order including accounting data, tracking/package data, line items for all sales orders that match the search criteria provided. Results are sorted by the lastUpdateTs from oldest to newest.

Orders placed more than one year ago are excluded from results, unless channelOrderIds is provided.

get/salesOrder

Request

  • Base URL
    https://api.zentail.com/v1
  • Auth
    API key in header AUTHORIZATION

Query parameters

lastUpdatedTsstring date-time

If provided, only orders with a last updated timestamp greater than or equal to the one provided (inclusive) will be included.

statusstring[]

If provided, only orders with the given status will be included.

channelOrderIdsstring[]

If provided, only orders with the given Channel Order Ids will be included.

orderTsstring date-time

If provided, only orders with a timestamp greater than or equal to the one provided (inclusive) will be included. Note: orders placed more than one year ago are excluded unless channelOrderIds is provided.

pageLengthinteger

Passing this will return the number of SalesOrder objects specified in pageLength. 100 is the maximum allowed value.

nextTokenstring

The link to a requested page in the format of a full URL with the nextToken as a query parameter (all other parameters will be ignored). Use this to request the next page.

warehouseIdinteger

Specifying a Zentail Warehouse Id will only return sales order line items that are routed to the corresponding warehouse.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.