Sign in

List refs of a Brand

GET https://{organization}.myguper.com/api/catalog/brand-external-ref/by-brand/{brandId}

Lists every external refId mapped to one brand, one row per source (interface).

Reverse of /api/catalog/{interface}/brand/{refId}: that one goes refId -> entity, this one goes entity -> refIds. Mirrors /api/register/person-external-ref/by-person/{personId}.

Returns an empty array when the brand has no mapping. Does not 404 on an unknown id.

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.

Path parameters

Name Type Description
brandId * integer Guper id of the brand.

Responses

[{"refId":"VTEX-001","source":"vtex"},{"refId":"11-2","source":"pos"}]
Copied to clipboard