Get All Shipments

The operation fetches all created Shipments. If query parameters are not provided, it will default endDate as current date, page as 1 and size as 10.

SecuritybearerAuth
Request
query Parameters
startDate
string

While searching shipments, user set a date range to get all created shipments. This indicatesthe start date of the set date range under shipment search criteria. The date format must be: YYYY-MM-DD.

endDate
string

While searching shipments, user set a date range to get all created shipments. This indicatesthe end date of the set date range under shipment search criteria. The date format must be: YYYY-MM-DD.

page
string

The page of the Shipments search result list.

size
string

The size/count of the searched result list.

header Parameters
X-PB-Developer-Partner-Id
string

This is the Developer Partner ID. When the developer is the only partner, this field is not required.

Responses
200

List of shipments.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

get/api/v1/shipments
Request samples 
Response samples 
application/json
{
  • "pageInfo": {
    },
  • "data": [
    ]
}