/bff/shipment/list

No description provided.

bffgetBffShipmentList

Parameters

8 query

Query parameters

· 8

carrierIdstringOptional

Exampleexample_carrierId

statesstringOptional

Exampleexample_states

orderExternalIdstringOptional

Exampleexample_orderExternalId

trackingNumberQuerystringOptional

Exampleexample_trackingNumberQuery

dateFromstringOptional

Exampleexample_dateFrom

dateTostringOptional

Exampleexample_dateTo

offsetstringOptional

Exampleexample_offset

limitstringOptional

Exampleexample_limit

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json

{
  "success": true
}

Request example

GET /bff/shipment/list

get

curl -X GET "https://api.bizkithub.com/bff/shipment/list?carrierId=example_carrierId&states=example_states&orderExternalId=example_orderExternalId&trackingNumberQuery=example_trackingNumberQuery&dateFrom=example_dateFrom&dateTo=example_dateTo&offset=example_offset&limit=example_limit" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key