List Shipping Zones

GET {{baseUrl}}/shipping/zones?company=<number>

This endpoint allows you to list all Custom Shipping Zones.

Scope: shipping.read- Shipping Read Only

Request Params

KeyDatatypeRequiredDescription
companystringShipping Company ID

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;status&quot;:&quot;\u003cnumber\u003e&quot;,&quot;success&quot;:&quot;\u003cboolean\u003e&quot;,&quot;data&quot;:[{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;zone_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;company&quot;:{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;slug&quot;:&quot;\u003cstring\u003e&quot;},&quot;country&quot;:{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;name_en&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;mobile_code&quot;:&quot;\u003cstring\u003e&quot;},&quot;city&quot;:{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;name_en&quot;:&quot;\u003cstring\u003e&quot;},&quot;cities_excluded&quot;:[{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;name_en&quot;:&quot;\u003cstring\u003e&quot;},{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;name_en&quot;:&quot;\u003cstring\u003e&quot;}],&quot;fees&quot;:{&quot;amount&quot;:&quot;\u003cstring\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;weight_unit&quot;:&quot;\u003cstring\u003e&quot;,&quot;up_to_weight&quot;:&quot;\u003cnumber\u003e&quot;,&quot;amount_per_unit&quot;:&quot;\u003cnumber\u003e&quot;,&quot;per_unit&quot;:&quot;\u003cnumber\u003e&quot;},&quot;cash_on_delivery&quot;:{&quot;status&quot;:true,&quot;fees&quot;:&quot;\u003cstring\u003e&quot;},&quot;duration&quot;:&quot;\u003cstring\u003e&quot;},{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;zone_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;company&quot;:{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;slug&quot;:&quot;\u003cstring\u003e&quot;},&quot;country&quot;:{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;name_en&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;mobile_code&quot;:&quot;\u003cstring\u003e&quot;},&quot;city&quot;:{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;name_en&quot;:&quot;\u003cstring\u003e&quot;},&quot;cities_excluded&quot;:[{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;name_en&quot;:&quot;\u003cstring\u003e&quot;},{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;name_en&quot;:&quot;\u003cstring\u003e&quot;}],&quot;fees&quot;:{&quot;amount&quot;:&quot;\u003cstring\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;weight_unit&quot;:&quot;\u003cstring\u003e&quot;,&quot;up_to_weight&quot;:&quot;\u003cnumber\u003e&quot;,&quot;amount_per_unit&quot;:&quot;\u003cnumber\u003e&quot;,&quot;per_unit&quot;:&quot;\u003cnumber\u003e&quot;},&quot;cash_on_delivery&quot;:{&quot;status&quot;:true,&quot;fees&quot;:&quot;\u003cstring\u003e&quot;},&quot;duration&quot;:&quot;\u003cstring\u003e&quot;}],&quot;pagination&quot;:{&quot;count&quot;:&quot;\u003cnumber\u003e&quot;,&quot;total&quot;:&quot;\u003cnumber\u003e&quot;,&quot;perPage&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currentPage&quot;:&quot;\u003cnumber\u003e&quot;,&quot;totalPages&quot;:&quot;\u003cnumber\u003e&quot;,&quot;links&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]}}