Skip to main content
POST
Search Shipments

Headers

authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Query Parameters

limit
integer
default:10
offset
integer
default:0

Body

application/json

Query parameters can also be provided in the request body as a JSON object

limit
integer | null
default:10
offset
integer | null
default:0
orderBy
object[] | null
where
ShipmentsBoolExp · object | null

Boolean expression to filter rows from the table "shipments". All fields are combined with a logical 'AND'.

Response

200 - application/json

Responses for POST /api/rest/shipments/search

shipments
Shipments · object[]