List Price Records by Variant

GET

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

GET

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

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

{
  "data": [
    {
      "calculated_price": 24.64,
      "date_created": "2022-08-23T19:59:23Z",
      "date_modified": "2022-08-23T19:59:23Z",
      "product_id": 158,
      "price_list_id": 2,
      "variant_id": 325,
      "sku": "SMB-123",
      "currency": "usd",
      "price": 3.99,
      "sale_price": 5.99,
      "retail_price": 6.99,
      "map_price": 5.99,
      "bulk_pricing_tiers": [
        {
          "quantity_min": 1,
          "quantity_max": 10,
          "type": "price",
          "amount": 3
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 36,
      "count": 36,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1
    },
    "cursor_pagination": {
      "count": 1,
      "per_page": 1,
      "start_cursor": "string",
      "end_cursor": "string",
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

Returns Price List Records using the variant ID. Will also contain currency records.

Notes

Supports up to 40 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.

variant_idintegerRequired

ID of the variant on a product, or on an associated Price List Record.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

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:

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.

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