GET /v1/commerce/shipping-areas

GET/v1/commerce/shipping-areas

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

inputstringrequired

Responses

200OK

itemsShippingArea[] | nullrequired

Show properties

Array of ShippingArea

city_namestring

district_namestring

idstringrequired

namestringrequired

postal_codeinteger<int64>

province_namestring

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/commerce/shipping-areas?input=string"

const response = await fetch("/v1/commerce/shipping-areas?input=string", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/commerce/shipping-areas?input=string",
)

Response

{
  "items": [
    {
      "city_name": "string",
      "district_name": "string",
      "id": "string",
      "name": "string",
      "postal_code": 0,
      "province_name": "string"
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}