Checkout API - Hands-on Lab

Checkout API

Allows for a checkout to be created from an existing cart using BigCommerce checkout logic. The existing BigCommerce front-end cart/checkout can be bypassed.In this activity, you will use the Checkout API to view and modify the details of a checkout using an API REST client.

In this lab, you will:

• GET a checkout
• Add checkout billing address
• Update checkout billing address
• Add consignment to checkout
• Update checkout consignment
• Add coupon to checkout
• Delete checkout coupon
• Create an order
• Delete checkout consignment

Prerequisites

• BigCommerce store (sandbox or live)
• API credentials for the store
• REST client (Postman)
• Completion of previous lab

GET a Checkout

1. Open Postman
2. Click the No Environment dropdown in the upper-right
3. Select the environment you created in the previous lab
4. Copy and paste the request below into Postman

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

5. Replace {checkout_id} with a cart/checkout ID
6. Select GET next to the request url
7. Click Send button
8. Observe response and copy a line item ID for next steps

Add Checkout Billing Address

1. Copy and paste the request below into Postman

https://api.bigcommerce.com/stores/{{store_hash}}/v3/checkouts/{checkout_id}/billing-address

2. Replace {checkout_id} with the Checkout ID from the previous steps
3. Copy and paste the code below into the Body section of Postman

{
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane@email.com",
    "address1": "123 Main Street",
    "address2": "",
    "city": "Austin",
    "state_or_province": "Texas",
    "state_or_province_code": "TX",
    "country_code": "US",
    "postal_code": "78751",
    "phone": "1234567890"
}

4. Select POST next to the request url
5. Click the Send button
6. Observe response and copy the address ID

Update Checkout Billing Address

1. Copy and paste the request below into Postman

https://api.bigcommerce.com/stores/{{store_hash}}/v3/checkouts/{checkout_id}/billing-address/{address_id}

2. Replace {checkout_id} with a cart/checkout ID
3. Replace {address_id} with a cart/checkout ID
4. Copy and paste the code below into the body section of Postman

{
    "email": "jenny@email.com",
    "phone": "5128675309"
}

5. Select PUT next to the request url
6. Click the Send button
7. Observe response

Add Consignment to Checkout

1. Copy and paste the request below into Postman

https://api.bigcommerce.com/stores/{{store_hash}}/v3/checkouts/{checkout_id}/consignments?include=consignments.available_shipping_options

2. Replace {checkout_id} with a cart/checkout ID
3. Copy and paste the code below into the Body section of Postman

[
    {
        "shipping_address": {
            "email": "bob@email.com",
            "country_code": "US",
            "first_name": "Bob",
            "last_name": "Ross",
            "address1": "123 Main Street",
            "city": "Austin",
            "state_or_province": "Texas",
            "state_or_province_code": "TX",
            "postal_code": "78751",
            "phone": "5555555555"
        },
        "line_items": [
            {
                "item_id": "{item_id}",
                "quantity": 1
            }
        ]
    }
]

4. Replace {item_id} with the item ID copied in previous steps
5. Select POST next to the request URL
6. Click the Send button
7. Observe response and copy consignment ID and shipping option ID

Update Checkout Consignment

1. Copy and paste the request below into Postman

https://api.bigcommerce.com/stores/{{store_hash}}/v3/checkouts/{checkout_id}/consignments/{consignment_id}

2. Replace {checkout_id} with a cart/checkout ID
3. Replace {consignment_id} with a consignment ID
4. Copy and paste the code below into the body section of Postman

{
    "shipping_option_id": "{shipping_option_id}"
}

5. Replace {shipping_option_id} with the shipping option ID
6. Select PUT next to the request url
7. Click the send button
8. Observe response

Add Coupon to Checkout

1. Copy and paste the request below into Postman

https://api.bigcommerce.com/stores/{{store_hash}}/v3/checkouts/{checkout_id}/coupons

2. Replace {checkout_id} with a cart/checkout ID
3. Copy and paste the code below into the Body section of Postman

{
    "coupon_code": {coupon_code}
}

4. Replace {coupon_code} with a valid coupon code from the store
5. Select POST next to the request URL
6. Click the Send button
7. Observe response and coupon added

Delete Checkout Coupon

1. Copy and paste the request below into Postman

https://api.bigcommerce.com/stores/{{store_hash}}/v3/checkouts/{checkout_id}/coupons/{coupon_code}

2. Replace {checkout_id} with a cart/checkout ID
3. Replace {coupon_code} with a valid coupon from the store
4. Select DELETE next to the request url
5. Click the Send button
6. Observe response

Create an Order

1. Copy and paste the request below into Postman

https://api.bigcommerce.com/stores/{{store_hash}}/v3/checkouts/{checkout_id}/orders

2. Replace {checkout_id} with a cart/checkout ID
3. Select POST next to the request URL
4. Click the Send button
5. Observe response and order created

Delete Checkout Consignment

1. Copy and paste the request below into Postman

https://api.bigcommerce.com/stores/{{store_hash}}/v3/checkouts/{checkout_id}/consignments/{consignment_id}

2. Replace {checkout_id} with a cart/checkout ID
3. Replace {consignment_id} with a consignment ID
4. Select DELETE next to the request url
5. Click the Send button
6. Observe response