Order Products - Hands-on Lab

In this lab, you will:

• Create an order with a custom product
• Add a product with options to an order
• List order products

Prerequisites

• BigCommerce store (sandbox or live)
• Basic knowledge of APIs
• REST client (Postman)

Create a Custom Order

1. Copy and paste the request below into Postman

https://api.bigcommerce.com/stores/{{store_hash}}/v2/orders

2. Copy and paste the code below into the Body section of Postman

{
    "products": [
        {
            "name": "Custom Product",
            "price_inc_tax": 10.83,
            "price_ex_tax": 10,
            "sku": "123custom",
            "quantity": 1
        }
        ],
    "billing_address": {
    "first_name": "John",
    "last_name": "Smith",
    "company": "",
    "street_1": "123 Main Street",
    "street_2": "",
    "city": "Austin",
    "state": "Texas",
    "zip": "78704",
    "country": "United States",
    "country_iso2": "US",
    "phone": "5555555555",
    "email": "jsmith@email.com"
    },
    "status_id": 11
}

3. Select POST next to the request url
4. Click the Send button
5. Observe response

Add a Product with Options to an Order

1. GET the option_values > id and option_values > option_id
2. Copy and paste the request below into Postman

https://api.bigcommerce.com/stores/{{store_hash}}/v3/catalog/products/{product_id}/variants

3. Replace {product_id} with the ID of a product in the store
4. Make note of the option_values > id and option_values > option_id . These will be passed into the products array
5. Copy and paste the request below into Postman

https://api.bigcommerce.com/stores/{{store_hash}}/v2/orders/{order_id}

6. Replace {order_id} with the order ID to be updated
7. Copy and paste the code below into the body section of Postman

{
        "products": [
            {
                "product_id": {product_id},
            "product_options": [
                {
                    "id": {option_values > option_id},
                    "value": "{option_values > id}"
                },
                {
                    "id": {option_values > option_id},
                    "value": "{option_values > id}"
                }
        ],
        "quantity": 1
        }
    ]
}

8. Replace {product_id} with the ID of the product with option to be added to the order
9. Replace {option_values > option_id} with the option ID retrieved previously
10. Replace {option_values > id} with the option ID retrieved previously
11. Select PUT next to the request url
12. Click the Send button
13. Observe response

List Order Products

1. Copy and paste the request below into Postman

https://api.bigcommerce.com/stores/{{store_hash}}/v2/orders/{order_id}/products

2. Replace {order_id} with the ID of an order
3. Select GET next to the request url
4. Click the Send button
5. Observe response