Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Shipments

Get Shipments

Provides a list of shipments for the specified shipping location in a given time period.

get/v4/shipments/{shippingLocationId}

Path parameters

shippingLocationIdstring required

Shipping Location Id <br />SAPIENT Shipping Location Id (assigned by SAPIENT) or Alias (assigned by you). <br />Filter by shipping location.

Query parameters

shippingAccountIdstring

Shipping Account Id <br />SAPIENT Shipping Account Id (assigned by SAPIENT) or Alias (assigned by you). <br />Filter by shipping account.

carrierCodestring

Carrier Code <br />If shippingAccountId and carrier are both provided, then the value sent in the carrier field will be ignored and the carrier associated with the shipping account will be used.

status'Created' | 'OnHold' | 'Cancelled' | 'ReadyToPrint' | 'LabelPrinted' | 'Confirmed' | 'Picked'

Get Shipments Status Type

Status <br />Filter by shipment status.

destinationCountryCodestring

Country Code <br />ISO Alpha-2 Country Code per ISO 3166 Standard.

dateFromstring date

Date From <br />Defaults to Today's date if not provided. <br />Format: YYYY-MM-DD

dateTostring date

Date To <br />Defaults to Today's date if not provided. <br />Format: YYYY-MM-DD

pageSizeinteger

The maximum number of records per page.

pageNumberinteger

The number of the requested page, starting at 1.

Response

Returns a list of shipments.

TotalCountinteger required

Total Count <br />The total number of shipments matching the request.

Example response

{
  "TotalCount": 32
}