Integration API · Залишки

Оновити залишки

PUThttps://{store}/api/v1/integrations/inventory

Задає залишок до 100 варіантів за раз — за SKU (без урахування регістру) або за id варіанта, зокрема тих, що створені в адмінці, а не лише вашим ключем. Кожен рядок має власний результат: один невідомий SKU не відхиляє всю пачку.

status для кожного рядка: updated, unchanged, not_found або ambiguous_sku, коли SKU мають два варіанти (тоді передайте variant_id). Зміна надсилає вебхук inventory.updated, як і правка в адмінці.

Ключ інтеграції з правом inventory:write: Authorization: Bearer {key}.

Ідемпотентний. Потрібен заголовок Idempotency-Key: повтор із тим самим ключем повертає першу відповідь.

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

itemsarray of objectsобов'язкове

Рядки {sku або variant_id, quantity}: від 1 до 100; quantity від 0 до 1 000 000.

Приклад

{
    "items": [
        {
            "sku": "HOOD-BLK-M",
            "quantity": 12
        },
        {
            "variant_id": 4412,
            "quantity": 0
        }
    ]
}

Відповіді

200Результат для кожного рядка в порядку запиту.

{
    "data": [
        {
            "index": 0,
            "sku": "HOOD-BLK-M",
            "variant_id": 4410,
            "status": "updated",
            "quantity": 12
        },
        {
            "index": 1,
            "sku": null,
            "variant_id": 4412,
            "status": "not_found",
            "quantity": null
        }
    ]
}

401Ключа немає, він невідомий або відкликаний.

{
    "code": "unauthenticated",
    "message": "Integration key is inactive.",
    "field": null
}

403У ключа немає права inventory:write, або тариф магазину без доступу до API.

{
    "code": "forbidden",
    "message": "Integration key cannot inventory:write.",
    "field": null
}

422Поле має помилку; його назва — у field.

{
    "code": "validation_error",
    "message": "name is required.",
    "field": "name"
}

429Понад 60 запитів за хвилину для цього ключа. Зачекайте Retry-After секунд.

{
    "code": "rate_limited",
    "message": "Too many integration requests.",
    "field": null
}

{ "data": [ { "index": 0, "sku": "HOOD-BLK-M", "variant_id": 4410, "status": "updated", "quantity": 12 }, { "index": 1, "sku": null, "variant_id": 4412, "status": "not_found", "quantity": null } ] }