Integration API · Catalog sync

Create or rename a category

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

Creates the category on first use and renames it afterwards. Link products to it with category_external_ids.

Integration key with the catalog:write ability: Authorization: Bearer {key}.

Path parameters

external_idstringrequired

Your category id.

namestringrequired

Category name.

{
    "name": "Аудіо"
}

200The category.

{
    "external_id": "erp-cat-audio",
    "data": {
        "id": 7,
        "name": "Аудіо"
    }
}

401Missing, unknown or revoked key.

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

403The key lacks catalog:write, or the store’s plan has no API access.

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

422A field is invalid; field names it.

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

429More than 60 requests a minute for this key. Wait Retry-After seconds.

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