Popular

↑↓ move ↵ open All results →

Storefront API · Shipping

List carriers

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

Carriers the store ships with, their services (branch, parcel_locker, courier…) and their shipping methods with who pays (store, customer, or threshold: the store from an order sum).

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

Responses

200The carriers. 
{
    "data": [
        {
            "code": "nova_poshta",
            "name": "Нова пошта",
            "service_types": [
                "branch",
                "parcel_locker",
                "courier"
            ],
            "supports_shipments": true,
            "shipments_ready": true,
            "shipment_service_types": [
                "branch",
                "parcel_locker",
                "courier"
            ],
            "shipping_methods": [
                {
                    "code": "NOVA_POSHTA",
                    "name": "Нова пошта",
                    "description": "Відділення або поштомат",
                    "service_types": [
                        "branch",
                        "parcel_locker"
                    ],
                    "paid_by": "customer"
                }
            ]
        }
    ]
}
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."
}