API References

Get Shipments

get
https://api.intersoftsapient.net/v4/shipments/

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

Path Params
string
required

Shipping Location Id
SAPIENT Shipping Location Id (assigned by SAPIENT) or Alias (assigned by you).
Filter by shipping location.

Query Params
string
length ≤ 36

Shipping Account Id
SAPIENT Shipping Account Id (assigned by SAPIENT) or Alias (assigned by you).
Filter by shipping account.

string
length ≤ 10

Carrier Code
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.

string
enum

Status
Filter by shipment status.

Allowed:
string
length between 2 and 2

Country Code
ISO Alpha-2 Country Code per ISO 3166 Standard.

date

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

date

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

int32
1 to 2147483647
Defaults to 100

The maximum number of records per page.

int32
1 to 2147483647
Defaults to 1

The number of the requested page, starting at 1.

Responses

401

Unauthorized

403

Forbidden

404

The shipping location was not found.

500

Internal Server Error

Updated 20 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated 20 days ago