List shipping rates of a zone
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/shipping-zones/1/rates?delivery_type=STANDARD';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The ID of the shipping zone the rate belongs to.
The store’s ref, as returned by GET /stores.
Query Parameters
Section titled “Query Parameters”Return only rates of this delivery type.
Return only active or only inactive rates.
Responses
Section titled “Responses”object
The zone’s rates, in display order.
object
Kind of delivery.
FIXED charges amount; CARRIER_QUOTE takes the price from the carrier at checkout.
What the rate’s min_value and max_value are measured on: NONE, the order value or the weight in grams.
Why an active carrier rate cannot produce options right now: carrier_not_connected, or null.
Rate ID.
ID of the zone the rate belongs to.
Name shown to the shopper at checkout.
Fee charged for a fixed rate; 0 means free. Always 0 for a carrier rate.
Lower bound of the condition, or null.
Upper bound of the condition, or null.
Fastest estimated delivery in days, or null.
Slowest estimated delivery in days, or null.
Carrier of a carrier rate: allingo. Null for a fixed rate.
IDs of the carrier services a carrier rate offers. Empty for a fixed rate.
Amount added to the carrier’s quote; may be negative. 0 for a fixed rate.
Whether the rate is offered at checkout.
Position of the rate in the zone’s list.
Gaps, overlaps or an empty zone, computed over all the zone’s rates before any filter.
object
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.
What from and to are measured on, or null for an empty zone.
Delivery type the issue applies to, or null.
Start of the affected range, or null.
End of the affected range, or null.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}