API References

Get Manifests

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

Retrieves a list of manifests created with a specific carrier. With this endpoint, you can filter manifests based on various criteria, such as shipping locations, accounts, and date ranges, enabling efficient tracking and management of shipment manifests.

Path Params
string
required

A unique identifier representing the shipping carrier for which the manifests are being queried. This code is alphanumeric and helps specify which carrier's manifests the request pertains to, ensuring that you retrieve relevant data.

Query Params
string
length ≤ 100

A unique identifier assigned by the system (ShippingLocationId) or by you (LocationAlias) for the shipping location from which the shipments are being manifested. This information is crucial for linking the manifest to the correct shipping point.

string
length ≤ 50

An identifier assigned by the SAPIENT system or by you (alias) for the shipping container associated with the shipment, important for managing cargo and logistics at scale.

string
length ≤ 36

A unique identifier assigned by the SAPIENT system (ShippingAccountId) or by you (AccountAlias) for the shipping account associated with the shipments. This information is important for billing and tracking purposes, connecting the manifest to the correct account. If needed, provide this information if you want to get the manifests by a specific shipping account only.

date

A timestamp indicating the start date for filtering manifests in the query. This allows you to retrieve manifests created after this specified date, providing a way to narrow down the results based on a specified start date.

Note: The date must be in the YYYY-MM-DD format. By default, this date is set to current (today's) date.

date

A timestamp indicating the end date for filtering manifests in the query. This provides a cutoff date for the results, allowing you to view manifests generated up to this date.

Note: The date must be in the YYYY-MM-DD format. By default, this date is set to current (today's) date.

int32
1 to 2147483647
Defaults to 100

An integer specifying the maximum number of manifests to return per page in the API's response. This parameter helps control the volume of data returned, enhancing performance and user experience.

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

int32
1 to 2147483647
Defaults to 1

An integer indicating which page of results to retrieve, allowing for pagination of larger datasets. In this field, you can specify the page number to access specific segments of the total manifest records.

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

Responses

401

Unauthorized

403

Forbidden

404

The carrier code was not found.

500

Internal Server Error

Updated about 1 month ago

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

Updated about 1 month ago

Did this page help you?