Get All Price Lists

Beta

GET

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

GET

/stores/store_hash/v3/pricelists

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

200Price Lists_getAllPriceLists_example

1 {
2   "data": [
3     {
4       "id": 101,
5       "name": "North America Retail",
6       "date_created": "2023-11-15T09:20:00Z",
7       "date_modified": "2024-04-10T12:45:30Z",
8       "active": true,
9       "layers": []
10     },
11     {
12       "id": 102,
13       "name": "B2B Wholesale",
14       "date_created": "2023-11-15T09:25:00Z",
15       "date_modified": "2023-11-15T09:25:00Z",
16       "active": true,
17       "layers": [
18         {
19           "price_list_id": 103
20         }
21       ]
22     }
23   ],
24   "meta": {
25     "pagination": {
26       "total": 2,
27       "count": 2,
28       "per_page": 50,
29       "current_page": 1,
30       "total_pages": 1
31     }
32   }
33 }

Returns a list of price lists. Use this endpoint to see the layers configured on each price list.

Authentication

X-Auth-Tokenstring

API account access token.

Response

datalist of objects

metaobject

Authentication

Headers

Response