Storefront API · Shipping

Search branches and lockers

GEThttps://{store}/api/v1/shipping/delivery-points

Branches or parcel lockers of the carrier in a city, by number or street.

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

Query parameters

carrierstringrequired

Carrier code.

city_refstringrequired

ref of a city from the cities call.

typestringrequired

Service: branch or parcel_locker.

branchparcel_locker

qstring

Number or part of the address.

limitinteger

From 1 to 40. Default 30.

Responses

200Matching points.

{
    "data": [
        {
            "ref": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
            "name": "Відділення №12",
            "number": "12",
            "type": "branch",
            "city_ref": "8d5a980d-391c-11dd-90d9-001a92567626",
            "address": "вул. Князів Острозьких, 32/2",
            "postcode": "01010"
        }
    ]
}

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."
}

{ "data": [ { "ref": "1ec09d88-e1c2-11e3-8c4a-0050568002cf", "name": "Відділення №12", "number": "12", "type": "branch", "city_ref": "8d5a980d-391c-11dd-90d9-001a92567626", "address": "вул. Князів Острозьких, 32/2", "postcode": "01010" } ] }