Skip to main content
GET
Retrieve shipping option transit times
Transit times are aggregated from your account’s recent shipping activity. The response contains one record per (shipping_option_code, from_country_code, to_country_code) row; rows with no transit-time data are omitted. When start_date and end_date are omitted, the response covers the last 90 days (UTC). start_date must be on or before end_date.

Authorizations

Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Query Parameters

shipping_option_code
string[]
required

One or more shipping option codes to retrieve transit times for. Repeat the parameter to pass multiple values.

Minimum array length: 1
Required string length: 1 - 256
Example:
from_country_code
string[]

ISO 3166-1 alpha-2 country codes of the origin to filter by. Repeat the parameter to pass multiple values.

Required string length: 2
Example:
to_country_code
string[]

ISO 3166-1 alpha-2 country codes of the destination to filter by. Repeat the parameter to pass multiple values.

Required string length: 2
Example:
start_date
string<date>

Inclusive start of the window in YYYY-MM-DD format. Defaults to 90 days before today (UTC) when omitted.

Example:

"2025-03-01"

end_date
string<date>

Inclusive end of the window in YYYY-MM-DD format. Defaults to today (UTC) when omitted.

Example:

"2025-03-31"

Response

OK

Response schema for the shipping option transit times endpoint.

transit_times
ShippingOptionTransitTimeRecord · object[]
required

Aggregated transit-time records matching the requested filters. Rows with no transit-time data are omitted.