Filter shipments

Gets shipment details based on filter criteria

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json

Filter criteria

filters

object

required

JSON to do filtration of records. <br /> Note To filter records json structure should be similar to target entity structure i.e order, shipment etc.

Show child attributes

limit

integer

default: 10

Ending record number (from the offset number) in the response. When no value is provided, the default value is 100.

offset

integer

default: 0

Starting number of the record (within the total number of records) in the response. Offset is zero-based. That is, the 10th record is at offset 9 starting from the 0th record. When no value is provided, the default value is 0

sortBy

string

default: updatedAt

Sorting criteria based on item attributes

sortDirection

enum<string>

default: desc

Sorting direction such as ascending or descending

Available options:

asc,

desc

Response

200 - application/json

Pagination details

count

integer

limit

integer

Ending record number (from the offset number) in the response. When no value is provided, the default value is 100.

offset

integer

Starting number of the record (within the total number of records) in the response. Offset is zero-based. That is, the 10th record is at offset 9 starting from the 0th record. When no value is provided, the default value is 0