BigCommerce · Example Payload

Bigcommerce Getproductvariants Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Getproductvariants 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": "getProductVariants",
  "method": "GET",
  "path": "/catalog/products/{product_id}/variants",
  "summary": "BigCommerce Get All Product Variants",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "data": [
          {
            "id": 382,
            "product_id": 192,
            "sku": "SMIT",
            "sku_id": 348,
            "price": 10,
            "calculated_price": 10,
            "sale_price": 8,
            "retail_price": 10,
            "map_price": {},
            "weight": 4,
            "calculated_weight": 2,
            "width": 5,
            "height": 5,
            "depth": 5,
            "is_free_shipping": false,
            "fixed_cost_shipping_price": 10,
            "purchasing_disabled": false,
            "purchasing_disabled_message": "",
            "image_url": "",
            "cost_price": 0,
            "upc": "",
            "mpn": "",
            "gtin": "",
            "inventory_level": 0,
            "inventory_warning_level": 0,
            "bin_picking_number": "",
            "option_values": [
              {
                "id": 174,
                "label": "Beige",
                "option_id": 220,
                "option_display_name": "Color"
              }
            ]
          },
          {
            "id": 383,
            "product_id": 192,
            "sku": "SMIT-1",
            "sku_id": 349,
            "price": 25,
            "calculated_price": 25,
            "sale_price": 20,
            "retail_price": 25,
            "map_price": {},
            "weight": 2,
            "calculated_weight": 1,
            "width": 5,
            "height": 5,
            "depth": 5,
            "is_free_shipping": false,
            "fixed_cost_shipping_price": 10,
            "purchasing_disabled": false,
            "purchasing_disabled_message": "",
            "image_url": "",
            "cost_price": 25,
            "upc": "",
            "mpn": "",
            "gtin": "",
            "inventory_level": 0,
            "inventory_warning_level": 0,
            "bin_picking_number": "",
            "option_values": [
              {
                "id": 175,
                "label": "Grey",
                "option_id": 220,
                "option_display_name": "Color"
              }
            ]
          },
          {
            "id": 384,
            "product_id": 192,
            "sku": "SMIT-2",
            "sku_id": 350,
            "price": 25,
            "calculated_price": 25,
            "sale_price": 20,
            "retail_price": 25,
            "map_price": {},
            "weight": 2,
            "calculated_weight": 1,
            "width": 5,
            "height": 5,
            "depth": 5,
            "is_free_shipping": false,
            "fixed_cost_shipping_price": 10,
            "purchasing_disabled": false,
            "purchasing_disabled_message": "",
            "image_url": "",
            "cost_price": 25,
            "upc": "",
            "mpn": "",
            "gtin": "",
            "inventory_level": 0,
            "inventory_warning_level": 0,
            "bin_picking_number": "",
            "option_values": [
              {
                "id": 176,
                "label": "Black",
                "option_id": 220,
                "option_display_name": "Color"
              }
            ]
          }
        ],
        "meta": {
          "pagination": {
            "total": 3,
            "count": 3,
            "per_page": 50,
            "current_page": 1,
            "total_pages": 1,
            "links": {
              "current": "?page=1&limit=50"
            }
          }
        }
      }
    }
  ]
}