Orders - Hands-on Lab

Orders API

In this lab, you will:

• Create an order with an existing simple product
• GET an order
• Update an order
• GET a count of orders

Prerequisites

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

Create An Order with An Existing Simple Product

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": [
        {
            "product_id": {simple_product_id},
            "quantity": 1
        }
        ],
    "billing_address": {
    "first_name": "API",
    "last_name": "Order",
    "company": "",
    "street_1": "123 Main Street",
    "street_2": "",
    "city": "Austin",
    "state": "Texas",
    "zip": "78704",
    "country": "United States",
    "country_iso2": "US",
    "phone": "5555555555",
    "email": "api.order@email.com"
    }
}

3. Replace {simple_product_id} with the ID of a simple product in the store
4. Select POST next to the request URL
5. Click the Send button
6. Observe response

GET an Order

1. Copy and paste the request below into Postman

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

2. Replace {order_id} with the id of the order created in the previous steps
3. Select GET next to the request url
4. Click the Send button
5. Observe the response

Update an Order (Update Billing Address)

1. Copy and paste the request below into Postman

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

2. Replace {order_id} with the id of the order created in previous steps
3. Copy and paste the code below into the body section of Postman

{
    "billing_address": {
    "street_1": "321 different Street"
    }
}

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

GET a Count of Orders

1. Copy and paste the request below into Postman

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

2. Select GET next to the request URL
3. Click the Send button
4. Observe response