NAV

PriceLists

BigCommerce Price Lists API Definition.

What is a Price List? - A Price List allows you to populate different versions of catalog pricing and assign them to different Customer Groups. The prices are specified exclusively at the variant level. If an active Price List does not contain prices for a variant then the Catalog pricing will be used. The association of a Price List to a Customer Group can be done either via the Control Panel or using the V2 Customer Groups API.

Definitions - Price List : A collection of price records. Price Records make up a price list.

Example Price List

Example Price List assigned to a customer group: Under discount_rules the type is set to price_list and the price_list_id is 1. Which is the id of the price list the group has been assigned to.

Notes

Run in Postman

getPriceListCollection

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}


r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/pricelists', params={

}, headers = headers)


print r.json()


require 'rest-client'
require 'json'


headers = {
  'Accept' ='application/json'
}


result = RestClient.get 'https://api.bigcommerce.com/stores/{store_id}/v3/pricelists',
  params: {
  }, headers: headers

p JSON.parse(result)


GET /pricelists

Returns a paginated collection of Price List objects from BigCommerce. Can use filters.

Parameters

Parameter In Type Required Description
id query integer false Filter items by id.
name query string false Filter items by name.
date_created query string(date-time) false Filter items by date_created.
date_modified query string(date-time) false Filter items by date_modified.
page query integer false Specifies the page number in a limited (paginated) list of products.
limit query integer false Controls the number of items per page in a limited (paginated) list of products.
{
  "data": [
    {
      "id": 0,
      "date_created": "2018-02-23T20:53:52Z",
      "date_modified": "2018-02-23T20:53:52Z",
      "record_count": 0,
      "name": "string",
      "active": true
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

Responses

Status Meaning Description Schema
200 OK An array of Price Lists and metadata. PriceListCollectionResponse

createPriceList

Create a new Price List, which is a new set of prices for the store. Price Lists contain Price Records.

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}


r = requests.post('https://api.bigcommerce.com/stores/{store_id}/v3/pricelists', params={


}, headers = headers)


print r.json()


require 'rest-client'
require 'json'


headers = {
  'Content-Type' ='application/json',
  'Accept' ='application/json'
}


result = RestClient.post 'https://api.bigcommerce.com/stores/{store_id}/v3/pricelists',
  params: {
  }, headers: headers


p JSON.parse(result)


POST /pricelists

Creates a Price List in BigCommerce.

{
  "name": "string",
  "active": true
}

Parameters

Parameter In Type Required Description
body body PriceListPost true A BigCommerce PriceList object.
{
  "data": {
    "id": 0,
    "date_created": "2018-02-23T20:53:52Z",
    "date_modified": "2018-02-23T20:53:52Z",
    "record_count": 0,
    "name": "string",
    "active": true
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK A Price List. PriceListResponse
409 Conflict Price List was in conflict with another Price List. This is the result of duplicate unique values, such as name. ErrorResponse
422 Unprocessable Entity Price List was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

deletePriceListsByFilter

import requests


r = requests.delete('https://api.bigcommerce.com/stores/{store_id}/v3/pricelists', params={


)


print r.json()


require 'rest-client'
require 'json'


result = RestClient.delete 'https://api.bigcommerce.com/stores/{store_id}/v3/pricelists',
  params: {
  }


p JSON.parse(result)


DELETE /pricelists

Deletes a set of Price List objects from BigCommerce using a filter. Also removes all associated Price Records and Bulk Pricing Tiers.

Parameters

Parameter In Type Required Description
id query integer false Filter items by id.
name query string false Filter items by name.

Responses

Status Meaning Description Schema
204 No Content An empty response. None

getPriceList

import requests
headers = {
  'Accept': 'application/json'
}


r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}', params={


}, headers = headers)


print r.json()


require 'rest-client'
require 'json'


headers = {
  'Accept' ='application/json'
}


result = RestClient.get 'https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}',
  params: {
  }, headers: headers


p JSON.parse(result)


GET /pricelists/{price_list_id}

Returns a Price List object from BigCommerce.

Parameters

Parameter In Type Required Description
price_list_id path integer true The ID of the Price List requested.
{
  "data": {
    "id": 0,
    "date_created": "2018-02-23T20:53:52Z",
    "date_modified": "2018-02-23T20:53:52Z",
    "record_count": 0,
    "name": "string",
    "active": true
  },
  "meta": {}
}

Responses

Status Meaning Description Schema
200 OK An array of Price Lists and metadata. PriceListResponse

updatePriceList

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}


r = requests.put('https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}', params={


}, headers = headers)


print r.json()


require 'rest-client'
require 'json'


headers = {
  'Content-Type' ='application/json',
  'Accept' ='application/json'
}


result = RestClient.put 'https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}',
  params: {
  }, headers: headers


p JSON.parse(result)


PUT /pricelists/{price_list_id}

Updates a single Price List object.

{
  "name": "string",
  "active": true
}

Parameters

Parameter In Type Required Description
body body PriceListPut true A BigCommerce Price List object.
price_list_id path integer true The ID of the Price List requested.
{
  "data": {
    "id": 0,
    "date_created": "2018-02-23T20:53:52Z",
    "date_modified": "2018-02-23T20:53:52Z",
    "record_count": 0,
    "name": "string",
    "active": true
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK A Price List. PriceListResponse
404 Not Found The resource was not found. NotFound
409 Conflict Price List was in conflict with another Price List. This is the result of duplicate unique values, such as name. ErrorResponse
422 Unprocessable Entity Price List was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

deletePriceList

import requests


r = requests.delete('https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}', params={


)


print r.json()


require 'rest-client'
require 'json'


result = RestClient.delete 'https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}',
  params: {
  }


p JSON.parse(result)


DELETE /pricelists/{price_list_id}

Deletes one Price List object from BigCommerce by its ID. Also removes all associated Price Records.

Parameters

Parameter In Type Required Description
price_list_id path integer true The ID of the Price List requested.

Responses

Status Meaning Description Schema
204 No Content An empty response. None

getPriceListRecordCollection

import requests
headers = {
  'Accept': 'application/json'
}


r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records', params={


}, headers = headers)


print r.json()


require 'rest-client'
require 'json'


headers = {
  'Accept' ='application/json'
}


result = RestClient.get 'https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records',
  params: {
  }, headers: headers


p JSON.parse(result)


GET /pricelists/{price_list_id}/records

Fetches the Price Records associated with a particular Price List, using a filter.

Parameters

Parameter In Type Required Description
variant_id query integer false The ID of the Variant whose prices were requested.
product_id query string false A comma-separated list of ids of Products whose prices were requested.
currency query string(ISO-4217) false Filter items by currency.
page query integer false Specifies the page number in a limited (paginated) list of products.
limit query integer false Controls the number of items per page in a limited (paginated) list of products.
include query string false Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include bulk_pricing_tiers and sku. Other values will be ignored.
price query number false Filter items by price.
sale_price query number false Filter items by sale_price.
retail_price query number false Filter items by retail_price.
map_price query number false Filter items by map_price.
calculated_price query number false Filter items by calculated_price.
date_created query string(date-time) false Filter items by date_created.
date_modified query string(date-time) false Filter items by date_modified.
price_list_id path integer true The ID of the Price List requested.

Enumerated Values

Parameter Value
include bulk_pricing_tiers
include sku
{
  "data": [
    {
      "calculated_price": 0,
      "date_created": "2018-02-23T20:53:52Z",
      "date_modified": "2018-02-23T20:53:52Z",
      "product_id": 0,
      "price_list_id": 0,
      "variant_id": 0,
      "sku": "string",
      "currency": "string",
      "price": 0,
      "sale_price": 0,
      "retail_price": 0,
      "map_price": 0,
      "bulk_pricing_tiers": [
        {
          "quantity_min": 0,
          "quantity_max": 0,
          "type": "fixed",
          "amount": 0
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

Responses

Status Meaning Description Schema
200 OK An array of prices and metadata. PriceRecordCollectionResponse

setPriceListRecordCollection

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-Strict-Mode': '0'
}


r = requests.put('https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records', params={


}, headers = headers)


print r.json()


require 'rest-client'
require 'json'


headers = {
  'Content-Type' ='application/json',
  'Accept' ='application/json',
  'X-Strict-Mode' ='0'
}


result = RestClient.put 'https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records',
  params: {
  }, headers: headers


p JSON.parse(result)


PUT /pricelists/{price_list_id}/records

Creates or updates a batch of Price Records associated with a particular Price List. The collection of price records is an array. There can be up to 1000 at once. If it is successful then it returns a blank body and a 200 response. Price List Records must be identified by either Variant ID or SKU.

[
  {
    "variant_id": 0,
    "sku": "string",
    "currency": "string",
    "price": 0,
    "sale_price": 0,
    "retail_price": 0,
    "map_price": 0,
    "bulk_pricing_tiers": [
      {
        "quantity_min": 0,
        "quantity_max": 0,
        "type": "fixed",
        "amount": 0
      }
    ]
  }
]

Parameters

Parameter In Type Required Description
X-Strict-Mode header integer false Header that determines whether the Batch API operates in strict mode or not. Strict mode will reject the entire request if any item in the batch has an error.
variant_id number The variant with which this price set is associated. Either variant_id or sku is required.
sku string The SKU code associated with this Price Record if requested and it exists.
currency string The 3-letter currency code with which this price set is associated.
price number The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product.
sale_price number The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant.
retail_price number The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant.
map_price number The MAP (Manufacturer’s Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant
bulk_pricing_tiers array
quantity_min number The minimum quantity of associated variant in the cart needed to qualify for this tiers pricing.
quantity_max number The maximum allowed quantity of associated variant in the cart to qualify for this tiers pricing.
type enum The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.
fixed string
price string
percent string
amount number The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier.
price_list_id path integer true The ID of the Price List requested.

X-Strict-Mode : Batch API operates in strict or non-strict mode. Strict mode will reject the entire request if any item in the batch has an error. For example, if a variant that you are trying to update has been deleted from the catalog, in Strict Mode the entire request will fail and no records will be updated. In non-strict mode, this case will return one error related to the failed record and all of the other Price Record changes will be committed.

{
  "batch_errors": [
    {
      "data": {
        "price_list_id": 0,
        "variant_id": 0,
        "sku": "string",
        "currency": "string"
      },
      "field_errors": {
        "property1": "string",
        "property2": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success response for batch PUT of Price Records. Empty object for Success case for Batch API
422 Unprocessable Entity Error response for batch PUT of Price Records. May include errors during partial update in non-strict mode. PriceRecordBatchErrorResponse

deletePriceListRecordsByFilter

import requests
headers = {
  'Accept': 'application/json'
}


r = requests.delete('https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records', params={


}, headers = headers)


print r.json()


require 'rest-client'
require 'json'


headers = {
  'Accept' ='application/json'
}


result = RestClient.delete 'https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records',
  params: {
  }, headers: headers


p JSON.parse(result)


DELETE /pricelists/{price_list_id}/records

Deletes one or more Price Record objects from BigCommerce using a filter.

Parameters

Parameter In Type Required Description
variant_id query integer false The ID of the Variant whose prices were requested.
price_list_id path integer true The ID of the Price List requested.
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

Responses

Status Meaning Description Schema
204 No Content An empty response. NoContent

getPriceListRecordsByVariantId

import requests
headers = {
  'Accept': 'application/json'
}


r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records/{variant_id}', params={


}, headers = headers)


print r.json()


require 'rest-client'
require 'json'


headers = {
  'Accept' ='application/json'
}


result = RestClient.get 'https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records/{variant_id}',
  params: {
  }, headers: headers


p JSON.parse(result)


GET /pricelists/{price_list_id}/records/{variant_id}

Fetches an array of Price Records matching a particular Price List and Variant ID. Will return an array of any available records in any currency.

Parameters

Parameter In Type Required Description
price_list_id path integer true The ID of the Price List requested.
variant_id path integer true ID of the variant on a product, or on an associated Price List Record.
{
  "data": [
    {
      "calculated_price": 0,
      "date_created": "2018-02-23T20:53:52Z",
      "date_modified": "2018-02-23T20:53:52Z",
      "product_id": 0,
      "price_list_id": 0,
      "variant_id": 0,
      "sku": "string",
      "currency": "string",
      "price": 0,
      "sale_price": 0,
      "retail_price": 0,
      "map_price": 0,
      "bulk_pricing_tiers": [
        {
          "quantity_min": 0,
          "quantity_max": 0,
          "type": "fixed",
          "amount": 0
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

Responses

Status Meaning Description Schema
200 OK An array of prices and metadata. PriceRecordCollectionResponse

deletePriceListRecordsByVariantId

import requests


r = requests.delete('https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records/{variant_id}', params={


)


print r.json()


require 'rest-client'
require 'json'


result = RestClient.delete 'https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records/{variant_id}',
  params: {
  }


p JSON.parse(result)


DELETE /pricelists/{price_list_id}/records/{variant_id}

Deletes the collection of Price Record objects associated with a certain price list and variant ID.

Parameters

Parameter In Type Required Description
price_list_id path integer true The ID of the Price List requested.
variant_id path integer true ID of the variant on a product, or on an associated Price List Record.

Responses

Status Meaning Description Schema
204 No Content An empty response. None

getPriceListRecord

Get a single Price List Record, specified by Price List ID, Variant ID, and Currency.

import requests
headers = {
  'Accept': 'application/json'
}


r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records/{variant_id}/{currency_code}', params={


}, headers = headers)


print r.json()


require 'rest-client'
require 'json'


headers = {
  'Accept' ='application/json'
}


result = RestClient.get 'https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records/{variant_id}/{currency_code}',
  params: {
  }, headers: headers


p JSON.parse(result)


GET /pricelists/{price_list_id}/records/{variant_id}/{currency_code}

Returns a Price Record object from BigCommerce.

Parameters

Parameter In Type Required Description
include query string false Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include bulk_pricing_tiers and sku. Other values will be ignored.
price_list_id path integer true The ID of the Price List requested.
variant_id path integer true ID of the variant on a product, or on an associated Price List Record.
currency_code path string(ISO-4217) true The currency code associated with the price record being acted upon.

Enumerated Values

Parameter Value
include bulk_pricing_tiers
include sku
{
  "data": {
    "calculated_price": 0,
    "date_created": "2018-02-23T20:53:52Z",
    "date_modified": "2018-02-23T20:53:52Z",
    "product_id": 0,
    "price_list_id": 0,
    "variant_id": 0,
    "sku": "string",
    "currency": "string",
    "price": 0,
    "sale_price": 0,
    "retail_price": 0,
    "map_price": 0,
    "bulk_pricing_tiers": [
      {
        "quantity_min": 0,
        "quantity_max": 0,
        "type": "fixed",
        "amount": 0
      }
    ]
  },
  "meta": {}
}

Responses

Status Meaning Description Schema
200 OK An array of prices and metadata. PriceRecordResponse

setPriceListRecord

Upsert (create if not exist, otherwise update) a single Price List Record, specified by Price List ID, Variant ID, and Currency.

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}


r = requests.put('https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records/{variant_id}/{currency_code}', params={


}, headers = headers)


print r.json()


require 'rest-client'
require 'json'


headers = {
  'Content-Type' ='application/json',
  'Accept' ='application/json'
}


result = RestClient.put 'https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records/{variant_id}/{currency_code}',
  params: {
  }, headers: headers


p JSON.parse(result)


PUT /pricelists/{price_list_id}/records/{variant_id}/{currency_code}

Creates or updates a single Price Record object.

{
  "price": 0,
  "sale_price": 0,
  "retail_price": 0,
  "map_price": 0,
  "bulk_pricing_tiers": [
    {
      "quantity_min": 0,
      "quantity_max": 0,
      "type": "fixed",
      "amount": 0
    }
  ],
  "sku": "string"
}

Parameters

Parameter In Type Required Description
body body PriceRecordPut true A BigCommerce Price Record object.
price_list_id path integer true The ID of the Price List requested.
variant_id path integer true ID of the variant on a product, or on an associated Price List Record.
currency_code path string(ISO-4217) true The currency code associated with the price record being acted upon.
sku body string false The SKU code associated with the variant. May be used in lieu of variant_id to identify the variant if variant_id is set to 0.
{
  "data": {
    "calculated_price": 0,
    "date_created": "2018-02-23T20:53:52Z",
    "date_modified": "2018-02-23T20:53:52Z",
    "product_id": 0,
    "price_list_id": 0,
    "variant_id": 0,
    "sku": "string",
    "currency": "string",
    "price": 0,
    "sale_price": 0,
    "retail_price": 0,
    "map_price": 0,
    "bulk_pricing_tiers": [
      {
        "quantity_min": 0,
        "quantity_max": 0,
        "type": "fixed",
        "amount": 0
      }
    ]
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK A price record. PriceRecordResponse
404 Not Found The resource was not found. NotFound
409 Conflict Price Record was in conflict with another price record. This is the result of duplicate unique values. ErrorResponse
422 Unprocessable Entity Price Record was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

deletePriceListRecord

import requests


r = requests.delete('https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records/{variant_id}/{currency_code}', params={


)


print r.json()


require 'rest-client'
require 'json'


result = RestClient.delete 'https://api.bigcommerce.com/stores/{store_id}/v3/pricelists/{price_list_id}/records/{variant_id}/{currency_code}',
  params: {
  }


p JSON.parse(result)


DELETE /pricelists/{price_list_id}/records/{variant_id}/{currency_code}

Deletes one Price Record object from BigCommerce, specified by Price List ID, Variant ID, and Currency.

Parameters

Parameter In Type Required Description
price_list_id path integer true The ID of the Price List requested.
variant_id path integer true ID of the variant on a product, or on an associated Price List Record.
currency_code path string(ISO-4217) true The currency code associated with the price record being acted upon.

Responses

Status Meaning Description Schema
204 No Content An empty response. None

PriceList Object References

PriceList

Common Price List properties.

Name Type Description
id (optional) integer The unique numeric ID of the Price List; increments sequentially.
date_created (optional) DateTime string The date on which the Price List was created.
date_modified (optional) DateTime string The date on which the Price List was created.
name (optional) string The unique name of the Price List.
currency (optional) ISO-4217 string The currency that applies for this Price List.

PriceListBase

Common Price List properties.

Name Type Description
name (optional) string The unique name of the Price List.
currency (optional) ISO-4217 string The currency that applies for this Price List.

PriceListCollectionResponse

Response payload for the BigCommerce API.

Name Type Description
data (optional) array
id number The unique numeric ID of the Price List; increments sequentially.
date_created string The date on which the Price List was created.
date_modified string The date on which the Price List was modified.
record_count number The number of Price Records associated with this Price List.
name string The unique name of the Price List
meta (optional) array Data about the response, including pagination and collection totals.
total number Total number of items in the result set.
count number Total number of items in the collection response.
per_page number The amount of items returned in the collection per page, controlled by the limit parameter.
current_page number The page you are currently on within the collection.
total_pages number The total number of pages in the collection.
links array Pagination links for the previous and next parts of the whole collection.
previous string Link to the previous page returned in the response.
current string Link to the current page returned in the response.
next Link to the next page returned in the response.

PriceListPost

Common Price List properties.

Name Type Description
name (optional) string The unique name of the Price List.
currency (optional) ISO-4217 string The currency that applies for this Price List.

PriceListPut

Common Price List properties.

Name Type Description
name (optional) string The unique name of the Price List.
active boolean Whether or not this Price List and its prices are active. Defaults to true.

PriceListResponse

Response payload for the BigCommerce API.

Name Type Description
data (optional) object inline_response_200_40_data
id number The unique numeric ID of the Price List; increments sequentially.
date_created string The date on which the Price List was created.
date_modified string The date on which this object was last updated.
record_count number The number of Price Records associated with this Price List.
name string The unique name of the Price List
active boolean Whether or not this Price List and its prices are active. Defaults to true.
meta (optional) object Empty meta object; might be used later.

PriceRecord

Common Price Record properties.

Name Type Description
price (optional) double float (number) The list price for the variant in the catalog for this Price List. Overrides any existing list price for variant/product.
sale_price (optional) double float (number) The sale price for the variant in the catalog for this Price List. Overrides any existing sale price for variant/product. If empty, the sale price will be treated as not being set on this product.
retail_price (optional) double float (number) The retail price for the variant in the catalog for this Price List. Overrides any existing retail price for variant/product. If empty, the retail price will be treated as not being set on this product.
cost_price (optional) double float (number) The cost price for the variant in the catalog for this Price List. Overrides any existing cost price for variant/product. If empty, the cost price will be treated as not being set on this product.
map_price (optional) double float (number) The MAP for the variant in the catalog for this Price List. Overrides any existing MAP price for variant/product. If empty, the MAP price will be treated as not being set on this product.
id (optional) integer The unique numeric ID of the price entry; increments sequentially.
date_created (optional) DateTime string The date on which the Price entry was created.
date_modified (optional) DateTime string The date on which the Price entry was updated.
price_list_id (optional) integer The Price List with which this price set is associated.
variant_id (optional) integer The variant with which this price set is associated.

PriceRecordBase

Common Price Record properties.

Name Type Description
price (required) double float (number) The list price for the variant in the catalog for this Price List. Overrides any existing list price for variant/product.
sale_price (optional) double float (number) The sale price for the variant in the catalog for this Price List. Overrides any existing sale price for variant/product. If null, the sale price will be treated as not being set on this product.
retail_price (optional) double float (number) The retail price for the variant in the catalog for this Price List. Overrides any existing retail price for variant/product. If null, the retail price will be treated as not being set on this product.
map_price (optional) double float (number) The MAP for the variant in the catalog for this Price List. Overrides any existing MAP price for variant/product. If null, the MAP price will be treated as not being set on this product.

PriceRecordCollectionResponse

Response payload for the BigCommerce API.

Name Type Description
data (optional) array The Price Record Object
calculated_price number The price of the variant as seen on the storefront if a price record is in effect. It will be equal to the sale_price, if set, and the price if there is not a sale_price. Read only
date_created (optional) DateTime string The date on which the Price entry was created.
date_modified (optional) DateTime string The date on which the Price entry was updated.
product_id number The id of the Product this Price Record’s variant_id is associated with. Read only.
price number The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product.
sale_price number The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant.
retail_price number The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant.
map_price number The MAP (Manufacturer’s Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant.
bulk_pricing_tiers array If included, this is an array of any bulk pricing tiers specified on the record. If set to an empty array, removes all bulk pricing tiers.
quantity_min number The minimum quantity of associated variant in the cart needed to qualify for this tiers pricing.
quantity_max number The maximum allowed quantity of associated variant in the cart to qualify for this tiers pricing.
type enum The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.
amount number The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier. For example, a value of 10 with type percent will discount by 10%. A value of 5 with type fixed will set the price to $5 when this tier is satisfied.
sku string The SKU code associated with this Price Record if requested and it exists.
meta (optional) array
meta (optional) array Data about the response, including pagination and collection totals.
total number Total number of items in the result set.
count number Total number of items in the collection response.
per_page number The amount of items returned in the collection per page, controlled by the limit parameter.
current_page number The page you are currently on within the collection.
total_pages number The total number of pages in the collection.
links array Pagination links for the previous and next parts of the whole collection.
previous string Link to the previous page returned in the response.
current string Link to the current page returned in the response.
next Link to the next page returned in the response.

PriceRecordPut

Common Price Record properties.

Name Type Description
price (required) double float (number) The list price for the variant in the catalog for this Price List. Overrides any existing list price for variant/product.
sale_price (optional) double float (number) The sale price for the variant in the catalog for this Price List. Overrides any existing sale price for variant/product. If null, the sale price will be treated as not being set on this product.
retail_price (optional) double float (number) The retail price for the variant in the catalog for this Price List. Overrides any existing retail price for variant/product. If null, the retail price will be treated as not being set on this product.
map_price (optional) double float (number) The MAP for the variant in the catalog for this Price List. Overrides any existing MAP price for variant/product. If null, the MAP price will be treated as not being set on this product.

PriceRecordResponse

Response payload for the BigCommerce API.

Name Type Description
data (optional) array The Price Record Object
calculated_price number The price of the variant as seen on the storefront if a price record is in effect. It will be equal to the sale_price, if set, and the price if there is not a sale_price. Read only
date_created (optional) DateTime string The date on which the Price entry was created.
date_modified (optional) DateTime string The date on which the Price entry was updated.
product_id number The id of the Product this Price Record’s variant_id is associated with. Read only.
price number The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product.
sale_price number The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant.
retail_price number The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant.
map_price number The MAP (Manufacturer’s Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant.
bulk_pricing_tiers array
quantity_min number The minimum quantity of associated variant in the cart needed to qualify for this tiers pricing.
quantity_max number The maximum allowed quantity of associated variant in the cart to qualify for this tiers pricing.
type enum The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.
fixed string
price string
percent string
amount number The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier.
sku string The SKU code associated with this Price Record if requested and it exists.
meta (optional) object Empty meta object; might be used later.

ErrorResponse

Error payload for the BigCommerce API.

Name Type Description
status (optional) integer The HTTP status code.
title (optional) string The error title describing the particular error.
type (optional) string [Description to follow.]
instance (optional) string [Description to follow.]
errors (optional) string map [Description to follow.]

Price Record Batch Error Response

Name Type Description
batch_errors array Error during Price Record batch PUT. Includes data sent in the request and errors.
price_list number The Price List with which this price set is associated
variant_id number The variant with which this price set is associated. Either variant_id or sku is required.
sku string The variant with which this price set is associated. Either sku or variant_id is required.
currency string The 3-letter currency code with which this price set is associated.
field_errors object The error title describing the particular error.