Integration API · Синхронізація каталогу

Створити або перейменувати мітку

PUThttps://{store}/api/v1/integrations/catalog/tags/{external_id}

Створює мітку каталогу під час першого виклику й перейменовує її під час наступних. Значення зберігаються великими літерами. Службові мітки (бейджі знижки чи новинки, якими керує сам магазин) відхиляються.

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

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

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

Ваш id мітки.

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

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

Текст мітки.

Приклад

{
    "value": "Bluetooth 5.3"
}

Відповіді

200Мітка.

{
    "external_id": "erp-tag-wireless",
    "data": {
        "id": 31,
        "value": "BLUETOOTH 5.3",
        "display_mode": "content"
    }
}

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

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

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

{
    "code": "forbidden",
    "message": "Integration key cannot catalog: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
}