Shipment Summary

get

https://api.commercevu.io/v1/realm/gateway/organizations/{organizationId}/tracking/shipments/

Returns a list of all shipments in the CommerceVu network.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

organizationId

string

required

The unique id of the organization

Query Params

page[size]

integer

≤ 100

Maximum number of records to be returned from each page of results

page[number]

integer

≥ 1

Maximum number of records to be returned from each page of results

filter[trackingNumber]

string

The specific trackingNumber to filter by

filter[carrierName]

string

The specific carrierName to filter by

filter[serviceLevel]

string

The specific serviceLevel to filter by

filter[referenceNumber1]

string

The specific referenceNumber1 to filter by

filter[referenceNumber2]

string

The specific referenceNumber2 to filter by

filter[trackingStatus]

string

The specific trackingStatus to filter by. Possible values:

READY_FOR_CARRIER
IN_TRANSIT
OUT_FOR_DELIVERY
ATTEMPTED_DELIVERY
DELIVERED
HELD_FOR_CUSTOMER
EXCEPTION
VOIDED
END_OF_LIFE
OTHER

filter[riskScore]

string

The specific riskScore to filter by

filter[hasExceptions]

string

The specific hasExceptions to filter by

filter[lastException]

string

The specific lastException to filter by

filter[shipDateSince]

string

Format: ISO8601 UTC datetime
Description: The specific shipDateSince to filter by

filter[shipDateUntil]

string

Format: ISO8601 UTC datetime
Description: The specific shipDateUntil to filter by

filter[originalEstimatedDeliveryDateSince]

string

Format: ISO8601 UTC datetime
Description: The specific originalEstimatedDeliveryDateSince to filter by

filter[originalEstimatedDeliveryDateUntil]

string

Format: ISO8601 UTC datetime
Description: The specific originalEstimatedDeliveryDateUntil to filter by

filter[currentAcceptableEstimatedDeliveryDateSince]

string

Format: ISO8601 UTC datetime
Description: The specific currentAcceptableEstimatedDeliveryDateSince to filter by

filter[currentAcceptableEstimatedDeliveryDateUntil]

string

Format: ISO8601 UTC datetime
Description: The specific currentAcceptableEstimatedDeliveryDateUntil to filter by

filter[currentEstimatedDeliveryDateSince]

string

Format: ISO8601 UTC datetime
Description: The specific currentEstimatedDeliveryDateSince to filter by

filter[currentEstimatedDeliveryDateUntil]

string

Format: ISO8601 UTC datetime
Description: The specific currentEstimatedDeliveryDateUntil to filter by

filter[w2gEstimatedDeliveryDateSince]

string

Format: ISO8601 UTC datetime
Description: The specific w2gEstimatedDeliveryDateSince to filter by

filter[w2gEstimatedDeliveryDateUntil]

string

Format: ISO8601 UTC datetime
Description: The specific w2gEstimatedDeliveryDateUntil to filter by

filter[deliveredDateSince]

string

Format: ISO8601 UTC datetime
Description: The specific deliveredDateSince to filter by

filter[deliveredDateUntil]

string

Format: ISO8601 UTC datetime
Description: The specific deliveredDateUntil to filter by

filter[originLocality]

string

The specific originLocality to filter by

filter[originRegion]

string

The specific originRegion to filter by

filter[originPostalCode]

string

The specific originPostalCode to filter by

filter[originCountryCode]

string

The specific originCountryCode to filter by

filter[destinationLocality]

string

The specific destinationLocality to filter by

filter[destinationRegion]

string

The specific destinationRegion to filter by

filter[destinationPostalCode]

string

The specific destinationPostalCode to filter by

filter[destinationCountryCode]

string

The specific destinationCountryCode to filter by

filter[shipperAccountNumber]

string

The specific shipperAccountNumber to filter by

filter[hasShipmentLag]

string

The specific hasShipmentLag to filter by

filter[hasAged]

string

The specific hasAged to filter by

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error