openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account Brand API
  description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud  Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)"
  version: '1.0'
servers:
- url: https://{providerApiEndpoint}
  description: Anti-fraud provider endpoint URL.
  variables:
    providerApiEndpoint:
      description: Anti-fraud provider endpoint URL.
      default: '{providerApiEndpoint}'
tags:
- name: Brand
paths:
  /api/catalog-seller-portal/brands:
    get:
      tags:
      - Brand
      summary: VTex Get List of Brands
      description: " >\U0001F4D8 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). \r\n\r\n Retrieves general information about all brands of the store. It is mandatory to use at least one query parameter.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| CatalogV2 | Management | **Brand Read** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: ListBrand
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - name: q
        in: query
        description: Search word.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: tshirt
      - name: from
        in: query
        description: The first page of the interval of the brand list.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '1'
      - name: to
        in: query
        description: The last page of the interval of the brand list.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '50'
      - name: orderBy
        in: query
        description: The order that the list is displayed. You can select `name`, or `updated_at` to select the order criteria. Then you can add `,` , `asc` or `desc` to define the brands order.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: status,asc;name,asc
      - name: name
        in: query
        description: Brand name.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: Zwilling
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                data:
                - id: '863'
                  name: Zwilling
                  isActive: false
                  createdAt: '2021-01-18T14:41:45.696488+00:00'
                  updatedAt: '2021-01-18T14:41:45.696488+00:00'
                - id: '1298'
                  name: Zooz Pets
                  isActive: false
                  createdAt: '2021-01-18T14:45:32.900176+00:00'
                  updatedAt: '2021-01-18T14:45:32.900176+00:00'
                _metadata:
                  total: 1399
                  from: 1
                  to: 10
                  orderBy: name,desc
              schema:
                type: object
                required:
                - data
                - _metadata
                properties:
                  data:
                    type: array
                    description: List with information about the store's brands.
                    items:
                      type: object
                      description: Brand information.
                      required:
                      - id
                      - name
                      - isActive
                      - createdAt
                      - updatedAt
                      properties:
                        id:
                          type: string
                          description: Brand unique identifier number.
                        name:
                          type: string
                          description: Brand name.
                        isActive:
                          type: boolean
                          description: The condition defines if the brand is active (`true`) or inactive (`false`).
                        createdAt:
                          type: string
                          description: Date when the brand was created.
                        updatedAt:
                          type: string
                          description: Last date when the brand was updated.
                  _metadata:
                    type: object
                    description: Information about the organization and exhibition of the brand list.
                    required:
                    - total
                    - from
                    - to
                    - orderBy
                    properties:
                      total:
                        type: integer
                        description: Total of brands on the list.
                      from:
                        type: integer
                        description: The first page of the interval of the brand list.
                      to:
                        type: integer
                        description: The last page of the interval of the brand list.
                      orderBy:
                        type: string
                        description: The order that the list is displayed. You can select `name`, or `updated_at` to select the order criteria. Then you can add `,` , `asc` or `desc` to define the brands order.
    post:
      tags:
      - Brand
      summary: VTex Create Brand
      description: " >\U0001F4D8 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). \r\n\r\n Creates a new brand.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| CatalogV2 | Management | **Brand Write** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: PostBrand
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - isActive
              properties:
                name:
                  type: string
                  description: Brand name.
                  example: Zwilling
                isActive:
                  type: boolean
                  description: The condition defines if the brand is active (`true`) or inactive (`false`).
                  example: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                id: '863'
                name: Zwilling
                isActive: true
                createdAt: '2021-05-17T15:20:36.077253+00:00'
                updatedAt: '2021-01-18T14:41:45.696488+00:00'
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Brand unique identifier number.
                  name:
                    type: string
                    description: Brand name.
                  isActive:
                    type: boolean
                    description: The condition defines if the brand is active (`true`) or inactive (`false`).
                  createdAt:
                    type: string
                    description: Date when the brand was created.
                  updatedAt:
                    type: string
                    description: Last date when the brand was updated.
  /api/catalog-seller-portal/brands/{brandId}:
    get:
      tags:
      - Brand
      summary: VTex Get Brand by ID
      description: " >\U0001F4D8 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). \r\n\r\n Retrieves general information about a brand by its ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| CatalogV2 | Management | **Brand Read** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: GetBrand
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - name: brandId
        in: path
        description: Brand unique identifier number.
        required: true
        schema:
          type: string
          example: '863'
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                id: '863'
                name: Zwilling
                isActive: false
                createdAt: '2021-01-18T14:41:45.696488+00:00'
                updatedAt: '2021-01-18T14:41:45.696488+00:00'
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Brand unique identifier number.
                  name:
                    type: string
                    description: Brand name.
                  isActive:
                    type: boolean
                    description: The condition defines if the brand is active (`true`) or inactive (`false`).
                  createdAt:
                    type: string
                    description: Date when the brand was created.
                  updatedAt:
                    type: string
                    description: Last date when the brand was updated.
    put:
      tags:
      - Brand
      summary: VTex Update Brand
      description: " >\U0001F4D8 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). \r\n\r\n Updates an existing brand.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| CatalogV2 | Management | **Brand Write** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: PutBrand
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - name: brandId
        in: path
        description: Brand unique identifier number.
        required: true
        schema:
          type: string
          example: '20'
      requestBody:
        content:
          application/json:
            example:
              id: '20'
              name: Zwilling
              isActive: true
            schema:
              type: object
              required:
              - id
              - name
              - isActive
              properties:
                id:
                  type: string
                  description: Brand unique identifier number.
                  example: '20'
                name:
                  type: string
                  description: Brand name.
                  example: Zwilling
                isActive:
                  type: boolean
                  description: The condition defines if the brand is active (`true`) or inactive (`false`).
                  example: true
      responses:
        '204':
          description: No Content
  /api/catalog_system/pvt/brand/list:
    get:
      tags:
      - Brand
      summary: VTex Get brand list
      description: "Retrieves all brands registered in the store's Catalog. \r\n>⚠️ This route's response is limited to 20k results. If you need to obtain more results, please use the [Get paginated brand list](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-brand-list) endpoint instead to get a paginated response.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Content | **Brands** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: BrandList
      parameters:
      - $ref: '#/components/parameters/Content-Type_2'
      - $ref: '#/components/parameters/Accept_2'
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
              - id: 9280
                name: Brand
                isActive: true
                metaTagDescription: Brand
                imageUrl: null
              - id: 2000000
                name: Orma Carbon
                isActive: true
                metaTagDescription: Orma Carbon
                imageUrl: null
              - id: 2000001
                name: Pedigree
                isActive: true
                metaTagDescription: ''
                imageUrl: null
              schema:
                type: array
                description: An array with all brands registered in the store.
                items:
                  $ref: '#/components/schemas/BrandGet'
      deprecated: false
  /api/catalog_system/pvt/brand/pagedlist:
    get:
      tags:
      - Brand
      summary: VTex Get paginated brand list
      description: "Retrieves all brands registered in the store's Catalog by page number.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Content | **Brands** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: BrandListPerPage
      parameters:
      - $ref: '#/components/parameters/Content-Type_2'
      - $ref: '#/components/parameters/Accept_2'
      - name: pageSize
        in: query
        required: true
        description: Quantity of brands per page.
        schema:
          type: integer
          example: 5
      - name: page
        in: query
        required: true
        description: Page number of the brand list.
        schema:
          type: integer
          example: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                - items
                - paging
                properties:
                  items:
                    type: array
                    description: Array of objects with information of the store's brands.
                    items:
                      $ref: '#/components/schemas/BrandGet'
                  paging:
                    type: object
                    description: Object with pagination information.
                    example:
                      page: 1
                      perPage: 3
                      total: 6
                      pages: 2
                    required:
                    - page
                    - perPage
                    - total
                    - pages
                    properties:
                      page:
                        type: integer
                        description: Page number of the brand list.
                        example: 1
                      perPage:
                        type: integer
                        description: Quantity of brands per page.
                        example: 3
                      total:
                        type: integer
                        description: Total of brands in the store.
                        example: 6
                      pages:
                        type: integer
                        description: Total number of pages.
                        example: 2
  /api/catalog_system/pvt/brand/{brandId}:
    get:
      tags:
      - Brand
      summary: VTex Get brand by ID
      description: "Retrieves a specific brand by its ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Content | **Brands** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: Brand
      parameters:
      - $ref: '#/components/parameters/Content-Type_2'
      - $ref: '#/components/parameters/Accept_2'
      - name: brandId
        in: path
        description: Brand ID.
        required: true
        style: simple
        schema:
          type: string
          example: '123'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandGet'
              example:
                id: 7000000
                name: Pedigree
                isActive: true
                metaTagDescription: Pedigree
                imageUrl: null
      deprecated: false
  /api/catalog/pvt/brand:
    post:
      tags:
      - Brand
      summary: VTex Create brand
      description: "Creates a new brand.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Content | **Brands Management** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      parameters:
      - $ref: '#/components/parameters/Content-Type_2'
      - $ref: '#/components/parameters/Accept_2'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandCreateUpdate'
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                Id: 2000013
                Name: Orma Carbon
                Text: Orma Carbon
                Keywords: orma
                SiteTitle: Orma Carbon
                Active: true
                MenuHome: true
                AdWordsRemarketingCode: ''
                LomadeeCampaignCode: ''
                Score: null
                LinkId: orma-carbon
              schema:
                $ref: '#/components/schemas/BrandCreateUpdate'
  /api/catalog/pvt/brand/{brandId}:
    get:
      tags:
      - Brand
      summary: VTex Get brand and context
      description: "Retrieves information about a specific brand and its context.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Content | **Brand Management** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      parameters:
      - $ref: '#/components/parameters/Content-Type_2'
      - $ref: '#/components/parameters/Accept_2'
      - name: brandId
        in: path
        description: Brand ID.
        required: true
        style: simple
        schema:
          type: string
          example: '123'
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                Id: 2000013
                Name: Orma Carbon
                Text: Orma Carbon
                Keywords: orma
                SiteTitle: Orma Carbon
                Active: true
                MenuHome: true
                AdWordsRemarketingCode: ''
                LomadeeCampaignCode: ''
                Score: null
                LinkId: orma-carbon
              schema:
                $ref: '#/components/schemas/BrandCreateUpdate'
    put:
      tags:
      - Brand
      summary: VTex Update brand
      description: "Updates a previously existing brand.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Content | **Brand Management** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      parameters:
      - name: brandId
        in: path
        required: true
        description: Brand's unique numerical identifier.
        schema:
          type: string
          example: '123'
      - $ref: '#/components/parameters/Content-Type_2'
      - $ref: '#/components/parameters/Accept_2'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandCreateUpdate'
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                Id: 2000013
                Name: Orma Carbon
                Text: Orma Carbon
                Keywords: orma
                SiteTitle: Orma Carbon
                Active: true
                MenuHome: true
                AdWordsRemarketingCode: ''
                LomadeeCampaignCode: ''
                Score: null
                LinkId: orma-carbon
              schema:
                $ref: '#/components/schemas/BrandCreateUpdate'
    delete:
      tags:
      - Brand
      summary: VTex Delete brand
      description: "Deletes an existing brand.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Content | **Brand Management** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      parameters:
      - name: brandId
        in: path
        required: true
        description: Brand's unique numerical identifier.
        schema:
          type: string
          example: '123'
      - $ref: '#/components/parameters/Content-Type_2'
      - $ref: '#/components/parameters/Accept_2'
      responses:
        '200':
          description: OK
