Sign in

Create or get Brand ref

POST https://{organization}.myguper.com/api/catalog/{interface}/brand

Find-or-create: if a ref with this refId already exists for the interface, returns the linked entity (no-op, _created: false). Otherwise creates a new entity with the given name AND the external ref pointing to it (_created: true). Idempotent on retry.

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Request body

Content-Type: application/json

{
    "refId": "VTEX-NIKE-001",
    "name": "Nike"
}

Responses

{"id":42,"name":"Nike","_ref":{"source":"vtex","refId":"VTEX-NIKE-001"},"_created":true}
Copied to clipboard