BigCommerce · Example Payload

Bigcommerce Getprices Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Getprices 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": "getPrices",
  "method": "POST",
  "path": "/pricing/products",
  "summary": "BigCommerce Get Prices (Batch)",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "data": [
          {
            "product_id": 1,
            "variant_id": 1,
            "options": [
              {
                "option_id": 1,
                "value_id": 1
              }
            ],
            "retail_price": {
              "as_entered": 1.5,
              "entered_inclusive": true,
              "tax_exclusive": 1.1,
              "tax_inclusive": 1.5
            },
            "sale_price": {
              "as_entered": 1.5,
              "entered_inclusive": true,
              "tax_exclusive": 1.1,
              "tax_inclusive": 1.5
            },
            "minimum_advertised_price": {
              "as_entered": 1.5,
              "entered_inclusive": true,
              "tax_exclusive": 1.1,
              "tax_inclusive": 1.5
            },
            "price": {
              "as_entered": 1.5,
              "entered_inclusive": true,
              "tax_exclusive": 1.1,
              "tax_inclusive": 1.5
            },
            "calculated_price": {
              "as_entered": 1.5,
              "entered_inclusive": true,
              "tax_exclusive": 1.1,
              "tax_inclusive": 1.5
            },
            "price_range": {
              "minimum": {
                "as_entered": 1.5,
                "entered_inclusive": true,
                "tax_exclusive": 1.1,
                "tax_inclusive": 1.5
              },
              "maximum": {
                "as_entered": 1.5,
                "entered_inclusive": true,
                "tax_exclusive": 1.1,
                "tax_inclusive": 1.5
              }
            },
            "retail_price_range": {
              "minimum": {
                "as_entered": 1.5,
                "entered_inclusive": true,
                "tax_exclusive": 1.1,
                "tax_inclusive": 1.5
              },
              "maximum": {
                "as_entered": 1.5,
                "entered_inclusive": true,
                "tax_exclusive": 1.1,
                "tax_inclusive": 1.5
              }
            },
            "bulk_pricing": [
              {
                "minimum": 1,
                "maximum": 1,
                "discount_amount": 1,
                "discount_type": "percent",
                "tax_discount_amount": [
                  {
                    "as_entered": 10,
                    "tax_inclusive": 10,
                    "tax_exclusive": 10,
                    "entered_inclusive": false
                  }
                ]
              }
            ]
          }
        ],
        "meta": {}
      }
    }
  ]
}