BigCommerce Brands API

openapi: 3.0.0
info:
  title: BigCommerce Abandoned Cart Emails Brands API
  version: 3.0.0
  termsOfService: https://www.bigcommerce.com/terms
  description: Abandoned Cart Emails V3 API managing Handlebars-based emails.
  contact:
    name: BigCommerce
    url: https://www.bigcommerce.com
    email: support@bigcommerce.com
servers:
- url: https://api.bigcommerce.com/stores/{store_hash}/v3
  variables:
    store_hash:
      default: store_hash
      description: Permanent ID of the BigCommerce store.
  description: BigCommerce API Gateway
security:
- X-Auth-Token: []
tags:
- name: Brands
paths:
  /catalog/brands:
    parameters:
    - $ref: '#/components/parameters/Accept'
    get:
      tags:
      - Brands
      summary: BigCommerce Get All Brands
      description: Returns a list of *Brands*. Optional filter parameters can be passed in.
      operationId: getBrands
      parameters:
      - name: id
        in: query
        description: 'Filter items by ID.

          '
        schema:
          type: integer
      - name: id:in
        in: query
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
      - name: id:not_in
        in: query
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
      - name: name
        in: query
        description: 'Filter items by name.

          '
        schema:
          type: string
      - name: name:like
        in: query
        description: Filter items by part of a name. For example, `name:like=new` returns brands with names that include `new`.
        schema:
          type: string
      - name: page_title
        in: query
        description: 'Filter items by page_title.

          '
        schema:
          type: string
      - name: page
        in: query
        description: Specifies the page number in a limited (paginated) list of products.
        schema:
          type: integer
      - name: limit
        in: query
        description: Controls the number of items per page in a limited (paginated) list of products.
        schema:
          type: integer
      - name: include_fields
        in: query
        description: Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
        schema:
          type: string
      - name: exclude_fields
        in: query
        description: Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
        schema:
          type: string
      - name: sort
        in: query
        description: Field name to sort by.
        schema:
          type: string
          enum:
          - name
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                title: Brand Collection Response
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/brand_Full'
                  meta:
                    $ref: '#/components/schemas/metaCollection_Full'
              example:
                data:
                - id: 35
                  name: Sagaform
                  page_title: ''
                  meta_keywords:
                  - ''
                  meta_description: ''
                  image_url: ''
                  search_keywords: ''
                  custom_url:
                    url: /brands/Sagaform.html
                    is_customized: false
                - id: 36
                  name: OFS
                  page_title: OFS
                  meta_keywords:
                  - modern
                  - clean
                  - contemporary
                  meta_description: OFS is a modern brand.
                  image_url: ''
                  search_keywords: kitchen, laundry, cart, storage
                  custom_url:
                    url: /brands/OFS.html
                    is_customized: false
                - id: 37
                  name: Common Good
                  page_title: ''
                  meta_keywords:
                  - ''
                  meta_description: ''
                  image_url: https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/k/screen%20shot%202018-05-07%20at%2012.24.24%20pm_1525785365__65102.png
                  search_keywords: ''
                  custom_url:
                    url: /brands/Common-Good.html
                    is_customized: false
                - id: 38
                  name: BigCommerce
                  page_title: ''
                  meta_keywords:
                  - ''
                  meta_description: ''
                  image_url: ''
                  search_keywords: ''
                  custom_url:
                    url: /bigcommerce/
                    is_customized: false
                - id: 39
                  name: Test Brand One
                  page_title: ''
                  meta_keywords:
                  - ''
                  meta_description: ''
                  image_url: https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/q/apihqggzm__53766.jpg
                  search_keywords: ''
                  custom_url:
                    url: /test-brand-one/
                    is_customized: false
                - id: 40
                  name: Fog Linen Work
                  page_title: ''
                  meta_keywords:
                  - ''
                  meta_description: description
                  image_url: ''
                  search_keywords: ''
                  custom_url:
                    url: /fog-linen-work/
                    is_customized: false
                - id: 41
                  name: Barr-Co.
                  page_title: ''
                  meta_keywords:
                  - ''
                  meta_description: description
                  image_url: ''
                  search_keywords: ''
                  custom_url:
                    url: /barr-co/
                    is_customized: false
                - id: 42
                  name: Thames & Hudson
                  page_title: ''
                  meta_keywords:
                  - ''
                  meta_description: description
                  image_url: ''
                  search_keywords: ''
                  custom_url:
                    url: /thames-hudson/
                    is_customized: false
                - id: 43
                  name: Able Brewing
                  page_title: ''
                  meta_keywords:
                  - ''
                  meta_description: description
                  image_url: ''
                  search_keywords: ''
                  custom_url:
                    url: /able-brewing/
                    is_customized: false
                - id: 44
                  name: Chemex
                  page_title: ''
                  meta_keywords:
                  - ''
                  meta_description: description
                  image_url: ''
                  search_keywords: ''
                  custom_url:
                    url: /chemex/
                    is_customized: false
                - id: 45
                  name: Kinfolk
                  page_title: ''
                  meta_keywords:
                  - ''
                  meta_description: description
                  image_url: ''
                  search_keywords: ''
                  custom_url:
                    url: /kinfolk/
                    is_customized: false
                - id: 46
                  name: Iris Hantverk
                  page_title: ''
                  meta_keywords:
                  - ''
                  meta_description: description
                  image_url: ''
                  search_keywords: ''
                  custom_url:
                    url: /iris-hantverk/
                    is_customized: false
                - id: 47
                  name: Gather Journal
                  page_title: ''
                  meta_keywords:
                  - ''
                  meta_description: description
                  image_url: ''
                  search_keywords: ''
                  custom_url:
                    url: /gather-journal/
                    is_customized: false
                - id: 48
                  name: Openhouse Magazine
                  page_title: ''
                  meta_keywords:
                  - ''
                  meta_description: description
                  image_url: ''
                  search_keywords: ''
                  custom_url:
                    url: /openhouse-magazine/
                    is_customized: false
                - id: 49
                  name: Smith Journal
                  page_title: ''
                  meta_keywords:
                  - ''
                  meta_description: description
                  image_url: ''
                  search_keywords: ''
                  custom_url:
                    url: /smith-journal/
                    is_customized: false
                meta:
                  pagination:
                    total: 15
                    count: 15
                    per_page: 50
                    current_page: 1
                    total_pages: 1
                    links:
                      current: ?page=1&limit=50
    post:
      tags:
      - Brands
      summary: BigCommerce Create a Brand
      description: 'Creates a *Brand*.


        **Required Fields**

        - name


        **Read-Only Fields**

        - id


        **Limits**

        - 30,000 brands per store limit'
      operationId: createBrand
      parameters:
      - $ref: '#/components/parameters/ContentType'
      requestBody:
        content:
          application/json:
            schema:
              title: Brand
              type: object
              description: Common brand properties.
              properties:
                name:
                  maxLength: 255
                  minLength: 1
                  type: string
                  description: 'The name of the brand. Must be unique.

                    Required in POST.'
                  example: Common Good
                  x-required:
                  - post
                  - put
                page_title:
                  maxLength: 255
                  minLength: 0
                  type: string
                  description: 'The title shown in the browser while viewing the brand.

                    '
                  example: Common Good
                meta_keywords:
                  type: array
                  description: 'An array of meta keywords to include in the HTML.

                    '
                  items:
                    type: string
                  example:
                  - modern
                  - clean
                  - contemporary
                meta_description:
                  maxLength: 65535
                  minLength: 0
                  type: string
                  description: 'A meta description to include.

                    '
                  example: Common Good is a modern brand.
                search_keywords:
                  maxLength: 65535
                  minLength: 0
                  type: string
                  description: 'A comma-separated list of keywords that can be used to locate this brand.

                    '
                  example: kitchen, laundry, cart, storage
                image_url:
                  type: string
                  description: 'Image URL used for this category on the storefront. Images can be uploaded via form file post to `/brands/{brandId}/image`, or by providing a publicly accessible URL in this field.

                    '
                  example: https://cdn8.bigcommerce.com/s-12345/product_images/k/your-image-name.png
                  x-url: true
                custom_url:
                  title: Custom Url Brand
                  type: object
                  description: The custom URL for the brand on the storefront.
                  properties:
                    url:
                      type: string
                      description: 'Brand URL on the storefront.

                        '
                      example: /shoes
                      x-url: true
                    is_customized:
                      type: boolean
                      description: 'Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).

                        '
                      example: true
              required:
              - name
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                title: Brand Response
                type: object
                properties:
                  data:
                    title: Brand
                    type: object
                    properties:
                      id:
                        type: integer
                        description: Unique ID of the *Brand*. Read-Only.
                        readOnly: true
                      name:
                        maxLength: 255
                        minLength: 1
                        type: string
                        description: 'The name of the brand. Must be unique.

                          Required in POST.'
                        example: Common Good
                        x-required:
                        - post
                        - put
                      page_title:
                        maxLength: 255
                        minLength: 0
                        type: string
                        description: 'The title shown in the browser while viewing the brand.

                          '
                        example: Common Good
                      meta_keywords:
                        type: array
                        description: 'An array of meta keywords to include in the HTML.

                          '
                        items:
                          type: string
                        example:
                        - modern
                        - clean
                        - contemporary
                      meta_description:
                        maxLength: 65535
                        minLength: 0
                        type: string
                        description: 'A meta description to include.

                          '
                        example: Common Good is a modern brand.
                      search_keywords:
                        maxLength: 65535
                        minLength: 0
                        type: string
                        description: 'A comma-separated list of keywords that can be used to locate this brand.

                          '
                        example: kitchen, laundry, cart, storage
                      image_url:
                        type: string
                        description: 'Image URL used for this category on the storefront. Images can be uploaded via form file post to `/brands/{brandId}/image`, or by providing a publicly accessible URL in this field.

                          '
                        example: https://cdn8.bigcommerce.com/s-12345/product_images/k/your-image-name.png
                        x-url: true
                      custom_url:
                        title: Custom Url Brand
                        type: object
                        properties:
                          url:
                            type: string
                            description: 'Brand URL on the storefront.

                              '
                            example: /shoes
                            x-url: true
                          is_customized:
                            type: boolean
                            description: 'Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).

                              '
                            example: true
                        description: The custom URL for the brand on the storefront.
                    description: Common Brand properties.
                  meta:
                    $ref: '#/components/schemas/metaEmpty_Full'
                description: 'Brand Response returns for:

                  * Create Brand

                  * Get Brand by Id

                  * Update Brand by Id'
              example:
                data:
                  id: 50
                  name: Common Good
                  meta_keywords:
                  - modern
                  - clean
                  - contemporary
                  meta_description: Common Good is a modern brand
                  image_url: ''
                  search_keywords: kitchen, laundry, cart, storage
                  custom_url:
                    url: /brands/Common-Good.html
                    is_customized: false
                meta: {}
        '207':
          $ref: '#/components/responses/General207Status'
        '409':
          description: Brand was in conflict with another brand. This is the result of duplicate unique fields such as name.
          content:
            application/json:
              schema:
                title: Error Response
                type: object
                properties:
                  errors:
                    title: Detailed Errors
                    type: object
                    properties: {}
                    additionalProperties: true
                  instance:
                    type: string
                  status:
                    type: integer
                    description: 'The HTTP status code.

                      '
                  title:
                    type: string
                    description: 'The error title describing the particular error.

                      '
                  type:
                    type: string
        '422':
          description: Brand was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.
          content:
            application/json:
              schema:
                title: Error Response
                type: object
                properties:
                  errors:
                    title: Detailed Errors
                    type: object
                    properties: {}
                    additionalProperties: true
                  instance:
                    type: string
                  status:
                    type: integer
                    description: 'The HTTP status code.

                      '
                  title:
                    type: string
                    description: 'The error title describing the particular error.

                      '
                  type:
                    type: string
      x-codegen-request-body-name: Brand
    delete:
      tags:
      - Brands
      summary: BigCommerce Delete Brands
      description: "To delete brand objects, you must include a filter.\n\n**Required Fields**\n - name"
      operationId: deleteBrands
      parameters:
      - name: name
        in: query
        description: 'Filter items by name.

          '
        schema:
          type: string
        required: true
      - name: page_title
        in: query
        description: 'Filter items by page_title.

          '
        schema:
          type: string
      responses:
        '204':
          description: ''
          content: {}
  /catalog/brands/{brand_id}:
    parameters:
    - $ref: '#/components/parameters/Accept'
    - $ref: '#/components/parameters/BrandIdParam'
    get:
      tags:
      - Brands
      summary: BigCommerce Get a Brand
      description: Returns a single *Brand*. Optional filter parameters can be passed in.
      operationId: getBrand
      parameters:
      - name: include_fields
        in: query
        description: Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
        schema:
          type: string
      - name: exclude_fields
        in: query
        description: Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                title: Brand Response
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/brand_Full'
                  meta:
                    $ref: '#/components/schemas/metaEmpty_Full'
                description: 'Brand Response returns for:

                  * Create Brand

                  * Get Brand by Id

                  * Update Brand by Id'
              example:
                data:
                  id: 50
                  name: Common Good
                  meta_keywords:
                  - modern
                  - clean
                  - contemporary
                  meta_description: Common Good is a modern brand
                  image_url: ''
                  search_keywords: kitchen, laundry, cart, storage
                  custom_url:
                    url: /brands/Common-Good.html
                    is_customized: false
                meta: {}
        '404':
          description: 'The resource was not found.

            '
          content:
            application/json:
              schema:
                title: Not Found
                type: object
                properties:
                  status:
                    type: integer
                    description: '404 HTTP status code.

                      '
                  title:
                    type: string
                    description: The error title describing the particular error.
                  type:
                    type: string
                  instance:
                    type: string
                description: Error payload for the BigCommerce API.
    put:
      tags:
      - Brands
      summary: BigCommerce Update a Brand
      description: 'Updates a *Brand*.


        **Required Fields**

        - None


        **Read-Only Fields**

        - id


        To update a *Brand Image*, send a request with an `image_url`.'
      operationId: updateBrand
      parameters:
      - $ref: '#/components/parameters/ContentType'
      requestBody:
        content:
          application/json:
            schema:
              title: Brand
              required:
              - name
              type: object
              properties:
                id:
                  type: integer
                  description: Unique ID of the *Brand*. Read-Only.
                  readOnly: true
                name:
                  maxLength: 255
                  minLength: 1
                  type: string
                  description: 'The name of the brand. Must be unique.

                    Required in POST.'
                  example: Common Good
                  x-required:
                  - post
                  - put
                page_title:
                  maxLength: 255
                  minLength: 0
                  type: string
                  description: 'The title shown in the browser while viewing the brand.

                    '
                  example: Common Good
                meta_keywords:
                  type: array
                  description: 'An array of meta keywords to include in the HTML.

                    '
                  items:
                    type: string
                  example:
                  - modern
                  - clean
                  - contemporary
                meta_description:
                  maxLength: 65535
                  minLength: 0
                  type: string
                  description: 'A meta description to include.

                    '
                  example: Common Good is a modern brand.
                search_keywords:
                  maxLength: 65535
                  minLength: 0
                  type: string
                  description: 'A comma-separated list of keywords that can be used to locate this brand.

                    '
                  example: kitchen, laundry, cart, storage
                image_url:
                  type: string
                  description: 'Image URL used for this category on the storefront. Images can be uploaded via form file post to `/brands/{brandId}/image`, or by providing a publicly accessible URL in this field.

                    '
                  example: https://cdn8.bigcommerce.com/s-12345/product_images/k/your-image-name.png
                  x-url: true
                custom_url:
                  title: Custom Url Brand
                  type: object
                  properties:
                    url:
                      type: string
                      description: 'Brand URL on the storefront.

                        '
                      example: /shoes
                      x-url: true
                    is_customized:
                      type: boolean
                      description: 'Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).

                        '
                      example: true
                  description: The custom URL for the brand on the storefront.
              description: Common Brand properties.
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                title: Brand Response
                type: object
                properties:
                  data:
                    title: Brand
                    required:
                    - name
                    type: object
                    properties:
                      id:
                        type: integer
                        description: Unique ID of the *Brand*. Read-Only.
                        readOnly: true
                      name:
                        maxLength: 255
                        minLength: 1
                        type: string
                        description: 'The name of the brand. Must be unique.

                          Required in POST.'
                        example: Common Good
                        x-required:
                        - post
                        - put
                      page_title:
                        maxLength: 255
                        minLength: 0
                        type: string
                        description: 'The title shown in the browser while viewing the brand.

                          '
                        example: Common Good
                      meta_keywords:
                        type: array
                        description: 'An array of meta keywords to include in the HTML.

                          '
                        items:
                          type: string
                        example:
                        - modern
                        - clean
                        - contemporary
                      meta_description:
                        maxLength: 65535
                        minLength: 0
                        type: string
                        description: 'A meta description to include.

                          '
                        example: Common Good is a modern brand.
                      search_keywords:
                        maxLength: 65535
                        minLength: 0
                        type: string
                        description: 'A comma-separated list of keywords that can be used to locate this brand.

                          '
                        example: kitchen, laundry, cart, storage
                      image_url:
                        type: string
                        description: 'Image URL used for this category on the storefront. Images can be uploaded via form file post to `/brands/{brandId}/image`, or by providing a publicly accessible URL in this field.

                          '
                        example: https://cdn8.bigcommerce.com/s-12345/product_images/k/your-image-name.png
                        x-url: true
                      custom_url:
                        title: Custom Url Brand
                        type: object
                        properties:
                          url:
                            type: string
                            description: 'Brand URL on the storefront.

                              '
                            example: /shoes
                            x-url: true
                          is_customized:
                            type: boolean
                            description: 'Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).

                              '
                            example: true
                        description: The custom URL for the brand on the storefront.
                    description: Common Brand properties.
                  meta:
                    $ref: '#/components/schemas/metaEmpty_Full'
                description: 'Brand Response returns for:

                  * Create Brand

                  * Get Brand by Id

                  * Update Brand by Id'
              example:
                data:
                  id: 50
                  name: Common Good
                  meta_keywords:
                  - modern
                  - clean
                  - contemporary
                  meta_description: Common Good is a modern brand
                  image_url: ''
                  search_keywords: kitchen, laundry, cart, storage
                  custom_url:
                    url: /brands/Common-Good.html
                    is_customized: false
                meta: {}
        '207':
          $ref: '#/components/responses/General207Status'
        '404':
          description: 'The resource was not found.

            '
          content:
            application/json:
              schema:
                title: Not Found
                type: object
                properties:
                  status:
                    type: integer
                    description: '404 HTTP status code.

                      '
                  title:
                    type: string
                    description: The error title describing the particular error.
                  type:
                    type: string
                  instance:
                    type: string
                description: Error payload for the BigCommerce API.
        '409':
          description: 'The `Brand` was in conflict with another product. This is the result of duplicate unique values, such as `name`.

            '
          content:
            application/json:
              schema:
                title: Error Response
                type: object
                properties:
                  errors:
                    title: Detailed Errors
                    type: object
                    properties: {}
                    additionalProperties: true
                  instance:
                    type: string
                  status:
                    type: integer
                    description: 'The HTTP status code.

                      '
                  title:
                    type: string
                    description: 'The error title describing the particular error.

                      '
                  type:
                    type: string
        '422':
          description: 'The `Brand` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

            '
          content:
            application/json:
              schema:
                title: Error Response
                type: object
                properties:
                  errors:
                    title: Detailed Errors
                    type: object
                    prope

# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bigcommerce/refs/heads/main/openapi/bigcommerce-brands-api-openapi.yml