API References

Get Shipments

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

Retrieve a list of shipments for the specified shipping location in a given time period. With this endpoint, you can filter and view details of your shipments based on various criteria, such as status, date ranges, and other parameters.

Path Params
string
required

A unique identifier for the shipping location assigned by the system or by you (alias), allowing users to reference and manage specific locations effectively.

Note: To get the shipments for a particular shipping location, you can filter this value by the shipping location ID. If the ShippingLocationId is not provided, then the response will return shipments for all shipping locations.

Query Params
string
length ≤ 36

A unique identifier for each shipping account assigned by the system or you (alias), allowing for efficient reference and management of individual accounts within the system.

Note: To get the shipments for a particular shipping account, you can filter this value by the shipping account ID. If the ShippingAccountId is not provided, then the response will return shipments for all shipping accounts.

string
length ≤ 10

A unique identifier for the carrier associated with the shipping account. This code is typically alphanumeric and helps in identifying the specific carrier linked to the shipping account.

Note: If both the shipping account ID and the carrier code are provided, then the value sent in the carrierCode field is ignored and the carrier associated with the shipping account is used instead.

string
enum

Indicates the current state of a shipment. You can filter your shipments using any of the following statuses:
• Created: The shipment has been initiated but not processed.
• OnHold: The shipment is temporarily paused for various reasons.
• Cancelled: The shipment has been cancelled and will not proceed.
• ReadyToPrint: The shipment is prepared for label printing.
• LabelPrinted: The shipping label has been generated and printed.
• Confirmed: The shipment has been confirmed and is set for processing.
• Picked: The package has been picked up for delivery.

Allowed:
string
length between 2 and 2

An abbreviation representing the destination country for the shipment, following the ISO 3166-1 alpha-2 standard, for example, "GB" for the United Kingdom.

date

A timestamp indicating the start date for filtering shipments in the query. This helps users retrieve shipments created or processed after this specified date.

Note: The date must be in the YYYY-MM-DD format. If the date is not provided, then the value in this field defaults to the current (today's) date.

date

A timestamp indicating the end date for filtering shipments in the query. This allows users to view shipments processed up to this specified date.

Note: The date must be in the YYYY-MM-DD format. If the date is not provided, then the value in this field defaults to the current (today's) date.

int32
1 to 2147483647
Defaults to 100

An integer that defines the number of shipments returned per page in the response. For instance, if pageSize is set to 20, the API will return up to 20 shipments in each response.

Note: By default, this value is set to 100.

int32
1 to 2147483647
Defaults to 1

An integer indicating the specific page of results to retrieve, allowing for pagination of larger datasets. For example, if pageNumber is set to 3, the API will return the results corresponding to the third page of shipments based on the specified pageSize.

Note: By default, this value is set to 1.

Responses

401

Unauthorized

403

Forbidden

404

The shipping location was not found.

500

Internal Server Error

Updated 21 days ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated 21 days ago

Did this page help you?