Storefront API · Shipping

Search cities

GEThttps://{store}/api/v1/shipping/cities

Cities from the carrier’s directory, by the start of the name. Up to 30.

Cart token from POST /carts: X-Cart-Token: {token}.

Query parameters

carrierstringrequired

Carrier code from the carriers call.

qstring

Start of the city name.

Responses

200Matching cities.

{
    "data": [
        {
            "ref": "8d5a980d-391c-11dd-90d9-001a92567626",
            "name": "Київ",
            "label": "Київ, Київська обл."
        }
    ]
}

401No X-Cart-Token, an expired token, or a cart that is already ordered.

{
    "message": "A valid X-Cart-Token header is required.",
    "errors": {
        "cart_token": [
            "Кошик не знайдено, строк доступу минув або його вже оформлено."
        ]
    }
}

429Too many requests (cart creation 20/min per IP, cart calls 120/min, checkout 10/min).

{
    "message": "Too Many Attempts."
}