components:
  schemas:
    BrandCreateUpdate:
      type: object
      description: Object containing brand information.
      required:
      - Id
      - Name
      properties:
        Id:
          type: integer
          description: Brand's unique numerical identifier.
          example: 2000003
        Name:
          type: string
          description: Brand name.
          example: Adidas
        Text:
          type: string
          description: Meta description for the brand page. A brief description of the brand, displayed by search engines. Since search engines can only display less than 150 characters, we recommend not exceeding this character limit when creating the description.
          example: Adidas
        Keywords:
          type: string
          description: "Store Framework - Deprecated.\r\nLegacy CMS Portal - Alternative search terms that will lead to the specific brand. The user can find the desired brand even when misspelling it. Used especially when words are of foreign origin and have a distinct spelling that is transcribed into a generic one, or when small spelling mistakes occur."
          example: adidas
        SiteTitle:
          type: string
          description: Meta title for the brand page.
          example: Adidas
        AdWordsRemarketingCode:
          type: string
          description: This is a legacy field. Do not take this information into consideration.
          deprecated: true
        LomadeeCampaignCode:
          type: string
          description: This is a legacy field. Do not take this information into consideration.
          deprecated: true
        Score:
          type: integer
          description: "Store Framework - Deprecated\r\nLegacy CMS Portal - Value used to set the priority on the search result page."
          example: 10
          nullable: true
        MenuHome:
          type: boolean
          description: "Store Framework - Deprecated.\r\nLegacy CMS Portal - Defines if the brand appears in the Department Menu control (`<vtex.cmc:departmentNavigator/>`)."
          example: true
        Active:
          type: boolean
          description: Defines if the brand is active (`true`) or not (`false`).
          example: true
        LinkId:
          type: string
          description: Brand page slug. Only lowercase letters and hyphens (`-`) are allowed.
          example: adidas-sports
          nullable: true
      example:
        Id: 2000013
        Name: Orma Carbono2
        Text: Orma Carbon2
        Keywords: orma
        SiteTitle: Orma Carbon2
        Active: true
        MenuHome: true
        AdWordsRemarketingCode: ''
        LomadeeCampaignCode: ''
        Score: null
        LinkId: null
    BrandGet:
      type: object
      description: Object containing brand information.
      required:
      - id
      - name
      - isActive
      - imageUrl
      - title
      - metaTagDescription
      properties:
        id:
          type: integer
          description: Brand's unique numerical identifier.
        name:
          type: string
          description: Brand name.
        isActive:
          type: boolean
          description: Defines if the brand is active (`true`) or not (`false`).
        title:
          type: string
          description: Meta title for the brand page.
        metaTagDescription:
          type: string
          description: Meta Description for the brand page. A brief description of the brand, displayed by search engines. Since search engines can only display less than 150 characters, we recommend not exceeding this character limit when creating the description.
        imageUrl:
          type: string
          description: URL of the brand's image.
          nullable: true
  parameters:
    Accept_2:
      name: Accept
      in: header
      description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
      required: true
      style: simple
      schema:
        type: string
        default: application/json
    Accept:
      name: Accept
      in: header
      description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
      required: true
      style: simple
      schema:
        type: string
        example: application/json
    Content-Type:
      name: Content-Type
      in: header
      description: Type of the content being sent.
      required: true
      style: simple
      schema:
        type: string
        example: application/json
    Content-Type_2:
      name: Content-Type
      in: header
      description: Type of the content being sent.
      required: true
      style: simple
      schema:
        type: string
        default: application/json
  securitySchemes:
    VtexIdclientAutCookie:
      type: apiKey
      in: header
      name: VtexIdclientAutCookie
      description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'