Storefront API · Кошик

Вказати адресу

PUThttps://{store}/api/v1/cart/addresses/{type}

Встановлює адресу доставки чи оплати. Від адреси доставки залежать способи доставки, тож вкажіть її, перш ніж їх запитувати. Без адреси оплати під час оформлення використовується адреса доставки.

Токен кошика з POST /carts: X-Cart-Token: {token}.

Параметри шляху

typestringобов'язковий

shipping або billing.

shippingbilling

Тіло запиту application/json

first_namestringобов'язкове

До 120 символів.

last_namestringобов'язкове

До 120 символів.

line_onestringобов'язкове

Вулиця й будинок. Для відділення чи самовивозу — будь-який короткий текст: адресу заповнить відділення.

line_twostring

Квартира, поверх.

citystringобов'язкове

Місто.

postcodestring

Поштовий індекс; потрібен для кур’єрської доставки.

country_idintegerобов'язкове

Id країни зі списку країн магазину.

contact_emailstring

Email покупця; оформленню він потрібен тут або в окремому полі.

contact_phonestring

Телефон покупця; обов’язковий для оформлення.

delivery_instructionsstring

Коментар для кур’єра, до 2000 символів.

Приклад

{
    "first_name": "Олена",
    "last_name": "Коваль",
    "line_one": "вул. Хрещатик, 1",
    "city": "Київ",
    "postcode": "01001",
    "country_id": 1,
    "contact_email": "[email protected]",
    "contact_phone": "+380671234567"
}

Відповіді

200Кошик.

{
    "data": {
        "id": "42",
        "currency": "UAH",
        "lines": [
            {
                "id": "7",
                "purchasable_id": "15",
                "quantity": 1,
                "unit_price": 599900,
                "total": 599900
            }
        ],
        "totals": {
            "subtotal": 599900,
            "shipping": 0,
            "tax": 0,
            "discount": 0,
            "total": 599900
        },
        "shipping_option": "NOVA_POSHTA",
        "shipping_paid_by": "customer",
        "shipping_delivery": {
            "shipping_method_id": 1,
            "shipping_method_code": "NOVA_POSHTA",
            "shipping_method_name": "Нова пошта",
            "carrier": "nova_poshta",
            "carrier_name": "Нова пошта",
            "service_type": "branch",
            "city_ref": "8d5a980d-391c-11dd-90d9-001a92567626",
            "delivery_point_ref": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
            "city_name": "Київ",
            "delivery_point_name": "Відділення №12"
        }
    }
}

422Не передано обов’язкове поле.

{
    "message": "The first name field is required.",
    "errors": {
        "first_name": [
            "The first name field is required."
        ]
    }
}

401Немає X-Cart-Token, токен прострочений або кошик уже оформлено.

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

429Забагато запитів (створення кошика 20/хв з IP, запити кошика 120/хв, оформлення 10/хв).

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