POST
/
shipments
/
search

Authorizations

Authorization
string
headerrequired

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

Headers

x-fabric-tenant-id
string
required

Merchant's 24-character tenant ID

x-fabric-channel-id
string
required

Sales channel ID

x-fabric-request-id
string

Unique request ID

Query Parameters

fetchOnlyIds
boolean
default: false
offset
number
default: 0

The number of records to skip before returning all records. For example, offset=20, limit=10 returns records 21-30.

limit
number
default: 10

Maximum number of records per page.

Body

application/json
filters
object[]
required
sort
string
default: -shipment.shipDate

Property name on which response needed to be sorted. Note: - refers to descending and + refers to ascending order

Response

200 - application/json
data
object[]
pagination
object

Pagination response