Skip to main content
GET
Quote shipping options for a destination and package

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

zip_code
string
required

Destination zip code

Example:

"06600"

country
enum<string>
default:MX

Destination country code. Only MX and BR are supported.

Available options:
MX,
BR
sku
string

SKU used to match the store's product shipping rules, when configured

Example:

"SKU-RED-M"

shipping_type
enum<string>
default:national

Shipment scope

Available options:
national,
international
width_cm
number
required

Package width in centimeters

Required range: x >= 0.1
Example:

20

height_cm
number
required

Package height in centimeters

Required range: x >= 0.1
Example:

10

length_cm
number
required

Package length in centimeters

Required range: x >= 0.1
Example:

30

weight_kg
number
required

Declared package weight in kilograms

Example:

1.5

order_total
number

Cart value, used to price click-and-collect options when the store prices them by cart value

Example:

1500

item_count
string

Number of units in the cart, used to price click-and-collect options when the store prices them by item count. Digits only.

Pattern: ^\d+$
Example:

"3"

Response

Shipping options. Regular options come first, click-and-collect options (if any) after them.

shipping_method_id
integer
required

Id of the shipping method to use when creating the order

Example:

12

carrier_name
string
required

Carrier name

Example:

"ESTAFETA"

carrier_delivery
enum<string>
required

Delivery service level

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

"Ground"

quoted_weight_kg
number
required

Weight the price was computed for (greater of declared and volumetric weight)

Example:

2

delivery_sla_in_hours
integer | null
required

Total delivery SLA in hours; null for click-and-collect options

Example:

72

price
number | null
required

Shipping price in the store's currency

Example:

149

delivery_eta_range
object | null

Estimated delivery window. Omitted when unavailable; null for click-and-collect options.

is_click_and_collect
boolean

Present and true for pickup-point options

Example:

true

service_code
string

Pickup point identifier to send as click_and_collect_service_code when creating the order

Example:

"CUBBOCNCCUBBOCUBBO001"

location_name
string

Pickup point name

Example:

"Punto Cubbo Centro"

distance_km
number | null

Distance from the destination zip code in kilometers

Example:

0.8

pickup_address
string

Pickup point address

Example:

"Calle Centro 300, CDMX, 06000"

cnc_pricing_basis
enum<string>

Which input priced the pickup option

Available options:
cart_value,
item_count
Example:

"cart_value"