NAV
  • Content Service (Early Access)
  • Widget Template (Early Access)
  • Widget (Early Access)
  • Placement (Early Access)
  • Content Service Object References
  • Subscribe to developer updates

    Content Service (Early Access)

    Widget Template (Early Access)

    BigCommerce Widget Templates API definition.

    createWidgetTemplate

    Code samples

    import requests
    headers = {
        'X-Auth-Client': 'SampleClientID',
        'X-Auth-Token': 'SampleTokenHere',
        'Content-Type':'application/json',
        'Accept':'application/json'
    
    }
    
    r = requests.post('https://api.bigcommerce.com/stores/{store_id}/v3/content/widget-templates', params={
     # Coming Soon
     },
        headers=headers
    
    )
    
    print r.json()
    
    

    POST /content/widget-templates

    Creates a widget template.

    Body parameter

    {
      "name": "string",
      "schema": {},
      "template": "string"
    }
    

    Parameters

    Parameter Type Required Description
    body WidgetTemplatePost true No description
    name string true User friendly name.
    schema object(json) true The JSON schema of data for this template. Used to validate a configuration.
    template string(html) true Handlebars HTML content. Also has access to Stencil Paper helpers.

    Example responses

    {
      "data": {
        "uuid": "string",
        "name": "string",
        "kind": "string",
        "schema": {},
        "template": "string",
        "date_created": "string",
        "date_modified": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    201 Created A widget template. WidgetTemplateResponse
    422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

    getWidgetTemplates

    Code samples

    import requests
    headers = {
        'X-Auth-Client': 'SampleClientID',
        'X-Auth-Token': 'SampleTokenHere',
        'Accept':'application/json'
    
    }
    
    r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/widget-templates', headers=headers)
    
    print r.json()
    
    

    GET /content/widget-templates

    Gets all widget templates.

    Parameters

    Parameter Type Required Description
    page integer false Specifies the page number in a limited (paginated) list of products.
    limit integer false Controls the number of items per page in a limited (paginated) list of products.
    widget_template_kind string false The kind of widget template.

    Example responses

    {
      "data": [
        {
          "uuid": "string",
          "name": "string",
          "kind": "string",
          "schema": {},
          "template": "string",
          "date_created": "string",
          "date_modified": "string"
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success WidgetTemplatesResponse
    422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

    getWidgetTemplate

    Code samples

    import requests
    headers = {
        'X-Auth-Client': 'SampleClientID',
        'X-Auth-Token': 'SampleTokenHere',
        'Accept':'application/json'
    
    }
    
    r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/widget-templates/{uuid}', headers=headers)
    
    print r.json()
    
    

    GET /content/widget-templates/{uuid}

    Gets a widget template.

    Parameters

    Parameter Type Required Description
    uuid string(uuid) true The identifier for a specific template.

    Example responses

    {
      "data": {
        "uuid": "string",
        "name": "string",
        "kind": "string",
        "schema": {},
        "template": "string",
        "date_created": "string",
        "date_modified": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success WidgetTemplateResponse
    404 Not Found The resource was not found. ErrorResponse
    422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

    updateWidgetTemplate

    Code samples

    import requests
    headers = {
        'X-Auth-Client': 'SampleClientID',
        'X-Auth-Token': 'SampleTokenHere',
        'Content-Type':'application/json',
        'Accept':'application/json'
    
    }
    
    r = requests.put('https://api.bigcommerce.com/stores/{store_id}/v3/content/widget-templates/{uuid}', params={
     # Coming Soon 
     },
        headers=headers
    
    )
    
    print r.json()
    
    

    PUT /content/widget-templates/{uuid}

    Updates a widget template.

    Body parameter

    {
      "name": "string",
      "schema": {},
      "template": "string"
    }
    

    Parameters

    Parameter Type Required Description
    uuid string(uuid)(uuid) true The identifier for a specific template.
    body WidgetTemplatePut true No description
    name string false User-friendly name.
    schema object(json) false The schema for this template. Describes how to build dynamic forms for widget configurations.
    template string(html) false Handlebars HTML content. Also has access to Stencil Paper helpers.

    Example responses

    {
      "data": {
        "uuid": "string",
        "name": "string",
        "kind": "string",
        "schema": {},
        "template": "string",
        "date_created": "string",
        "date_modified": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success WidgetTemplateResponse
    404 Not Found The resource was not found. ErrorResponse
    422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

    deleteWidgetTemplate

    Code samples

    import requests
    headers = {
        'X-Auth-Client': 'SampleClientID',
        'X-Auth-Token': 'SampleTokenHere',
        'Accept':'application/json'
    
    }
    
    r = requests.delete('https://api.bigcommerce.com/stores/{store_id}/v3/content/widget-templates/{uuid}', headers=headers)
    
    print r.json()
    
    

    DELETE /content/widget-templates/{uuid}

    Deletes a widget template.

    Parameters

    Parameter Type Required Description
    uuid string(uuid)(uuid)(uuid) true The identifier for a specific template.

    Example responses

    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    204 No Content An empty response. None
    404 Not Found The resource was not found. ErrorResponse
    422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

    Widget (Early Access)

    BigCommerce Widgets API Definition.

    createWidget

    Code samples

    import requests
    headers = {
        'X-Auth-Client': 'SampleClientID',
        'X-Auth-Token': 'SampleTokenHere',
        'Content-Type':'application/json',
        'Accept':'application/json'
    
    }
    
    r = requests.post('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets', params={
     # Coming Soon
     },
        headers=headers
    
    )
    
    print r.json()
    
    

    POST /content/widgets

    Creates a widget.

    Body parameter

    {
      "name": "string",
      "widget_configuration": {},
      "widget_template_uuid": "string"
    }
    

    Parameters

    Parameter Type Required Description
    body WidgetPost true No description
    name string true User friendly name.
    widget_configuration object(json) true The JSON data that populates the template.
    widget_template_uuid string true The widget template UUID.

    Example responses

    {
      "data": {
        "uuid": "string",
        "name": "string",
        "widget_configuration": {},
        "widget_template": {
          "uuid": "string",
          "name": "string",
          "kind": "string",
          "schema": {},
          "template": "string",
          "date_created": "string",
          "date_modified": "string"
        },
        "date_created": "string",
        "date_modified": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success WidgetResponse
    422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

    getWidgets

    Code samples

    import requests
    headers = {
        'X-Auth-Client': 'SampleClientID',
        'X-Auth-Token': 'SampleTokenHere',
        'Accept':'application/json'
    
    }
    
    r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets', headers=headers)
    
    print r.json()
    
    

    GET /content/widgets

    Gets all widgets.

    Parameters

    Parameter Type Required Description
    page integer false Specifies the page number in a limited (paginated) list of products.
    limit integer false Controls the number of items per page in a limited (paginated) list of products.
    widget_template_kind string false The kind of widget template.

    Example responses

    {
      "data": [
        {
          "uuid": "string",
          "name": "string",
          "widget_configuration": {},
          "widget_template": {
            "uuid": "string",
            "name": "string",
            "kind": "string",
            "schema": {},
            "template": "string",
            "date_created": "string",
            "date_modified": "string"
          },
          "date_created": "string",
          "date_modified": "string"
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success WidgetsResponse
    422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

    getWidget

    Code samples

    import requests
    headers = {
        'X-Auth-Client': 'SampleClientID',
        'X-Auth-Token': 'SampleTokenHere',
        'Accept':'application/json'
    
    }
    
    r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets/{uuid}', headers=headers)
    
    print r.json()
    
    

    GET /content/widgets/{uuid}

    Gets a widget.

    Parameters

    Parameter Type Required Description
    uuid string(uuid) true The identifier for a specific widget.

    Example responses

    {
      "data": {
        "uuid": "string",
        "name": "string",
        "widget_configuration": {},
        "widget_template": {
          "uuid": "string",
          "name": "string",
          "kind": "string",
          "schema": {},
          "template": "string",
          "date_created": "string",
          "date_modified": "string"
        },
        "date_created": "string",
        "date_modified": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success WidgetResponse
    404 Not Found The resource was not found. ErrorResponse
    422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

    updateWidget

    Code samples

    import requests
    headers = {
        'X-Auth-Client': 'SampleClientID',
        'X-Auth-Token': 'SampleTokenHere',
        'Content-Type':'application/json',
        'Accept':'application/json'
    
    }
    
    r = requests.put('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets/{uuid}', params={
     # Coming Soon 
     },
        headers=headers
    
    )
    
    print r.json()
    
    

    PUT /content/widgets/{uuid}

    Updates a widget.

    Body parameter

    {
      "name": "string",
      "widget_configuration": {},
      "widget_template_uuid": "string"
    }
    

    Parameters

    Parameter Type Required Description
    uuid string(uuid)(uuid) true The identifier for a specific widget.
    body WidgetPut true No description
    name string false User-friendly name.
    widget_configuration object(json) false The JSON data that populates the template.
    widget_template_uuid string false The widget template UUID.

    Example responses

    {
      "data": {
        "uuid": "string",
        "name": "string",
        "widget_configuration": {},
        "widget_template": {
          "uuid": "string",
          "name": "string",
          "kind": "string",
          "schema": {},
          "template": "string",
          "date_created": "string",
          "date_modified": "string"
        },
        "date_created": "string",
        "date_modified": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success WidgetResponse
    404 Not Found The resource was not found. ErrorResponse
    422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

    deleteWidget

    Code samples

    import requests
    headers = {
        'X-Auth-Client': 'SampleClientID',
        'X-Auth-Token': 'SampleTokenHere',
        'Accept':'application/json'
    
    }
    
    r = requests.delete('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets/{uuid}', headers=headers)
    
    print r.json()
    
    

    DELETE /content/widgets/{uuid}

    Deletes a widget.

    Parameters

    Parameter Type Required Description
    uuid string(uuid)(uuid)(uuid) true The identifier for a specific widget.

    Example responses

    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    204 No Content An empty response. None
    404 Not Found The resource was not found. ErrorResponse
    422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

    Placement (Early Access)

    BigCommerce Placements API definition.

    createPlacement

    Code samples

    import requests
    headers = {
        'X-Auth-Client': 'SampleClientID',
        'X-Auth-Token': 'SampleTokenHere',
        'Content-Type':'application/json',
        'Accept':'application/json'
    
    }
    
    r = requests.post('https://api.bigcommerce.com/stores/{store_id}/v3/content/placements', params={
     # Coming Soon
     },
        headers=headers
    
    )
    
    print r.json()
    
    

    POST /content/placements

    Creates a placement.

    Body parameter

    {
      "widget_uuid": "string",
      "entity_id": "string",
      "sort_order": "string",
      "region": "string",
      "template_file": "string",
      "status": "inactive"
    }
    

    Parameters

    Parameter Type Required Description
    body PlacementPost true No description
    widget_uuid string true A widget identifier.
    entity_id string false The specific instance of a page that you would like to target.
    sort_order string false The sorting order to control the position of a content widget in a region.
    region string true The name of the region in which to insert content widgets.
    template_file string true The template file that you would like to target.
    status string false Sets the placement as inactive (the default) or active.

    Enumerated Values

    Parameter Value
    status inactive
    status active

    Example responses

    {
      "data": [
        {
          "uuid": "string",
          "entity_id": "string",
          "status": "inactive",
          "template_file": "string",
          "region": "string",
          "widget": {
            "uuid": "string",
            "name": "string",
            "widget_configuration": {},
            "widget_template": {
              "uuid": "string",
              "name": "string",
              "kind": "string",
              "schema": {},
              "template": "string",
              "date_created": "string",
              "date_modified": "string"
            },
            "date_created": "string",
            "date_modified": "string"
          },
          "date_created": "string",
          "date_modified": "string"
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    201 Created A placement. PlacementsResponse
    422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

    getPlacements

    Code samples

    import requests
    headers = {
        'X-Auth-Client': 'SampleClientID',
        'X-Auth-Token': 'SampleTokenHere',
        'Accept':'application/json'
    
    }
    
    r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/placements', headers=headers)
    
    print r.json()
    
    

    GET /content/placements

    Gets all placements.

    Parameters

    Parameter Type Required Description
    page integer false Specifies the page number in a limited (paginated) list of products.
    limit integer false Controls the number of items per page in a limited (paginated) list of products.
    widget_template_kind string false The kind of widget template.
    template_file string false The template file, for example, pages/home.

    Example responses

    {
      "data": [
        {
          "uuid": "string",
          "entity_id": "string",
          "status": "inactive",
          "template_file": "string",
          "region": "string",
          "widget": {
            "uuid": "string",
            "name": "string",
            "widget_configuration": {},
            "widget_template": {
              "uuid": "string",
              "name": "string",
              "kind": "string",
              "schema": {},
              "template": "string",
              "date_created": "string",
              "date_modified": "string"
            },
            "date_created": "string",
            "date_modified": "string"
          },
          "date_created": "string",
          "date_modified": "string"
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success PlacementsResponse
    422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

    getPlacement

    Code samples

    import requests
    headers = {
        'X-Auth-Client': 'SampleClientID',
        'X-Auth-Token': 'SampleTokenHere',
        'Accept':'application/json'
    
    }
    
    r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/placements/{uuid}', headers=headers)
    
    print r.json()
    
    

    GET /content/placements/{uuid}

    Gets a placement.

    Parameters

    Parameter Type Required Description
    uuid string(uuid) true The identifier for a specific placement.

    Example responses

    {
      "data": {
        "uuid": "string",
        "entity_id": "string",
        "status": "inactive",
        "template_file": "string",
        "region": "string",
        "widget": {
          "uuid": "string",
          "name": "string",
          "widget_configuration": {},
          "widget_template": {
            "uuid": "string",
            "name": "string",
            "kind": "string",
            "schema": {},
            "template": "string",
            "date_created": "string",
            "date_modified": "string"
          },
          "date_created": "string",
          "date_modified": "string"
        },
        "date_created": "string",
        "date_modified": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success PlacementResponse
    404 Not Found The resource was not found. ErrorResponse
    422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

    updatePlacement

    Code samples

    import requests
    headers = {
        'X-Auth-Client': 'SampleClientID',
        'X-Auth-Token': 'SampleTokenHere',
        'Content-Type':'application/json',
        'Accept':'application/json'
    
    }
    
    r = requests.put('https://api.bigcommerce.com/stores/{store_id}/v3/content/placements/{uuid}', params={
     # Coming Soon 
     },
        headers=headers
    
    )
    
    print r.json()
    
    

    PUT /content/placements/{uuid}

    Updates a placement.

    Body parameter

    {
      "entity_id": "string",
      "template_file": "string",
      "region": "string",
      "sort_order": "string",
      "widget_uuid": "string",
      "status": "inactive"
    }
    

    Parameters

    Parameter Type Required Description
    uuid string(uuid)(uuid) true The identifier for a specific placement.
    body PlacementPut true No description
    entity_id string false Optional. The specific instance of a page that you would like to target.
    template_file string false The template file that you would like to target.
    region string false The name of the region in which to insert content widgets.
    sort_order string false The sorting order to control the position of a content widget in a region.
    widget_uuid string false A widget identifier.
    status string false Sets the placement as inactive (the default) or active.

    Enumerated Values

    Parameter Value
    status inactive
    status active

    Example responses

    {
      "data": {
        "uuid": "string",
        "entity_id": "string",
        "status": "inactive",
        "template_file": "string",
        "region": "string",
        "widget": {
          "uuid": "string",
          "name": "string",
          "widget_configuration": {},
          "widget_template": {
            "uuid": "string",
            "name": "string",
            "kind": "string",
            "schema": {},
            "template": "string",
            "date_created": "string",
            "date_modified": "string"
          },
          "date_created": "string",
          "date_modified": "string"
        },
        "date_created": "string",
        "date_modified": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success PlacementResponse
    404 Not Found The resource was not found. ErrorResponse
    422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

    deletePlacement

    Code samples

    import requests
    headers = {
        'X-Auth-Client': 'SampleClientID',
        'X-Auth-Token': 'SampleTokenHere',
        'Accept':'application/json'
    
    }
    
    r = requests.delete('https://api.bigcommerce.com/stores/{store_id}/v3/content/placements/{uuid}', headers=headers)
    
    print r.json()
    
    

    DELETE /content/placements/{uuid}

    Deletes a placement.

    Parameters

    Parameter Type Required Description
    uuid string(uuid)(uuid)(uuid) true The identifier for a specific placement.

    Example responses

    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "instance": "string",
      "errors": {
        "property1": "string",
        "property2": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    204 No Content An empty response. None
    404 Not Found The resource was not found. ErrorResponse
    422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

    Content Service Object References

    WidgetTemplatePut

    {
      "name": "string",
      "schema": {},
      "template": "string"
    } 
    

    Properties

    Name Type Required Description
    name string false User-friendly name.
    schema object(json) false The schema for this template. Describes how to build dynamic forms for widget configurations.
    template string(html) false Handlebars HTML content. Also has access to Stencil Paper helpers.

    WidgetTemplatePost

    {
      "name": "string",
      "schema": {},
      "template": "string"
    } 
    

    Properties

    Name Type Required Description
    name string true User friendly name.
    schema object(json) true The JSON schema of data for this template. Used to validate a configuration.
    template string(html) true Handlebars HTML content. Also has access to Stencil Paper helpers.

    WidgetTemplateResponse

    {
      "data": {
        "uuid": "string",
        "name": "string",
        "kind": "string",
        "schema": {},
        "template": "string",
        "date_created": "string",
        "date_modified": "string"
      }
    } 
    

    Properties

    Name Type Required Description
    data WidgetTemplate false No description
    uuid string(uuid) false The primary identifier.
    name string false The user-friendly name.
    kind string false The kind of widget template.
    schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
    template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.

    WidgetTemplatesResponse

    {
      "data": [
        {
          "uuid": "string",
          "name": "string",
          "kind": "string",
          "schema": {},
          "template": "string",
          "date_created": "string",
          "date_modified": "string"
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [WidgetTemplate] false No description
    uuid string(uuid) false The primary identifier.
    name string false The user-friendly name.
    kind string false The kind of widget template.
    schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
    template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.

    WidgetTemplate

    {
      "uuid": "string",
      "name": "string",
      "kind": "string",
      "schema": {},
      "template": "string",
      "date_created": "string",
      "date_modified": "string"
    } 
    

    Properties

    Name Type Required Description
    uuid string(uuid) false The primary identifier.
    name string false The user-friendly name.
    kind string false The kind of widget template.
    schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
    template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.

    Widget

    {
      "uuid": "string",
      "name": "string",
      "widget_configuration": {},
      "widget_template": {
        "uuid": "string",
        "name": "string",
        "kind": "string",
        "schema": {},
        "template": "string",
        "date_created": "string",
        "date_modified": "string"
      },
      "date_created": "string",
      "date_modified": "string"
    } 
    

    Properties

    Name Type Required Description
    uuid string(uuid) false The primary identifier.
    name string false The user-friendly name.
    widget_configuration object(json) false The JSON data that populates the template.
    widget_template [WidgetTemplate] false No description
    uuid string(uuid) false The primary identifier.
    name string false The user-friendly name.
    kind string false The kind of widget template.
    schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
    template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.

    WidgetPost

    {
      "name": "string",
      "widget_configuration": {},
      "widget_template_uuid": "string"
    } 
    

    Properties

    Name Type Required Description
    name string true User friendly name.
    widget_configuration object(json) true The JSON data that populates the template.
    widget_template_uuid string true The widget template UUID.

    WidgetPut

    {
      "name": "string",
      "widget_configuration": {},
      "widget_template_uuid": "string"
    } 
    

    Properties

    Name Type Required Description
    name string false User-friendly name.
    widget_configuration object(json) false The JSON data that populates the template.
    widget_template_uuid string false The widget template UUID.

    WidgetResponse

    {
      "data": {
        "uuid": "string",
        "name": "string",
        "widget_configuration": {},
        "widget_template": {
          "uuid": "string",
          "name": "string",
          "kind": "string",
          "schema": {},
          "template": "string",
          "date_created": "string",
          "date_modified": "string"
        },
        "date_created": "string",
        "date_modified": "string"
      }
    } 
    

    Properties

    Name Type Required Description
    data Widget false No description
    uuid string(uuid) false The primary identifier.
    name string false The user-friendly name.
    widget_configuration object(json) false The JSON data that populates the template.
    widget_template [WidgetTemplate] false No description
    uuid string(uuid) false The primary identifier.
    name string false The user-friendly name.
    kind string false The kind of widget template.
    schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
    template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.

    WidgetsResponse

    {
      "data": [
        {
          "uuid": "string",
          "name": "string",
          "widget_configuration": {},
          "widget_template": {
            "uuid": "string",
            "name": "string",
            "kind": "string",
            "schema": {},
            "template": "string",
            "date_created": "string",
            "date_modified": "string"
          },
          "date_created": "string",
          "date_modified": "string"
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [Widget] false No description
    uuid string(uuid) false The primary identifier.
    name string false The user-friendly name.
    widget_configuration object(json) false The JSON data that populates the template.
    widget_template [WidgetTemplate] false No description
    uuid string(uuid) false The primary identifier.
    name string false The user-friendly name.
    kind string false The kind of widget template.
    schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
    template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.

    PlacementPost

    {
      "widget_uuid": "string",
      "entity_id": "string",
      "sort_order": "string",
      "region": "string",
      "template_file": "string",
      "status": "inactive"
    } 
    

    Properties

    Name Type Required Description
    widget_uuid string true A widget identifier.
    entity_id string false The specific instance of a page that you would like to target.
    sort_order string false The sorting order to control the position of a content widget in a region.
    region string true The name of the region in which to insert content widgets.
    template_file string true The template file that you would like to target.
    status string false Sets the placement as inactive (the default) or active.

    Enumerated Values

    Property Value
    status inactive
    status active

    PlacementPut

    {
      "entity_id": "string",
      "template_file": "string",
      "region": "string",
      "sort_order": "string",
      "widget_uuid": "string",
      "status": "inactive"
    } 
    

    Properties

    Name Type Required Description
    entity_id string false Optional. The specific instance of a page that you would like to target.
    template_file string false The template file that you would like to target.
    region string false The name of the region in which to insert content widgets.
    sort_order string false The sorting order to control the position of a content widget in a region.
    widget_uuid string false A widget identifier.
    status string false Sets the placement as inactive (the default) or active.

    Enumerated Values

    Property Value
    status inactive
    status active

    PlacementResponse

    {
      "data": {
        "uuid": "string",
        "entity_id": "string",
        "status": "inactive",
        "template_file": "string",
        "region": "string",
        "widget": {
          "uuid": "string",
          "name": "string",
          "widget_configuration": {},
          "widget_template": {
            "uuid": "string",
            "name": "string",
            "kind": "string",
            "schema": {},
            "template": "string",
            "date_created": "string",
            "date_modified": "string"
          },
          "date_created": "string",
          "date_modified": "string"
        },
        "date_created": "string",
        "date_modified": "string"
      }
    } 
    

    Properties

    Name Type Required Description
    data Placement false No description
    uuid string(uuid) false The primary identifier.
    entity_id string false The specific instance of a page
    status string false Determines whether this placement is active or inactive.
    template_file string false The page template name.
    region string false The user-friendly name.
    widget [Widget] false No description
    uuid string(uuid) false The primary identifier.
    name string false The user-friendly name.
    widget_configuration object(json) false The JSON data that populates the template.
    widget_template [WidgetTemplate] false No description
    uuid string(uuid) false The primary identifier.
    name string false The user-friendly name.
    kind string false The kind of widget template.
    schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
    template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.

    Enumerated Values

    Property Value
    status inactive
    status active

    PlacementsResponse

    {
      "data": [
        {
          "uuid": "string",
          "entity_id": "string",
          "status": "inactive",
          "template_file": "string",
          "region": "string",
          "widget": {
            "uuid": "string",
            "name": "string",
            "widget_configuration": {},
            "widget_template": {
              "uuid": "string",
              "name": "string",
              "kind": "string",
              "schema": {},
              "template": "string",
              "date_created": "string",
              "date_modified": "string"
            },
            "date_created": "string",
            "date_modified": "string"
          },
          "date_created": "string",
          "date_modified": "string"
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [Placement] false No description
    uuid string(uuid) false The primary identifier.
    entity_id string false The specific instance of a page
    status string false Determines whether this placement is active or inactive.
    template_file string false The page template name.
    region string false The user-friendly name.
    widget [Widget] false No description
    uuid string(uuid) false The primary identifier.
    name string false The user-friendly name.
    widget_configuration object(json) false The JSON data that populates the template.
    widget_template [WidgetTemplate] false No description
    uuid string(uuid) false The primary identifier.
    name string false The user-friendly name.
    kind string false The kind of widget template.
    schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
    template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.

    Enumerated Values

    Property Value
    status inactive
    status active

    Placement

    {
      "uuid": "string",
      "entity_id": "string",
      "status": "inactive",
      "template_file": "string",
      "region": "string",
      "widget": {
        "uuid": "string",
        "name": "string",
        "widget_configuration": {},
        "widget_template": {
          "uuid": "string",
          "name": "string",
          "kind": "string",
          "schema": {},
          "template": "string",
          "date_created": "string",
          "date_modified": "string"
        },
        "date_created": "string",
        "date_modified": "string"
      },
      "date_created": "string",
      "date_modified": "string"
    } 
    

    Properties

    Name Type Required Description
    uuid string(uuid) false The primary identifier.
    entity_id string false The specific instance of a page
    status string false Determines whether this placement is active or inactive.
    template_file string false The page template name.
    region string false The user-friendly name.
    widget [Widget] false No description
    uuid string(uuid) false The primary identifier.
    name string false The user-friendly name.
    widget_configuration object(json) false The JSON data that populates the template.
    widget_template [WidgetTemplate] false No description
    uuid string(uuid) false The primary identifier.
    name string false The user-friendly name.
    kind string false The kind of widget template.
    schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
    template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.
    date_created string(datetime) false The date on which this object was initially created.
    date_modified string(datetime) false The date on which this object was last updated.

    Enumerated Values

    Property Value
    status inactive
    status active

    ModifierCollectionResponse

    {
      "data": [
        {
          "type": "date",
          "required": true,
          "config": {
            "default_value": "string",
            "checked_by_default": true,
            "checkbox_label": "string",
            "date_limited": true,
            "date_limit_mode": "earliest",
            "date_earliest_value": "2017-08-10",
            "date_latest_value": "2017-08-10",
            "file_types_mode": "specific",
            "file_types_supported": [
              "string"
            ],
            "file_types_other": [
              "string"
            ],
            "file_max_size": 0,
            "text_characters_limited": true,
            "text_min_length": 0,
            "text_max_length": 0,
            "text_lines_limited": true,
            "text_max_lines": 0,
            "number_limited": true,
            "number_limit_mode": "lowest",
            "number_lowest_value": 0,
            "number_highest_value": 0,
            "number_integers_only": true,
            "product_list_adjusts_inventory": true,
            "product_list_adjusts_pricing": true,
            "product_list_shipping_calc": "none"
          },
          "option_values": [
            {
              "id": 0
            }
          ],
          "id": 0,
          "product_id": 0,
          "name": "string",
          "display_name": "string"
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [Modifier] false Common Modifier properties.
    type string false BigCommerce API, which determines how it will display on the storefront. Acceptable values: date, checkbox, file, text, multi_line_text, numbers_only_text, radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. For reference, the former v2 API values are: D = date, C = checkbox, F = file, T = text, MT = multi_line_text, N = numbers_only_text, RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
    required boolean false Whether or not this modifer is required or not at checkout.
    config OptionConfig false No description
    default_value string false (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
    checked_by_default boolean false (checkbox) Flag for setting the checkbox to be checked by default.
    checkbox_label string false (checkbox) Label displayed for the checkbox option.
    date_limited boolean false (date) Flag to limit the dates allowed to be entered on a date option.
    date_limit_mode string false (date) The type of limit that is allowed to be entered on a date option.
    date_earliest_value string(date) false (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    date_latest_value string(date) false (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    file_types_mode string false (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.
    file_max_size integer false (file) The maximum size for a file that can be used with the file upload option.
    text_characters_limited boolean false (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
    text_min_length integer false (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
    text_max_length integer false (text, multi_line_text) The maximum length allowed for a text or multi line text option.
    text_lines_limited boolean false (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
    text_max_lines integer false (multi_line_text) The maximum number of lines allowed on a multi-line text input.
    number_limited boolean false (numbers_only_text) Flag to limit the value of a number option.
    number_limit_mode string false (numbers_only_text) The type of limit on values entered for a number option.
    number_lowest_value number false (numbers_only_text) The lowest allowed value for a number option if number_limited is true.
    number_highest_value number false (numbers_only_text) The highest allowed value for a number option if number_limited is true.
    number_integers_only boolean false (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
    product_list_adjusts_inventory boolean false (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
    product_list_adjusts_pricing boolean false (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
    product_list_shipping_calc string false (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: none - don't adjust; weight - use shipping weight only; package - use weight and dimensions.
    file_types_supported [string] false No description
    file_types_other [string] false No description
    id integer false The unique numeric ID of the modifier; increments sequentially.
    product_id integer false The unique numeric ID of the product to which the option belongs.
    name string false The unique option name. Auto-generated from the display name, a timestamp, and the product ID.
    display_name string false The name of the option shown on the storefront.
    option_values [ModifierValue] false No description
    id integer false The unique numeric ID of the value; increments sequentially.

    Enumerated Values

    Property Value
    type date
    type checkbox
    type file
    type text
    type multi_line_text
    type numbers_only_text
    type radio_buttons
    type rectangles
    type dropdown
    type product_list
    type product_list_with_images
    type swatch
    date_limit_mode earliest
    date_limit_mode range
    date_limit_mode latest
    file_types_mode specific
    file_types_mode all
    number_limit_mode lowest
    number_limit_mode highest
    number_limit_mode range
    product_list_shipping_calc none
    product_list_shipping_calc weight
    product_list_shipping_calc package

    ModifierResponse

    {
      "data": {
        "type": "date",
        "required": true,
        "config": {
          "default_value": "string",
          "checked_by_default": true,
          "checkbox_label": "string",
          "date_limited": true,
          "date_limit_mode": "earliest",
          "date_earliest_value": "2017-08-10",
          "date_latest_value": "2017-08-10",
          "file_types_mode": "specific",
          "file_types_supported": [
            "string"
          ],
          "file_types_other": [
            "string"
          ],
          "file_max_size": 0,
          "text_characters_limited": true,
          "text_min_length": 0,
          "text_max_length": 0,
          "text_lines_limited": true,
          "text_max_lines": 0,
          "number_limited": true,
          "number_limit_mode": "lowest",
          "number_lowest_value": 0,
          "number_highest_value": 0,
          "number_integers_only": true,
          "product_list_adjusts_inventory": true,
          "product_list_adjusts_pricing": true,
          "product_list_shipping_calc": "none"
        },
        "option_values": [
          {
            "id": 0
          }
        ],
        "id": 0,
        "product_id": 0,
        "name": "string",
        "display_name": "string"
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [Modifier] false Common Modifier properties.
    type string false BigCommerce API, which determines how it will display on the storefront. Acceptable values: date, checkbox, file, text, multi_line_text, numbers_only_text, radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. For reference, the former v2 API values are: D = date, C = checkbox, F = file, T = text, MT = multi_line_text, N = numbers_only_text, RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
    required boolean false Whether or not this modifer is required or not at checkout.
    config OptionConfig false No description
    default_value string false (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
    checked_by_default boolean false (checkbox) Flag for setting the checkbox to be checked by default.
    checkbox_label string false (checkbox) Label displayed for the checkbox option.
    date_limited boolean false (date) Flag to limit the dates allowed to be entered on a date option.
    date_limit_mode string false (date) The type of limit that is allowed to be entered on a date option.
    date_earliest_value string(date) false (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    date_latest_value string(date) false (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    file_types_mode string false (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.
    file_max_size integer false (file) The maximum size for a file that can be used with the file upload option.
    text_characters_limited boolean false (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
    text_min_length integer false (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
    text_max_length integer false (text, multi_line_text) The maximum length allowed for a text or multi line text option.
    text_lines_limited boolean false (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
    text_max_lines integer false (multi_line_text) The maximum number of lines allowed on a multi-line text input.
    number_limited boolean false (numbers_only_text) Flag to limit the value of a number option.
    number_limit_mode string false (numbers_only_text) The type of limit on values entered for a number option.
    number_lowest_value number false (numbers_only_text) The lowest allowed value for a number option if number_limited is true.
    number_highest_value number false (numbers_only_text) The highest allowed value for a number option if number_limited is true.
    number_integers_only boolean false (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
    product_list_adjusts_inventory boolean false (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
    product_list_adjusts_pricing boolean false (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
    product_list_shipping_calc string false (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: none - don't adjust; weight - use shipping weight only; package - use weight and dimensions.
    file_types_supported [string] false No description
    file_types_other [string] false No description
    id integer false The unique numeric ID of the modifier; increments sequentially.
    product_id integer false The unique numeric ID of the product to which the option belongs.
    name string false The unique option name. Auto-generated from the display name, a timestamp, and the product ID.
    display_name string false The name of the option shown on the storefront.
    option_values [ModifierValue] false No description
    id integer false The unique numeric ID of the value; increments sequentially.
    meta Meta false Empty meta object; may be used later.

    Enumerated Values

    Property Value
    type date
    type checkbox
    type file
    type text
    type multi_line_text
    type numbers_only_text
    type radio_buttons
    type rectangles
    type dropdown
    type product_list
    type product_list_with_images
    type swatch
    date_limit_mode earliest
    date_limit_mode range
    date_limit_mode latest
    file_types_mode specific
    file_types_mode all
    number_limit_mode lowest
    number_limit_mode highest
    number_limit_mode range
    product_list_shipping_calc none
    product_list_shipping_calc weight
    product_list_shipping_calc package

    ModifierBase

    {
      "type": "date",
      "required": true,
      "config": {
        "default_value": "string",
        "checked_by_default": true,
        "checkbox_label": "string",
        "date_limited": true,
        "date_limit_mode": "earliest",
        "date_earliest_value": "2017-08-10",
        "date_latest_value": "2017-08-10",
        "file_types_mode": "specific",
        "file_types_supported": [
          "string"
        ],
        "file_types_other": [
          "string"
        ],
        "file_max_size": 0,
        "text_characters_limited": true,
        "text_min_length": 0,
        "text_max_length": 0,
        "text_lines_limited": true,
        "text_max_lines": 0,
        "number_limited": true,
        "number_limit_mode": "lowest",
        "number_lowest_value": 0,
        "number_highest_value": 0,
        "number_integers_only": true,
        "product_list_adjusts_inventory": true,
        "product_list_adjusts_pricing": true,
        "product_list_shipping_calc": "none"
      },
      "option_values": [
        {
          "id": 0
        }
      ]
    } 
    

    Properties

    Name Type Required Description
    type string false BigCommerce API, which determines how it will display on the storefront. Acceptable values: date, checkbox, file, text, multi_line_text, numbers_only_text, radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. For reference, the former v2 API values are: D = date, C = checkbox, F = file, T = text, MT = multi_line_text, N = numbers_only_text, RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
    required boolean false Whether or not this modifer is required or not at checkout.
    config OptionConfig false No description
    default_value string false (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
    checked_by_default boolean false (checkbox) Flag for setting the checkbox to be checked by default.
    checkbox_label string false (checkbox) Label displayed for the checkbox option.
    date_limited boolean false (date) Flag to limit the dates allowed to be entered on a date option.
    date_limit_mode string false (date) The type of limit that is allowed to be entered on a date option.
    date_earliest_value string(date) false (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    date_latest_value string(date) false (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    file_types_mode string false (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.
    file_max_size integer false (file) The maximum size for a file that can be used with the file upload option.
    text_characters_limited boolean false (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
    text_min_length integer false (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
    text_max_length integer false (text, multi_line_text) The maximum length allowed for a text or multi line text option.
    text_lines_limited boolean false (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
    text_max_lines integer false (multi_line_text) The maximum number of lines allowed on a multi-line text input.
    number_limited boolean false (numbers_only_text) Flag to limit the value of a number option.
    number_limit_mode string false (numbers_only_text) The type of limit on values entered for a number option.
    number_lowest_value number false (numbers_only_text) The lowest allowed value for a number option if number_limited is true.
    number_highest_value number false (numbers_only_text) The highest allowed value for a number option if number_limited is true.
    number_integers_only boolean false (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
    product_list_adjusts_inventory boolean false (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
    product_list_adjusts_pricing boolean false (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
    product_list_shipping_calc string false (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: none - don't adjust; weight - use shipping weight only; package - use weight and dimensions.
    file_types_supported [string] false No description
    file_types_other [string] false No description
    option_values [ModifierValue] false No description
    id integer false The unique numeric ID of the value; increments sequentially.

    Enumerated Values

    Property Value
    type date
    type checkbox
    type file
    type text
    type multi_line_text
    type numbers_only_text
    type radio_buttons
    type rectangles
    type dropdown
    type product_list
    type product_list_with_images
    type swatch
    date_limit_mode earliest
    date_limit_mode range
    date_limit_mode latest
    file_types_mode specific
    file_types_mode all
    number_limit_mode lowest
    number_limit_mode highest
    number_limit_mode range
    product_list_shipping_calc none
    product_list_shipping_calc weight
    product_list_shipping_calc package

    Modifier

    {
      "type": "date",
      "required": true,
      "config": {
        "default_value": "string",
        "checked_by_default": true,
        "checkbox_label": "string",
        "date_limited": true,
        "date_limit_mode": "earliest",
        "date_earliest_value": "2017-08-10",
        "date_latest_value": "2017-08-10",
        "file_types_mode": "specific",
        "file_types_supported": [
          "string"
        ],
        "file_types_other": [
          "string"
        ],
        "file_max_size": 0,
        "text_characters_limited": true,
        "text_min_length": 0,
        "text_max_length": 0,
        "text_lines_limited": true,
        "text_max_lines": 0,
        "number_limited": true,
        "number_limit_mode": "lowest",
        "number_lowest_value": 0,
        "number_highest_value": 0,
        "number_integers_only": true,
        "product_list_adjusts_inventory": true,
        "product_list_adjusts_pricing": true,
        "product_list_shipping_calc": "none"
      },
      "option_values": [
        {
          "id": 0
        }
      ],
      "id": 0,
      "product_id": 0,
      "name": "string",
      "display_name": "string"
    } 
    

    Properties

    Name Type Required Description
    type string false BigCommerce API, which determines how it will display on the storefront. Acceptable values: date, checkbox, file, text, multi_line_text, numbers_only_text, radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. For reference, the former v2 API values are: D = date, C = checkbox, F = file, T = text, MT = multi_line_text, N = numbers_only_text, RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
    required boolean false Whether or not this modifer is required or not at checkout.
    config OptionConfig false No description
    default_value string false (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
    checked_by_default boolean false (checkbox) Flag for setting the checkbox to be checked by default.
    checkbox_label string false (checkbox) Label displayed for the checkbox option.
    date_limited boolean false (date) Flag to limit the dates allowed to be entered on a date option.
    date_limit_mode string false (date) The type of limit that is allowed to be entered on a date option.
    date_earliest_value string(date) false (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    date_latest_value string(date) false (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    file_types_mode string false (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.
    file_max_size integer false (file) The maximum size for a file that can be used with the file upload option.
    text_characters_limited boolean false (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
    text_min_length integer false (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
    text_max_length integer false (text, multi_line_text) The maximum length allowed for a text or multi line text option.
    text_lines_limited boolean false (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
    text_max_lines integer false (multi_line_text) The maximum number of lines allowed on a multi-line text input.
    number_limited boolean false (numbers_only_text) Flag to limit the value of a number option.
    number_limit_mode string false (numbers_only_text) The type of limit on values entered for a number option.
    number_lowest_value number false (numbers_only_text) The lowest allowed value for a number option if number_limited is true.
    number_highest_value number false (numbers_only_text) The highest allowed value for a number option if number_limited is true.
    number_integers_only boolean false (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
    product_list_adjusts_inventory boolean false (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
    product_list_adjusts_pricing boolean false (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
    product_list_shipping_calc string false (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: none - don't adjust; weight - use shipping weight only; package - use weight and dimensions.
    file_types_supported [string] false No description
    file_types_other [string] false No description
    id integer false The unique numeric ID of the modifier; increments sequentially.
    product_id integer false The unique numeric ID of the product to which the option belongs.
    name string false The unique option name. Auto-generated from the display name, a timestamp, and the product ID.
    display_name string false The name of the option shown on the storefront.
    option_values [ModifierValue] false No description
    id integer false The unique numeric ID of the value; increments sequentially.

    Enumerated Values

    Property Value
    type date
    type checkbox
    type file
    type text
    type multi_line_text
    type numbers_only_text
    type radio_buttons
    type rectangles
    type dropdown
    type product_list
    type product_list_with_images
    type swatch
    date_limit_mode earliest
    date_limit_mode range
    date_limit_mode latest
    file_types_mode specific
    file_types_mode all
    number_limit_mode lowest
    number_limit_mode highest
    number_limit_mode range
    product_list_shipping_calc none
    product_list_shipping_calc weight
    product_list_shipping_calc package

    ModifierPost

    {
      "type": "date",
      "required": true,
      "config": {
        "default_value": "string",
        "checked_by_default": true,
        "checkbox_label": "string",
        "date_limited": true,
        "date_limit_mode": "earliest",
        "date_earliest_value": "2017-08-10",
        "date_latest_value": "2017-08-10",
        "file_types_mode": "specific",
        "file_types_supported": [
          "string"
        ],
        "file_types_other": [
          "string"
        ],
        "file_max_size": 0,
        "text_characters_limited": true,
        "text_min_length": 0,
        "text_max_length": 0,
        "text_lines_limited": true,
        "text_max_lines": 0,
        "number_limited": true,
        "number_limit_mode": "lowest",
        "number_lowest_value": 0,
        "number_highest_value": 0,
        "number_integers_only": true,
        "product_list_adjusts_inventory": true,
        "product_list_adjusts_pricing": true,
        "product_list_shipping_calc": "none"
      },
      "option_values": [
        {
          "id": 0
        }
      ],
      "display_name": "string"
    } 
    

    Properties

    Name Type Required Description
    type string false BigCommerce API, which determines how it will display on the storefront. Acceptable values: date, checkbox, file, text, multi_line_text, numbers_only_text, radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. For reference, the former v2 API values are: D = date, C = checkbox, F = file, T = text, MT = multi_line_text, N = numbers_only_text, RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
    required boolean false Whether or not this modifer is required or not at checkout.
    config OptionConfig false No description
    default_value string false (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
    checked_by_default boolean false (checkbox) Flag for setting the checkbox to be checked by default.
    checkbox_label string false (checkbox) Label displayed for the checkbox option.
    date_limited boolean false (date) Flag to limit the dates allowed to be entered on a date option.
    date_limit_mode string false (date) The type of limit that is allowed to be entered on a date option.
    date_earliest_value string(date) false (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    date_latest_value string(date) false (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    file_types_mode string false (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.
    file_max_size integer false (file) The maximum size for a file that can be used with the file upload option.
    text_characters_limited boolean false (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
    text_min_length integer false (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
    text_max_length integer false (text, multi_line_text) The maximum length allowed for a text or multi line text option.
    text_lines_limited boolean false (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
    text_max_lines integer false (multi_line_text) The maximum number of lines allowed on a multi-line text input.
    number_limited boolean false (numbers_only_text) Flag to limit the value of a number option.
    number_limit_mode string false (numbers_only_text) The type of limit on values entered for a number option.
    number_lowest_value number false (numbers_only_text) The lowest allowed value for a number option if number_limited is true.
    number_highest_value number false (numbers_only_text) The highest allowed value for a number option if number_limited is true.
    number_integers_only boolean false (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
    product_list_adjusts_inventory boolean false (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
    product_list_adjusts_pricing boolean false (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
    product_list_shipping_calc string false (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: none - don't adjust; weight - use shipping weight only; package - use weight and dimensions.
    file_types_supported [string] false No description
    file_types_other [string] false No description
    display_name string false The name of the option shown on the storefront.
    option_values [ModifierValue] false No description
    id integer false The unique numeric ID of the value; increments sequentially.

    Enumerated Values

    Property Value
    type date
    type checkbox
    type file
    type text
    type multi_line_text
    type numbers_only_text
    type radio_buttons
    type rectangles
    type dropdown
    type product_list
    type product_list_with_images
    type swatch
    date_limit_mode earliest
    date_limit_mode range
    date_limit_mode latest
    file_types_mode specific
    file_types_mode all
    number_limit_mode lowest
    number_limit_mode highest
    number_limit_mode range
    product_list_shipping_calc none
    product_list_shipping_calc weight
    product_list_shipping_calc package

    ModifierPut

    {
      "type": "date",
      "required": true,
      "config": {
        "default_value": "string",
        "checked_by_default": true,
        "checkbox_label": "string",
        "date_limited": true,
        "date_limit_mode": "earliest",
        "date_earliest_value": "2017-08-10",
        "date_latest_value": "2017-08-10",
        "file_types_mode": "specific",
        "file_types_supported": [
          "string"
        ],
        "file_types_other": [
          "string"
        ],
        "file_max_size": 0,
        "text_characters_limited": true,
        "text_min_length": 0,
        "text_max_length": 0,
        "text_lines_limited": true,
        "text_max_lines": 0,
        "number_limited": true,
        "number_limit_mode": "lowest",
        "number_lowest_value": 0,
        "number_highest_value": 0,
        "number_integers_only": true,
        "product_list_adjusts_inventory": true,
        "product_list_adjusts_pricing": true,
        "product_list_shipping_calc": "none"
      },
      "option_values": [
        {
          "id": 0
        }
      ]
    } 
    

    Properties

    Name Type Required Description
    type string false BigCommerce API, which determines how it will display on the storefront. Acceptable values: date, checkbox, file, text, multi_line_text, numbers_only_text, radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. For reference, the former v2 API values are: D = date, C = checkbox, F = file, T = text, MT = multi_line_text, N = numbers_only_text, RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
    required boolean false Whether or not this modifer is required or not at checkout.
    config OptionConfig false No description
    default_value string false (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
    checked_by_default boolean false (checkbox) Flag for setting the checkbox to be checked by default.
    checkbox_label string false (checkbox) Label displayed for the checkbox option.
    date_limited boolean false (date) Flag to limit the dates allowed to be entered on a date option.
    date_limit_mode string false (date) The type of limit that is allowed to be entered on a date option.
    date_earliest_value string(date) false (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    date_latest_value string(date) false (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    file_types_mode string false (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.
    file_max_size integer false (file) The maximum size for a file that can be used with the file upload option.
    text_characters_limited boolean false (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
    text_min_length integer false (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
    text_max_length integer false (text, multi_line_text) The maximum length allowed for a text or multi line text option.
    text_lines_limited boolean false (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
    text_max_lines integer false (multi_line_text) The maximum number of lines allowed on a multi-line text input.
    number_limited boolean false (numbers_only_text) Flag to limit the value of a number option.
    number_limit_mode string false (numbers_only_text) The type of limit on values entered for a number option.
    number_lowest_value number false (numbers_only_text) The lowest allowed value for a number option if number_limited is true.
    number_highest_value number false (numbers_only_text) The highest allowed value for a number option if number_limited is true.
    number_integers_only boolean false (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
    product_list_adjusts_inventory boolean false (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
    product_list_adjusts_pricing boolean false (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
    product_list_shipping_calc string false (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: none - don't adjust; weight - use shipping weight only; package - use weight and dimensions.
    file_types_supported [string] false No description
    file_types_other [string] false No description
    option_values [ModifierValue] false No description
    id integer false The unique numeric ID of the value; increments sequentially.

    Enumerated Values

    Property Value
    type date
    type checkbox
    type file
    type text
    type multi_line_text
    type numbers_only_text
    type radio_buttons
    type rectangles
    type dropdown
    type product_list
    type product_list_with_images
    type swatch
    date_limit_mode earliest
    date_limit_mode range
    date_limit_mode latest
    file_types_mode specific
    file_types_mode all
    number_limit_mode lowest
    number_limit_mode highest
    number_limit_mode range
    product_list_shipping_calc none
    product_list_shipping_calc weight
    product_list_shipping_calc package

    ModifierValueCollectionResponse

    {
      "data": [
        {
          "id": 0
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [ModifierValue] false No description
    id integer false The unique numeric ID of the value; increments sequentially.

    ModifierValueResponse

    {
      "data": {
        "id": 0
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [ModifierValue] false No description
    id integer false The unique numeric ID of the value; increments sequentially.
    meta Meta false Empty meta object; may be used later.

    ModifierValueBase

    {
      "is_default": true,
      "label": "string",
      "sort_order": -2147483648,
      "value_data": {},
      "adjusters": {
        "price": {
          "adjuster": "relative",
          "adjuster_value": 0
        },
        "weight": {
          "adjuster": "relative",
          "adjuster_value": 0
        },
        "image_url": "string",
        "purchasing_disabled": {
          "status": true,
          "message": "string"
        }
      }
    } 
    

    Properties

    Name Type Required Description
    is_default boolean false The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
    label string false The text display identifying the value on the storefront.
    sort_order integer false The order in which the value will be displayed on the product page.
    value_data object false 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.
    adjusters object false No description
    price Adjuster false No description
    adjuster string false The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
    adjuster_value number false 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.
    image_url string false The URL for an image displayed on the storefront when the modifier value is selected.
    purchasing_disabled object false No description
    status boolean false 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 string false The message displayed on the storefront when the purchasing disabled status is true.

    Enumerated Values

    Property Value
    adjuster relative
    adjuster percentage

    ModifierValue

    {
      "id": 0
    } 
    

    Properties

    Name Type Required Description
    id integer false The unique numeric ID of the value; increments sequentially.

    ModifierValuePost

    {} 
    

    Properties

    Name Type Required Description
    undefined object false The model for a POST to create a modifier value on a product.

    ModifierValuePut

    {
      "id": 0
    } 
    

    Properties

    Name Type Required Description
    id integer false The unique numeric ID of the value; increments sequentially.

    OptionCollectionResponse

    {
      "data": [
        {
          "id": 0,
          "product_id": 0,
          "display_name": "string",
          "type": "radio_buttons",
          "config": {
            "default_value": "string",
            "checked_by_default": true,
            "checkbox_label": "string",
            "date_limited": true,
            "date_limit_mode": "earliest",
            "date_earliest_value": "2017-08-10",
            "date_latest_value": "2017-08-10",
            "file_types_mode": "specific",
            "file_types_supported": [
              "string"
            ],
            "file_types_other": [
              "string"
            ],
            "file_max_size": 0,
            "text_characters_limited": true,
            "text_min_length": 0,
            "text_max_length": 0,
            "text_lines_limited": true,
            "text_max_lines": 0,
            "number_limited": true,
            "number_limit_mode": "lowest",
            "number_lowest_value": 0,
            "number_highest_value": 0,
            "number_integers_only": true,
            "product_list_adjusts_inventory": true,
            "product_list_adjusts_pricing": true,
            "product_list_shipping_calc": "none"
          },
          "option_values": [
            {
              "is_default": true,
              "label": "string",
              "sort_order": -2147483648,
              "value_data": {},
              "id": 0
            }
          ],
          "name": "string"
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [Option] false Common Option properties.
    id integer false The unique numerical ID of the option, increments sequentially.
    product_id integer false The unique numerical ID of the product to which the option belongs.
    display_name string false The name of the option shown on the storefront.
    type string false The type of option, which determines how it will display on the storefront. Acceptable values: radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
    config OptionConfig false No description
    default_value string false (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
    checked_by_default boolean false (checkbox) Flag for setting the checkbox to be checked by default.
    checkbox_label string false (checkbox) Label displayed for the checkbox option.
    date_limited boolean false (date) Flag to limit the dates allowed to be entered on a date option.
    date_limit_mode string false (date) The type of limit that is allowed to be entered on a date option.
    date_earliest_value string(date) false (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    date_latest_value string(date) false (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    file_types_mode string false (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.
    file_max_size integer false (file) The maximum size for a file that can be used with the file upload option.
    text_characters_limited boolean false (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
    text_min_length integer false (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
    text_max_length integer false (text, multi_line_text) The maximum length allowed for a text or multi line text option.
    text_lines_limited boolean false (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
    text_max_lines integer false (multi_line_text) The maximum number of lines allowed on a multi-line text input.
    number_limited boolean false (numbers_only_text) Flag to limit the value of a number option.
    number_limit_mode string false (numbers_only_text) The type of limit on values entered for a number option.
    number_lowest_value number false (numbers_only_text) The lowest allowed value for a number option if number_limited is true.
    number_highest_value number false (numbers_only_text) The highest allowed value for a number option if number_limited is true.
    number_integers_only boolean false (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
    product_list_adjusts_inventory boolean false (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
    product_list_adjusts_pricing boolean false (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
    product_list_shipping_calc string false (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: none - don't adjust; weight - use shipping weight only; package - use weight and dimensions.
    file_types_supported [string] false No description
    file_types_other [string] false No description
    name string false The unique option name, auto-generated from the display name, a timestamp, and the product ID.
    option_values [OptionValue] false Common OptionValue properties.
    is_default boolean false The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
    label string false The text display identifying the value on the storefront.
    sort_order integer false The order in which the value will be displayed on the product page.
    value_data object false 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.
    id integer false The unique numeric ID of the value; increments sequentially.

    Enumerated Values

    Property Value
    type radio_buttons
    type rectangles
    type dropdown
    type product_list
    type product_list_with_images
    type swatch
    date_limit_mode earliest
    date_limit_mode range
    date_limit_mode latest
    file_types_mode specific
    file_types_mode all
    number_limit_mode lowest
    number_limit_mode highest
    number_limit_mode range
    product_list_shipping_calc none
    product_list_shipping_calc weight
    product_list_shipping_calc package

    OptionResponse

    {
      "data": {
        "id": 0,
        "product_id": 0,
        "display_name": "string",
        "type": "radio_buttons",
        "config": {
          "default_value": "string",
          "checked_by_default": true,
          "checkbox_label": "string",
          "date_limited": true,
          "date_limit_mode": "earliest",
          "date_earliest_value": "2017-08-10",
          "date_latest_value": "2017-08-10",
          "file_types_mode": "specific",
          "file_types_supported": [
            "string"
          ],
          "file_types_other": [
            "string"
          ],
          "file_max_size": 0,
          "text_characters_limited": true,
          "text_min_length": 0,
          "text_max_length": 0,
          "text_lines_limited": true,
          "text_max_lines": 0,
          "number_limited": true,
          "number_limit_mode": "lowest",
          "number_lowest_value": 0,
          "number_highest_value": 0,
          "number_integers_only": true,
          "product_list_adjusts_inventory": true,
          "product_list_adjusts_pricing": true,
          "product_list_shipping_calc": "none"
        },
        "option_values": [
          {
            "is_default": true,
            "label": "string",
            "sort_order": -2147483648,
            "value_data": {},
            "id": 0
          }
        ],
        "name": "string"
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [Option] false Common Option properties.
    id integer false The unique numerical ID of the option, increments sequentially.
    product_id integer false The unique numerical ID of the product to which the option belongs.
    display_name string false The name of the option shown on the storefront.
    type string false The type of option, which determines how it will display on the storefront. Acceptable values: radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
    config OptionConfig false No description
    default_value string false (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
    checked_by_default boolean false (checkbox) Flag for setting the checkbox to be checked by default.
    checkbox_label string false (checkbox) Label displayed for the checkbox option.
    date_limited boolean false (date) Flag to limit the dates allowed to be entered on a date option.
    date_limit_mode string false (date) The type of limit that is allowed to be entered on a date option.
    date_earliest_value string(date) false (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    date_latest_value string(date) false (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    file_types_mode string false (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.
    file_max_size integer false (file) The maximum size for a file that can be used with the file upload option.
    text_characters_limited boolean false (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
    text_min_length integer false (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
    text_max_length integer false (text, multi_line_text) The maximum length allowed for a text or multi line text option.
    text_lines_limited boolean false (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
    text_max_lines integer false (multi_line_text) The maximum number of lines allowed on a multi-line text input.
    number_limited boolean false (numbers_only_text) Flag to limit the value of a number option.
    number_limit_mode string false (numbers_only_text) The type of limit on values entered for a number option.
    number_lowest_value number false (numbers_only_text) The lowest allowed value for a number option if number_limited is true.
    number_highest_value number false (numbers_only_text) The highest allowed value for a number option if number_limited is true.
    number_integers_only boolean false (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
    product_list_adjusts_inventory boolean false (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
    product_list_adjusts_pricing boolean false (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
    product_list_shipping_calc string false (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: none - don't adjust; weight - use shipping weight only; package - use weight and dimensions.
    file_types_supported [string] false No description
    file_types_other [string] false No description
    name string false The unique option name, auto-generated from the display name, a timestamp, and the product ID.
    option_values [OptionValue] false Common OptionValue properties.
    is_default boolean false The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
    label string false The text display identifying the value on the storefront.
    sort_order integer false The order in which the value will be displayed on the product page.
    value_data object false 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.
    id integer false The unique numeric ID of the value; increments sequentially.
    meta Meta false Empty meta object; may be used later.

    Enumerated Values

    Property Value
    type radio_buttons
    type rectangles
    type dropdown
    type product_list
    type product_list_with_images
    type swatch
    date_limit_mode earliest
    date_limit_mode range
    date_limit_mode latest
    file_types_mode specific
    file_types_mode all
    number_limit_mode lowest
    number_limit_mode highest
    number_limit_mode range
    product_list_shipping_calc none
    product_list_shipping_calc weight
    product_list_shipping_calc package

    OptionBase

    {
      "id": 0,
      "product_id": 0,
      "display_name": "string",
      "type": "radio_buttons",
      "config": {
        "default_value": "string",
        "checked_by_default": true,
        "checkbox_label": "string",
        "date_limited": true,
        "date_limit_mode": "earliest",
        "date_earliest_value": "2017-08-10",
        "date_latest_value": "2017-08-10",
        "file_types_mode": "specific",
        "file_types_supported": [
          "string"
        ],
        "file_types_other": [
          "string"
        ],
        "file_max_size": 0,
        "text_characters_limited": true,
        "text_min_length": 0,
        "text_max_length": 0,
        "text_lines_limited": true,
        "text_max_lines": 0,
        "number_limited": true,
        "number_limit_mode": "lowest",
        "number_lowest_value": 0,
        "number_highest_value": 0,
        "number_integers_only": true,
        "product_list_adjusts_inventory": true,
        "product_list_adjusts_pricing": true,
        "product_list_shipping_calc": "none"
      },
      "option_values": [
        {
          "is_default": true,
          "label": "string",
          "sort_order": -2147483648,
          "value_data": {},
          "id": 0
        }
      ]
    } 
    

    Properties

    Name Type Required Description
    id integer false The unique numerical ID of the option, increments sequentially.
    product_id integer false The unique numerical ID of the product to which the option belongs.
    display_name string false The name of the option shown on the storefront.
    type string false The type of option, which determines how it will display on the storefront. Acceptable values: radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
    config OptionConfig false No description
    default_value string false (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
    checked_by_default boolean false (checkbox) Flag for setting the checkbox to be checked by default.
    checkbox_label string false (checkbox) Label displayed for the checkbox option.
    date_limited boolean false (date) Flag to limit the dates allowed to be entered on a date option.
    date_limit_mode string false (date) The type of limit that is allowed to be entered on a date option.
    date_earliest_value string(date) false (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    date_latest_value string(date) false (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    file_types_mode string false (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.
    file_max_size integer false (file) The maximum size for a file that can be used with the file upload option.
    text_characters_limited boolean false (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
    text_min_length integer false (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
    text_max_length integer false (text, multi_line_text) The maximum length allowed for a text or multi line text option.
    text_lines_limited boolean false (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
    text_max_lines integer false (multi_line_text) The maximum number of lines allowed on a multi-line text input.
    number_limited boolean false (numbers_only_text) Flag to limit the value of a number option.
    number_limit_mode string false (numbers_only_text) The type of limit on values entered for a number option.
    number_lowest_value number false (numbers_only_text) The lowest allowed value for a number option if number_limited is true.
    number_highest_value number false (numbers_only_text) The highest allowed value for a number option if number_limited is true.
    number_integers_only boolean false (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
    product_list_adjusts_inventory boolean false (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
    product_list_adjusts_pricing boolean false (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
    product_list_shipping_calc string false (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: none - don't adjust; weight - use shipping weight only; package - use weight and dimensions.
    file_types_supported [string] false No description
    file_types_other [string] false No description
    option_values [OptionValue] false Common OptionValue properties.
    is_default boolean false The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
    label string false The text display identifying the value on the storefront.
    sort_order integer false The order in which the value will be displayed on the product page.
    value_data object false 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.
    id integer false The unique numeric ID of the value; increments sequentially.

    Enumerated Values

    Property Value
    type radio_buttons
    type rectangles
    type dropdown
    type product_list
    type product_list_with_images
    type swatch
    date_limit_mode earliest
    date_limit_mode range
    date_limit_mode latest
    file_types_mode specific
    file_types_mode all
    number_limit_mode lowest
    number_limit_mode highest
    number_limit_mode range
    product_list_shipping_calc none
    product_list_shipping_calc weight
    product_list_shipping_calc package

    Option

    {
      "id": 0,
      "product_id": 0,
      "display_name": "string",
      "type": "radio_buttons",
      "config": {
        "default_value": "string",
        "checked_by_default": true,
        "checkbox_label": "string",
        "date_limited": true,
        "date_limit_mode": "earliest",
        "date_earliest_value": "2017-08-10",
        "date_latest_value": "2017-08-10",
        "file_types_mode": "specific",
        "file_types_supported": [
          "string"
        ],
        "file_types_other": [
          "string"
        ],
        "file_max_size": 0,
        "text_characters_limited": true,
        "text_min_length": 0,
        "text_max_length": 0,
        "text_lines_limited": true,
        "text_max_lines": 0,
        "number_limited": true,
        "number_limit_mode": "lowest",
        "number_lowest_value": 0,
        "number_highest_value": 0,
        "number_integers_only": true,
        "product_list_adjusts_inventory": true,
        "product_list_adjusts_pricing": true,
        "product_list_shipping_calc": "none"
      },
      "option_values": [
        {
          "is_default": true,
          "label": "string",
          "sort_order": -2147483648,
          "value_data": {},
          "id": 0
        }
      ],
      "name": "string"
    } 
    

    Properties

    Name Type Required Description
    id integer false The unique numerical ID of the option, increments sequentially.
    product_id integer false The unique numerical ID of the product to which the option belongs.
    display_name string false The name of the option shown on the storefront.
    type string false The type of option, which determines how it will display on the storefront. Acceptable values: radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
    config OptionConfig false No description
    default_value string false (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
    checked_by_default boolean false (checkbox) Flag for setting the checkbox to be checked by default.
    checkbox_label string false (checkbox) Label displayed for the checkbox option.
    date_limited boolean false (date) Flag to limit the dates allowed to be entered on a date option.
    date_limit_mode string false (date) The type of limit that is allowed to be entered on a date option.
    date_earliest_value string(date) false (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    date_latest_value string(date) false (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    file_types_mode string false (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.
    file_max_size integer false (file) The maximum size for a file that can be used with the file upload option.
    text_characters_limited boolean false (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
    text_min_length integer false (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
    text_max_length integer false (text, multi_line_text) The maximum length allowed for a text or multi line text option.
    text_lines_limited boolean false (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
    text_max_lines integer false (multi_line_text) The maximum number of lines allowed on a multi-line text input.
    number_limited boolean false (numbers_only_text) Flag to limit the value of a number option.
    number_limit_mode string false (numbers_only_text) The type of limit on values entered for a number option.
    number_lowest_value number false (numbers_only_text) The lowest allowed value for a number option if number_limited is true.
    number_highest_value number false (numbers_only_text) The highest allowed value for a number option if number_limited is true.
    number_integers_only boolean false (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
    product_list_adjusts_inventory boolean false (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
    product_list_adjusts_pricing boolean false (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
    product_list_shipping_calc string false (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: none - don't adjust; weight - use shipping weight only; package - use weight and dimensions.
    file_types_supported [string] false No description
    file_types_other [string] false No description
    name string false The unique option name, auto-generated from the display name, a timestamp, and the product ID.
    option_values [OptionValue] false Common OptionValue properties.
    is_default boolean false The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
    label string false The text display identifying the value on the storefront.
    sort_order integer false The order in which the value will be displayed on the product page.
    value_data object false 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.
    id integer false The unique numeric ID of the value; increments sequentially.

    Enumerated Values

    Property Value
    type radio_buttons
    type rectangles
    type dropdown
    type product_list
    type product_list_with_images
    type swatch
    date_limit_mode earliest
    date_limit_mode range
    date_limit_mode latest
    file_types_mode specific
    file_types_mode all
    number_limit_mode lowest
    number_limit_mode highest
    number_limit_mode range
    product_list_shipping_calc none
    product_list_shipping_calc weight
    product_list_shipping_calc package

    OptionPost

    {
      "id": 0,
      "product_id": 0,
      "display_name": "string",
      "type": "radio_buttons",
      "config": {
        "default_value": "string",
        "checked_by_default": true,
        "checkbox_label": "string",
        "date_limited": true,
        "date_limit_mode": "earliest",
        "date_earliest_value": "2017-08-10",
        "date_latest_value": "2017-08-10",
        "file_types_mode": "specific",
        "file_types_supported": [
          "string"
        ],
        "file_types_other": [
          "string"
        ],
        "file_max_size": 0,
        "text_characters_limited": true,
        "text_min_length": 0,
        "text_max_length": 0,
        "text_lines_limited": true,
        "text_max_lines": 0,
        "number_limited": true,
        "number_limit_mode": "lowest",
        "number_lowest_value": 0,
        "number_highest_value": 0,
        "number_integers_only": true,
        "product_list_adjusts_inventory": true,
        "product_list_adjusts_pricing": true,
        "product_list_shipping_calc": "none"
      },
      "option_values": [
        {
          "is_default": true,
          "label": "string",
          "sort_order": -2147483648,
          "value_data": {},
          "id": 0
        }
      ]
    } 
    

    Properties

    Name Type Required Description
    id integer false The unique numerical ID of the option, increments sequentially.
    product_id integer false The unique numerical ID of the product to which the option belongs.
    display_name string false The name of the option shown on the storefront.
    type string false The type of option, which determines how it will display on the storefront. Acceptable values: radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
    config OptionConfig false No description
    default_value string false (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
    checked_by_default boolean false (checkbox) Flag for setting the checkbox to be checked by default.
    checkbox_label string false (checkbox) Label displayed for the checkbox option.
    date_limited boolean false (date) Flag to limit the dates allowed to be entered on a date option.
    date_limit_mode string false (date) The type of limit that is allowed to be entered on a date option.
    date_earliest_value string(date) false (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    date_latest_value string(date) false (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    file_types_mode string false (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.
    file_max_size integer false (file) The maximum size for a file that can be used with the file upload option.
    text_characters_limited boolean false (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
    text_min_length integer false (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
    text_max_length integer false (text, multi_line_text) The maximum length allowed for a text or multi line text option.
    text_lines_limited boolean false (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
    text_max_lines integer false (multi_line_text) The maximum number of lines allowed on a multi-line text input.
    number_limited boolean false (numbers_only_text) Flag to limit the value of a number option.
    number_limit_mode string false (numbers_only_text) The type of limit on values entered for a number option.
    number_lowest_value number false (numbers_only_text) The lowest allowed value for a number option if number_limited is true.
    number_highest_value number false (numbers_only_text) The highest allowed value for a number option if number_limited is true.
    number_integers_only boolean false (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
    product_list_adjusts_inventory boolean false (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
    product_list_adjusts_pricing boolean false (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
    product_list_shipping_calc string false (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: none - don't adjust; weight - use shipping weight only; package - use weight and dimensions.
    file_types_supported [string] false No description
    file_types_other [string] false No description
    option_values [OptionValue] false Common OptionValue properties.
    is_default boolean false The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
    label string false The text display identifying the value on the storefront.
    sort_order integer false The order in which the value will be displayed on the product page.
    value_data object false 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.
    id integer false The unique numeric ID of the value; increments sequentially.

    Enumerated Values

    Property Value
    type radio_buttons
    type rectangles
    type dropdown
    type product_list
    type product_list_with_images
    type swatch
    date_limit_mode earliest
    date_limit_mode range
    date_limit_mode latest
    file_types_mode specific
    file_types_mode all
    number_limit_mode lowest
    number_limit_mode highest
    number_limit_mode range
    product_list_shipping_calc none
    product_list_shipping_calc weight
    product_list_shipping_calc package

    OptionPut

    {
      "id": 0,
      "product_id": 0,
      "display_name": "string",
      "type": "radio_buttons",
      "config": {
        "default_value": "string",
        "checked_by_default": true,
        "checkbox_label": "string",
        "date_limited": true,
        "date_limit_mode": "earliest",
        "date_earliest_value": "2017-08-10",
        "date_latest_value": "2017-08-10",
        "file_types_mode": "specific",
        "file_types_supported": [
          "string"
        ],
        "file_types_other": [
          "string"
        ],
        "file_max_size": 0,
        "text_characters_limited": true,
        "text_min_length": 0,
        "text_max_length": 0,
        "text_lines_limited": true,
        "text_max_lines": 0,
        "number_limited": true,
        "number_limit_mode": "lowest",
        "number_lowest_value": 0,
        "number_highest_value": 0,
        "number_integers_only": true,
        "product_list_adjusts_inventory": true,
        "product_list_adjusts_pricing": true,
        "product_list_shipping_calc": "none"
      },
      "option_values": [
        {
          "is_default": true,
          "label": "string",
          "sort_order": -2147483648,
          "value_data": {},
          "id": 0
        }
      ]
    } 
    

    Properties

    Name Type Required Description
    id integer false The unique numerical ID of the option, increments sequentially.
    product_id integer false The unique numerical ID of the product to which the option belongs.
    display_name string false The name of the option shown on the storefront.
    type string false The type of option, which determines how it will display on the storefront. Acceptable values: radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
    config OptionConfig false No description
    default_value string false (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
    checked_by_default boolean false (checkbox) Flag for setting the checkbox to be checked by default.
    checkbox_label string false (checkbox) Label displayed for the checkbox option.
    date_limited boolean false (date) Flag to limit the dates allowed to be entered on a date option.
    date_limit_mode string false (date) The type of limit that is allowed to be entered on a date option.
    date_earliest_value string(date) false (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    date_latest_value string(date) false (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    file_types_mode string false (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.
    file_max_size integer false (file) The maximum size for a file that can be used with the file upload option.
    text_characters_limited boolean false (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
    text_min_length integer false (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
    text_max_length integer false (text, multi_line_text) The maximum length allowed for a text or multi line text option.
    text_lines_limited boolean false (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
    text_max_lines integer false (multi_line_text) The maximum number of lines allowed on a multi-line text input.
    number_limited boolean false (numbers_only_text) Flag to limit the value of a number option.
    number_limit_mode string false (numbers_only_text) The type of limit on values entered for a number option.
    number_lowest_value number false (numbers_only_text) The lowest allowed value for a number option if number_limited is true.
    number_highest_value number false (numbers_only_text) The highest allowed value for a number option if number_limited is true.
    number_integers_only boolean false (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
    product_list_adjusts_inventory boolean false (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
    product_list_adjusts_pricing boolean false (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
    product_list_shipping_calc string false (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: none - don't adjust; weight - use shipping weight only; package - use weight and dimensions.
    file_types_supported [string] false No description
    file_types_other [string] false No description
    option_values [OptionValue] false Common OptionValue properties.
    is_default boolean false The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
    label string false The text display identifying the value on the storefront.
    sort_order integer false The order in which the value will be displayed on the product page.
    value_data object false 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.
    id integer false The unique numeric ID of the value; increments sequentially.

    Enumerated Values

    Property Value
    type radio_buttons
    type rectangles
    type dropdown
    type product_list
    type product_list_with_images
    type swatch
    date_limit_mode earliest
    date_limit_mode range
    date_limit_mode latest
    file_types_mode specific
    file_types_mode all
    number_limit_mode lowest
    number_limit_mode highest
    number_limit_mode range
    product_list_shipping_calc none
    product_list_shipping_calc weight
    product_list_shipping_calc package

    CategoryTreeCollectionResponse

    {
      "data": [
        {}
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [CategoryNode] false No description

    CategoryNode

    {
      "id": 0,
      "parent_id": 0,
      "name": "string",
      "is_visible": true,
      "url": "string",
      "children": [
        {}
      ]
    } 
    

    Properties

    Name Type Required Description
    id integer false The unique numeric ID of the category; increments sequentially.
    parent_id integer false The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog.
    name string false The name displayed for the category. Name is unique with respect to the category's siblings.
    is_visible boolean false Flag to determine whether the product should be displayed to customers browsing the store. If true, the category will be displayed. If false, the category will be hidden from view.
    url string false The custom URL for the category on the storefront.
    children [CategoryNode] false No description

    CategoryCollectionResponse

    {
      "data": [
        {
          "parent_id": 0,
          "name": "string",
          "description": "string",
          "views": 0,
          "sort_order": -2147483648,
          "page_title": "string",
          "search_keywords": "string",
          "meta_keywords": [
            "string"
          ],
          "meta_description": "string",
          "layout_file": "string",
          "is_visible": true,
          "default_product_sort": "use_store_settings",
          "image_url": "string",
          "custom_url": {
            "url": "string",
            "is_customized": true
          },
          "id": 0
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [Category] false A BigCommerce category object.
    parent_id integer false The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog.
    name string false The name displayed for the category. Name is unique with respect to the category's siblings.
    description string false The product description, which can include HTML formatting.
    views integer false Number of views the category has on the storefront.
    sort_order integer false Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be.
    page_title string false Custom title for the category page. If not defined, the category name will be used as the meta title.
    search_keywords string false A comma-separated list of keywords that can be used to locate the category when searching the store.
    meta_description string false Custom meta description for the category page. If not defined, the store's default meta description will be used.
    layout_file string false The layout template file used to render this category.
    is_visible boolean false Flag to determine whether the product should be displayed to customers browsing the store. If true, the category will be displayed. If false, the category will be hidden from view.
    default_product_sort string false Determines how the products are sorted on category page load.
    image_url string false Image URL used for this category on the storefront. Images can be uploaded via form file post to /categories/{categoryId}/image, or by providing a publicly accessible URL in this field.
    custom_url CustomUrlCategory false The custom URL for the category on the storefront.
    url string false Category URL on the storefront.
    is_customized boolean false Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).
    id integer false The unique numeric ID of the category; increments sequentially.
    meta_keywords [string] false No description

    Enumerated Values

    Property Value
    default_product_sort use_store_settings
    default_product_sort featured
    default_product_sort newest
    default_product_sort best_selling
    default_product_sort alpha_asc
    default_product_sort alpha_desc
    default_product_sort avg_customer_review
    default_product_sort price_asc
    default_product_sort price_desc

    CategoryResponse

    {
      "data": {
        "parent_id": 0,
        "name": "string",
        "description": "string",
        "views": 0,
        "sort_order": -2147483648,
        "page_title": "string",
        "search_keywords": "string",
        "meta_keywords": [
          "string"
        ],
        "meta_description": "string",
        "layout_file": "string",
        "is_visible": true,
        "default_product_sort": "use_store_settings",
        "image_url": "string",
        "custom_url": {
          "url": "string",
          "is_customized": true
        },
        "id": 0
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [Category] false A BigCommerce category object.
    parent_id integer false The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog.
    name string false The name displayed for the category. Name is unique with respect to the category's siblings.
    description string false The product description, which can include HTML formatting.
    views integer false Number of views the category has on the storefront.
    sort_order integer false Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be.
    page_title string false Custom title for the category page. If not defined, the category name will be used as the meta title.
    search_keywords string false A comma-separated list of keywords that can be used to locate the category when searching the store.
    meta_description string false Custom meta description for the category page. If not defined, the store's default meta description will be used.
    layout_file string false The layout template file used to render this category.
    is_visible boolean false Flag to determine whether the product should be displayed to customers browsing the store. If true, the category will be displayed. If false, the category will be hidden from view.
    default_product_sort string false Determines how the products are sorted on category page load.
    image_url string false Image URL used for this category on the storefront. Images can be uploaded via form file post to /categories/{categoryId}/image, or by providing a publicly accessible URL in this field.
    custom_url CustomUrlCategory false The custom URL for the category on the storefront.
    url string false Category URL on the storefront.
    is_customized boolean false Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).
    id integer false The unique numeric ID of the category; increments sequentially.
    meta_keywords [string] false No description
    meta Meta false Empty meta object; may be used later.

    Enumerated Values

    Property Value
    default_product_sort use_store_settings
    default_product_sort featured
    default_product_sort newest
    default_product_sort best_selling
    default_product_sort alpha_asc
    default_product_sort alpha_desc
    default_product_sort avg_customer_review
    default_product_sort price_asc
    default_product_sort price_desc

    CategoryBase

    {
      "parent_id": 0,
      "name": "string",
      "description": "string",
      "views": 0,
      "sort_order": -2147483648,
      "page_title": "string",
      "search_keywords": "string",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "layout_file": "string",
      "is_visible": true,
      "default_product_sort": "use_store_settings",
      "image_url": "string",
      "custom_url": {
        "url": "string",
        "is_customized": true
      }
    } 
    

    Properties

    Name Type Required Description
    parent_id integer false The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog.
    name string false The name displayed for the category. Name is unique with respect to the category's siblings.
    description string false The product description, which can include HTML formatting.
    views integer false Number of views the category has on the storefront.
    sort_order integer false Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be.
    page_title string false Custom title for the category page. If not defined, the category name will be used as the meta title.
    search_keywords string false A comma-separated list of keywords that can be used to locate the category when searching the store.
    meta_description string false Custom meta description for the category page. If not defined, the store's default meta description will be used.
    layout_file string false The layout template file used to render this category.
    is_visible boolean false Flag to determine whether the product should be displayed to customers browsing the store. If true, the category will be displayed. If false, the category will be hidden from view.
    default_product_sort string false Determines how the products are sorted on category page load.
    image_url string false Image URL used for this category on the storefront. Images can be uploaded via form file post to /categories/{categoryId}/image, or by providing a publicly accessible URL in this field.
    custom_url CustomUrlCategory false The custom URL for the category on the storefront.
    url string false Category URL on the storefront.
    is_customized boolean false Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).
    meta_keywords [string] false No description

    Enumerated Values

    Property Value
    default_product_sort use_store_settings
    default_product_sort featured
    default_product_sort newest
    default_product_sort best_selling
    default_product_sort alpha_asc
    default_product_sort alpha_desc
    default_product_sort avg_customer_review
    default_product_sort price_asc
    default_product_sort price_desc

    Category

    {
      "parent_id": 0,
      "name": "string",
      "description": "string",
      "views": 0,
      "sort_order": -2147483648,
      "page_title": "string",
      "search_keywords": "string",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "layout_file": "string",
      "is_visible": true,
      "default_product_sort": "use_store_settings",
      "image_url": "string",
      "custom_url": {
        "url": "string",
        "is_customized": true
      },
      "id": 0
    } 
    

    Properties

    Name Type Required Description
    parent_id integer false The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog.
    name string false The name displayed for the category. Name is unique with respect to the category's siblings.
    description string false The product description, which can include HTML formatting.
    views integer false Number of views the category has on the storefront.
    sort_order integer false Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be.
    page_title string false Custom title for the category page. If not defined, the category name will be used as the meta title.
    search_keywords string false A comma-separated list of keywords that can be used to locate the category when searching the store.
    meta_description string false Custom meta description for the category page. If not defined, the store's default meta description will be used.
    layout_file string false The layout template file used to render this category.
    is_visible boolean false Flag to determine whether the product should be displayed to customers browsing the store. If true, the category will be displayed. If false, the category will be hidden from view.
    default_product_sort string false Determines how the products are sorted on category page load.
    image_url string false Image URL used for this category on the storefront. Images can be uploaded via form file post to /categories/{categoryId}/image, or by providing a publicly accessible URL in this field.
    custom_url CustomUrlCategory false The custom URL for the category on the storefront.
    url string false Category URL on the storefront.
    is_customized boolean false Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).
    id integer false The unique numeric ID of the category; increments sequentially.
    meta_keywords [string] false No description

    Enumerated Values

    Property Value
    default_product_sort use_store_settings
    default_product_sort featured
    default_product_sort newest
    default_product_sort best_selling
    default_product_sort alpha_asc
    default_product_sort alpha_desc
    default_product_sort avg_customer_review
    default_product_sort price_asc
    default_product_sort price_desc

    CategoryPost

    {
      "parent_id": 0,
      "name": "string",
      "description": "string",
      "views": 0,
      "sort_order": -2147483648,
      "page_title": "string",
      "search_keywords": "string",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "layout_file": "string",
      "is_visible": true,
      "default_product_sort": "use_store_settings",
      "image_url": "string",
      "custom_url": {
        "url": "string",
        "is_customized": true
      }
    } 
    

    Properties

    Name Type Required Description
    parent_id integer false The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog.
    name string false The name displayed for the category. Name is unique with respect to the category's siblings.
    description string false The product description, which can include HTML formatting.
    views integer false Number of views the category has on the storefront.
    sort_order integer false Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be.
    page_title string false Custom title for the category page. If not defined, the category name will be used as the meta title.
    search_keywords string false A comma-separated list of keywords that can be used to locate the category when searching the store.
    meta_description string false Custom meta description for the category page. If not defined, the store's default meta description will be used.
    layout_file string false The layout template file used to render this category.
    is_visible boolean false Flag to determine whether the product should be displayed to customers browsing the store. If true, the category will be displayed. If false, the category will be hidden from view.
    default_product_sort string false Determines how the products are sorted on category page load.
    image_url string false Image URL used for this category on the storefront. Images can be uploaded via form file post to /categories/{categoryId}/image, or by providing a publicly accessible URL in this field.
    custom_url CustomUrlCategory false The custom URL for the category on the storefront.
    url string false Category URL on the storefront.
    is_customized boolean false Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).
    meta_keywords [string] false No description

    Enumerated Values

    Property Value
    default_product_sort use_store_settings
    default_product_sort featured
    default_product_sort newest
    default_product_sort best_selling
    default_product_sort alpha_asc
    default_product_sort alpha_desc
    default_product_sort avg_customer_review
    default_product_sort price_asc
    default_product_sort price_desc

    CategoryPut

    {
      "parent_id": 0,
      "name": "string",
      "description": "string",
      "views": 0,
      "sort_order": -2147483648,
      "page_title": "string",
      "search_keywords": "string",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "layout_file": "string",
      "is_visible": true,
      "default_product_sort": "use_store_settings",
      "image_url": "string",
      "custom_url": {
        "url": "string",
        "is_customized": true
      }
    } 
    

    Properties

    Name Type Required Description
    parent_id integer false The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog.
    name string false The name displayed for the category. Name is unique with respect to the category's siblings.
    description string false The product description, which can include HTML formatting.
    views integer false Number of views the category has on the storefront.
    sort_order integer false Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be.
    page_title string false Custom title for the category page. If not defined, the category name will be used as the meta title.
    search_keywords string false A comma-separated list of keywords that can be used to locate the category when searching the store.
    meta_description string false Custom meta description for the category page. If not defined, the store's default meta description will be used.
    layout_file string false The layout template file used to render this category.
    is_visible boolean false Flag to determine whether the product should be displayed to customers browsing the store. If true, the category will be displayed. If false, the category will be hidden from view.
    default_product_sort string false Determines how the products are sorted on category page load.
    image_url string false Image URL used for this category on the storefront. Images can be uploaded via form file post to /categories/{categoryId}/image, or by providing a publicly accessible URL in this field.
    custom_url CustomUrlCategory false The custom URL for the category on the storefront.
    url string false Category URL on the storefront.
    is_customized boolean false Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).
    meta_keywords [string] false No description

    Enumerated Values

    Property Value
    default_product_sort use_store_settings
    default_product_sort featured
    default_product_sort newest
    default_product_sort best_selling
    default_product_sort alpha_asc
    default_product_sort alpha_desc
    default_product_sort avg_customer_review
    default_product_sort price_asc
    default_product_sort price_desc

    BrandCollectionResponse

    {
      "data": [
        {
          "name": "string",
          "page_title": "string",
          "meta_keywords": [
            "string"
          ],
          "meta_description": "string",
          "search_keywords": "string",
          "image_url": "string",
          "id": 0
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [Brand] false Common Brand properties.
    name string false The name of the brand. Must be unique.
    page_title string false The title shown in the browser while viewing the brand.
    meta_description string false A meta description to include.
    search_keywords string false A comma-separated list of keywords that can be used to locate this brand.
    image_url string false 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.
    id integer false The unique numeric ID of the brand; increments sequentially.
    meta_keywords [string] false No description

    BrandResponse

    {
      "data": {
        "name": "string",
        "page_title": "string",
        "meta_keywords": [
          "string"
        ],
        "meta_description": "string",
        "search_keywords": "string",
        "image_url": "string",
        "id": 0
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [Brand] false Common Brand properties.
    name string false The name of the brand. Must be unique.
    page_title string false The title shown in the browser while viewing the brand.
    meta_description string false A meta description to include.
    search_keywords string false A comma-separated list of keywords that can be used to locate this brand.
    image_url string false 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.
    id integer false The unique numeric ID of the brand; increments sequentially.
    meta_keywords [string] false No description
    meta Meta false Empty meta object; may be used later.

    BrandBase

    {
      "name": "string",
      "page_title": "string",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "search_keywords": "string",
      "image_url": "string"
    } 
    

    Properties

    Name Type Required Description
    name string false The name of the brand. Must be unique.
    page_title string false The title shown in the browser while viewing the brand.
    meta_description string false A meta description to include.
    search_keywords string false A comma-separated list of keywords that can be used to locate this brand.
    image_url string false 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.
    meta_keywords [string] false No description

    Brand

    {
      "name": "string",
      "page_title": "string",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "search_keywords": "string",
      "image_url": "string",
      "id": 0
    } 
    

    Properties

    Name Type Required Description
    name string false The name of the brand. Must be unique.
    page_title string false The title shown in the browser while viewing the brand.
    meta_description string false A meta description to include.
    search_keywords string false A comma-separated list of keywords that can be used to locate this brand.
    image_url string false 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.
    id integer false The unique numeric ID of the brand; increments sequentially.
    meta_keywords [string] false No description

    BrandPost

    {
      "name": "string",
      "page_title": "string",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "search_keywords": "string",
      "image_url": "string"
    } 
    

    Properties

    Name Type Required Description
    name string false The name of the brand. Must be unique.
    page_title string false The title shown in the browser while viewing the brand.
    meta_description string false A meta description to include.
    search_keywords string false A comma-separated list of keywords that can be used to locate this brand.
    image_url string false 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.
    meta_keywords [string] false No description

    BrandPut

    {
      "name": "string",
      "page_title": "string",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "search_keywords": "string",
      "image_url": "string",
      "id": 0
    } 
    

    Properties

    Name Type Required Description
    name string false The name of the brand. Must be unique.
    page_title string false The title shown in the browser while viewing the brand.
    meta_description string false A meta description to include.
    search_keywords string false A comma-separated list of keywords that can be used to locate this brand.
    image_url string false 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.
    id integer false The unique numeric ID of the brand; increments sequentially.
    meta_keywords [string] false No description

    SubscriberCollectionResponse

    {
      "data": [
        {
          "id": 0,
          "email": "string",
          "first_name": "string",
          "last_name": "string",
          "source": "string",
          "order_id": 1,
          "date_modified": "2017-08-10T19:38:09Z",
          "date_created": "2017-08-10T19:38:09Z"
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [Subscriber] false Common Subscriber properties.
    id integer false The unique numeric ID of the subscriber; increments sequentially.
    email string false The email of the subscriber. Must be unique.
    first_name string false The first name of the subscriber.
    last_name string false The last name of the subscriber.
    source string false The source of the subscriber. Values are: storefront, order, or custom.
    order_id integer false The ID of the source order, if source was an order.
    date_modified string(date-time) false The date on which the subscriber was modified.
    date_created string(date-time) false The date of which the subscriber was created.

    SubscriberResponse

    {
      "data": {
        "id": 0,
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "source": "string",
        "order_id": 1,
        "date_modified": "2017-08-10T19:38:09Z",
        "date_created": "2017-08-10T19:38:09Z"
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [Subscriber] false Common Subscriber properties.
    id integer false The unique numeric ID of the subscriber; increments sequentially.
    email string false The email of the subscriber. Must be unique.
    first_name string false The first name of the subscriber.
    last_name string false The last name of the subscriber.
    source string false The source of the subscriber. Values are: storefront, order, or custom.
    order_id integer false The ID of the source order, if source was an order.
    date_modified string(date-time) false The date on which the subscriber was modified.
    date_created string(date-time) false The date of which the subscriber was created.
    meta Meta false Empty meta object; may be used later.

    SubscriberBase

    {
      "id": 0,
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "source": "string",
      "order_id": 1
    } 
    

    Properties

    Name Type Required Description
    id integer false The unique numeric ID of the subscriber; increments sequentially.
    email string false The email of the subscriber. Must be unique.
    first_name string false The first name of the subscriber.
    last_name string false The last name of the subscriber.
    source string false The source of the subscriber. Values are: storefront, order, or custom.
    order_id integer false The ID of the source order, if source was an order.

    Subscriber

    {
      "id": 0,
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "source": "string",
      "order_id": 1,
      "date_modified": "2017-08-10T19:38:09Z",
      "date_created": "2017-08-10T19:38:09Z"
    } 
    

    Properties

    Name Type Required Description
    id integer false The unique numeric ID of the subscriber; increments sequentially.
    email string false The email of the subscriber. Must be unique.
    first_name string false The first name of the subscriber.
    last_name string false The last name of the subscriber.
    source string false The source of the subscriber. Values are: storefront, order, or custom.
    order_id integer false The ID of the source order, if source was an order.
    date_modified string(date-time) false The date on which the subscriber was modified.
    date_created string(date-time) false The date of which the subscriber was created.

    SubscriberPost

    {
      "id": 0,
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "source": "string",
      "order_id": 1
    } 
    

    Properties

    Name Type Required Description
    id integer false The unique numeric ID of the subscriber; increments sequentially.
    email string false The email of the subscriber. Must be unique.
    first_name string false The first name of the subscriber.
    last_name string false The last name of the subscriber.
    source string false The source of the subscriber. Values are: storefront, order, or custom.
    order_id integer false The ID of the source order, if source was an order.

    SubscriberPut

    {
      "id": 0,
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "source": "string",
      "order_id": 1
    } 
    

    Properties

    Name Type Required Description
    id integer false The unique numeric ID of the subscriber; increments sequentially.
    email string false The email of the subscriber. Must be unique.
    first_name string false The first name of the subscriber.
    last_name string false The last name of the subscriber.
    source string false The source of the subscriber. Values are: storefront, order, or custom.
    order_id integer false The ID of the source order, if source was an order.

    VariantCollectionResponse

    {
      "data": [
        {
          "cost_price": 0,
          "price": 0,
          "sale_price": 0,
          "retail_price": 0,
          "weight": 0,
          "width": 0,
          "height": 0,
          "depth": 0,
          "is_free_shipping": true,
          "fixed_cost_shipping_price": 0,
          "purchasing_disabled": true,
          "purchasing_disabled_message": "string",
          "image_url": "string",
          "upc": "string",
          "inventory_level": 0,
          "inventory_warning_level": 0,
          "bin_picking_number": "string",
          "id": 0,
          "product_id": 0,
          "sku": "string",
          "sku_id": 0,
          "option_values": [
            {
              "option_display_name": "string",
              "label": "string",
              "id": 0,
              "option_id": 0
            }
          ]
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [Variant] false Common Variant properties.
    cost_price number(double) false The cost price of the variant. Not affected by Price List prices.
    price number(double) false This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's default price (set in the Product resource's price field) will be used as the base price.
    sale_price number(double) false This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's price field) will be used as the sale price.
    retail_price number(double) false This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's price field) will be used as the retail price.
    weight number(double) false This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
    width number(double) false Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width.
    height number(double) false Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height.
    depth number(double) false Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth.
    is_free_shipping boolean false Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    purchasing_disabled boolean false If true, this variant will not be purchasable on the storefront.
    purchasing_disabled_message string false If purchasing_disabled is true, this message should show on the storefront when the variant is selected.
    image_url string false The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product.
    upc string false The UPC code used in feeds for shopping comparison sites and external channel integrations.
    inventory_level integer false Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.
    inventory_warning_level integer false When the variant hits this inventory level, it is considered low stock.
    bin_picking_number string false Identifies where in a warehouse the variant is located.
    id integer false No description
    product_id integer false No description
    sku string false No description
    sku_id integer false Read-only reference to v2 API's SKU ID. Null if it is a base variant.
    option_values [OptionValueVariant] false Common OptionValueProduct properties.
    option_display_name string false The name of the option.
    label string false The label of the option value.
    id integer false No description
    option_id integer false No description

    VariantResponse

    {
      "data": {
        "cost_price": 0,
        "price": 0,
        "sale_price": 0,
        "retail_price": 0,
        "weight": 0,
        "width": 0,
        "height": 0,
        "depth": 0,
        "is_free_shipping": true,
        "fixed_cost_shipping_price": 0,
        "purchasing_disabled": true,
        "purchasing_disabled_message": "string",
        "image_url": "string",
        "upc": "string",
        "inventory_level": 0,
        "inventory_warning_level": 0,
        "bin_picking_number": "string",
        "id": 0,
        "product_id": 0,
        "sku": "string",
        "sku_id": 0,
        "option_values": [
          {
            "option_display_name": "string",
            "label": "string",
            "id": 0,
            "option_id": 0
          }
        ]
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [Variant] false Common Variant properties.
    cost_price number(double) false The cost price of the variant. Not affected by Price List prices.
    price number(double) false This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's default price (set in the Product resource's price field) will be used as the base price.
    sale_price number(double) false This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's price field) will be used as the sale price.
    retail_price number(double) false This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's price field) will be used as the retail price.
    weight number(double) false This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
    width number(double) false Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width.
    height number(double) false Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height.
    depth number(double) false Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth.
    is_free_shipping boolean false Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    purchasing_disabled boolean false If true, this variant will not be purchasable on the storefront.
    purchasing_disabled_message string false If purchasing_disabled is true, this message should show on the storefront when the variant is selected.
    image_url string false The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product.
    upc string false The UPC code used in feeds for shopping comparison sites and external channel integrations.
    inventory_level integer false Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.
    inventory_warning_level integer false When the variant hits this inventory level, it is considered low stock.
    bin_picking_number string false Identifies where in a warehouse the variant is located.
    id integer false No description
    product_id integer false No description
    sku string false No description
    sku_id integer false Read-only reference to v2 API's SKU ID. Null if it is a base variant.
    option_values [OptionValueVariant] false Common OptionValueProduct properties.
    option_display_name string false The name of the option.
    label string false The label of the option value.
    id integer false No description
    option_id integer false No description
    meta Meta false Empty meta object; may be used later.

    VariantBase

    {
      "cost_price": 0,
      "price": 0,
      "sale_price": 0,
      "retail_price": 0,
      "weight": 0,
      "width": 0,
      "height": 0,
      "depth": 0,
      "is_free_shipping": true,
      "fixed_cost_shipping_price": 0,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "image_url": "string",
      "upc": "string",
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "bin_picking_number": "string"
    } 
    

    Properties

    Name Type Required Description
    cost_price number(double) false The cost price of the variant. Not affected by Price List prices.
    price number(double) false This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's default price (set in the Product resource's price field) will be used as the base price.
    sale_price number(double) false This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's price field) will be used as the sale price.
    retail_price number(double) false This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's price field) will be used as the retail price.
    weight number(double) false This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
    width number(double) false Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width.
    height number(double) false Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height.
    depth number(double) false Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth.
    is_free_shipping boolean false Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    purchasing_disabled boolean false If true, this variant will not be purchasable on the storefront.
    purchasing_disabled_message string false If purchasing_disabled is true, this message should show on the storefront when the variant is selected.
    image_url string false The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product.
    upc string false The UPC code used in feeds for shopping comparison sites and external channel integrations.
    inventory_level integer false Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.
    inventory_warning_level integer false When the variant hits this inventory level, it is considered low stock.
    bin_picking_number string false Identifies where in a warehouse the variant is located.

    Variant

    {
      "cost_price": 0,
      "price": 0,
      "sale_price": 0,
      "retail_price": 0,
      "weight": 0,
      "width": 0,
      "height": 0,
      "depth": 0,
      "is_free_shipping": true,
      "fixed_cost_shipping_price": 0,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "image_url": "string",
      "upc": "string",
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "bin_picking_number": "string",
      "id": 0,
      "product_id": 0,
      "sku": "string",
      "sku_id": 0,
      "option_values": [
        {
          "option_display_name": "string",
          "label": "string",
          "id": 0,
          "option_id": 0
        }
      ]
    } 
    

    Properties

    Name Type Required Description
    cost_price number(double) false The cost price of the variant. Not affected by Price List prices.
    price number(double) false This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's default price (set in the Product resource's price field) will be used as the base price.
    sale_price number(double) false This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's price field) will be used as the sale price.
    retail_price number(double) false This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's price field) will be used as the retail price.
    weight number(double) false This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
    width number(double) false Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width.
    height number(double) false Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height.
    depth number(double) false Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth.
    is_free_shipping boolean false Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    purchasing_disabled boolean false If true, this variant will not be purchasable on the storefront.
    purchasing_disabled_message string false If purchasing_disabled is true, this message should show on the storefront when the variant is selected.
    image_url string false The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product.
    upc string false The UPC code used in feeds for shopping comparison sites and external channel integrations.
    inventory_level integer false Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.
    inventory_warning_level integer false When the variant hits this inventory level, it is considered low stock.
    bin_picking_number string false Identifies where in a warehouse the variant is located.
    id integer false No description
    product_id integer false No description
    sku string false No description
    sku_id integer false Read-only reference to v2 API's SKU ID. Null if it is a base variant.
    option_values [OptionValueVariant] false Common OptionValueProduct properties.
    option_display_name string false The name of the option.
    label string false The label of the option value.
    id integer false No description
    option_id integer false No description

    VariantPost

    {
      "cost_price": 0,
      "price": 0,
      "sale_price": 0,
      "retail_price": 0,
      "weight": 0,
      "width": 0,
      "height": 0,
      "depth": 0,
      "is_free_shipping": true,
      "fixed_cost_shipping_price": 0,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "image_url": "string",
      "upc": "string",
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "bin_picking_number": "string",
      "product_id": 0,
      "sku": "string",
      "option_values": [
        {
          "id": 0,
          "option_id": 0
        }
      ]
    } 
    

    Properties

    Name Type Required Description
    cost_price number(double) false The cost price of the variant. Not affected by Price List prices.
    price number(double) false This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's default price (set in the Product resource's price field) will be used as the base price.
    sale_price number(double) false This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's price field) will be used as the sale price.
    retail_price number(double) false This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's price field) will be used as the retail price.
    weight number(double) false This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
    width number(double) false Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width.
    height number(double) false Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height.
    depth number(double) false Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth.
    is_free_shipping boolean false Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    purchasing_disabled boolean false If true, this variant will not be purchasable on the storefront.
    purchasing_disabled_message string false If purchasing_disabled is true, this message should show on the storefront when the variant is selected.
    image_url string false The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product.
    upc string false The UPC code used in feeds for shopping comparison sites and external channel integrations.
    inventory_level integer false Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.
    inventory_warning_level integer false When the variant hits this inventory level, it is considered low stock.
    bin_picking_number string false Identifies where in a warehouse the variant is located.
    product_id integer false No description
    sku string false No description
    option_values [OptionValueVariantPost] false The model for a POST to create option values on a variant.
    id integer false No description
    option_id integer false No description

    VariantPut

    {
      "cost_price": 0,
      "price": 0,
      "sale_price": 0,
      "retail_price": 0,
      "weight": 0,
      "width": 0,
      "height": 0,
      "depth": 0,
      "is_free_shipping": true,
      "fixed_cost_shipping_price": 0,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "image_url": "string",
      "upc": "string",
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "bin_picking_number": "string",
      "id": 0
    } 
    

    Properties

    Name Type Required Description
    cost_price number(double) false The cost price of the variant. Not affected by Price List prices.
    price number(double) false This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's default price (set in the Product resource's price field) will be used as the base price.
    sale_price number(double) false This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's price field) will be used as the sale price.
    retail_price number(double) false This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's price field) will be used as the retail price.
    weight number(double) false This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
    width number(double) false Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width.
    height number(double) false Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height.
    depth number(double) false Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth.
    is_free_shipping boolean false Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    purchasing_disabled boolean false If true, this variant will not be purchasable on the storefront.
    purchasing_disabled_message string false If purchasing_disabled is true, this message should show on the storefront when the variant is selected.
    image_url string false The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product.
    upc string false The UPC code used in feeds for shopping comparison sites and external channel integrations.
    inventory_level integer false Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.
    inventory_warning_level integer false When the variant hits this inventory level, it is considered low stock.
    bin_picking_number string false Identifies where in a warehouse the variant is located.
    id integer false No description

    VariantProductPost

    {
      "cost_price": 0,
      "price": 0,
      "sale_price": 0,
      "retail_price": 0,
      "weight": 0,
      "width": 0,
      "height": 0,
      "depth": 0,
      "is_free_shipping": true,
      "fixed_cost_shipping_price": 0,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "image_url": "string",
      "upc": "string",
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "bin_picking_number": "string",
      "product_id": 0,
      "sku": "string",
      "option_values": [
        {
          "option_display_name": "string",
          "label": "string"
        }
      ]
    } 
    

    Properties

    Name Type Required Description
    cost_price number(double) false The cost price of the variant. Not affected by Price List prices.
    price number(double) false This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's default price (set in the Product resource's price field) will be used as the base price.
    sale_price number(double) false This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's price field) will be used as the sale price.
    retail_price number(double) false This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's price field) will be used as the retail price.
    weight number(double) false This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
    width number(double) false Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width.
    height number(double) false Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height.
    depth number(double) false Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth.
    is_free_shipping boolean false Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    purchasing_disabled boolean false If true, this variant will not be purchasable on the storefront.
    purchasing_disabled_message string false If purchasing_disabled is true, this message should show on the storefront when the variant is selected.
    image_url string false The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product.
    upc string false The UPC code used in feeds for shopping comparison sites and external channel integrations.
    inventory_level integer false Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.
    inventory_warning_level integer false When the variant hits this inventory level, it is considered low stock.
    bin_picking_number string false Identifies where in a warehouse the variant is located.
    product_id integer false No description
    sku string false No description
    option_values [OptionValueProductPost] false The model for a POST to create option values on a product.
    option_display_name string false The name of the option.
    label string false The label of the option value.

    VariantProductPut

    {
      "cost_price": 0,
      "price": 0,
      "sale_price": 0,
      "retail_price": 0,
      "weight": 0,
      "width": 0,
      "height": 0,
      "depth": 0,
      "is_free_shipping": true,
      "fixed_cost_shipping_price": 0,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "image_url": "string",
      "upc": "string",
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "bin_picking_number": "string",
      "product_id": 0,
      "sku": "string"
    } 
    

    Properties

    Name Type Required Description
    cost_price number(double) false The cost price of the variant. Not affected by Price List prices.
    price number(double) false This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's default price (set in the Product resource's price field) will be used as the base price.
    sale_price number(double) false This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's price field) will be used as the sale price.
    retail_price number(double) false This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's price field) will be used as the retail price.
    weight number(double) false This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
    width number(double) false Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width.
    height number(double) false Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height.
    depth number(double) false Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth.
    is_free_shipping boolean false Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    purchasing_disabled boolean false If true, this variant will not be purchasable on the storefront.
    purchasing_disabled_message string false If purchasing_disabled is true, this message should show on the storefront when the variant is selected.
    image_url string false The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product.
    upc string false The UPC code used in feeds for shopping comparison sites and external channel integrations.
    inventory_level integer false Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.
    inventory_warning_level integer false When the variant hits this inventory level, it is considered low stock.
    bin_picking_number string false Identifies where in a warehouse the variant is located.
    product_id integer false No description
    sku string false No description

    OptionValueProductBase

    {
      "option_display_name": "string",
      "label": "string"
    } 
    

    Properties

    Name Type Required Description
    option_display_name string false The name of the option.
    label string false The label of the option value.

    OptionValueProductPost

    {
      "option_display_name": "string",
      "label": "string"
    } 
    

    Properties

    Name Type Required Description
    option_display_name string false The name of the option.
    label string false The label of the option value.

    OptionValueVariant

    {
      "option_display_name": "string",
      "label": "string",
      "id": 0,
      "option_id": 0
    } 
    

    Properties

    Name Type Required Description
    option_display_name string false The name of the option.
    label string false The label of the option value.
    id integer false No description
    option_id integer false No description

    OptionValueVariantPost

    {
      "id": 0,
      "option_id": 0
    } 
    

    Properties

    Name Type Required Description
    id integer false No description
    option_id integer false No description

    OptionValueCollectionResponse

    {
      "data": [
        {
          "is_default": true,
          "label": "string",
          "sort_order": -2147483648,
          "value_data": {},
          "id": 0
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [OptionValue] false Common OptionValue properties.
    is_default boolean false The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
    label string false The text display identifying the value on the storefront.
    sort_order integer false The order in which the value will be displayed on the product page.
    value_data object false 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.
    id integer false The unique numeric ID of the value; increments sequentially.

    OptionValueResponse

    {
      "data": {
        "is_default": true,
        "label": "string",
        "sort_order": -2147483648,
        "value_data": {},
        "id": 0
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [OptionValue] false Common OptionValue properties.
    is_default boolean false The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
    label string false The text display identifying the value on the storefront.
    sort_order integer false The order in which the value will be displayed on the product page.
    value_data object false 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.
    id integer false The unique numeric ID of the value; increments sequentially.
    meta Meta false Empty meta object; may be used later.

    OptionValueBase

    {
      "is_default": true,
      "label": "string",
      "sort_order": -2147483648,
      "value_data": {}
    } 
    

    Properties

    Name Type Required Description
    is_default boolean false The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
    label string false The text display identifying the value on the storefront.
    sort_order integer false The order in which the value will be displayed on the product page.
    value_data object false 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.

    OptionValue

    {
      "is_default": true,
      "label": "string",
      "sort_order": -2147483648,
      "value_data": {},
      "id": 0
    } 
    

    Properties

    Name Type Required Description
    is_default boolean false The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
    label string false The text display identifying the value on the storefront.
    sort_order integer false The order in which the value will be displayed on the product page.
    value_data object false 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.
    id integer false The unique numeric ID of the value; increments sequentially.

    OptionValuePost

    {
      "is_default": true,
      "label": "string",
      "sort_order": -2147483648,
      "value_data": {}
    } 
    

    Properties

    Name Type Required Description
    is_default boolean false The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
    label string false The text display identifying the value on the storefront.
    sort_order integer false The order in which the value will be displayed on the product page.
    value_data object false 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.

    OptionValuePut

    {
      "is_default": true,
      "label": "string",
      "sort_order": -2147483648,
      "value_data": {},
      "id": 0
    } 
    

    Properties

    Name Type Required Description
    is_default boolean false The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
    label string false The text display identifying the value on the storefront.
    sort_order integer false The order in which the value will be displayed on the product page.
    value_data object false 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.
    id integer false The unique numeric ID of the value; increments sequentially.

    ProductImageCollectionResponse

    {
      "data": [
        {
          "is_thumbnail": true,
          "sort_order": -2147483648,
          "description": "string",
          "id": 0,
          "product_id": 0,
          "image_file": "string",
          "url_zoom": "string",
          "url_standard": "string",
          "url_thumbnail": "string",
          "url_tiny": "string",
          "date_modified": "2017-08-10T19:38:09Z"
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [ProductImage] false The full ProductImage model.
    is_thumbnail boolean false Flag for identifying whether the image is used as the product's thumbnail.
    sort_order integer false The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a sort_order the same as or greater than the image's new sort_order value will have their sort_orders reordered.
    description string false The description for the image.
    id integer false The unique numeric ID of the image; increments sequentially.
    product_id integer false The unique numeric identifier for the product with which the image is associated.
    image_file string false The local path to the original image file uploaded to BigCommerce.
    url_zoom string false The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
    url_standard string false The standard URL for this image. By default, this is used for product-page images.
    url_thumbnail string false The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
    url_tiny string false The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
    date_modified string(date-time) false The date on which the product image was modified.

    ProductImageResponse

    {
      "data": {
        "is_thumbnail": true,
        "sort_order": -2147483648,
        "description": "string",
        "id": 0,
        "product_id": 0,
        "image_file": "string",
        "url_zoom": "string",
        "url_standard": "string",
        "url_thumbnail": "string",
        "url_tiny": "string",
        "date_modified": "2017-08-10T19:38:09Z"
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [ProductImage] false The full ProductImage model.
    is_thumbnail boolean false Flag for identifying whether the image is used as the product's thumbnail.
    sort_order integer false The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a sort_order the same as or greater than the image's new sort_order value will have their sort_orders reordered.
    description string false The description for the image.
    id integer false The unique numeric ID of the image; increments sequentially.
    product_id integer false The unique numeric identifier for the product with which the image is associated.
    image_file string false The local path to the original image file uploaded to BigCommerce.
    url_zoom string false The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
    url_standard string false The standard URL for this image. By default, this is used for product-page images.
    url_thumbnail string false The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
    url_tiny string false The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
    date_modified string(date-time) false The date on which the product image was modified.
    meta Meta false Empty meta object; may be used later.

    ProductImageBase

    {
      "is_thumbnail": true,
      "sort_order": -2147483648,
      "description": "string"
    } 
    

    Properties

    Name Type Required Description
    is_thumbnail boolean false Flag for identifying whether the image is used as the product's thumbnail.
    sort_order integer false The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a sort_order the same as or greater than the image's new sort_order value will have their sort_orders reordered.
    description string false The description for the image.

    ProductImage

    {
      "is_thumbnail": true,
      "sort_order": -2147483648,
      "description": "string",
      "id": 0,
      "product_id": 0,
      "image_file": "string",
      "url_zoom": "string",
      "url_standard": "string",
      "url_thumbnail": "string",
      "url_tiny": "string",
      "date_modified": "2017-08-10T19:38:09Z"
    } 
    

    Properties

    Name Type Required Description
    is_thumbnail boolean false Flag for identifying whether the image is used as the product's thumbnail.
    sort_order integer false The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a sort_order the same as or greater than the image's new sort_order value will have their sort_orders reordered.
    description string false The description for the image.
    id integer false The unique numeric ID of the image; increments sequentially.
    product_id integer false The unique numeric identifier for the product with which the image is associated.
    image_file string false The local path to the original image file uploaded to BigCommerce.
    url_zoom string false The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
    url_standard string false The standard URL for this image. By default, this is used for product-page images.
    url_thumbnail string false The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
    url_tiny string false The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
    date_modified string(date-time) false The date on which the product image was modified.

    ProductImagePost

    {
      "is_thumbnail": true,
      "sort_order": -2147483648,
      "description": "string",
      "image_url": "string",
      "image_file": "string"
    } 
    

    Properties

    Name Type Required Description
    is_thumbnail boolean false Flag for identifying whether the image is used as the product's thumbnail.
    sort_order integer false The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a sort_order the same as or greater than the image's new sort_order value will have their sort_orders reordered.
    description string false The description for the image.
    image_url string false Must be a fully qualified URL path, including protocol.
    image_file string false Must be sent as a multipart/form-data field in the request body.

    ProductImagePut

    {
      "is_thumbnail": true,
      "sort_order": -2147483648,
      "description": "string"
    } 
    

    Properties

    Name Type Required Description
    is_thumbnail boolean false Flag for identifying whether the image is used as the product's thumbnail.
    sort_order integer false The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a sort_order the same as or greater than the image's new sort_order value will have their sort_orders reordered.
    description string false The description for the image.

    ProductVideoCollectionResponse

    {
      "data": [
        {
          "title": "string",
          "description": "string",
          "sort_order": -2147483648,
          "type": "youtube",
          "id": 0,
          "video_id": "string",
          "product_id": 0,
          "length": "string"
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [ProductVideo] false A product video model.
    title string false The title for the video. If left blank, this will be filled in according to data on a host site.
    description string false The description for the video. If left blank, this will be filled in according to data on a host site.
    sort_order integer false The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a sort_order the same as or greater than the video's new sort_order value will have their sort_orders reordered.
    type string false The video type (a short name of a host site).
    id integer false The unique numeric ID of the product video; increments sequentially.
    video_id string false The ID of the video on a host site.
    product_id integer false The unique numeric identifier for the product with which the image is associated.
    length string false Length of the video. This will be filled in according to data on a host site.

    Enumerated Values

    Property Value
    type youtube

    ProductVideoResponse

    {
      "data": {
        "title": "string",
        "description": "string",
        "sort_order": -2147483648,
        "type": "youtube",
        "id": 0,
        "video_id": "string",
        "product_id": 0,
        "length": "string"
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [ProductVideo] false A product video model.
    title string false The title for the video. If left blank, this will be filled in according to data on a host site.
    description string false The description for the video. If left blank, this will be filled in according to data on a host site.
    sort_order integer false The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a sort_order the same as or greater than the video's new sort_order value will have their sort_orders reordered.
    type string false The video type (a short name of a host site).
    id integer false The unique numeric ID of the product video; increments sequentially.
    video_id string false The ID of the video on a host site.
    product_id integer false The unique numeric identifier for the product with which the image is associated.
    length string false Length of the video. This will be filled in according to data on a host site.
    meta Meta false Empty meta object; may be used later.

    Enumerated Values

    Property Value
    type youtube

    ProductVideoBase

    {
      "title": "string",
      "description": "string",
      "sort_order": -2147483648,
      "type": "youtube"
    } 
    

    Properties

    Name Type Required Description
    title string false The title for the video. If left blank, this will be filled in according to data on a host site.
    description string false The description for the video. If left blank, this will be filled in according to data on a host site.
    sort_order integer false The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a sort_order the same as or greater than the video's new sort_order value will have their sort_orders reordered.
    type string false The video type (a short name of a host site).

    Enumerated Values

    Property Value
    type youtube

    ProductVideo

    {
      "title": "string",
      "description": "string",
      "sort_order": -2147483648,
      "type": "youtube",
      "id": 0,
      "video_id": "string",
      "product_id": 0,
      "length": "string"
    } 
    

    Properties

    Name Type Required Description
    title string false The title for the video. If left blank, this will be filled in according to data on a host site.
    description string false The description for the video. If left blank, this will be filled in according to data on a host site.
    sort_order integer false The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a sort_order the same as or greater than the video's new sort_order value will have their sort_orders reordered.
    type string false The video type (a short name of a host site).
    id integer false The unique numeric ID of the product video; increments sequentially.
    video_id string false The ID of the video on a host site.
    product_id integer false The unique numeric identifier for the product with which the image is associated.
    length string false Length of the video. This will be filled in according to data on a host site.

    Enumerated Values

    Property Value
    type youtube

    ProductVideoPost

    {
      "title": "string",
      "description": "string",
      "sort_order": -2147483648,
      "type": "youtube",
      "video_id": "string"
    } 
    

    Properties

    Name Type Required Description
    title string false The title for the video. If left blank, this will be filled in according to data on a host site.
    description string false The description for the video. If left blank, this will be filled in according to data on a host site.
    sort_order integer false The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a sort_order the same as or greater than the video's new sort_order value will have their sort_orders reordered.
    type string false The video type (a short name of a host site).
    video_id string false The ID of the video on a host site.

    Enumerated Values

    Property Value
    type youtube

    ProductVideoPut

    {
      "title": "string",
      "description": "string",
      "sort_order": -2147483648,
      "type": "youtube",
      "id": 0
    } 
    

    Properties

    Name Type Required Description
    title string false The title for the video. If left blank, this will be filled in according to data on a host site.
    description string false The description for the video. If left blank, this will be filled in according to data on a host site.
    sort_order integer false The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a sort_order the same as or greater than the video's new sort_order value will have their sort_orders reordered.
    type string false The video type (a short name of a host site).
    id integer false The unique numeric ID of the product video; increments sequentially.

    Enumerated Values

    Property Value
    type youtube

    ProductReviewCollectionResponse

    {
      "data": [
        {
          "title": "string",
          "text": "string",
          "status": "string",
          "rating": 0,
          "email": "string",
          "name": "string",
          "date_reviewed": "2017-08-10T19:38:09Z",
          "id": 0,
          "product_id": 0,
          "date_created": "2017-08-10T19:38:09Z",
          "date_modified": "2017-08-10T19:38:09Z"
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [ProductReview] false A product review model.
    title string false The title for the product review.
    text string false The text for the product review.
    status string false The status of the product review. Must be one of approved, disapproved or pending.
    rating integer false The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5.
    email string false The email of the reviewer. Must be a valid email, or an empty string.
    name string false The name of the reviewer.
    date_reviewed string(date-time) false Date the product was reviewed.
    id integer false The unique numeric ID of the product review; increments sequentially.
    product_id integer false The unique numeric identifier for the product with which the review is associated.
    date_created string(date-time) false Date the product review was created.
    date_modified string(date-time) false Date the product review was modified.

    ProductReviewResponse

    {
      "data": {
        "title": "string",
        "text": "string",
        "status": "string",
        "rating": 0,
        "email": "string",
        "name": "string",
        "date_reviewed": "2017-08-10T19:38:09Z",
        "id": 0,
        "product_id": 0,
        "date_created": "2017-08-10T19:38:09Z",
        "date_modified": "2017-08-10T19:38:09Z"
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [ProductReview] false A product review model.
    title string false The title for the product review.
    text string false The text for the product review.
    status string false The status of the product review. Must be one of approved, disapproved or pending.
    rating integer false The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5.
    email string false The email of the reviewer. Must be a valid email, or an empty string.
    name string false The name of the reviewer.
    date_reviewed string(date-time) false Date the product was reviewed.
    id integer false The unique numeric ID of the product review; increments sequentially.
    product_id integer false The unique numeric identifier for the product with which the review is associated.
    date_created string(date-time) false Date the product review was created.
    date_modified string(date-time) false Date the product review was modified.
    meta Meta false Empty meta object; may be used later.

    ProductReviewBase

    {
      "title": "string",
      "text": "string",
      "status": "string",
      "rating": 0,
      "email": "string",
      "name": "string",
      "date_reviewed": "2017-08-10T19:38:09Z"
    } 
    

    Properties

    Name Type Required Description
    title string false The title for the product review.
    text string false The text for the product review.
    status string false The status of the product review. Must be one of approved, disapproved or pending.
    rating integer false The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5.
    email string false The email of the reviewer. Must be a valid email, or an empty string.
    name string false The name of the reviewer.
    date_reviewed string(date-time) false Date the product was reviewed.

    ProductReview

    {
      "title": "string",
      "text": "string",
      "status": "string",
      "rating": 0,
      "email": "string",
      "name": "string",
      "date_reviewed": "2017-08-10T19:38:09Z",
      "id": 0,
      "product_id": 0,
      "date_created": "2017-08-10T19:38:09Z",
      "date_modified": "2017-08-10T19:38:09Z"
    } 
    

    Properties

    Name Type Required Description
    title string false The title for the product review.
    text string false The text for the product review.
    status string false The status of the product review. Must be one of approved, disapproved or pending.
    rating integer false The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5.
    email string false The email of the reviewer. Must be a valid email, or an empty string.
    name string false The name of the reviewer.
    date_reviewed string(date-time) false Date the product was reviewed.
    id integer false The unique numeric ID of the product review; increments sequentially.
    product_id integer false The unique numeric identifier for the product with which the review is associated.
    date_created string(date-time) false Date the product review was created.
    date_modified string(date-time) false Date the product review was modified.

    ProductReviewPost

    {
      "title": "string",
      "text": "string",
      "status": "string",
      "rating": 0,
      "email": "string",
      "name": "string",
      "date_reviewed": "2017-08-10T19:38:09Z"
    } 
    

    Properties

    Name Type Required Description
    title string false The title for the product review.
    text string false The text for the product review.
    status string false The status of the product review. Must be one of approved, disapproved or pending.
    rating integer false The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5.
    email string false The email of the reviewer. Must be a valid email, or an empty string.
    name string false The name of the reviewer.
    date_reviewed string(date-time) false Date the product was reviewed.

    ProductReviewPut

    {
      "title": "string",
      "text": "string",
      "status": "string",
      "rating": 0,
      "email": "string",
      "name": "string",
      "date_reviewed": "2017-08-10T19:38:09Z"
    } 
    

    Properties

    Name Type Required Description
    title string false The title for the product review.
    text string false The text for the product review.
    status string false The status of the product review. Must be one of approved, disapproved or pending.
    rating integer false The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5.
    email string false The email of the reviewer. Must be a valid email, or an empty string.
    name string false The name of the reviewer.
    date_reviewed string(date-time) false Date the product was reviewed.

    ImageResponse

    {
      "data": {
        "image_url": "string"
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data ResourceImage false An object containing a publicly accessible image URL, or a form post that contains an image file.
    image_url string false A public URL for a GIF, JPEG, or PNG image.
    meta Meta false Empty meta object; may be used later.

    ResourceImage

    {
      "image_url": "string"
    } 
    

    Properties

    Name Type Required Description
    image_url string false A public URL for a GIF, JPEG, or PNG image.

    ProductCollectionResponse

    {
      "data": [
        {
          "name": "string",
          "type": "physical",
          "sku": "string",
          "description": "string",
          "weight": 0,
          "width": 0,
          "depth": 0,
          "height": 0,
          "price": 0,
          "cost_price": 0,
          "retail_price": 0,
          "sale_price": 0,
          "tax_class_id": 0,
          "product_tax_code": "string",
          "categories": [
            0
          ],
          "brand_id": 0,
          "inventory_level": 0,
          "inventory_warning_level": 0,
          "inventory_tracking": "none",
          "fixed_cost_shipping_price": 0,
          "is_free_shipping": true,
          "is_visible": true,
          "is_featured": true,
          "related_products": [
            0
          ],
          "warranty": "string",
          "bin_picking_number": "string",
          "layout_file": "string",
          "upc": "string",
          "search_keywords": "string",
          "availability": "available",
          "availability_description": "string",
          "gift_wrapping_options_type": "any",
          "gift_wrapping_options_list": [
            0
          ],
          "sort_order": -2147483648,
          "condition": "New",
          "is_condition_shown": true,
          "order_quantity_minimum": 0,
          "order_quantity_maximum": 0,
          "page_title": "string",
          "meta_keywords": [
            "string"
          ],
          "meta_description": "string",
          "view_count": 0,
          "preorder_release_date": "2017-08-10T19:38:09Z",
          "preorder_message": "string",
          "is_preorder_only": true,
          "is_price_hidden": true,
          "price_hidden_label": "string",
          "custom_url": {
            "url": "string",
            "is_customized": true
          },
          "id": 0,
          "calculated_price": 0,
          "reviews_rating_sum": 0,
          "reviews_count": 0,
          "custom_fields": [
            {
              "name": "string",
              "value": "string",
              "id": 1
            }
          ],
          "bulk_pricing_rules": [
            {
              "quantity_min": 0,
              "quantity_max": 0,
              "type": "price",
              "amount": 0,
              "id": 1
            }
          ],
          "date_created": "2017-08-10T19:38:09Z",
          "date_modified": "2017-08-10T19:38:09Z",
          "images": [
            {
              "is_thumbnail": true,
              "sort_order": -2147483648,
              "description": "string",
              "id": 0,
              "product_id": 0,
              "image_file": "string",
              "url_zoom": "string",
              "url_standard": "string",
              "url_thumbnail": "string",
              "url_tiny": "string",
              "date_modified": "2017-08-10T19:38:09Z"
            }
          ],
          "videos": [
            {
              "title": "string",
              "description": "string",
              "sort_order": -2147483648,
              "type": "youtube",
              "id": 0,
              "video_id": "string",
              "product_id": 0,
              "length": "string"
            }
          ],
          "variants": [
            {
              "cost_price": 0,
              "price": 0,
              "sale_price": 0,
              "retail_price": 0,
              "weight": 0,
              "width": 0,
              "height": 0,
              "depth": 0,
              "is_free_shipping": true,
              "fixed_cost_shipping_price": 0,
              "purchasing_disabled": true,
              "purchasing_disabled_message": "string",
              "image_url": "string",
              "upc": "string",
              "inventory_level": 0,
              "inventory_warning_level": 0,
              "bin_picking_number": "string",
              "id": 0,
              "product_id": 0,
              "sku": "string",
              "sku_id": 0,
              "option_values": [
                {
                  "option_display_name": "string",
                  "label": "string",
                  "id": 0,
                  "option_id": 0
                }
              ]
            }
          ],
          "base_variant_id": 0
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [Product] false A BigCommerce Product object describes a single purchasable unit or a collection of purchasable units.
    name string false The product name.
    type string false The product type. One of: physical - a physical stock unit, digital - a digital download.
    sku string false User defined product code/stock keeping unit (SKU).
    description string false The product description, which can include HTML formatting.
    weight number(double) false Weight of the product, which can be used when calculating shipping costs.
    width number(double) false Width of the product, which can be used when calculating shipping costs.
    depth number(double) false Depth of the product, which can be used when calculating shipping costs.
    height number(double) false Height of the product, which can be used when calculating shipping costs.
    price number(double) false The price of the product. The price should include or exclude tax, based on the store settings.
    cost_price number(double) false The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store.
    retail_price number(double) false The retail cost of the product. If entered, the retail cost price will be shown on the product page.
    sale_price number(double) false If entered, the sale price will be used instead of value in the price field when calculating the product's cost.
    tax_class_id integer false The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)
    product_tax_code string false Accepts AvaTax System Tax Codes, which identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to BigCommerce's Avalara Premium integration can calculate sales taxes more accurately. Stores without Avalara Premium will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see Avalara's documentation.
    brand_id integer false The ID associated with the product's brand.
    inventory_level integer false Current inventory level of the product. Simple inventory tracking must be enabled (See the inventory_tracking field) for this to take any effect.
    inventory_warning_level integer false Inventory warning level for the product. When the product's inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the inventory_tracking field) for this to take any effect.
    inventory_tracking string false The type of inventory tracking for the product. Values are: none - inventory levels will not be tracked; product - inventory levels will be tracked using the inventory_level and inventory_warning_level fields; variant - inventory levels will be tracked based on variants, which maintain their own warning levels and inventory levels.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    is_free_shipping boolean false Flag used to indicate whether the product has free shipping. If true, the shipping cost for the product will be zero.
    is_visible boolean false Flag to determine whether the product should be displayed to customers browsing the store. If true, the product will be displayed. If false, the product will be hidden from view.
    is_featured boolean false Flag to determine whether the product should be included in the featured products panel when viewing the store.
    warranty string false Warranty information displayed on the product page. Can include HTML formatting.
    bin_picking_number string false The BIN picking number for the product.
    layout_file string false The layout template file used to render this product.
    upc string false The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations.
    search_keywords string false A comma-separated list of keywords that can be used to locate the product when searching the store.
    availability string false Availability of the product. Availability options are: available - the product can be purchased on the storefront; disabled - the product is listed in the storefront, but cannot be purchased; preorder - the product is listed for pre-orders.
    availability_description string false Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.'
    gift_wrapping_options_type string false Type of gift-wrapping options. Values: any - allow any gift-wrapping options in the store; none - disallow gift-wrapping on the product; list – provide a list of IDs in the gift_wrapping_options_list field.
    sort_order integer false Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results.
    condition string false The product condition. Will be shown on the product page if the is_condition_shown field's value is true. Possible values: New, Used, Refurbished.
    is_condition_shown boolean false Flag used to determine whether the product condition is shown to the customer on the product page.
    order_quantity_minimum integer false The minimum quantity an order must contain, to be eligible to purchase this product.
    order_quantity_maximum integer false The maximum quantity an order can contain when purchasing the product.
    page_title string false Custom title for the product page. If not defined, the product name will be used as the meta title.
    meta_description string false Custom meta description for the product page. If not defined, the store's default meta description will be used.
    view_count integer false The number of times the product has been viewed.
    preorder_release_date string(date-time) false Pre-order release date. See the availability field for details on setting a product's availability to accept pre-orders.
    preorder_message string false Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the %%DATE%% placeholder, which will be substituted for the release date.
    is_preorder_only boolean false If set to false, the product will not change its availability from preorder to available on the release date. Otherwise, on the release date the product's availability/status will change to available.
    is_price_hidden boolean false False by default, indicating that this product's price should be shown on the product page. If set to true, the price is hidden. (NOTE: To successfully set is_price_hidden to true, the availability value must be disabled.)
    price_hidden_label string false By default, an empty string. If is_price_hidden is true, the value of price_hidden_label is displayed instead of the price. (NOTE: To successfully set a non-empty string value with is_price_hidden set to true, the availability value must be disabled.)
    custom_url CustomUrlProduct false The custom URL for the product on the storefront.
    url string false Product URL on the storefront.
    is_customized boolean false Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).
    id integer false The unique numeric ID of the product; increments sequentially.
    calculated_price number(double) false The price of the product, unless a sale_price is set.
    reviews_rating_sum integer false The total rating for the product.
    reviews_count integer false The number of times the product has been rated.
    date_created string(date-time) false The date on which the product was created.
    date_modified string(date-time) false The date on which the product was modified.
    base_variant_id integer false The unique identifier of the base variant associated with a simple product. This value is null for complex products.
    categories [integer] false No description
    related_products [integer] false No description
    gift_wrapping_options_list [integer] false No description
    meta_keywords [string] false No description
    custom_fields [CustomField] false Gets custom fields associated with a product. These allow you to specify additional information that will appear on the product's page, such as a book's ISBN or a DVD's release date.
    name string false The name of the field, shown on the storefront, orders, etc.
    value string false The name of the field, shown on the storefront, orders, etc.
    id integer false The unique numeric ID of the custom field; increments sequentially.
    bulk_pricing_rules [BulkPricingRule] false Rules that offer price discounts based on quantity breaks.
    quantity_min integer false The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero.
    quantity_max integer false The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the quantity_min value – unless this field has a value of 0 (zero), in which case there will be no maximum bound for this rule.
    type string false The type of adjustment that is made. Values: price - the adjustment amount per product; percent - the adjustment as a percentage of the original price; fixed - the adjusted absolute price of the product.
    amount number(double) false The value of the adjustment by the bulk pricing rule.
    id integer false The ID of the bulk pricing rule.
    images [ProductImage] false The full ProductImage model.
    is_thumbnail boolean false Flag for identifying whether the image is used as the product's thumbnail.
    sort_order integer false The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a sort_order the same as or greater than the image's new sort_order value will have their sort_orders reordered.
    description string false The description for the image.
    id integer false The unique numeric ID of the image; increments sequentially.
    product_id integer false The unique numeric identifier for the product with which the image is associated.
    image_file string false The local path to the original image file uploaded to BigCommerce.
    url_zoom string false The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
    url_standard string false The standard URL for this image. By default, this is used for product-page images.
    url_thumbnail string false The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
    url_tiny string false The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
    date_modified string(date-time) false The date on which the product image was modified.
    videos [ProductVideo] false A product video model.
    title string false The title for the video. If left blank, this will be filled in according to data on a host site.
    description string false The description for the video. If left blank, this will be filled in according to data on a host site.
    sort_order integer false The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a sort_order the same as or greater than the video's new sort_order value will have their sort_orders reordered.
    type string false The video type (a short name of a host site).
    id integer false The unique numeric ID of the product video; increments sequentially.
    video_id string false The ID of the video on a host site.
    product_id integer false The unique numeric identifier for the product with which the image is associated.
    length string false Length of the video. This will be filled in according to data on a host site.
    variants [Variant] false Common Variant properties.
    cost_price number(double) false The cost price of the variant. Not affected by Price List prices.
    price number(double) false This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's default price (set in the Product resource's price field) will be used as the base price.
    sale_price number(double) false This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's price field) will be used as the sale price.
    retail_price number(double) false This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's price field) will be used as the retail price.
    weight number(double) false This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
    width number(double) false Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width.
    height number(double) false Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height.
    depth number(double) false Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth.
    is_free_shipping boolean false Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    purchasing_disabled boolean false If true, this variant will not be purchasable on the storefront.
    purchasing_disabled_message string false If purchasing_disabled is true, this message should show on the storefront when the variant is selected.
    image_url string false The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product.
    upc string false The UPC code used in feeds for shopping comparison sites and external channel integrations.
    inventory_level integer false Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.
    inventory_warning_level integer false When the variant hits this inventory level, it is considered low stock.
    bin_picking_number string false Identifies where in a warehouse the variant is located.
    id integer false No description
    product_id integer false No description
    sku string false No description
    sku_id integer false Read-only reference to v2 API's SKU ID. Null if it is a base variant.
    option_values [OptionValueVariant] false Common OptionValueProduct properties.
    option_display_name string false The name of the option.
    label string false The label of the option value.
    id integer false No description
    option_id integer false No description

    Enumerated Values

    Property Value
    type physical
    type digital
    inventory_tracking none
    inventory_tracking product
    inventory_tracking variant
    availability available
    availability disabled
    availability preorder
    gift_wrapping_options_type any
    gift_wrapping_options_type none
    gift_wrapping_options_type list
    condition New
    condition Used
    condition Refurbished
    type price
    type percent
    type fixed
    type youtube

    ProductResponse

    {
      "data": {
        "name": "string",
        "type": "physical",
        "sku": "string",
        "description": "string",
        "weight": 0,
        "width": 0,
        "depth": 0,
        "height": 0,
        "price": 0,
        "cost_price": 0,
        "retail_price": 0,
        "sale_price": 0,
        "tax_class_id": 0,
        "product_tax_code": "string",
        "categories": [
          0
        ],
        "brand_id": 0,
        "inventory_level": 0,
        "inventory_warning_level": 0,
        "inventory_tracking": "none",
        "fixed_cost_shipping_price": 0,
        "is_free_shipping": true,
        "is_visible": true,
        "is_featured": true,
        "related_products": [
          0
        ],
        "warranty": "string",
        "bin_picking_number": "string",
        "layout_file": "string",
        "upc": "string",
        "search_keywords": "string",
        "availability": "available",
        "availability_description": "string",
        "gift_wrapping_options_type": "any",
        "gift_wrapping_options_list": [
          0
        ],
        "sort_order": -2147483648,
        "condition": "New",
        "is_condition_shown": true,
        "order_quantity_minimum": 0,
        "order_quantity_maximum": 0,
        "page_title": "string",
        "meta_keywords": [
          "string"
        ],
        "meta_description": "string",
        "view_count": 0,
        "preorder_release_date": "2017-08-10T19:38:09Z",
        "preorder_message": "string",
        "is_preorder_only": true,
        "is_price_hidden": true,
        "price_hidden_label": "string",
        "custom_url": {
          "url": "string",
          "is_customized": true
        },
        "id": 0,
        "calculated_price": 0,
        "reviews_rating_sum": 0,
        "reviews_count": 0,
        "custom_fields": [
          {
            "name": "string",
            "value": "string",
            "id": 1
          }
        ],
        "bulk_pricing_rules": [
          {
            "quantity_min": 0,
            "quantity_max": 0,
            "type": "price",
            "amount": 0,
            "id": 1
          }
        ],
        "date_created": "2017-08-10T19:38:09Z",
        "date_modified": "2017-08-10T19:38:09Z",
        "images": [
          {
            "is_thumbnail": true,
            "sort_order": -2147483648,
            "description": "string",
            "id": 0,
            "product_id": 0,
            "image_file": "string",
            "url_zoom": "string",
            "url_standard": "string",
            "url_thumbnail": "string",
            "url_tiny": "string",
            "date_modified": "2017-08-10T19:38:09Z"
          }
        ],
        "videos": [
          {
            "title": "string",
            "description": "string",
            "sort_order": -2147483648,
            "type": "youtube",
            "id": 0,
            "video_id": "string",
            "product_id": 0,
            "length": "string"
          }
        ],
        "variants": [
          {
            "cost_price": 0,
            "price": 0,
            "sale_price": 0,
            "retail_price": 0,
            "weight": 0,
            "width": 0,
            "height": 0,
            "depth": 0,
            "is_free_shipping": true,
            "fixed_cost_shipping_price": 0,
            "purchasing_disabled": true,
            "purchasing_disabled_message": "string",
            "image_url": "string",
            "upc": "string",
            "inventory_level": 0,
            "inventory_warning_level": 0,
            "bin_picking_number": "string",
            "id": 0,
            "product_id": 0,
            "sku": "string",
            "sku_id": 0,
            "option_values": [
              {
                "option_display_name": "string",
                "label": "string",
                "id": 0,
                "option_id": 0
              }
            ]
          }
        ],
        "base_variant_id": 0
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [Product] false A BigCommerce Product object describes a single purchasable unit or a collection of purchasable units.
    name string false The product name.
    type string false The product type. One of: physical - a physical stock unit, digital - a digital download.
    sku string false User defined product code/stock keeping unit (SKU).
    description string false The product description, which can include HTML formatting.
    weight number(double) false Weight of the product, which can be used when calculating shipping costs.
    width number(double) false Width of the product, which can be used when calculating shipping costs.
    depth number(double) false Depth of the product, which can be used when calculating shipping costs.
    height number(double) false Height of the product, which can be used when calculating shipping costs.
    price number(double) false The price of the product. The price should include or exclude tax, based on the store settings.
    cost_price number(double) false The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store.
    retail_price number(double) false The retail cost of the product. If entered, the retail cost price will be shown on the product page.
    sale_price number(double) false If entered, the sale price will be used instead of value in the price field when calculating the product's cost.
    tax_class_id integer false The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)
    product_tax_code string false Accepts AvaTax System Tax Codes, which identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to BigCommerce's Avalara Premium integration can calculate sales taxes more accurately. Stores without Avalara Premium will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see Avalara's documentation.
    brand_id integer false The ID associated with the product's brand.
    inventory_level integer false Current inventory level of the product. Simple inventory tracking must be enabled (See the inventory_tracking field) for this to take any effect.
    inventory_warning_level integer false Inventory warning level for the product. When the product's inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the inventory_tracking field) for this to take any effect.
    inventory_tracking string false The type of inventory tracking for the product. Values are: none - inventory levels will not be tracked; product - inventory levels will be tracked using the inventory_level and inventory_warning_level fields; variant - inventory levels will be tracked based on variants, which maintain their own warning levels and inventory levels.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    is_free_shipping boolean false Flag used to indicate whether the product has free shipping. If true, the shipping cost for the product will be zero.
    is_visible boolean false Flag to determine whether the product should be displayed to customers browsing the store. If true, the product will be displayed. If false, the product will be hidden from view.
    is_featured boolean false Flag to determine whether the product should be included in the featured products panel when viewing the store.
    warranty string false Warranty information displayed on the product page. Can include HTML formatting.
    bin_picking_number string false The BIN picking number for the product.
    layout_file string false The layout template file used to render this product.
    upc string false The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations.
    search_keywords string false A comma-separated list of keywords that can be used to locate the product when searching the store.
    availability string false Availability of the product. Availability options are: available - the product can be purchased on the storefront; disabled - the product is listed in the storefront, but cannot be purchased; preorder - the product is listed for pre-orders.
    availability_description string false Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.'
    gift_wrapping_options_type string false Type of gift-wrapping options. Values: any - allow any gift-wrapping options in the store; none - disallow gift-wrapping on the product; list – provide a list of IDs in the gift_wrapping_options_list field.
    sort_order integer false Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results.
    condition string false The product condition. Will be shown on the product page if the is_condition_shown field's value is true. Possible values: New, Used, Refurbished.
    is_condition_shown boolean false Flag used to determine whether the product condition is shown to the customer on the product page.
    order_quantity_minimum integer false The minimum quantity an order must contain, to be eligible to purchase this product.
    order_quantity_maximum integer false The maximum quantity an order can contain when purchasing the product.
    page_title string false Custom title for the product page. If not defined, the product name will be used as the meta title.
    meta_description string false Custom meta description for the product page. If not defined, the store's default meta description will be used.
    view_count integer false The number of times the product has been viewed.
    preorder_release_date string(date-time) false Pre-order release date. See the availability field for details on setting a product's availability to accept pre-orders.
    preorder_message string false Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the %%DATE%% placeholder, which will be substituted for the release date.
    is_preorder_only boolean false If set to false, the product will not change its availability from preorder to available on the release date. Otherwise, on the release date the product's availability/status will change to available.
    is_price_hidden boolean false False by default, indicating that this product's price should be shown on the product page. If set to true, the price is hidden. (NOTE: To successfully set is_price_hidden to true, the availability value must be disabled.)
    price_hidden_label string false By default, an empty string. If is_price_hidden is true, the value of price_hidden_label is displayed instead of the price. (NOTE: To successfully set a non-empty string value with is_price_hidden set to true, the availability value must be disabled.)
    custom_url CustomUrlProduct false The custom URL for the product on the storefront.
    url string false Product URL on the storefront.
    is_customized boolean false Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).
    id integer false The unique numeric ID of the product; increments sequentially.
    calculated_price number(double) false The price of the product, unless a sale_price is set.
    reviews_rating_sum integer false The total rating for the product.
    reviews_count integer false The number of times the product has been rated.
    date_created string(date-time) false The date on which the product was created.
    date_modified string(date-time) false The date on which the product was modified.
    base_variant_id integer false The unique identifier of the base variant associated with a simple product. This value is null for complex products.
    categories [integer] false No description
    related_products [integer] false No description
    gift_wrapping_options_list [integer] false No description
    meta_keywords [string] false No description
    custom_fields [CustomField] false Gets custom fields associated with a product. These allow you to specify additional information that will appear on the product's page, such as a book's ISBN or a DVD's release date.
    name string false The name of the field, shown on the storefront, orders, etc.
    value string false The name of the field, shown on the storefront, orders, etc.
    id integer false The unique numeric ID of the custom field; increments sequentially.
    bulk_pricing_rules [BulkPricingRule] false Rules that offer price discounts based on quantity breaks.
    quantity_min integer false The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero.
    quantity_max integer false The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the quantity_min value – unless this field has a value of 0 (zero), in which case there will be no maximum bound for this rule.
    type string false The type of adjustment that is made. Values: price - the adjustment amount per product; percent - the adjustment as a percentage of the original price; fixed - the adjusted absolute price of the product.
    amount number(double) false The value of the adjustment by the bulk pricing rule.
    id integer false The ID of the bulk pricing rule.
    images [ProductImage] false The full ProductImage model.
    is_thumbnail boolean false Flag for identifying whether the image is used as the product's thumbnail.
    sort_order integer false The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a sort_order the same as or greater than the image's new sort_order value will have their sort_orders reordered.
    description string false The description for the image.
    id integer false The unique numeric ID of the image; increments sequentially.
    product_id integer false The unique numeric identifier for the product with which the image is associated.
    image_file string false The local path to the original image file uploaded to BigCommerce.
    url_zoom string false The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
    url_standard string false The standard URL for this image. By default, this is used for product-page images.
    url_thumbnail string false The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
    url_tiny string false The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
    date_modified string(date-time) false The date on which the product image was modified.
    videos [ProductVideo] false A product video model.
    title string false The title for the video. If left blank, this will be filled in according to data on a host site.
    description string false The description for the video. If left blank, this will be filled in according to data on a host site.
    sort_order integer false The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a sort_order the same as or greater than the video's new sort_order value will have their sort_orders reordered.
    type string false The video type (a short name of a host site).
    id integer false The unique numeric ID of the product video; increments sequentially.
    video_id string false The ID of the video on a host site.
    product_id integer false The unique numeric identifier for the product with which the image is associated.
    length string false Length of the video. This will be filled in according to data on a host site.
    variants [Variant] false Common Variant properties.
    cost_price number(double) false The cost price of the variant. Not affected by Price List prices.
    price number(double) false This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's default price (set in the Product resource's price field) will be used as the base price.
    sale_price number(double) false This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's price field) will be used as the sale price.
    retail_price number(double) false This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's price field) will be used as the retail price.
    weight number(double) false This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
    width number(double) false Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width.
    height number(double) false Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height.
    depth number(double) false Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth.
    is_free_shipping boolean false Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    purchasing_disabled boolean false If true, this variant will not be purchasable on the storefront.
    purchasing_disabled_message string false If purchasing_disabled is true, this message should show on the storefront when the variant is selected.
    image_url string false The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product.
    upc string false The UPC code used in feeds for shopping comparison sites and external channel integrations.
    inventory_level integer false Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.
    inventory_warning_level integer false When the variant hits this inventory level, it is considered low stock.
    bin_picking_number string false Identifies where in a warehouse the variant is located.
    id integer false No description
    product_id integer false No description
    sku string false No description
    sku_id integer false Read-only reference to v2 API's SKU ID. Null if it is a base variant.
    option_values [OptionValueVariant] false Common OptionValueProduct properties.
    option_display_name string false The name of the option.
    label string false The label of the option value.
    id integer false No description
    option_id integer false No description
    meta Meta false Empty meta object; may be used later.

    Enumerated Values

    Property Value
    type physical
    type digital
    inventory_tracking none
    inventory_tracking product
    inventory_tracking variant
    availability available
    availability disabled
    availability preorder
    gift_wrapping_options_type any
    gift_wrapping_options_type none
    gift_wrapping_options_type list
    condition New
    condition Used
    condition Refurbished
    type price
    type percent
    type fixed
    type youtube

    ProductBase

    {
      "name": "string",
      "type": "physical",
      "sku": "string",
      "description": "string",
      "weight": 0,
      "width": 0,
      "depth": 0,
      "height": 0,
      "price": 0,
      "cost_price": 0,
      "retail_price": 0,
      "sale_price": 0,
      "tax_class_id": 0,
      "product_tax_code": "string",
      "categories": [
        0
      ],
      "brand_id": 0,
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "inventory_tracking": "none",
      "fixed_cost_shipping_price": 0,
      "is_free_shipping": true,
      "is_visible": true,
      "is_featured": true,
      "related_products": [
        0
      ],
      "warranty": "string",
      "bin_picking_number": "string",
      "layout_file": "string",
      "upc": "string",
      "search_keywords": "string",
      "availability": "available",
      "availability_description": "string",
      "gift_wrapping_options_type": "any",
      "gift_wrapping_options_list": [
        0
      ],
      "sort_order": -2147483648,
      "condition": "New",
      "is_condition_shown": true,
      "order_quantity_minimum": 0,
      "order_quantity_maximum": 0,
      "page_title": "string",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "view_count": 0,
      "preorder_release_date": "2017-08-10T19:38:09Z",
      "preorder_message": "string",
      "is_preorder_only": true,
      "is_price_hidden": true,
      "price_hidden_label": "string",
      "custom_url": {
        "url": "string",
        "is_customized": true
      }
    } 
    

    Properties

    Name Type Required Description
    name string false The product name.
    type string false The product type. One of: physical - a physical stock unit, digital - a digital download.
    sku string false User defined product code/stock keeping unit (SKU).
    description string false The product description, which can include HTML formatting.
    weight number(double) false Weight of the product, which can be used when calculating shipping costs.
    width number(double) false Width of the product, which can be used when calculating shipping costs.
    depth number(double) false Depth of the product, which can be used when calculating shipping costs.
    height number(double) false Height of the product, which can be used when calculating shipping costs.
    price number(double) false The price of the product. The price should include or exclude tax, based on the store settings.
    cost_price number(double) false The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store.
    retail_price number(double) false The retail cost of the product. If entered, the retail cost price will be shown on the product page.
    sale_price number(double) false If entered, the sale price will be used instead of value in the price field when calculating the product's cost.
    tax_class_id integer false The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)
    product_tax_code string false Accepts AvaTax System Tax Codes, which identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to BigCommerce's Avalara Premium integration can calculate sales taxes more accurately. Stores without Avalara Premium will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see Avalara's documentation.
    brand_id integer false The ID associated with the product's brand.
    inventory_level integer false Current inventory level of the product. Simple inventory tracking must be enabled (See the inventory_tracking field) for this to take any effect.
    inventory_warning_level integer false Inventory warning level for the product. When the product's inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the inventory_tracking field) for this to take any effect.
    inventory_tracking string false The type of inventory tracking for the product. Values are: none - inventory levels will not be tracked; product - inventory levels will be tracked using the inventory_level and inventory_warning_level fields; variant - inventory levels will be tracked based on variants, which maintain their own warning levels and inventory levels.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    is_free_shipping boolean false Flag used to indicate whether the product has free shipping. If true, the shipping cost for the product will be zero.
    is_visible boolean false Flag to determine whether the product should be displayed to customers browsing the store. If true, the product will be displayed. If false, the product will be hidden from view.
    is_featured boolean false Flag to determine whether the product should be included in the featured products panel when viewing the store.
    warranty string false Warranty information displayed on the product page. Can include HTML formatting.
    bin_picking_number string false The BIN picking number for the product.
    layout_file string false The layout template file used to render this product.
    upc string false The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations.
    search_keywords string false A comma-separated list of keywords that can be used to locate the product when searching the store.
    availability string false Availability of the product. Availability options are: available - the product can be purchased on the storefront; disabled - the product is listed in the storefront, but cannot be purchased; preorder - the product is listed for pre-orders.
    availability_description string false Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.'
    gift_wrapping_options_type string false Type of gift-wrapping options. Values: any - allow any gift-wrapping options in the store; none - disallow gift-wrapping on the product; list – provide a list of IDs in the gift_wrapping_options_list field.
    sort_order integer false Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results.
    condition string false The product condition. Will be shown on the product page if the is_condition_shown field's value is true. Possible values: New, Used, Refurbished.
    is_condition_shown boolean false Flag used to determine whether the product condition is shown to the customer on the product page.
    order_quantity_minimum integer false The minimum quantity an order must contain, to be eligible to purchase this product.
    order_quantity_maximum integer false The maximum quantity an order can contain when purchasing the product.
    page_title string false Custom title for the product page. If not defined, the product name will be used as the meta title.
    meta_description string false Custom meta description for the product page. If not defined, the store's default meta description will be used.
    view_count integer false The number of times the product has been viewed.
    preorder_release_date string(date-time) false Pre-order release date. See the availability field for details on setting a product's availability to accept pre-orders.
    preorder_message string false Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the %%DATE%% placeholder, which will be substituted for the release date.
    is_preorder_only boolean false If set to false, the product will not change its availability from preorder to available on the release date. Otherwise, on the release date the product's availability/status will change to available.
    is_price_hidden boolean false False by default, indicating that this product's price should be shown on the product page. If set to true, the price is hidden. (NOTE: To successfully set is_price_hidden to true, the availability value must be disabled.)
    price_hidden_label string false By default, an empty string. If is_price_hidden is true, the value of price_hidden_label is displayed instead of the price. (NOTE: To successfully set a non-empty string value with is_price_hidden set to true, the availability value must be disabled.)
    custom_url CustomUrlProduct false The custom URL for the product on the storefront.
    url string false Product URL on the storefront.
    is_customized boolean false Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).
    categories [integer] false No description
    related_products [integer] false No description
    gift_wrapping_options_list [integer] false No description
    meta_keywords [string] false No description

    Enumerated Values

    Property Value
    type physical
    type digital
    inventory_tracking none
    inventory_tracking product
    inventory_tracking variant
    availability available
    availability disabled
    availability preorder
    gift_wrapping_options_type any
    gift_wrapping_options_type none
    gift_wrapping_options_type list
    condition New
    condition Used
    condition Refurbished

    Product

    {
      "name": "string",
      "type": "physical",
      "sku": "string",
      "description": "string",
      "weight": 0,
      "width": 0,
      "depth": 0,
      "height": 0,
      "price": 0,
      "cost_price": 0,
      "retail_price": 0,
      "sale_price": 0,
      "tax_class_id": 0,
      "product_tax_code": "string",
      "categories": [
        0
      ],
      "brand_id": 0,
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "inventory_tracking": "none",
      "fixed_cost_shipping_price": 0,
      "is_free_shipping": true,
      "is_visible": true,
      "is_featured": true,
      "related_products": [
        0
      ],
      "warranty": "string",
      "bin_picking_number": "string",
      "layout_file": "string",
      "upc": "string",
      "search_keywords": "string",
      "availability": "available",
      "availability_description": "string",
      "gift_wrapping_options_type": "any",
      "gift_wrapping_options_list": [
        0
      ],
      "sort_order": -2147483648,
      "condition": "New",
      "is_condition_shown": true,
      "order_quantity_minimum": 0,
      "order_quantity_maximum": 0,
      "page_title": "string",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "view_count": 0,
      "preorder_release_date": "2017-08-10T19:38:09Z",
      "preorder_message": "string",
      "is_preorder_only": true,
      "is_price_hidden": true,
      "price_hidden_label": "string",
      "custom_url": {
        "url": "string",
        "is_customized": true
      },
      "id": 0,
      "calculated_price": 0,
      "reviews_rating_sum": 0,
      "reviews_count": 0,
      "custom_fields": [
        {
          "name": "string",
          "value": "string",
          "id": 1
        }
      ],
      "bulk_pricing_rules": [
        {
          "quantity_min": 0,
          "quantity_max": 0,
          "type": "price",
          "amount": 0,
          "id": 1
        }
      ],
      "date_created": "2017-08-10T19:38:09Z",
      "date_modified": "2017-08-10T19:38:09Z",
      "images": [
        {
          "is_thumbnail": true,
          "sort_order": -2147483648,
          "description": "string",
          "id": 0,
          "product_id": 0,
          "image_file": "string",
          "url_zoom": "string",
          "url_standard": "string",
          "url_thumbnail": "string",
          "url_tiny": "string",
          "date_modified": "2017-08-10T19:38:09Z"
        }
      ],
      "videos": [
        {
          "title": "string",
          "description": "string",
          "sort_order": -2147483648,
          "type": "youtube",
          "id": 0,
          "video_id": "string",
          "product_id": 0,
          "length": "string"
        }
      ],
      "variants": [
        {
          "cost_price": 0,
          "price": 0,
          "sale_price": 0,
          "retail_price": 0,
          "weight": 0,
          "width": 0,
          "height": 0,
          "depth": 0,
          "is_free_shipping": true,
          "fixed_cost_shipping_price": 0,
          "purchasing_disabled": true,
          "purchasing_disabled_message": "string",
          "image_url": "string",
          "upc": "string",
          "inventory_level": 0,
          "inventory_warning_level": 0,
          "bin_picking_number": "string",
          "id": 0,
          "product_id": 0,
          "sku": "string",
          "sku_id": 0,
          "option_values": [
            {
              "option_display_name": "string",
              "label": "string",
              "id": 0,
              "option_id": 0
            }
          ]
        }
      ],
      "base_variant_id": 0
    } 
    

    Properties

    Name Type Required Description
    name string false The product name.
    type string false The product type. One of: physical - a physical stock unit, digital - a digital download.
    sku string false User defined product code/stock keeping unit (SKU).
    description string false The product description, which can include HTML formatting.
    weight number(double) false Weight of the product, which can be used when calculating shipping costs.
    width number(double) false Width of the product, which can be used when calculating shipping costs.
    depth number(double) false Depth of the product, which can be used when calculating shipping costs.
    height number(double) false Height of the product, which can be used when calculating shipping costs.
    price number(double) false The price of the product. The price should include or exclude tax, based on the store settings.
    cost_price number(double) false The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store.
    retail_price number(double) false The retail cost of the product. If entered, the retail cost price will be shown on the product page.
    sale_price number(double) false If entered, the sale price will be used instead of value in the price field when calculating the product's cost.
    tax_class_id integer false The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)
    product_tax_code string false Accepts AvaTax System Tax Codes, which identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to BigCommerce's Avalara Premium integration can calculate sales taxes more accurately. Stores without Avalara Premium will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see Avalara's documentation.
    brand_id integer false The ID associated with the product's brand.
    inventory_level integer false Current inventory level of the product. Simple inventory tracking must be enabled (See the inventory_tracking field) for this to take any effect.
    inventory_warning_level integer false Inventory warning level for the product. When the product's inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the inventory_tracking field) for this to take any effect.
    inventory_tracking string false The type of inventory tracking for the product. Values are: none - inventory levels will not be tracked; product - inventory levels will be tracked using the inventory_level and inventory_warning_level fields; variant - inventory levels will be tracked based on variants, which maintain their own warning levels and inventory levels.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    is_free_shipping boolean false Flag used to indicate whether the product has free shipping. If true, the shipping cost for the product will be zero.
    is_visible boolean false Flag to determine whether the product should be displayed to customers browsing the store. If true, the product will be displayed. If false, the product will be hidden from view.
    is_featured boolean false Flag to determine whether the product should be included in the featured products panel when viewing the store.
    warranty string false Warranty information displayed on the product page. Can include HTML formatting.
    bin_picking_number string false The BIN picking number for the product.
    layout_file string false The layout template file used to render this product.
    upc string false The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations.
    search_keywords string false A comma-separated list of keywords that can be used to locate the product when searching the store.
    availability string false Availability of the product. Availability options are: available - the product can be purchased on the storefront; disabled - the product is listed in the storefront, but cannot be purchased; preorder - the product is listed for pre-orders.
    availability_description string false Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.'
    gift_wrapping_options_type string false Type of gift-wrapping options. Values: any - allow any gift-wrapping options in the store; none - disallow gift-wrapping on the product; list – provide a list of IDs in the gift_wrapping_options_list field.
    sort_order integer false Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results.
    condition string false The product condition. Will be shown on the product page if the is_condition_shown field's value is true. Possible values: New, Used, Refurbished.
    is_condition_shown boolean false Flag used to determine whether the product condition is shown to the customer on the product page.
    order_quantity_minimum integer false The minimum quantity an order must contain, to be eligible to purchase this product.
    order_quantity_maximum integer false The maximum quantity an order can contain when purchasing the product.
    page_title string false Custom title for the product page. If not defined, the product name will be used as the meta title.
    meta_description string false Custom meta description for the product page. If not defined, the store's default meta description will be used.
    view_count integer false The number of times the product has been viewed.
    preorder_release_date string(date-time) false Pre-order release date. See the availability field for details on setting a product's availability to accept pre-orders.
    preorder_message string false Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the %%DATE%% placeholder, which will be substituted for the release date.
    is_preorder_only boolean false If set to false, the product will not change its availability from preorder to available on the release date. Otherwise, on the release date the product's availability/status will change to available.
    is_price_hidden boolean false False by default, indicating that this product's price should be shown on the product page. If set to true, the price is hidden. (NOTE: To successfully set is_price_hidden to true, the availability value must be disabled.)
    price_hidden_label string false By default, an empty string. If is_price_hidden is true, the value of price_hidden_label is displayed instead of the price. (NOTE: To successfully set a non-empty string value with is_price_hidden set to true, the availability value must be disabled.)
    custom_url CustomUrlProduct false The custom URL for the product on the storefront.
    url string false Product URL on the storefront.
    is_customized boolean false Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).
    id integer false The unique numeric ID of the product; increments sequentially.
    calculated_price number(double) false The price of the product, unless a sale_price is set.
    reviews_rating_sum integer false The total rating for the product.
    reviews_count integer false The number of times the product has been rated.
    date_created string(date-time) false The date on which the product was created.
    date_modified string(date-time) false The date on which the product was modified.
    base_variant_id integer false The unique identifier of the base variant associated with a simple product. This value is null for complex products.
    categories [integer] false No description
    related_products [integer] false No description
    gift_wrapping_options_list [integer] false No description
    meta_keywords [string] false No description
    custom_fields [CustomField] false Gets custom fields associated with a product. These allow you to specify additional information that will appear on the product's page, such as a book's ISBN or a DVD's release date.
    name string false The name of the field, shown on the storefront, orders, etc.
    value string false The name of the field, shown on the storefront, orders, etc.
    id integer false The unique numeric ID of the custom field; increments sequentially.
    bulk_pricing_rules [BulkPricingRule] false Rules that offer price discounts based on quantity breaks.
    quantity_min integer false The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero.
    quantity_max integer false The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the quantity_min value – unless this field has a value of 0 (zero), in which case there will be no maximum bound for this rule.
    type string false The type of adjustment that is made. Values: price - the adjustment amount per product; percent - the adjustment as a percentage of the original price; fixed - the adjusted absolute price of the product.
    amount number(double) false The value of the adjustment by the bulk pricing rule.
    id integer false The ID of the bulk pricing rule.
    images [ProductImage] false The full ProductImage model.
    is_thumbnail boolean false Flag for identifying whether the image is used as the product's thumbnail.
    sort_order integer false The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a sort_order the same as or greater than the image's new sort_order value will have their sort_orders reordered.
    description string false The description for the image.
    id integer false The unique numeric ID of the image; increments sequentially.
    product_id integer false The unique numeric identifier for the product with which the image is associated.
    image_file string false The local path to the original image file uploaded to BigCommerce.
    url_zoom string false The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
    url_standard string false The standard URL for this image. By default, this is used for product-page images.
    url_thumbnail string false The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
    url_tiny string false The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
    date_modified string(date-time) false The date on which the product image was modified.
    videos [ProductVideo] false A product video model.
    title string false The title for the video. If left blank, this will be filled in according to data on a host site.
    description string false The description for the video. If left blank, this will be filled in according to data on a host site.
    sort_order integer false The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a sort_order the same as or greater than the video's new sort_order value will have their sort_orders reordered.
    type string false The video type (a short name of a host site).
    id integer false The unique numeric ID of the product video; increments sequentially.
    video_id string false The ID of the video on a host site.
    product_id integer false The unique numeric identifier for the product with which the image is associated.
    length string false Length of the video. This will be filled in according to data on a host site.
    variants [Variant] false Common Variant properties.
    cost_price number(double) false The cost price of the variant. Not affected by Price List prices.
    price number(double) false This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's default price (set in the Product resource's price field) will be used as the base price.
    sale_price number(double) false This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's price field) will be used as the sale price.
    retail_price number(double) false This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's price field) will be used as the retail price.
    weight number(double) false This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
    width number(double) false Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width.
    height number(double) false Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height.
    depth number(double) false Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth.
    is_free_shipping boolean false Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    purchasing_disabled boolean false If true, this variant will not be purchasable on the storefront.
    purchasing_disabled_message string false If purchasing_disabled is true, this message should show on the storefront when the variant is selected.
    image_url string false The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product.
    upc string false The UPC code used in feeds for shopping comparison sites and external channel integrations.
    inventory_level integer false Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.
    inventory_warning_level integer false When the variant hits this inventory level, it is considered low stock.
    bin_picking_number string false Identifies where in a warehouse the variant is located.
    id integer false No description
    product_id integer false No description
    sku string false No description
    sku_id integer false Read-only reference to v2 API's SKU ID. Null if it is a base variant.
    option_values [OptionValueVariant] false Common OptionValueProduct properties.
    option_display_name string false The name of the option.
    label string false The label of the option value.
    id integer false No description
    option_id integer false No description

    Enumerated Values

    Property Value
    type physical
    type digital
    inventory_tracking none
    inventory_tracking product
    inventory_tracking variant
    availability available
    availability disabled
    availability preorder
    gift_wrapping_options_type any
    gift_wrapping_options_type none
    gift_wrapping_options_type list
    condition New
    condition Used
    condition Refurbished
    type price
    type percent
    type fixed
    type youtube

    ProductPost

    {
      "name": "string",
      "type": "physical",
      "sku": "string",
      "description": "string",
      "weight": 0,
      "width": 0,
      "depth": 0,
      "height": 0,
      "price": 0,
      "cost_price": 0,
      "retail_price": 0,
      "sale_price": 0,
      "tax_class_id": 0,
      "product_tax_code": "string",
      "categories": [
        0
      ],
      "brand_id": 0,
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "inventory_tracking": "none",
      "fixed_cost_shipping_price": 0,
      "is_free_shipping": true,
      "is_visible": true,
      "is_featured": true,
      "related_products": [
        0
      ],
      "warranty": "string",
      "bin_picking_number": "string",
      "layout_file": "string",
      "upc": "string",
      "search_keywords": "string",
      "availability": "available",
      "availability_description": "string",
      "gift_wrapping_options_type": "any",
      "gift_wrapping_options_list": [
        0
      ],
      "sort_order": -2147483648,
      "condition": "New",
      "is_condition_shown": true,
      "order_quantity_minimum": 0,
      "order_quantity_maximum": 0,
      "page_title": "string",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "view_count": 0,
      "preorder_release_date": "2017-08-10T19:38:09Z",
      "preorder_message": "string",
      "is_preorder_only": true,
      "is_price_hidden": true,
      "price_hidden_label": "string",
      "custom_url": {
        "url": "string",
        "is_customized": true
      },
      "custom_fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "bulk_pricing_rules": [
        {
          "quantity_min": 0,
          "quantity_max": 0,
          "type": "price",
          "amount": 0
        }
      ],
      "variants": [
        {
          "cost_price": 0,
          "price": 0,
          "sale_price": 0,
          "retail_price": 0,
          "weight": 0,
          "width": 0,
          "height": 0,
          "depth": 0,
          "is_free_shipping": true,
          "fixed_cost_shipping_price": 0,
          "purchasing_disabled": true,
          "purchasing_disabled_message": "string",
          "image_url": "string",
          "upc": "string",
          "inventory_level": 0,
          "inventory_warning_level": 0,
          "bin_picking_number": "string",
          "product_id": 0,
          "sku": "string",
          "option_values": [
            {
              "option_display_name": "string",
              "label": "string"
            }
          ]
        }
      ]
    } 
    

    Properties

    Name Type Required Description
    name string false The product name.
    type string false The product type. One of: physical - a physical stock unit, digital - a digital download.
    sku string false User defined product code/stock keeping unit (SKU).
    description string false The product description, which can include HTML formatting.
    weight number(double) false Weight of the product, which can be used when calculating shipping costs.
    width number(double) false Width of the product, which can be used when calculating shipping costs.
    depth number(double) false Depth of the product, which can be used when calculating shipping costs.
    height number(double) false Height of the product, which can be used when calculating shipping costs.
    price number(double) false The price of the product. The price should include or exclude tax, based on the store settings.
    cost_price number(double) false The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store.
    retail_price number(double) false The retail cost of the product. If entered, the retail cost price will be shown on the product page.
    sale_price number(double) false If entered, the sale price will be used instead of value in the price field when calculating the product's cost.
    tax_class_id integer false The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)
    product_tax_code string false Accepts AvaTax System Tax Codes, which identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to BigCommerce's Avalara Premium integration can calculate sales taxes more accurately. Stores without Avalara Premium will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see Avalara's documentation.
    brand_id integer false The ID associated with the product's brand.
    inventory_level integer false Current inventory level of the product. Simple inventory tracking must be enabled (See the inventory_tracking field) for this to take any effect.
    inventory_warning_level integer false Inventory warning level for the product. When the product's inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the inventory_tracking field) for this to take any effect.
    inventory_tracking string false The type of inventory tracking for the product. Values are: none - inventory levels will not be tracked; product - inventory levels will be tracked using the inventory_level and inventory_warning_level fields; variant - inventory levels will be tracked based on variants, which maintain their own warning levels and inventory levels.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    is_free_shipping boolean false Flag used to indicate whether the product has free shipping. If true, the shipping cost for the product will be zero.
    is_visible boolean false Flag to determine whether the product should be displayed to customers browsing the store. If true, the product will be displayed. If false, the product will be hidden from view.
    is_featured boolean false Flag to determine whether the product should be included in the featured products panel when viewing the store.
    warranty string false Warranty information displayed on the product page. Can include HTML formatting.
    bin_picking_number string false The BIN picking number for the product.
    layout_file string false The layout template file used to render this product.
    upc string false The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations.
    search_keywords string false A comma-separated list of keywords that can be used to locate the product when searching the store.
    availability string false Availability of the product. Availability options are: available - the product can be purchased on the storefront; disabled - the product is listed in the storefront, but cannot be purchased; preorder - the product is listed for pre-orders.
    availability_description string false Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.'
    gift_wrapping_options_type string false Type of gift-wrapping options. Values: any - allow any gift-wrapping options in the store; none - disallow gift-wrapping on the product; list – provide a list of IDs in the gift_wrapping_options_list field.
    sort_order integer false Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results.
    condition string false The product condition. Will be shown on the product page if the is_condition_shown field's value is true. Possible values: New, Used, Refurbished.
    is_condition_shown boolean false Flag used to determine whether the product condition is shown to the customer on the product page.
    order_quantity_minimum integer false The minimum quantity an order must contain, to be eligible to purchase this product.
    order_quantity_maximum integer false The maximum quantity an order can contain when purchasing the product.
    page_title string false Custom title for the product page. If not defined, the product name will be used as the meta title.
    meta_description string false Custom meta description for the product page. If not defined, the store's default meta description will be used.
    view_count integer false The number of times the product has been viewed.
    preorder_release_date string(date-time) false Pre-order release date. See the availability field for details on setting a product's availability to accept pre-orders.
    preorder_message string false Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the %%DATE%% placeholder, which will be substituted for the release date.
    is_preorder_only boolean false If set to false, the product will not change its availability from preorder to available on the release date. Otherwise, on the release date the product's availability/status will change to available.
    is_price_hidden boolean false False by default, indicating that this product's price should be shown on the product page. If set to true, the price is hidden. (NOTE: To successfully set is_price_hidden to true, the availability value must be disabled.)
    price_hidden_label string false By default, an empty string. If is_price_hidden is true, the value of price_hidden_label is displayed instead of the price. (NOTE: To successfully set a non-empty string value with is_price_hidden set to true, the availability value must be disabled.)
    custom_url CustomUrlProduct false The custom URL for the product on the storefront.
    url string false Product URL on the storefront.
    is_customized boolean false Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).
    categories [integer] false No description
    related_products [integer] false No description
    gift_wrapping_options_list [integer] false No description
    meta_keywords [string] false No description
    custom_fields [CustomFieldPost] false The model for a POST to create a custom field on a product.
    name string false The name of the field, shown on the storefront, orders, etc.
    value string false The name of the field, shown on the storefront, orders, etc.
    bulk_pricing_rules [BulkPricingRulePost] false The model for a POST to create bulk pricing rules on a product.
    quantity_min integer false The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero.
    quantity_max integer false The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the quantity_min value – unless this field has a value of 0 (zero), in which case there will be no maximum bound for this rule.
    type string false The type of adjustment that is made. Values: price - the adjustment amount per product; percent - the adjustment as a percentage of the original price; fixed - the adjusted absolute price of the product.
    amount number(double) false The value of the adjustment by the bulk pricing rule.
    variants [VariantProductPost] false The model for a POST to create variants on a product.
    cost_price number(double) false The cost price of the variant. Not affected by Price List prices.
    price number(double) false This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's default price (set in the Product resource's price field) will be used as the base price.
    sale_price number(double) false This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's price field) will be used as the sale price.
    retail_price number(double) false This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's price field) will be used as the retail price.
    weight number(double) false This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
    width number(double) false Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width.
    height number(double) false Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height.
    depth number(double) false Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth.
    is_free_shipping boolean false Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    purchasing_disabled boolean false If true, this variant will not be purchasable on the storefront.
    purchasing_disabled_message string false If purchasing_disabled is true, this message should show on the storefront when the variant is selected.
    image_url string false The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product.
    upc string false The UPC code used in feeds for shopping comparison sites and external channel integrations.
    inventory_level integer false Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.
    inventory_warning_level integer false When the variant hits this inventory level, it is considered low stock.
    bin_picking_number string false Identifies where in a warehouse the variant is located.
    product_id integer false No description
    sku string false No description
    option_values [OptionValueProductPost] false The model for a POST to create option values on a product.
    option_display_name string false The name of the option.
    label string false The label of the option value.

    Enumerated Values

    Property Value
    type physical
    type digital
    inventory_tracking none
    inventory_tracking product
    inventory_tracking variant
    availability available
    availability disabled
    availability preorder
    gift_wrapping_options_type any
    gift_wrapping_options_type none
    gift_wrapping_options_type list
    condition New
    condition Used
    condition Refurbished
    type price
    type percent
    type fixed

    ProductPut

    {
      "name": "string",
      "type": "physical",
      "sku": "string",
      "description": "string",
      "weight": 0,
      "width": 0,
      "depth": 0,
      "height": 0,
      "price": 0,
      "cost_price": 0,
      "retail_price": 0,
      "sale_price": 0,
      "tax_class_id": 0,
      "product_tax_code": "string",
      "categories": [
        0
      ],
      "brand_id": 0,
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "inventory_tracking": "none",
      "fixed_cost_shipping_price": 0,
      "is_free_shipping": true,
      "is_visible": true,
      "is_featured": true,
      "related_products": [
        0
      ],
      "warranty": "string",
      "bin_picking_number": "string",
      "layout_file": "string",
      "upc": "string",
      "search_keywords": "string",
      "availability": "available",
      "availability_description": "string",
      "gift_wrapping_options_type": "any",
      "gift_wrapping_options_list": [
        0
      ],
      "sort_order": -2147483648,
      "condition": "New",
      "is_condition_shown": true,
      "order_quantity_minimum": 0,
      "order_quantity_maximum": 0,
      "page_title": "string",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "view_count": 0,
      "preorder_release_date": "2017-08-10T19:38:09Z",
      "preorder_message": "string",
      "is_preorder_only": true,
      "is_price_hidden": true,
      "price_hidden_label": "string",
      "custom_url": {
        "url": "string",
        "is_customized": true
      },
      "id": 0,
      "custom_fields": [
        {
          "name": "string",
          "value": "string",
          "id": 1
        }
      ],
      "bulk_pricing_rules": [
        {
          "quantity_min": 0,
          "quantity_max": 0,
          "type": "price",
          "amount": 0,
          "id": 1
        }
      ],
      "variants": [
        {
          "cost_price": 0,
          "price": 0,
          "sale_price": 0,
          "retail_price": 0,
          "weight": 0,
          "width": 0,
          "height": 0,
          "depth": 0,
          "is_free_shipping": true,
          "fixed_cost_shipping_price": 0,
          "purchasing_disabled": true,
          "purchasing_disabled_message": "string",
          "image_url": "string",
          "upc": "string",
          "inventory_level": 0,
          "inventory_warning_level": 0,
          "bin_picking_number": "string",
          "product_id": 0,
          "sku": "string"
        }
      ]
    } 
    

    Properties

    Name Type Required Description
    name string false The product name.
    type string false The product type. One of: physical - a physical stock unit, digital - a digital download.
    sku string false User defined product code/stock keeping unit (SKU).
    description string false The product description, which can include HTML formatting.
    weight number(double) false Weight of the product, which can be used when calculating shipping costs.
    width number(double) false Width of the product, which can be used when calculating shipping costs.
    depth number(double) false Depth of the product, which can be used when calculating shipping costs.
    height number(double) false Height of the product, which can be used when calculating shipping costs.
    price number(double) false The price of the product. The price should include or exclude tax, based on the store settings.
    cost_price number(double) false The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store.
    retail_price number(double) false The retail cost of the product. If entered, the retail cost price will be shown on the product page.
    sale_price number(double) false If entered, the sale price will be used instead of value in the price field when calculating the product's cost.
    tax_class_id integer false The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)
    product_tax_code string false Accepts AvaTax System Tax Codes, which identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to BigCommerce's Avalara Premium integration can calculate sales taxes more accurately. Stores without Avalara Premium will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see Avalara's documentation.
    brand_id integer false The ID associated with the product's brand.
    inventory_level integer false Current inventory level of the product. Simple inventory tracking must be enabled (See the inventory_tracking field) for this to take any effect.
    inventory_warning_level integer false Inventory warning level for the product. When the product's inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the inventory_tracking field) for this to take any effect.
    inventory_tracking string false The type of inventory tracking for the product. Values are: none - inventory levels will not be tracked; product - inventory levels will be tracked using the inventory_level and inventory_warning_level fields; variant - inventory levels will be tracked based on variants, which maintain their own warning levels and inventory levels.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    is_free_shipping boolean false Flag used to indicate whether the product has free shipping. If true, the shipping cost for the product will be zero.
    is_visible boolean false Flag to determine whether the product should be displayed to customers browsing the store. If true, the product will be displayed. If false, the product will be hidden from view.
    is_featured boolean false Flag to determine whether the product should be included in the featured products panel when viewing the store.
    warranty string false Warranty information displayed on the product page. Can include HTML formatting.
    bin_picking_number string false The BIN picking number for the product.
    layout_file string false The layout template file used to render this product.
    upc string false The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations.
    search_keywords string false A comma-separated list of keywords that can be used to locate the product when searching the store.
    availability string false Availability of the product. Availability options are: available - the product can be purchased on the storefront; disabled - the product is listed in the storefront, but cannot be purchased; preorder - the product is listed for pre-orders.
    availability_description string false Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.'
    gift_wrapping_options_type string false Type of gift-wrapping options. Values: any - allow any gift-wrapping options in the store; none - disallow gift-wrapping on the product; list – provide a list of IDs in the gift_wrapping_options_list field.
    sort_order integer false Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results.
    condition string false The product condition. Will be shown on the product page if the is_condition_shown field's value is true. Possible values: New, Used, Refurbished.
    is_condition_shown boolean false Flag used to determine whether the product condition is shown to the customer on the product page.
    order_quantity_minimum integer false The minimum quantity an order must contain, to be eligible to purchase this product.
    order_quantity_maximum integer false The maximum quantity an order can contain when purchasing the product.
    page_title string false Custom title for the product page. If not defined, the product name will be used as the meta title.
    meta_description string false Custom meta description for the product page. If not defined, the store's default meta description will be used.
    view_count integer false The number of times the product has been viewed.
    preorder_release_date string(date-time) false Pre-order release date. See the availability field for details on setting a product's availability to accept pre-orders.
    preorder_message string false Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the %%DATE%% placeholder, which will be substituted for the release date.
    is_preorder_only boolean false If set to false, the product will not change its availability from preorder to available on the release date. Otherwise, on the release date the product's availability/status will change to available.
    is_price_hidden boolean false False by default, indicating that this product's price should be shown on the product page. If set to true, the price is hidden. (NOTE: To successfully set is_price_hidden to true, the availability value must be disabled.)
    price_hidden_label string false By default, an empty string. If is_price_hidden is true, the value of price_hidden_label is displayed instead of the price. (NOTE: To successfully set a non-empty string value with is_price_hidden set to true, the availability value must be disabled.)
    custom_url CustomUrlProduct false The custom URL for the product on the storefront.
    url string false Product URL on the storefront.
    is_customized boolean false Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).
    id integer false The unique numerical ID of the product; increments sequentially.
    categories [integer] false No description
    related_products [integer] false No description
    gift_wrapping_options_list [integer] false No description
    meta_keywords [string] false No description
    custom_fields [CustomField] false Gets custom fields associated with a product. These allow you to specify additional information that will appear on the product's page, such as a book's ISBN or a DVD's release date.
    name string false The name of the field, shown on the storefront, orders, etc.
    value string false The name of the field, shown on the storefront, orders, etc.
    id integer false The unique numeric ID of the custom field; increments sequentially.
    bulk_pricing_rules [BulkPricingRule] false Rules that offer price discounts based on quantity breaks.
    quantity_min integer false The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero.
    quantity_max integer false The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the quantity_min value – unless this field has a value of 0 (zero), in which case there will be no maximum bound for this rule.
    type string false The type of adjustment that is made. Values: price - the adjustment amount per product; percent - the adjustment as a percentage of the original price; fixed - the adjusted absolute price of the product.
    amount number(double) false The value of the adjustment by the bulk pricing rule.
    id integer false The ID of the bulk pricing rule.
    variants [VariantProductPut] false The model for a PUT to update variants on a product.
    cost_price number(double) false The cost price of the variant. Not affected by Price List prices.
    price number(double) false This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's default price (set in the Product resource's price field) will be used as the base price.
    sale_price number(double) false This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's price field) will be used as the sale price.
    retail_price number(double) false This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's price field) will be used as the retail price.
    weight number(double) false This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
    width number(double) false Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width.
    height number(double) false Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height.
    depth number(double) false Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth.
    is_free_shipping boolean false Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.
    fixed_cost_shipping_price number(double) false A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    purchasing_disabled boolean false If true, this variant will not be purchasable on the storefront.
    purchasing_disabled_message string false If purchasing_disabled is true, this message should show on the storefront when the variant is selected.
    image_url string false The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product.
    upc string false The UPC code used in feeds for shopping comparison sites and external channel integrations.
    inventory_level integer false Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.
    inventory_warning_level integer false When the variant hits this inventory level, it is considered low stock.
    bin_picking_number string false Identifies where in a warehouse the variant is located.
    product_id integer false No description
    sku string false No description

    Enumerated Values

    Property Value
    type physical
    type digital
    inventory_tracking none
    inventory_tracking product
    inventory_tracking variant
    availability available
    availability disabled
    availability preorder
    gift_wrapping_options_type any
    gift_wrapping_options_type none
    gift_wrapping_options_type list
    condition New
    condition Used
    condition Refurbished
    type price
    type percent
    type fixed

    CatalogSummaryResponse

    {
      "data": {
        "inventory_count": 0,
        "inventory_value": 0,
        "primary_category_id": 0,
        "primary_category_name": "string"
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data CatalogSummary false A BigCommerce Catalog Summary object describes a lightweight summary of the catalog.
    inventory_count integer false A count of all inventory items in the catalog.
    inventory_value number(double) false Total value of store's inventory.
    primary_category_id integer false ID of the category containing the most products.
    primary_category_name string false Name of the category containing the most products.
    meta Meta false Empty meta object; may be used later.

    CatalogSummary

    {
      "inventory_count": 0,
      "inventory_value": 0,
      "primary_category_id": 0,
      "primary_category_name": "string"
    } 
    

    Properties

    Name Type Required Description
    inventory_count integer false A count of all inventory items in the catalog.
    inventory_value number(double) false Total value of store's inventory.
    primary_category_id integer false ID of the category containing the most products.
    primary_category_name string false Name of the category containing the most products.

    MetaFieldCollectionResponse

    {
      "data": [
        {
          "permission_set": "app_only",
          "namespace": "string",
          "key": "string",
          "value": "string",
          "description": "string",
          "resource_type": "category",
          "resource_id": 0,
          "id": 0,
          "created_at": "2017-08-10T19:38:09Z",
          "updated_at": "2017-08-10T19:38:09Z"
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [Metafield] false Allows app partners to write custom data to various resources in the API.
    permission_set string false Determines whether the field is completely private to the app that owns the field (app_only), or visible to other API consumers (read), or completely open for reading and writing to other apps (write).
    namespace string false Namespace for the metafield, for organizational purposes.
    key string false The name of the field, for example: location_id, color.
    value string false The value of the field, for example: 1, blue.
    description string false Description for the metafields.
    resource_type string false The type of resource with which the metafield is associated.
    resource_id integer false The unique identifier for the resource with which the metafield is associated.
    id integer false The unique identifier for the metafields.
    created_at string(date-time) false Date and time of the metafield's creation.
    updated_at string(date-time) false Date and time when the metafield was last updated.

    Enumerated Values

    Property Value
    permission_set app_only
    permission_set read
    permission_set write
    resource_type category
    resource_type brand
    resource_type product
    resource_type variant

    MetafieldResponse

    {
      "data": {
        "permission_set": "app_only",
        "namespace": "string",
        "key": "string",
        "value": "string",
        "description": "string",
        "resource_type": "category",
        "resource_id": 0,
        "id": 0,
        "created_at": "2017-08-10T19:38:09Z",
        "updated_at": "2017-08-10T19:38:09Z"
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [Metafield] false Allows app partners to write custom data to various resources in the API.
    permission_set string false Determines whether the field is completely private to the app that owns the field (app_only), or visible to other API consumers (read), or completely open for reading and writing to other apps (write).
    namespace string false Namespace for the metafield, for organizational purposes.
    key string false The name of the field, for example: location_id, color.
    value string false The value of the field, for example: 1, blue.
    description string false Description for the metafields.
    resource_type string false The type of resource with which the metafield is associated.
    resource_id integer false The unique identifier for the resource with which the metafield is associated.
    id integer false The unique identifier for the metafields.
    created_at string(date-time) false Date and time of the metafield's creation.
    updated_at string(date-time) false Date and time when the metafield was last updated.
    meta Meta false Empty meta object; may be used later.

    Enumerated Values

    Property Value
    permission_set app_only
    permission_set read
    permission_set write
    resource_type category
    resource_type brand
    resource_type product
    resource_type variant

    MetafieldBase

    {
      "permission_set": "app_only",
      "namespace": "string",
      "key": "string",
      "value": "string",
      "description": "string",
      "resource_type": "category",
      "resource_id": 0
    } 
    

    Properties

    Name Type Required Description
    permission_set string false Determines whether the field is completely private to the app that owns the field (app_only), or visible to other API consumers (read), or completely open for reading and writing to other apps (write).
    namespace string false Namespace for the metafield, for organizational purposes.
    key string false The name of the field, for example: location_id, color.
    value string false The value of the field, for example: 1, blue.
    description string false Description for the metafields.
    resource_type string false The type of resource with which the metafield is associated.
    resource_id integer false The unique identifier for the resource with which the metafield is associated.

    Enumerated Values

    Property Value
    permission_set app_only
    permission_set read
    permission_set write
    resource_type category
    resource_type brand
    resource_type product
    resource_type variant

    Metafield

    {
      "permission_set": "app_only",
      "namespace": "string",
      "key": "string",
      "value": "string",
      "description": "string",
      "resource_type": "category",
      "resource_id": 0,
      "id": 0,
      "created_at": "2017-08-10T19:38:09Z",
      "updated_at": "2017-08-10T19:38:09Z"
    } 
    

    Properties

    Name Type Required Description
    permission_set string false Determines whether the field is completely private to the app that owns the field (app_only), or visible to other API consumers (read), or completely open for reading and writing to other apps (write).
    namespace string false Namespace for the metafield, for organizational purposes.
    key string false The name of the field, for example: location_id, color.
    value string false The value of the field, for example: 1, blue.
    description string false Description for the metafields.
    resource_type string false The type of resource with which the metafield is associated.
    resource_id integer false The unique identifier for the resource with which the metafield is associated.
    id integer false The unique identifier for the metafields.
    created_at string(date-time) false Date and time of the metafield's creation.
    updated_at string(date-time) false Date and time when the metafield was last updated.

    Enumerated Values

    Property Value
    permission_set app_only
    permission_set read
    permission_set write
    resource_type category
    resource_type brand
    resource_type product
    resource_type variant

    MetafieldPost

    {
      "permission_set": "app_only",
      "namespace": "string",
      "key": "string",
      "value": "string",
      "description": "string",
      "resource_type": "category",
      "resource_id": 0
    } 
    

    Properties

    Name Type Required Description
    permission_set string false Determines whether the field is completely private to the app that owns the field (app_only), or visible to other API consumers (read), or completely open for reading and writing to other apps (write).
    namespace string false Namespace for the metafield, for organizational purposes.
    key string false The name of the field, for example: location_id, color.
    value string false The value of the field, for example: 1, blue.
    description string false Description for the metafields.
    resource_type string false The type of resource with which the metafield is associated.
    resource_id integer false The unique identifier for the resource with which the metafield is associated.

    Enumerated Values

    Property Value
    permission_set app_only
    permission_set read
    permission_set write
    resource_type category
    resource_type brand
    resource_type product
    resource_type variant

    MetafieldPut

    {
      "permission_set": "app_only",
      "namespace": "string",
      "key": "string",
      "value": "string",
      "description": "string",
      "resource_type": "category",
      "resource_id": 0,
      "id": 0
    } 
    

    Properties

    Name Type Required Description
    permission_set string false Determines whether the field is completely private to the app that owns the field (app_only), or visible to other API consumers (read), or completely open for reading and writing to other apps (write).
    namespace string false Namespace for the metafield, for organizational purposes.
    key string false The name of the field, for example: location_id, color.
    value string false The value of the field, for example: 1, blue.
    description string false Description for the metafields.
    resource_type string false The type of resource with which the metafield is associated.
    resource_id integer false The unique identifier for the resource with which the metafield is associated.
    id integer false The unique identifier for the metafields.

    Enumerated Values

    Property Value
    permission_set app_only
    permission_set read
    permission_set write
    resource_type category
    resource_type brand
    resource_type product
    resource_type variant

    ComplexRuleCollectionResponse

    {
      "data": [
        {
          "product_id": 0,
          "sort_order": -2147483648,
          "enabled": true,
          "stop": true,
          "purchasing_disabled": true,
          "purchasing_disabled_message": "string",
          "purchasing_hidden": true,
          "price_adjuster": {
            "adjuster": "relative",
            "adjuster_value": 0
          },
          "weight_adjuster": {
            "adjuster": "relative",
            "adjuster_value": 0
          },
          "id": 0,
          "image_url": "string",
          "conditions": [
            {
              "id": 0,
              "rule_id": 0,
              "modifier_id": 0,
              "modifier_value_id": 0,
              "variant_id": 0,
              "combination_id": 0
            }
          ]
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [ComplexRule] false Apply price, weight, image, or availabilty adjustments to product, based on a set of conditions. A complex rule's condition must either contain more than one modifier value, or else contain a modifier value and a variant ID.
    product_id integer false The unique numeric ID of the product with which the rule is associated; increments sequentially.
    sort_order integer false The priority to give this rule when making adjustments to the product properties.
    enabled boolean false Flag for determining whether the rule is to be used when adjusting a product's price, weight, image, or availabilty.
    stop boolean false Flag for determining whether other rules should not be applied after this rule has been applied.
    purchasing_disabled boolean false Flag for determining whether the rule should disable purchasing of a product when the conditions are applied.
    purchasing_disabled_message string false Message displayed on the storefront when a rule disables the purchasing of a product.
    purchasing_hidden boolean false Flag for determining whether the rule should hide purchasing of a product when the conditions are applied.
    price_adjuster Adjuster false No description
    adjuster string false The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
    adjuster_value number false 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.
    id integer false The unique numeric ID of the rule; increments sequentially.
    image_url string false The URL for an image displayed on the storefront when the conditions are applied.
    conditions [ComplexRuleCondition] false Complex rules may return with conditions that apply to one or more variants, or with a single modifier value (if the rules were created using the v2 API or the control panel). Complex rules created or updated in the v3 API must have conditions that either reference multiple modifier_value_id's, or else reference a modifier_value_id and a variant_id.
    id integer false The unique numeric ID of the rule condition; increments sequentially.
    rule_id integer false The unique numeric ID of the rule with which the condition is associated.
    modifier_id integer false The unique numeric ID of the modifier with which the rule condition is associated.
    modifier_value_id integer false The unique numeric ID of the modifier value with which the rule condition is associated.
    variant_id integer false The unique numeric ID of the variant with which the rule condition is associated.
    combination_id integer false (READ-ONLY:) The unique numeric ID of the SKU (v2 API), or Combination, with which the rule condition is associated. This is to maintain cross-compatibility between v2 and v3.

    Enumerated Values

    Property Value
    adjuster relative
    adjuster percentage

    ComplexRuleResponse

    {
      "data": {
        "product_id": 0,
        "sort_order": -2147483648,
        "enabled": true,
        "stop": true,
        "purchasing_disabled": true,
        "purchasing_disabled_message": "string",
        "purchasing_hidden": true,
        "price_adjuster": {
          "adjuster": "relative",
          "adjuster_value": 0
        },
        "weight_adjuster": {
          "adjuster": "relative",
          "adjuster_value": 0
        },
        "id": 0,
        "image_url": "string",
        "conditions": [
          {
            "id": 0,
            "rule_id": 0,
            "modifier_id": 0,
            "modifier_value_id": 0,
            "variant_id": 0,
            "combination_id": 0
          }
        ]
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [ComplexRule] false Apply price, weight, image, or availabilty adjustments to product, based on a set of conditions. A complex rule's condition must either contain more than one modifier value, or else contain a modifier value and a variant ID.
    product_id integer false The unique numeric ID of the product with which the rule is associated; increments sequentially.
    sort_order integer false The priority to give this rule when making adjustments to the product properties.
    enabled boolean false Flag for determining whether the rule is to be used when adjusting a product's price, weight, image, or availabilty.
    stop boolean false Flag for determining whether other rules should not be applied after this rule has been applied.
    purchasing_disabled boolean false Flag for determining whether the rule should disable purchasing of a product when the conditions are applied.
    purchasing_disabled_message string false Message displayed on the storefront when a rule disables the purchasing of a product.
    purchasing_hidden boolean false Flag for determining whether the rule should hide purchasing of a product when the conditions are applied.
    price_adjuster Adjuster false No description
    adjuster string false The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
    adjuster_value number false 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.
    id integer false The unique numeric ID of the rule; increments sequentially.
    image_url string false The URL for an image displayed on the storefront when the conditions are applied.
    conditions [ComplexRuleCondition] false Complex rules may return with conditions that apply to one or more variants, or with a single modifier value (if the rules were created using the v2 API or the control panel). Complex rules created or updated in the v3 API must have conditions that either reference multiple modifier_value_id's, or else reference a modifier_value_id and a variant_id.
    id integer false The unique numeric ID of the rule condition; increments sequentially.
    rule_id integer false The unique numeric ID of the rule with which the condition is associated.
    modifier_id integer false The unique numeric ID of the modifier with which the rule condition is associated.
    modifier_value_id integer false The unique numeric ID of the modifier value with which the rule condition is associated.
    variant_id integer false The unique numeric ID of the variant with which the rule condition is associated.
    combination_id integer false (READ-ONLY:) The unique numeric ID of the SKU (v2 API), or Combination, with which the rule condition is associated. This is to maintain cross-compatibility between v2 and v3.
    meta Meta false Empty meta object; may be used later.

    Enumerated Values

    Property Value
    adjuster relative
    adjuster percentage

    ComplexRuleBase

    {
      "product_id": 0,
      "sort_order": -2147483648,
      "enabled": true,
      "stop": true,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "purchasing_hidden": true,
      "price_adjuster": {
        "adjuster": "relative",
        "adjuster_value": 0
      },
      "weight_adjuster": {
        "adjuster": "relative",
        "adjuster_value": 0
      }
    } 
    

    Properties

    Name Type Required Description
    product_id integer false The unique numeric ID of the product with which the rule is associated; increments sequentially.
    sort_order integer false The priority to give this rule when making adjustments to the product properties.
    enabled boolean false Flag for determining whether the rule is to be used when adjusting a product's price, weight, image, or availabilty.
    stop boolean false Flag for determining whether other rules should not be applied after this rule has been applied.
    purchasing_disabled boolean false Flag for determining whether the rule should disable purchasing of a product when the conditions are applied.
    purchasing_disabled_message string false Message displayed on the storefront when a rule disables the purchasing of a product.
    purchasing_hidden boolean false Flag for determining whether the rule should hide purchasing of a product when the conditions are applied.
    price_adjuster Adjuster false No description
    adjuster string false The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
    adjuster_value number false 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.

    Enumerated Values

    Property Value
    adjuster relative
    adjuster percentage

    ComplexRule

    {
      "product_id": 0,
      "sort_order": -2147483648,
      "enabled": true,
      "stop": true,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "purchasing_hidden": true,
      "price_adjuster": {
        "adjuster": "relative",
        "adjuster_value": 0
      },
      "weight_adjuster": {
        "adjuster": "relative",
        "adjuster_value": 0
      },
      "id": 0,
      "image_url": "string",
      "conditions": [
        {
          "id": 0,
          "rule_id": 0,
          "modifier_id": 0,
          "modifier_value_id": 0,
          "variant_id": 0,
          "combination_id": 0
        }
      ]
    } 
    

    Properties

    Name Type Required Description
    product_id integer false The unique numeric ID of the product with which the rule is associated; increments sequentially.
    sort_order integer false The priority to give this rule when making adjustments to the product properties.
    enabled boolean false Flag for determining whether the rule is to be used when adjusting a product's price, weight, image, or availabilty.
    stop boolean false Flag for determining whether other rules should not be applied after this rule has been applied.
    purchasing_disabled boolean false Flag for determining whether the rule should disable purchasing of a product when the conditions are applied.
    purchasing_disabled_message string false Message displayed on the storefront when a rule disables the purchasing of a product.
    purchasing_hidden boolean false Flag for determining whether the rule should hide purchasing of a product when the conditions are applied.
    price_adjuster Adjuster false No description
    adjuster string false The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
    adjuster_value number false 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.
    id integer false The unique numeric ID of the rule; increments sequentially.
    image_url string false The URL for an image displayed on the storefront when the conditions are applied.
    conditions [ComplexRuleCondition] false Complex rules may return with conditions that apply to one or more variants, or with a single modifier value (if the rules were created using the v2 API or the control panel). Complex rules created or updated in the v3 API must have conditions that either reference multiple modifier_value_id's, or else reference a modifier_value_id and a variant_id.
    id integer false The unique numeric ID of the rule condition; increments sequentially.
    rule_id integer false The unique numeric ID of the rule with which the condition is associated.
    modifier_id integer false The unique numeric ID of the modifier with which the rule condition is associated.
    modifier_value_id integer false The unique numeric ID of the modifier value with which the rule condition is associated.
    variant_id integer false The unique numeric ID of the variant with which the rule condition is associated.
    combination_id integer false (READ-ONLY:) The unique numeric ID of the SKU (v2 API), or Combination, with which the rule condition is associated. This is to maintain cross-compatibility between v2 and v3.

    Enumerated Values

    Property Value
    adjuster relative
    adjuster percentage

    ComplexRulePost

    {
      "product_id": 0,
      "sort_order": -2147483648,
      "enabled": true,
      "stop": true,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "purchasing_hidden": true,
      "price_adjuster": {
        "adjuster": "relative",
        "adjuster_value": 0
      },
      "weight_adjuster": {
        "adjuster": "relative",
        "adjuster_value": 0
      },
      "conditions": [
        {
          "id": 0,
          "rule_id": 0,
          "modifier_id": 0,
          "modifier_value_id": 0,
          "variant_id": 0
        }
      ]
    } 
    

    Properties

    Name Type Required Description
    product_id integer false The unique numeric ID of the product with which the rule is associated; increments sequentially.
    sort_order integer false The priority to give this rule when making adjustments to the product properties.
    enabled boolean false Flag for determining whether the rule is to be used when adjusting a product's price, weight, image, or availabilty.
    stop boolean false Flag for determining whether other rules should not be applied after this rule has been applied.
    purchasing_disabled boolean false Flag for determining whether the rule should disable purchasing of a product when the conditions are applied.
    purchasing_disabled_message string false Message displayed on the storefront when a rule disables the purchasing of a product.
    purchasing_hidden boolean false Flag for determining whether the rule should hide purchasing of a product when the conditions are applied.
    price_adjuster Adjuster false No description
    adjuster string false The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
    adjuster_value number false 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.
    conditions [ComplexRuleConditionPost] false The model for a POST to create conditions on a complex rule.
    id integer false The unique numeric ID of the rule condition; increments sequentially.
    rule_id integer false The unique numeric ID of the rule with which the condition is associated.
    modifier_id integer false The unique numeric ID of the modifier with which the rule condition is associated.
    modifier_value_id integer false The unique numeric ID of the modifier value with which the rule condition is associated.
    variant_id integer false The unique numeric ID of the variant with which the rule condition is associated.

    Enumerated Values

    Property Value
    adjuster relative
    adjuster percentage

    ComplexRulePut

    {
      "product_id": 0,
      "sort_order": -2147483648,
      "enabled": true,
      "stop": true,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "purchasing_hidden": true,
      "price_adjuster": {
        "adjuster": "relative",
        "adjuster_value": 0
      },
      "weight_adjuster": {
        "adjuster": "relative",
        "adjuster_value": 0
      },
      "id": 0,
      "conditions": [
        {
          "id": 0,
          "rule_id": 0,
          "modifier_id": 0,
          "modifier_value_id": 0,
          "variant_id": 0
        }
      ]
    } 
    

    Properties

    Name Type Required Description
    product_id integer false The unique numeric ID of the product with which the rule is associated; increments sequentially.
    sort_order integer false The priority to give this rule when making adjustments to the product properties.
    enabled boolean false Flag for determining whether the rule is to be used when adjusting a product's price, weight, image, or availabilty.
    stop boolean false Flag for determining whether other rules should not be applied after this rule has been applied.
    purchasing_disabled boolean false Flag for determining whether the rule should disable purchasing of a product when the conditions are applied.
    purchasing_disabled_message string false Message displayed on the storefront when a rule disables the purchasing of a product.
    purchasing_hidden boolean false Flag for determining whether the rule should hide purchasing of a product when the conditions are applied.
    price_adjuster Adjuster false No description
    adjuster string false The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
    adjuster_value number false 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.
    id integer false The unique numeric ID of the rule; increments sequentially.
    conditions [ComplexRuleConditionPut] false The model for a PUT to update conditions on a complex rule.
    id integer false The unique numeric ID of the rule condition; increments sequentially.
    rule_id integer false The unique numeric ID of the rule with which the condition is associated.
    modifier_id integer false The unique numeric ID of the modifier with which the rule condition is associated.
    modifier_value_id integer false The unique numeric ID of the modifier value with which the rule condition is associated.
    variant_id integer false The unique numeric ID of the variant with which the rule condition is associated.

    Enumerated Values

    Property Value
    adjuster relative
    adjuster percentage

    CustomFieldCollectionResponse

    {
      "data": [
        {
          "name": "string",
          "value": "string",
          "id": 1
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [CustomField] false Gets custom fields associated with a product. These allow you to specify additional information that will appear on the product's page, such as a book's ISBN or a DVD's release date.
    name string false The name of the field, shown on the storefront, orders, etc.
    value string false The name of the field, shown on the storefront, orders, etc.
    id integer false The unique numeric ID of the custom field; increments sequentially.

    CustomFieldResponse

    {
      "data": {
        "name": "string",
        "value": "string",
        "id": 1
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [CustomField] false Gets custom fields associated with a product. These allow you to specify additional information that will appear on the product's page, such as a book's ISBN or a DVD's release date.
    name string false The name of the field, shown on the storefront, orders, etc.
    value string false The name of the field, shown on the storefront, orders, etc.
    id integer false The unique numeric ID of the custom field; increments sequentially.
    meta Meta false Empty meta object; may be used later.

    CustomFieldBase

    {
      "name": "string",
      "value": "string"
    } 
    

    Properties

    Name Type Required Description
    name string false The name of the field, shown on the storefront, orders, etc.
    value string false The name of the field, shown on the storefront, orders, etc.

    CustomField

    {
      "name": "string",
      "value": "string",
      "id": 1
    } 
    

    Properties

    Name Type Required Description
    name string false The name of the field, shown on the storefront, orders, etc.
    value string false The name of the field, shown on the storefront, orders, etc.
    id integer false The unique numeric ID of the custom field; increments sequentially.

    CustomFieldPost

    {
      "name": "string",
      "value": "string"
    } 
    

    Properties

    Name Type Required Description
    name string false The name of the field, shown on the storefront, orders, etc.
    value string false The name of the field, shown on the storefront, orders, etc.

    CustomFieldPut

    {
      "name": "string",
      "value": "string",
      "id": 1
    } 
    

    Properties

    Name Type Required Description
    name string false The name of the field, shown on the storefront, orders, etc.
    value string false The name of the field, shown on the storefront, orders, etc.
    id integer false The unique numeric ID of the custom field; increments sequentially.

    ComplexRuleConditionBase

    {
      "id": 0,
      "rule_id": 0,
      "modifier_id": 0,
      "modifier_value_id": 0,
      "variant_id": 0
    } 
    

    Properties

    Name Type Required Description
    id integer false The unique numeric ID of the rule condition; increments sequentially.
    rule_id integer false The unique numeric ID of the rule with which the condition is associated.
    modifier_id integer false The unique numeric ID of the modifier with which the rule condition is associated.
    modifier_value_id integer false The unique numeric ID of the modifier value with which the rule condition is associated.
    variant_id integer false The unique numeric ID of the variant with which the rule condition is associated.

    ComplexRuleCondition

    {
      "id": 0,
      "rule_id": 0,
      "modifier_id": 0,
      "modifier_value_id": 0,
      "variant_id": 0,
      "combination_id": 0
    } 
    

    Properties

    Name Type Required Description
    id integer false The unique numeric ID of the rule condition; increments sequentially.
    rule_id integer false The unique numeric ID of the rule with which the condition is associated.
    modifier_id integer false The unique numeric ID of the modifier with which the rule condition is associated.
    modifier_value_id integer false The unique numeric ID of the modifier value with which the rule condition is associated.
    variant_id integer false The unique numeric ID of the variant with which the rule condition is associated.
    combination_id integer false (READ-ONLY:) The unique numeric ID of the SKU (v2 API), or Combination, with which the rule condition is associated. This is to maintain cross-compatibility between v2 and v3.

    ComplexRuleConditionPost

    {
      "id": 0,
      "rule_id": 0,
      "modifier_id": 0,
      "modifier_value_id": 0,
      "variant_id": 0
    } 
    

    Properties

    Name Type Required Description
    id integer false The unique numeric ID of the rule condition; increments sequentially.
    rule_id integer false The unique numeric ID of the rule with which the condition is associated.
    modifier_id integer false The unique numeric ID of the modifier with which the rule condition is associated.
    modifier_value_id integer false The unique numeric ID of the modifier value with which the rule condition is associated.
    variant_id integer false The unique numeric ID of the variant with which the rule condition is associated.

    ComplexRuleConditionPut

    {
      "id": 0,
      "rule_id": 0,
      "modifier_id": 0,
      "modifier_value_id": 0,
      "variant_id": 0
    } 
    

    Properties

    Name Type Required Description
    id integer false The unique numeric ID of the rule condition; increments sequentially.
    rule_id integer false The unique numeric ID of the rule with which the condition is associated.
    modifier_id integer false The unique numeric ID of the modifier with which the rule condition is associated.
    modifier_value_id integer false The unique numeric ID of the modifier value with which the rule condition is associated.
    variant_id integer false The unique numeric ID of the variant with which the rule condition is associated.

    CustomUrlProduct

    {
      "url": "string",
      "is_customized": true
    } 
    

    Properties

    Name Type Required Description
    url string false Product URL on the storefront.
    is_customized boolean false Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).

    CustomUrlCategory

    {
      "url": "string",
      "is_customized": true
    } 
    

    Properties

    Name Type Required Description
    url string false Category URL on the storefront.
    is_customized boolean false Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).

    BulkPricingRuleCollectionResponse

    {
      "data": [
        {
          "quantity_min": 0,
          "quantity_max": 0,
          "type": "price",
          "amount": 0,
          "id": 1
        }
      ],
      "meta": {
        "pagination": {
          "total": 0,
          "count": 0,
          "per_page": 0,
          "current_page": 0,
          "total_pages": 0,
          "links": {
            "previous": "string",
            "current": "string",
            "next": "string"
          }
        }
      }
    } 
    

    Properties

    Name Type Required Description
    meta CollectionMeta false Data about the response, including pagination and collection totals.
    pagination Pagination false Data about the response, including pagination and collection totals.
    total integer false Total number of items in the result set.
    count integer false Total number of items in the collection response.
    per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
    current_page integer false The page you are currently on within the collection.
    total_pages integer false The total number of pages in the collection.
    links object false Pagination links for the previous and next parts of the whole collection.
    previous string false Link to the previous page returned in the response.
    current string false Link to the current page returned in the response.
    next string false Link to the next page returned in the response.
    data [BulkPricingRule] false Rules that offer price discounts based on quantity breaks.
    quantity_min integer false The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero.
    quantity_max integer false The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the quantity_min value – unless this field has a value of 0 (zero), in which case there will be no maximum bound for this rule.
    type string false The type of adjustment that is made. Values: price - the adjustment amount per product; percent - the adjustment as a percentage of the original price; fixed - the adjusted absolute price of the product.
    amount number(double) false The value of the adjustment by the bulk pricing rule.
    id integer false The ID of the bulk pricing rule.

    Enumerated Values

    Property Value
    type price
    type percent
    type fixed

    BulkPricingRuleResponse

    {
      "data": {
        "quantity_min": 0,
        "quantity_max": 0,
        "type": "price",
        "amount": 0,
        "id": 1
      },
      "meta": {}
    } 
    

    Properties

    Name Type Required Description
    data [BulkPricingRule] false Rules that offer price discounts based on quantity breaks.
    quantity_min integer false The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero.
    quantity_max integer false The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the quantity_min value – unless this field has a value of 0 (zero), in which case there will be no maximum bound for this rule.
    type string false The type of adjustment that is made. Values: price - the adjustment amount per product; percent - the adjustment as a percentage of the original price; fixed - the adjusted absolute price of the product.
    amount number(double) false The value of the adjustment by the bulk pricing rule.
    id integer false The ID of the bulk pricing rule.
    meta Meta false Empty meta object; may be used later.

    Enumerated Values

    Property Value
    type price
    type percent
    type fixed

    BulkPricingRuleBase

    {
      "quantity_min": 0,
      "quantity_max": 0,
      "type": "price",
      "amount": 0
    } 
    

    Properties

    Name Type Required Description
    quantity_min integer false The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero.
    quantity_max integer false The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the quantity_min value – unless this field has a value of 0 (zero), in which case there will be no maximum bound for this rule.
    type string false The type of adjustment that is made. Values: price - the adjustment amount per product; percent - the adjustment as a percentage of the original price; fixed - the adjusted absolute price of the product.
    amount number(double) false The value of the adjustment by the bulk pricing rule.

    Enumerated Values

    Property Value
    type price
    type percent
    type fixed

    BulkPricingRule

    {
      "quantity_min": 0,
      "