Lab - Price Lists

This lab activity will give you a chance to practice working with price lists. Each step will walk you through how to use all of the endpoints covered in the previous lesson.

Prerequisites:

• BigCommerce store (sandbox or live)
• Basic knowledge of APIs
• REST client (Postman)
• Completion of all previous Catalog API labs

In this lab, you will:

• Get all price lists
• Create a Price List
• Update a Price List
• Set Price List Record by Currency
• Get Price Records by Variant

GET All Price Lists

1. Copy and paste the request below into Postman

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

2. Select GET next to the request url (if not already selected)
3. Click the Send button
4. Observe response

Create a Price List

1. Copy and paste the request below into Postman

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

2. Select POST next to the request url (if not already selected)
3. Copy and paste the code below into the Body section of Postman

{
   "name": "Wholesale group",
   "active": false
}

4. Click the SEND button to send the POST request below to create a price list:

Update a Price List

1. Copy and paste the request below into Postman

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

2. Enter the ID of the price list created in previous lab for price_list_id in the Params tab
3. Copy and paste the code below into the Body section of Postman

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

4. Select PUT next to the request url
5. Click the Send button
6. Observe response and updated price list

Set Price List Record by Currency

1. Copy and paste the request below into Postman

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

2. Enter the ID of the price list created in previous lab for :price_list_id in the Params tab
3. Enter a valid variant ID forvariant_id in the Params tab
4. Enter a valid currency code for currency_code in the Params tab
5. Copy and paste the code below into the Body section of Postman

{
    "price": 12.99,
    "sale_price": 10.99,
    "retail_price": 15.99,
    "map_price": 17.99,
    "bulk_pricing_tiers": [
        {
            "quantity_min": 5,
            "quantity_max": 10,
            "type": "percent",
            "amount": 1
        },
        {
            "quantity_min": 11,
            "quantity_max": 20,
            "type": "percent",
            "amount": 2
        }
    ]
}

6. Click the SEND button to send the PUT request below to create a price list record using the currency code
7. Observe the response

Get Price List Records

1. Copy and paste the request below into Postman

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

2. Enter the ID of the price list created in previous lab for price_list_id in the Params tab
3. Select GET next to the request url (if not already selected)
4. Click the Send button
5. Observe response

Get Price List Records by Variant

1. Copy and paste the request below into Postman

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

2. Enter the ID of the price list created in previous lab for price_list_id in the Params tab
3. Enter a valid variant ID forvariant_id in the Params tab
4. Select GET next to the request url (if not already selected)
5. Click the Send button
6. Observe response

Resources

• Price List API
• Price List Assignments