/global-addresses/{globalAddressId}/inventory

List the shipment loads currently at, inbound to, or outbound from a global address. Inventory accumulates only at crossdock-capable global addresses; any other address returns an empty page. Records move automatically as legs execute: a load becomes inbound while a leg drives toward the address, at once it is unloaded there, outbound while a departing leg is on its way to pick it up, and the record disappears when the load leaves. Loads whose goods no longer exist, reported lost or damaged and disposed of, are left out: this is a picture of what is physically on the floor. To ask what became of one such load, read its location instead.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the global address.

Query Params
string
enum

Only return records in this state. Omit for all states.

Allowed:
number

Maximum number of items to return in one page.

string

Opaque pagination cursor from the previous response's cursors.after.

Responses

400

Invalid request parameters.

401

Unauthorized - invalid or missing API key.

404

Global address not found.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json