BigCommerce · Example Payload

Bigcommerce Getproductvariantoptionvalues Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Getproductvariantoptionvalues 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

{
  "operationId": "getProductVariantOptionValues",
  "method": "GET",
  "path": "/catalog/products/{product_id}/options/{option_id}/values",
  "summary": "BigCommerce Get All Product Variant Option Values",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "data": [
          {
            "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
          }
        ],
        "meta": {
          "pagination": {
            "total": 4,
            "count": 4,
            "per_page": 50,
            "current_page": 1,
            "total_pages": 1,
            "links": {
              "current": "?page=1&limit=50"
            }
          }
        }
      }
    }
  ]
}