BigCommerce Values API

openapi: 3.0.0
info:
  title: BigCommerce Abandoned Cart Emails Values 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: Values
paths:
  /catalog/products/{product_id}/modifiers/{modifier_id}/values:
    parameters:
    - $ref: '#/components/parameters/Accept'
    - $ref: '#/components/parameters/ProductIdParam'
    - $ref: '#/components/parameters/ModifierIdParam'
    get:
      tags:
      - Values
      summary: BigCommerce Get All Product Modifier Values
      description: Returns a list of all product *Modifier Values*. Optional parameters can be passed in.
      operationId: getProductModifierValues
      parameters:
      - name: modifier_id
        in: path
        description: 'The ID of the `Modifier`.

          '
        required: true
        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: 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
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                title: Modifier Value Collection Response
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/productModifierOptionValue_Full'
                  meta:
                    $ref: '#/components/schemas/metaCollection_Full'
                description: Returns for GET All Modifier Values on a Product
              example:
                data:
                - id: 190
                  option_id: 222
                  label: 'Yes'
                  sort_order: 0
                  value_data:
                    checked_value: true
                  is_default: false
                  adjusters:
                    price:
                      adjuster: relative
                      adjuster_value: 5
                    weight: {}
                    image_url: ''
                    purchasing_disabled:
                      status: false
                      message: ''
                - id: 191
                  option_id: 222
                  label: 'No'
                  sort_order: 1
                  value_data:
                    checked_value: false
                  is_default: true
                  adjusters:
                    price: {}
                    weight: {}
                    image_url: ''
                    purchasing_disabled:
                      status: false
                      message: ''
                meta:
                  pagination:
                    total: 2
                    count: 2
                    per_page: 50
                    current_page: 1
                    total_pages: 1
                    links:
                      current: ?page=1&limit=50
    post:
      tags:
      - Values
      summary: BigCommerce Create Product Modifier Value
      description: 'Creates a *Modifier Value*.


        **Required Fields**

        * label

        * sort_order


        **Read-Only Fields**

        * id'
      operationId: createProductModifierValue
      parameters:
      - $ref: '#/components/parameters/ContentType'
      - name: modifier_id
        in: path
        description: 'The ID of the `Modifier`.

          '
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              title: Modifier Value Post
              description: The model for a POST to create a modifier value on a product.
              allOf:
              - title: Modifier Value Base
                allOf:
                - title: Option Value Base
                  required:
                  - label
                  - sort_order
                  type: object
                  properties:
                    is_default:
                      type: boolean
                      description: 'The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.

                        '
                      example: false
                    label:
                      type: string
                      description: 'The text display identifying the value on the storefront. Required in a /POST.

                        '
                      example: Green
                      x-required:
                      - post
                    sort_order:
                      maximum: 2147483647
                      minimum: -2147483648
                      type: integer
                      description: 'The order in which the value will be displayed on the product page. Required in a /POST.

                        '
                      example: 0
                      x-required:
                      - post
                    value_data:
                      type: object
                      properties: {}
                      description: 'Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state.

                        '
                  description: Common Option Value properties.
                - type: object
                  properties:
                    adjusters:
                      type: object
                      properties:
                        price:
                          title: Adjuster
                          type: object
                          properties:
                            adjuster:
                              type: string
                              description: 'The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.

                                '
                              nullable: true
                              enum:
                              - relative
                              - percentage
                            adjuster_value:
                              type: number
                              description: 'The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.

                                '
                              example: 5
                          description: Adjuster for Complex Rules.
                        weight:
                          title: Adjuster
                          type: object
                          properties:
                            adjuster:
                              type: string
                              description: 'The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.

                                '
                              nullable: true
                              enum:
                              - relative
                              - percentage
                            adjuster_value:
                              type: number
                              description: 'The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.

                                '
                              example: 5
                          description: Adjuster for Complex Rules.
                        image_url:
                          type: string
                          description: 'The URL for an image displayed on the storefront when the modifier value is selected.Limit of 8MB per file.

                            '
                          example: https://cdn8.bigcommerce.com/s-{{store_hash}}/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.1280.1280.jpg?c=2
                        purchasing_disabled:
                          type: object
                          properties:
                            status:
                              type: boolean
                              description: 'Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value.

                                '
                            message:
                              type: string
                              description: 'The message displayed on the storefront when the purchasing disabled status is `true`.

                                '
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                title: Modifier Value Response
                type: object
                properties:
                  data:
                    title: Modifier Value
                    type: object
                    description: 'Part of Modifier Value Response '
                    allOf:
                    - title: Modifier Value Base
                      type: object
                      allOf:
                      - title: Option Value Base
                        required:
                        - label
                        - sort_order
                        type: object
                        properties:
                          is_default:
                            type: boolean
                            description: 'The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.

                              '
                            example: false
                          label:
                            type: string
                            description: 'The text display identifying the value on the storefront. Required in a /POST.

                              '
                            example: Green
                            x-required:
                            - post
                          sort_order:
                            maximum: 2147483647
                            minimum: -2147483648
                            type: integer
                            description: 'The order in which the value will be displayed on the product page. Required in a /POST.

                              '
                            example: 0
                            x-required:
                            - post
                          value_data:
                            type: object
                            properties: {}
                            description: 'Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state.

                              '
                        description: Common Option Value properties.
                      - type: object
                        properties:
                          adjusters:
                            type: object
                            properties:
                              price:
                                title: Adjuster
                                type: object
                                properties:
                                  adjuster:
                                    type: string
                                    description: 'The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.

                                      '
                                    enum:
                                    - relative
                                    - percentage
                                    x-nullable: true
                                  adjuster_value:
                                    type: number
                                    description: 'The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.

                                      '
                                    example: 5
                                description: Adjuster for Complex Rules.
                              weight:
                                title: Adjuster
                                type: object
                                properties:
                                  adjuster:
                                    type: string
                                    description: 'The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.

                                      '
                                    enum:
                                    - relative
                                    - percentage
                                    x-nullable: true
                                  adjuster_value:
                                    type: number
                                    description: 'The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.

                                      '
                                    example: 5
                                description: Adjuster for Complex Rules.
                              image_url:
                                type: string
                                description: 'The URL for an image displayed on the storefront when the modifier value is selected.Limit of 8MB per file.

                                  '
                                example: https://cdn8.bigcommerce.com/s-{{store_hash}}/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.1280.1280.jpg?c=2
                              purchasing_disabled:
                                type: object
                                properties:
                                  status:
                                    type: boolean
                                    description: 'Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value.

                                      '
                                  message:
                                    type: string
                                    description: 'The message displayed on the storefront when the purchasing disabled status is `true`.

                                      '
                    - type: object
                      properties:
                        id:
                          type: integer
                          description: 'The unique numeric ID of the value; increments sequentially.

                            '
                  meta:
                    $ref: '#/components/schemas/metaEmpty_Full'
              example:
                data:
                  id: 190
                  option_id: 222
                  label: 'Yes'
                  sort_order: 0
                  value_data: {}
                  is_default: false
                  adjusters:
                    price:
                      adjuster: relative
                      adjuster_value: 5
                    weight: {}
                    image_url: ''
                    purchasing_disabled:
                      status: false
                      message: ''
                meta: {}
        '422':
          description: 'The `ModifierValue` 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: ModifierValue
  /catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}:
    parameters:
    - $ref: '#/components/parameters/Accept'
    - $ref: '#/components/parameters/ProductIdParam'
    - $ref: '#/components/parameters/ModifierIdParam'
    - $ref: '#/components/parameters/ValueIdParam'
    get:
      tags:
      - Values
      summary: BigCommerce Get a Product Modifier Value
      description: Returns a single *Modifier Value*. Optional parameters can be passed in.
      operationId: getProductModifierValue
      parameters:
      - name: modifier_id
        in: path
        description: 'The ID of the `Modifier`.

          '
        required: true
        schema:
          type: integer
      - name: value_id
        in: path
        description: 'The ID of the `Modifier/Option Value`.

          '
        required: true
        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
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                title: Modifier Value Response
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/productModifierOptionValue_Full'
                  meta:
                    $ref: '#/components/schemas/metaEmpty_Full'
              example:
                data:
                  id: 190
                  option_id: 222
                  label: 'Yes'
                  sort_order: 0
                  value_data: {}
                  is_default: false
                  adjusters:
                    price:
                      adjuster: relative
                      adjuster_value: 5
                    weight: {}
                    image_url: ''
                    purchasing_disabled:
                      status: false
                      message: ''
                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.
      security:
      - X-Auth-Token: []
    put:
      tags:
      - Values
      summary: BigCommerce Update a Product Modifier Value
      description: 'Updates a *Modifier Value*.


        **Required Fields**

        * none


        **Read-Only Fields**

        * id'
      operationId: updateProductModifierValue
      parameters:
      - $ref: '#/components/parameters/ContentType'
      - name: modifier_id
        in: path
        description: 'The ID of the `Modifier`.

          '
        required: true
        schema:
          type: integer
      - name: value_id
        in: path
        description: 'The ID of the `Modifier/Option Value`.

          '
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              title: Modifier Value Put
              description: The model for a PUT to update a modifier value on a product.
              allOf:
              - title: Modifier Value Base
                allOf:
                - title: Option Value Base
                  required:
                  - label
                  - sort_order
                  type: object
                  properties:
                    is_default:
                      type: boolean
                      description: 'The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.

                        '
                      example: false
                    label:
                      type: string
                      description: 'The text display identifying the value on the storefront. Required in a /POST.

                        '
                      example: Green
                      x-required:
                      - post
                    sort_order:
                      maximum: 2147483647
                      minimum: -2147483648
                      type: integer
                      description: 'The order in which the value will be displayed on the product page. Required in a /POST.

                        '
                      example: 0
                      x-required:
                      - post
                    value_data:
                      type: object
                      properties: {}
                      description: 'Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state.

                        '
                  description: Common Option Value properties.
                - type: object
                  properties:
                    adjusters:
                      type: object
                      properties:
                        price:
                          title: Adjuster
                          type: object
                          properties:
                            adjuster:
                              type: string
                              description: 'The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.

                                '
                              nullable: true
                              enum:
                              - relative
                              - percentage
                            adjuster_value:
                              type: number
                              description: 'The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.

                                '
                              example: 5
                          description: Adjuster for Complex Rules.
                        weight:
                          title: Adjuster
                          type: object
                          properties:
                            adjuster:
                              type: string
                              description: 'The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.

                                '
                              nullable: true
                              enum:
                              - relative
                              - percentage
                            adjuster_value:
                              type: number
                              description: 'The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.

                                '
                              example: 5
                          description: Adjuster for Complex Rules.
                        image_url:
                          type: string
                          description: 'The URL for an image displayed on the storefront when the modifier value is selected.Limit of 8MB per file.

                            '
                          example: https://cdn8.bigcommerce.com/s-{{store_hash}}/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.1280.1280.jpg?c=2
                        purchasing_disabled:
                          type: object
                          properties:
                            status:
                              type: boolean
                              description: 'Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value.

                                '
                            message:
                              type: string
                              description: 'The message displayed on the storefront when the purchasing disabled status is `true`.

                                '
              - type: object
                properties:
                  id:
                    type: integer
                    description: 'The unique numeric ID of the value; increments sequentially.

                      '
                    x-required:
                    - put
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                title: Modifier Value Response
                type: object
                properties:
                  data:
                    title: Modifier Value
                    type: object
                    description: 'Part of Modifier Value Response '
                    allOf:
                    - title: Modifier Value Base
                      type: object
                      allOf:
                      - title: Option Value Base
                        required:
                        - label
                        - sort_order
                        type: object
                        properties:
                          is_default:
                            type: boolean
                            description: 'The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.

                              '
                            example: false
                          label:
                            type: string
                            description: 'The text display identifying the value on the storefront. Required in a /POST.

                              '
                            example: Green
                            x-required:
                            - post
                          sort_order:
                            maximum: 2147483647
                            minimum: -2147483648
                            type: integer
                            description: 'The order in which the value will be displayed on the product page. Required in a /POST.

                              '
                            example: 0
                            x-required:
                            - post
                          value_data:
                            type: object
                            properties: {}
                            description: 'Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state.

                              '
                        description: Common Option Value properties.
                      - type: object
                        properties:
                          adjusters:
                            type: object
                            properties:
                              price:
                                title: Adjuster
                                type: object
                                properties:
                                  adjuster:
                                    type: string
                                    description: 'The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.

                                      '
                                    enum:
                                    - relative
                                    - percentage
                                    x-nullable: true
                                  adjuster_value:
                                    type: number
                                    description: 'The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.

                                      '
                                    example: 5
                                description: Adjuster for Complex Rules.
                              weight:
                                title: Adjuster
                                type: object
                                properties:
                                  adjuster:
                                    type: string
                                    description: 'The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.

                                      '
                                    enum:
                                    - relative
                                    - percentage
                                    x-nullable: true
                                  adjuster_value:
                                    type: number
                                    description: 'The numeric amount by which the ad

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