Integration API · Catalog sync

Create or rename a tag

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

Creates a catalog tag on first use and renames it afterwards. Values are stored in upper case. Status labels (such as sale or new badges the store manages itself) are rejected.

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

Path parameters

external_idstringrequired

Your tag id.

Request body application/json

valuestringrequired

Tag text.

Example

{
    "value": "Bluetooth 5.3"
}

Responses

200The tag.

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

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
}