BigCommerce · Example Payload

Bigcommerce Createproductvariantoption Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Createproductvariantoption Example is an example object payload from BigCommerce, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "createProductVariantOption",
  "method": "POST",
  "path": "/catalog/products/{product_id}/options",
  "summary": "BigCommerce Create a Product Variant Option",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "example-1",
      "example": {
        "data": {
          "id": 55,
          "product_id": 4,
          "display_name": "Add-a-$5-Donation1535042499-187",
          "type": "radio_buttons",
          "config": {
            "default_value": "string",
            "checked_by_default": true,
            "checkbox_label": "string",
            "date_limited": true,
            "date_limit_mode": "earliest",
            "date_earliest_value": "2022-08-24T00:00:00+00:00",
            "date_latest_value": "2022-08-27T00:00:00+00:00",
            "file_types_mode": "specific",
            "file_types_supported": [
              "images, documents, other"
            ],
            "file_types_other": [
              "pdf"
            ],
            "file_max_size": 5,
            "text_characters_limited": true,
            "text_min_length": 1,
            "text_max_length": 55,
            "text_lines_limited": true,
            "text_max_lines": 4,
            "number_limited": true,
            "number_limit_mode": "lowest",
            "number_lowest_value": 100,
            "number_highest_value": 0,
            "number_integers_only": false,
            "product_list_adjusts_inventory": true,
            "product_list_adjusts_pricing": true,
            "product_list_shipping_calc": "none"
          },
          "sort_order": 1,
          "option_values": [
            {
              "is_default": false,
              "label": "Green",
              "sort_order": 0,
              "value_data": {},
              "id": 0
            }
          ],
          "image_url": "string",
          "name": "Add-a-$5-Donation1535042499-187"
        },
        "meta": {}
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "example-2",
      "example": {
        "data": {
          "id": 220,
          "product_id": 192,
          "name": "Color (Colors only)",
          "display_name": "Color",
          "type": "swatch",
          "sort_order": 0,
          "option_values": [
            {
              "id": 174,
              "label": "Beige",
              "sort_order": 1,
              "value_data": {
                "colors": [
                  "#FAFAEB"
                ]
              },
              "is_default": false
            },
            {
              "id": 175,
              "label": "Grey",
              "sort_order": 2,
              "value_data": {
                "colors": [
                  "#BDBDBD"
                ]
              },
              "is_default": false
            },
            {
              "id": 176,
              "label": "Black",
              "sort_order": 3,
              "value_data": {
                "colors": [
                  "#000000"
                ]
              },
              "is_default": false
            },
            {
              "id": 189,
              "label": "Black-Walnut",
              "sort_order": 4,
              "value_data": {
                "colors": [
                  "#e80ee8"
                ]
              },
              "is_default": false
            }
          ],
          "config": {}
        },
        "meta": {}
      }
    }
  ]
}