How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

VTEX Brand API

The Brand API from VTEX — 7 operation(s) for brand.

VTEX Brand API is one of 142 APIs that VTEX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Brand. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 7 paths, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://{providerApiEndpoint}.

11 operations 7 paths 2 schemas 1 DELETE6 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://{providerApiEndpoint}
Authentication
API Key
Resource Areas
1

Authentication & Security 1

VTEX Brand API declares 1 security scheme for authenticating requests. An API key is passed in the header as VtexIdclientAutCookie (VtexIdclientAutCookie).

  • VtexIdclientAutCookie — [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 1 DELETE, 6 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Brand 11
GET
/api/catalog-seller-portal/brands
VTex Get List of Brands
ListBrand 7 params → 200
POST
/api/catalog-seller-portal/brands
VTex Create Brand
PostBrand 2 params body → 200
GET
/api/catalog-seller-portal/brands/{brandId}
VTex Get Brand by ID
GetBrand 3 params → 200
PUT
/api/catalog-seller-portal/brands/{brandId}
VTex Update Brand
PutBrand 3 params body → 204
GET
/api/catalog_system/pvt/brand/list
VTex Get brand list
BrandList 2 params → 200
GET
/api/catalog_system/pvt/brand/pagedlist
VTex Get paginated brand list
BrandListPerPage 4 params → 200
GET
/api/catalog_system/pvt/brand/{brandId}
VTex Get brand by ID
Brand 3 params → 200
POST
/api/catalog/pvt/brand
VTex Create brand
2 params body → 200
GET
/api/catalog/pvt/brand/{brandId}
VTex Get brand and context
3 params → 200
PUT
/api/catalog/pvt/brand/{brandId}
VTex Update brand
3 params body → 200
DELETE
/api/catalog/pvt/brand/{brandId}
VTex Delete brand
3 params → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are BrandCreateUpdate (11 properties), BrandGet (6 properties). Each schema is shown below with its type and property counts.

BrandCreateUpdate
object
Object containing brand information.
11 properties 2 required
BrandGet
object
Object containing brand information.
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-brand-api-openapi.yml Raw ↑

Other APIs VTEX publishes across the network.

VTEX Account API
VTEX Addresses API
VTEX Anti-Fraud Flow API
VTEX App Keys API
VTEX Attachment API
VTEX Authentication API
VTEX Autocomplete API
VTEX Bulk Import API
VTEX Carriers API
VTEX Cart Attachments API
VTEX Category API
VTEX Category Specification API
Where this information came from

This is an independent, third-party profile of VTEX Brand API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.