List Price List Records

GET

https://api.bigcommerce.com/stores/:store_hash/v3/pricelists/:price_list_id/records

GET

/stores/:store_hash/v3/pricelists/:price_list_id/records

curl https://api.bigcommerce.com/stores/store_hash/v3/pricelists/1/records \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

{
  "data": [
    {
      "calculated_price": 25.48,
      "date_created": "2022-09-17T20:33:14Z",
      "date_modified": "2022-09-17T20:33:14Z",
      "product_id": 187,
      "price_list_id": 3,
      "variant_id": 358,
      "currency": "usd",
      "price": 25.48,
      "sale_price": 18.57,
      "retail_price": 25.48,
      "map_price": 18.57,
      "bulk_pricing_tiers": []
    },
    {
      "calculated_price": 31.31,
      "date_created": "2022-09-17T20:33:14Z",
      "date_modified": "2022-09-17T20:33:14Z",
      "product_id": 188,
      "price_list_id": 3,
      "variant_id": 359,
      "currency": "usd",
      "price": 31.31,
      "sale_price": 31.31,
      "retail_price": 31.31,
      "map_price": 31.31,
      "bulk_pricing_tiers": []
    },
    {
      "calculated_price": 18.57,
      "date_created": "2022-09-17T20:33:14Z",
      "date_modified": "2022-09-17T20:33:14Z",
      "product_id": 189,
      "price_list_id": 3,
      "variant_id": 360,
      "currency": "usd",
      "price": 18.57,
      "sale_price": 18.57,
      "retail_price": 18.57,
      "map_price": 18.57,
      "bulk_pricing_tiers": []
    },
    {
      "calculated_price": 22.54,
      "date_created": "2022-09-17T20:33:14Z",
      "date_modified": "2022-09-17T20:33:14Z",
      "product_id": 190,
      "price_list_id": 3,
      "variant_id": 361,
      "currency": "usd",
      "price": 22.54,
      "sale_price": 22.54,
      "retail_price": 22.54,
      "map_price": 22.54,
      "bulk_pricing_tiers": []
    },
    {
      "calculated_price": 27.39,
      "date_created": "2022-09-17T20:33:14Z",
      "date_modified": "2022-09-17T20:51:26Z",
      "product_id": 191,
      "price_list_id": 3,
      "variant_id": 362,
      "currency": "usd",
      "price": 27.39,
      "sale_price": 27.39,
      "retail_price": 27.39,
      "map_price": 27.39,
      "bulk_pricing_tiers": [
        {
          "quantity_min": 10,
          "quantity_max": 19,
          "type": "percent",
          "amount": 1
        },
        {
          "quantity_min": 20,
          "quantity_max": 29,
          "type": "percent",
          "amount": 3
        },
        {
          "quantity_min": 30,
          "quantity_max": 2147483647,
          "type": "percent",
          "amount": 5
        }
      ]
    },
    {
      "calculated_price": 9.8,
      "date_created": "2022-09-17T20:33:14Z",
      "date_modified": "2022-09-17T20:33:14Z",
      "product_id": 192,
      "price_list_id": 3,
      "variant_id": 382,
      "currency": "usd",
      "price": 9.8,
      "sale_price": 9.8,
      "retail_price": 9.8,
      "map_price": 9.8,
      "bulk_pricing_tiers": []
    },
    {
      "calculated_price": 24.5,
      "date_created": "2022-09-17T20:33:14Z",
      "date_modified": "2022-09-17T20:33:14Z",
      "product_id": 192,
      "price_list_id": 3,
      "variant_id": 383,
      "currency": "usd",
      "price": 24.5,
      "sale_price": 24.5,
      "retail_price": 24.5,
      "map_price": 24.5,
      "bulk_pricing_tiers": []
    },
    {
      "calculated_price": 24.5,
      "date_created": "2022-09-17T20:33:14Z",
      "date_modified": "2022-09-17T20:33:14Z",
      "product_id": 192,
      "price_list_id": 3,
      "variant_id": 384,
      "currency": "usd",
      "price": 24.5,
      "sale_price": 24.5,
      "retail_price": 24.5,
      "map_price": 24.5,
      "bulk_pricing_tiers": []
    },
    {
      "calculated_price": 9.8,
      "date_created": "2022-09-17T20:33:14Z",
      "date_modified": "2022-09-17T20:33:14Z",
      "product_id": 193,
      "price_list_id": 3,
      "variant_id": 385,
      "currency": "usd",
      "price": 9.8,
      "sale_price": 9.8,
      "retail_price": 9.8,
      "map_price": 9.8,
      "bulk_pricing_tiers": []
    },
    {
      "calculated_price": 10.78,
      "date_created": "2022-09-17T20:33:14Z",
      "date_modified": "2022-09-17T20:33:14Z",
      "product_id": 194,
      "price_list_id": 3,
      "variant_id": 386,
      "currency": "usd",
      "price": 10.78,
      "sale_price": 10.78,
      "retail_price": 10.78,
      "map_price": 10.78,
      "bulk_pricing_tiers": []
    },
    {
      "calculated_price": 10.78,
      "date_created": "2022-09-17T20:33:14Z",
      "date_modified": "2022-09-17T20:35:42Z",
      "product_id": 195,
      "price_list_id": 3,
      "variant_id": 388,
      "currency": "usd",
      "price": 10.78,
      "sale_price": 10.78,
      "retail_price": 10.78,
      "map_price": 10.78,
      "bulk_pricing_tiers": [
        {
          "quantity_min": 2,
          "quantity_max": 9,
          "type": "percent",
          "amount": 1
        },
        {
          "quantity_min": 10,
          "quantity_max": 19,
          "type": "percent",
          "amount": 2
        },
        {
          "quantity_min": 20,
          "quantity_max": 2147483647,
          "type": "percent",
          "amount": 3
        }
      ]
    },
    {
      "calculated_price": 18.62,
      "date_created": "2022-09-17T20:33:14Z",
      "date_modified": "2022-09-17T20:35:42Z",
      "product_id": 195,
      "price_list_id": 3,
      "variant_id": 389,
      "currency": "usd",
      "price": 18.62,
      "sale_price": 18.62,
      "retail_price": 18.62,
      "map_price": 18.62,
      "bulk_pricing_tiers": [
        {
          "quantity_min": 2,
          "quantity_max": 9,
          "type": "percent",
          "amount": 1
        },
        {
          "quantity_min": 10,
          "quantity_max": 19,
          "type": "percent",
          "amount": 2
        },
        {
          "quantity_min": 20,
          "quantity_max": 2147483647,
          "type": "percent",
          "amount": 3
        }
      ]
    },
    {
      "calculated_price": 10.78,
      "date_created": "2022-09-17T20:33:14Z",
      "date_modified": "2022-09-17T20:35:42Z",
      "product_id": 195,
      "price_list_id": 3,
      "variant_id": 390,
      "currency": "usd",
      "price": 10.78,
      "sale_price": 10.78,
      "retail_price": 10.78,
      "map_price": 10.78,
      "bulk_pricing_tiers": [
        {
          "quantity_min": 2,
          "quantity_max": 9,
          "type": "percent",
          "amount": 1
        },
        {
          "quantity_min": 10,
          "quantity_max": 19,
          "type": "percent",
          "amount": 2
        },
        {
          "quantity_min": 20,
          "quantity_max": 2147483647,
          "type": "percent",
          "amount": 3
        }
      ]
    },
    {
      "calculated_price": 10.78,
      "date_created": "2022-09-17T20:33:14Z",
      "date_modified": "2022-09-17T20:35:42Z",
      "product_id": 195,
      "price_list_id": 3,
      "variant_id": 391,
      "currency": "usd",
      "price": 10.78,
      "sale_price": 10.78,
      "retail_price": 10.78,
      "map_price": 10.78,
      "bulk_pricing_tiers": [
        {
          "quantity_min": 2,
          "quantity_max": 9,
          "type": "percent",
          "amount": 1
        },
        {
          "quantity_min": 10,
          "quantity_max": 19,
          "type": "percent",
          "amount": 2
        },
        {
          "quantity_min": 20,
          "quantity_max": 2147483647,
          "type": "percent",
          "amount": 3
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 14,
      "count": 14,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1
    },
    "cursor_pagination": {
      "count": 1,
      "per_page": 50,
      "start_cursor": "MTUsMjEx",
      "end_cursor": "MTUsMjEx",
      "links": {}
    }
  }
}

Returns a list of Price List Records associated with a Price List.

Notes

Supports up to 10 simultaneous GET requests. Running more than the allowed number of requests concurrently on the same store will result in a 429 status error and your additional requests will fail.
Store Pricelist Records data to reduce the number of calls and maximize performance.

Returns a list of *Price List Records* associated with a *Price List*. **Notes** * Supports up to 10 simultaneous GET requests. Running more than the allowed number of requests concurrently on the same store will result in a `429` status error and your additional requests will fail. * Store Pricelist Records data to reduce the number of calls and maximize performance.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Products	modify	`store_v2_products`
Products	read-only	`store_v2_products_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

price_list_idintegerRequired

The ID of the Price List requested.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

variant_id:inlist of integersOptional

A comma-separated list of IDs for one or more variants for which prices were requested.

product_id:inlist of integersOptional

A comma-separated list of IDs for one or more products for which prices were requested.

currencystringOptionalformat: "ISO-4217"

Filter items by currency.

pageintegerOptional

Specifies the page number in a limited (paginated) list of products.

limitintegerOptional

Controls the number of items per page in a limited (paginated) list of products. If you provide only a limit, the API returns both paginations while applying that limit.

beforestringOptional

A cursor that can be used for backwards pagination. Will fetch results before the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'after' query parameter.

afterstringOptional

A cursor that can be used for forwards pagination. Will fetch results after the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'before' query parameter.

includelist of enumsOptional

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.

Allowed values:

pricedoubleOptional

Filter items by price.

sale_pricedoubleOptional

Filter items by sale_price.

retail_pricedoubleOptional

Filter items by retail_price.

map_pricedoubleOptional

Filter items by map_price.

calculated_pricedoubleOptional

Filter items by calculated_price.

date_createddatetimeOptional

Filter items by date_created.

date_modifieddatetimeOptional

Filter items by date_modified. For example v3/catalog/products?date_last_imported:min=2022-06-15

skustringOptional

Filter items by SKU.

sku:inlist of stringsOptional

Filter results to those whose SKU is in this list.

currency:inlist of stringsOptional

Filter results to those whose currency is in this list.

price:maxdoubleOptional

Filter results to those whose price is less than or equal to this value.

price:mindoubleOptional

Filter results to those whose price is greater than or equal to this value.

sale_price:maxdoubleOptional

Filter results to those whose sale price is less than or equal to this value.

sale_price:mindoubleOptional

Filter results to those whose sale price is greater than or equal to this value.

retail_price:maxdoubleOptional

Filter results to those whose retail price is less than or equal to this value.

retail_price:mindoubleOptional

Filter results to those whose retail price is greater than or equal to this value.

map_price:maxdoubleOptional

Filter results to those whose MAP (minimum advertised price) is less than or equal to this value.

map_price:mindoubleOptional

Filter results to those whose MAP (minimum advertised price) is greater than or equal to this value.

calculated_price:maxdoubleOptional

Filter results to those whose calculated price is less than or equal to this value.

calculated_price:mindoubleOptional

Filter results to those whose calculated price is greater than or equal to this value.

date_created:maxstringOptional

Filter results to those created on or before this date.

date_created:minstringOptional

Filter results to those created on or after this date.

date_modified:maxstringOptional

Filter results to those modified on or before this date.

date_modified:minstringOptional

Filter results to those modified on or after this date.

Response

datalist of objectsOptional

metaobjectOptional

‘Contains data about paginating the response via cursors. If no pagination details are specified or if you only provide a limit, then both properties will be present. When a ‘before’ or ‘after’ cursor is provided, only the ‘cursor_pagination’ property will be present. When a ‘page’ parameter is provided, only the offset based ‘pagination’ property will be present.’

Errors

429

Too Many Requests Error

List Price List Records

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Headers

Query parameters

Response

Errors

OAuth scopes

Authentication header

Further reading