Skip to main content
GET
Check which shipping method a shipping configuration would select for a postcode

Authorizations

Authorization
string
header
required

Token returned by POST /auth/token, sent as Authorization: Bearer <token>.

Query Parameters

store_id
integer
required

Id of the store. Your credential must have access to it.

Example:

1234

shipping_configuration_name
string
required

Name of one of the store's shipping configurations (shipping groups); matched case-insensitively

Example:

"Economy"

shipping_scope
enum<string>
required

Scope of the shipment to simulate

Available options:
national,
international,
pickup
Example:

"national"

postcode
string
required

Destination postcode

Example:

"06600"

country
string
required

Destination country, as an English name or ISO 3166-1 alpha-2 code

Example:

"MX"

for_cod
boolean
default:false

Simulate a cash-on-delivery order

Response

The selected shipping method, or id: null with a message when none covers the destination

Result of a coverage check. Either the selected shipping method, or id: null with a message when nothing covers the destination.

id
integer
required

Shipping method id

Example:

12

carrier_name
string
required

Customer-facing carrier name

Example:

"ESTAFETA"

shipping_type
enum<string>
required

Scope of the method

Available options:
national,
international,
pickup
Example:

"national"

delivery_type
enum<string>
required

Delivery service level

Available options:
SameDay,
NextDay,
Ground,
Pickup,
International
Example:

"Ground"

country
string
required

ISO 3166-1 alpha-2 country of the method

Example:

"MX"

is_cod
boolean
required

Whether this is a dedicated cash-on-delivery method

Example:

false