Skip to content

List shipping rates of a zone

GET
/stores/{storeRef}/shipping-zones/{zoneId}/rates
curl --request GET \
--url 'https://apibase.ecomweb.app/api/v1/stores/example/shipping-zones/1/rates?delivery_type=STANDARD' \
--header 'x-api-key: <x-api-key>'

Returns the zone’s rates in display order, with coverage_issues listing gaps or overlaps in how the rates cover order value or weight, or an empty zone. delivery_type and is_active narrow data; the coverage check always looks at all the zone’s rates. A carrier rate whose carrier account is not connected carries active_reason carrier_not_connected.

Required scopes: read:shippings

zoneId
required
integer

The ID of the shipping zone the rate belongs to.

storeRef
required
string

The store’s ref, as returned by GET /stores.

delivery_type
string
Allowed values: STANDARD EXPRESS SAME_DAY ECONOMY PICKUP

Return only rates of this delivery type.

is_active
boolean

Return only active or only inactive rates.

Media typeapplication/json
object
data
required

The zone’s rates, in display order.

Array<object>
object
delivery_type
required

Kind of delivery.

string
Allowed values: STANDARD EXPRESS SAME_DAY ECONOMY PICKUP
rate_type
required

FIXED charges amount; CARRIER_QUOTE takes the price from the carrier at checkout.

string
Allowed values: FIXED CARRIER_QUOTE
condition_type
required

What the rate’s min_value and max_value are measured on: NONE, the order value or the weight in grams.

string
Allowed values: NONE ORDER_VALUE WEIGHT
active_reason
required

Why an active carrier rate cannot produce options right now: carrier_not_connected, or null.

string
nullable
Allowed values: carrier_not_connected
id
required

Rate ID.

number
zone_id
required

ID of the zone the rate belongs to.

number
display_name
required

Name shown to the shopper at checkout.

string
amount
required

Fee charged for a fixed rate; 0 means free. Always 0 for a carrier rate.

number
min_value
required

Lower bound of the condition, or null.

number
nullable
max_value
required

Upper bound of the condition, or null.

number
nullable
estimated_days_min
required

Fastest estimated delivery in days, or null.

number
nullable
estimated_days_max
required

Slowest estimated delivery in days, or null.

number
nullable
carrier_code
required

Carrier of a carrier rate: allingo. Null for a fixed rate.

string
nullable
carrier_service_ids
required

IDs of the carrier services a carrier rate offers. Empty for a fixed rate.

Array<string>
price_adjustment
required

Amount added to the carrier’s quote; may be negative. 0 for a fixed rate.

number
is_active
required

Whether the rate is offered at checkout.

boolean
sort_order
required

Position of the rate in the zone’s list.

number
coverage_issues
required

Gaps, overlaps or an empty zone, computed over all the zone’s rates before any filter.

Array<object>
object
kind
required

GAP leaves orders between two tiers with no option, OVERLAP makes two tiers match the same order, EMPTY_ZONE means the zone has no usable rate.

string
Allowed values: GAP OVERLAP EMPTY_ZONE
condition_type
required

What from and to are measured on, or null for an empty zone.

string
nullable
Allowed values: ORDER_VALUE WEIGHT NONE
delivery_type
required

Delivery type the issue applies to, or null.

string
nullable
from
required

Start of the affected range, or null.

number
nullable
to
required

End of the affected range, or null.

number
nullable

Example

{
"data": [
{
"delivery_type": "STANDARD",
"rate_type": "FIXED",
"condition_type": "NONE",
"active_reason": "carrier_not_connected"
}
],
"coverage_issues": [
{
"kind": "GAP",
"condition_type": "ORDER_VALUE"
}
]
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}