BigCommerce · Example Payload

Bigcommerce Getproductmodifiers Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Getproductmodifiers 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": "getProductModifiers",
  "method": "GET",
  "path": "/catalog/products/{product_id}/modifiers",
  "summary": "BigCommerce Get All Product Modifiers",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "data": [
          {
            "id": 206,
            "product_id": 158,
            "name": "Insurance",
            "display_name": "Insurace",
            "type": "checkbox",
            "required": true,
            "config": {
              "checkbox_label": "$5 for insurance",
              "checked_by_default": false
            },
            "option_values": [
              {
                "id": 183,
                "option_id": 206,
                "label": "Yes",
                "sort_order": 0,
                "value_data": {
                  "checked_value": true
                },
                "is_default": false,
                "adjusters": {
                  "price": {},
                  "weight": {},
                  "image_url": "",
                  "purchasing_disabled": {
                    "status": false,
                    "message": ""
                  }
                }
              },
              {
                "id": 184,
                "option_id": 206,
                "label": "No",
                "sort_order": 1,
                "value_data": {
                  "checked_value": false
                },
                "is_default": true,
                "adjusters": {
                  "price": {},
                  "weight": {},
                  "image_url": "",
                  "purchasing_disabled": {
                    "status": false,
                    "message": ""
                  }
                }
              }
            ]
          }
        ],
        "meta": {
          "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 50,
            "current_page": 1,
            "total_pages": 1,
            "links": {
              "current": "?page=1&limit=50"
            }
          }
        }
      }
    }
  ]
}