JSDoc: Class: orders

Name Type Attributes Description

domainOrOptions

string | object

The project domain or options object. If object, see the object's optional properties.

Name	Type	Attributes	Description
`domain`	string	<optional>	The project domain
`token`	object	<optional>	auth token - object with value property and optional headerOrQueryName and isQuery properties

Source:

Retrieve details for specified order

Name	Type	Description
`orderId`	string	Order id whose details are to be retrieved
`xShopperId`	string	Shopper ID to be operated on, if different from JWT Reseller subaccounts are not supported
`xMarketId`	string	Unique identifier of the Market in which the request is happening

Source:

Retrieve a list of orders for the authenticated shopper. Only one filter may be used at a time

Name	Type	Description
`periodStart`	string	Start of range indicating what time-frame should be returned. Inclusive
`periodEnd`	string	End of range indicating what time-frame should be returned. Inclusive
`domain`	string	Domain name to use as the filter of results
`productGroupId`	integer	Product group id to use as the filter of results
`paymentProfileId`	integer	Payment profile id to use as the filter of results
`parentOrderId`	string	Parent order id to use as the filter of results
`offset`	integer	Number of results to skip for pagination
`limit`	integer	Maximum number of items to return
`sort`	string	Property name that will be used to sort results. '-' indicates descending
`xShopperId`	string	Shopper ID to be operated on, if different from JWT Reseller subaccounts are not supported
`xMarketId`	string	Unique identifier of the Market in which the request is happening

Source:

Set Token

Name	Type	Description
`value`	string	token's value
`headerOrQueryName`	string	the header or query name to send the token at
`isQuery`	boolean	true if send the token as query param, otherwise, send as header param

Source: