NAV
Subscribe to developer updates

v3 API Reference

PriceLists

BigCommerce Price Lists API Definition.

getPriceListCollection

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

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

print r.json()

GET /pricelists

Returns a paginated collection of Price List objects from BigCommerce.

Parameters

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

Example responses

{
  "data": [
    {
      "id": 0,
      "date_created": "2017-08-10T19:38:09Z",
      "date_modified": "2017-08-10T19:38:09Z",
      "name": "string",
      "currency": "string"
    }
  ],
  "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

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

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

)

print r.json()

POST /pricelists

Creates a Price List in BigCommerce.

Body parameter

{
  "name": "string",
  "currency": "string"
}

Parameters

Parameter Type Required Description
undefined object false No description
body PriceListPost true A BigCommerce PriceList object.
» name string false The unique name of the Price List.
» currency string(ISO-4217) false The currency that applies for this Price List.

Example responses

{
  "data": {
    "id": 0,
    "date_created": "2017-08-10T19:38:09Z",
    "date_modified": "2017-08-10T19:38:09Z",
    "name": "string",
    "currency": "string"
  },
  "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

getPriceList

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

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

print r.json()

GET /pricelists/{price_list_id}

Returns a Price List object from BigCommerce.

Parameters

Parameter Type Required Description
price_list_id number(integer) true The ID of the Price List requested.

Example responses

{
  "data": {
    "id": 0,
    "date_created": "2017-08-10T19:38:09Z",
    "date_modified": "2017-08-10T19:38:09Z",
    "name": "string",
    "currency": "string"
  },
  "meta": {}
}

Responses

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

updatePriceList

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

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

)

print r.json()

PUT /pricelists/{price_list_id}

Updates a single Price List object.

Body parameter

{
  "name": "string",
  "currency": "string"
}

Parameters

Parameter Type Required Description
undefined object false No description
price_list_id number(integer)(integer) true The ID of the Price List requested.
body PriceListPut true A BigCommerce Price List object.
» name string false The unique name of the Price List.
» currency string(ISO-4217) false The currency that applies for this Price List.

Example responses

{
  "data": {
    "id": 0,
    "date_created": "2017-08-10T19:38:09Z",
    "date_modified": "2017-08-10T19:38:09Z",
    "name": "string",
    "currency": "string"
  },
  "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

Code samples

import requests

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

print r.json()

DELETE /pricelists/{price_list_id}

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

Parameters

Parameter Type Required Description
price_list_id number(integer)(integer)(integer) true The ID of the Price List requested.

Responses

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

getPriceListRecordCollection

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

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

print r.json()

GET /pricelists/{price_list_id}/records

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

Parameters

Parameter Type Required Description
price_list_id number(integer)(integer)(integer)(integer) true The ID of the Price List requested.
variant_id integer false The ID of the Variant whose prices were requested.

Example responses

{
  "data": [
    {
      "price": 0,
      "sale_price": 0,
      "retail_price": 0,
      "cost_price": 0,
      "map_price": 0,
      "id": 0,
      "date_created": "2017-08-10T19:38:09Z",
      "date_modified": "2017-08-10T19:38:09Z",
      "price_list_id": 0,
      "variant_id": 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

deletePriceListRecordCollection

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

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

print r.json()

DELETE /pricelists/{price_list_id}/records

Deletes one or more Price Record objects from BigCommerce.

Parameters

Parameter Type Required Description
price_list_id number(integer)(integer)(integer)(integer)(integer) true The ID of the Price List requested.
id integer false Filter items by id.
variant_id integer false The ID of the Variant whose prices were requested.

Example responses

{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

Responses

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

getPriceListRecord

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

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

print r.json()

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

Returns a Price Record object from BigCommerce.

Parameters

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

Example responses

{
  "data": {
    "price": 0,
    "sale_price": 0,
    "retail_price": 0,
    "cost_price": 0,
    "map_price": 0,
    "id": 0,
    "date_created": "2017-08-10T19:38:09Z",
    "date_modified": "2017-08-10T19:38:09Z",
    "price_list_id": 0,
    "variant_id": 0
  },
  "meta": {}
}

Responses

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

setPriceListRecord

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    '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}', params={
 # Coming Soon 
 },
    headers=headers

)

print r.json()

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

Creates or updates a single Price Record object.

Body parameter

{
  "price": 0,
  "sale_price": 0,
  "retail_price": 0,
  "cost_price": 0,
  "map_price": 0
}

Parameters

Parameter Type Required Description
undefined object false No description
price_list_id number(integer)(integer)(integer)(integer)(integer)(integer)(integer) true The ID of the Price List requested.
variant_id number(int)(int)(int)(int)(int)(int)(int)(int)(int)(int)(int) true ID of the variant on a product, or on an associated Price List Record.
body PriceRecordPut true A BigCommerce Price Record object.
» price number(double) false 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(double) false 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(double) false 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.
» cost_price number(double) false The cost price for the variant mapped in a Price List. Overrides any existing or Catalog cost price for the variant/product. If empty, the cost price will be treated as not being set on this variant.
» map_price number(double) false 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.

Example responses

{
  "data": {
    "price": 0,
    "sale_price": 0,
    "retail_price": 0,
    "cost_price": 0,
    "map_price": 0,
    "id": 0,
    "date_created": "2017-08-10T19:38:09Z",
    "date_modified": "2017-08-10T19:38:09Z",
    "price_list_id": 0,
    "variant_id": 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

Code samples

import requests

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

print r.json()

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

Deletes one Price Record object from BigCommerce, by variant_id.

Parameters

Parameter Type Required Description
price_list_id number(integer)(integer)(integer)(integer)(integer)(integer)(integer)(integer) true The ID of the Price List requested.
variant_id number(int)(int)(int)(int)(int)(int)(int)(int)(int)(int)(int)(int) 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

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[inline_response_200_40_data]
meta (optional) inline_response_200_meta

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.
currency (optional) ISO-4217 string The currency that applies for this Price List.

PriceListResponse

Response payload for the Bigcommerce API.

Name Type Description
data (optional) inline_response_200_40_data
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 created.
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 (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.

PriceRecordCollectionResponse

Response payload for the Bigcommerce API.

Name Type Description
data (optional) array[inline_response_200_42_data]
meta (optional) inline_response_200_meta

PriceRecordPut

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.

PriceRecordResponse

Response payload for the Bigcommerce API.

Name Type Description
data (optional) inline_response_200_42_data
meta (optional) object Empty meta object; might be used later.