1. How do I create an order with custom products using BigCommerce API?
YES: Absolutely! Postman allows you to create an order with an existing catalog or custom product based on your needed information.
HOW: I will show you how to create an order with custom products using BigCommerce API in 4 easy steps.
Step 1: Access to Postman
Open Postman, log in to your account and choose a workspace.
Step 2: Create create an order request
Select POST request and fill in the URL:
In this case, replace [store_hash] with the store_hash generated on BigCommerce via the API path.
Step 3: Authenticate Parameters
In the Header section, you need to declare the following information:
- Accept: application/json
- Content-Type: application/json
- X-Auth-Token: Access token
Step 4: Declare the body
In the Body section, click on “raw” to fill in the data; remember to change the “text” to “JSON.”
Required Fields:
- Products
- Name Alias for name_customer. The product name that is shown to customers in the storefront.
- Quantity: number
- Price_ex_tax : Number
- Price_inc_tax : Number
- Billing_address
Below is an example of our code
{
"billing_address": {
"first_name": "Chau",
"last_name": "Hoang",
"street_1": "123 Main Street",
"city": "Austin",
"state": "Texas",
"zip": "78751",
"country": "United States",
"country_iso2": "US",
"email": "[email protected]"
},
"products": [
{
"name": "Bunny doll",
"quantity": 1,
"price_inc_tax": 10,
"price_ex_tax": 15
}
]
}
Code language: JSON / JSON with Comments (json)Note
- Below is an example of the minimum fields needed to create a request for an order.
- A custom product cannot be found in the catalog, so the product ordered must be made to order.
More detail: BigCommerce Devdocs
This is how the API will return the data at the end.
{
“id”: 103,
“customer_id”: 0,
“date_created”: “Fri, 30 Sep 2022 08:23:54 +0000”,
“date_modified”: “Fri, 30 Sep 2022 08:23:54 +0000”,
“date_shipped”: “”,
“status_id”: 1,
“status”: “Pending”,
“subtotal_ex_tax”: “15.0000”,
“subtotal_inc_tax”: “10.0000”,
“subtotal_tax”: “-5.0000”,
“base_shipping_cost”: “0.0000”,
“shipping_cost_ex_tax”: “0.0000”,
“shipping_cost_inc_tax”: “0.0000”,
“shipping_cost_tax”: “0.0000”,
“shipping_cost_tax_class_id”: 0,
“base_handling_cost”: “0.0000”,
“handling_cost_ex_tax”: “0.0000”,
“handling_cost_inc_tax”: “0.0000”,
“handling_cost_tax”: “0.0000”,
“handling_cost_tax_class_id”: 0,
“base_wrapping_cost”: “0.0000”,
“wrapping_cost_ex_tax”: “0.0000”,
“wrapping_cost_inc_tax”: “0.0000”,
“wrapping_cost_tax”: “0.0000”,
“wrapping_cost_tax_class_id”: 0,
“total_ex_tax”: “15.0000”,
“total_inc_tax”: “10.0000”,
“total_tax”: “-5.0000”,
“items_total”: 1,
“items_shipped”: 0,
“payment_method”: “Manual”,
“payment_provider_id”: null,
“payment_status”: “”,
“refunded_amount”: “0.0000”,
“order_is_digital”: false,
“store_credit_amount”: “0.0000”,
“gift_certificate_amount”: “0.0000”,
“ip_address”: “”,
“ip_address_v6”: “”,
“geoip_country”: “”,
“geoip_country_iso2”: “”,
“currency_id”: 1,
“currency_code”: “VND”,
“currency_exchange_rate”: “1.0000000000”,
“default_currency_id”: 1,
“default_currency_code”: “VND”,
“staff_notes”: null,
“customer_message”: null,
“discount_amount”: “0.0000”,
“coupon_discount”: “0.0000”,
“shipping_address_count”: 1,
“is_deleted”: false,
“ebay_order_id”: “0”,
“cart_id”: null,
“billing_address”: {
“first_name”: “Chau”,
“last_name”: “Hoang”,
“company”: “”,
“street_1”: “123 Main Street”,
“street_2”: “”,
“city”: “Austin”,
“state”: “Texas”,
“zip”: “78751”,
“country”: “United States”,
“country_iso2”: “US”,
“phone”: “”,
“email”: “[email protected]”,
“form_fields”: []
},
“is_email_opt_in”: false,
“credit_card_type”: null,
“order_source”: “external”,
“channel_id”: 1,
“external_source”: null,
“products”: {
“url”: “https://api.bigcommerce.com/stores/q851icihwa/v2/orders/102/products”,
“resource”: “/orders/102/products”
},
“shipping_addresses”: {
“url”: “https://api.bigcommerce.com/stores/q851icihwa/v2/orders/102/shipping_addresses”,
“resource”: “/orders/102/shipping_addresses”
},
“coupons”: {
“url”: “https://api.bigcommerce.com/stores/q851icihwa/v2/orders/102/coupons”,
“resource”: “/orders/102/coupons”
},
“external_id”: null,
“external_merchant_id”: null,
“tax_provider_id”: “”,
“customer_locale”: “”,
“external_order_id”: “”,
“store_default_currency_code”: “VND”,
“store_default_to_transactional_exchange_rate”: “1.0000000000”,
“custom_status”: “Pending”
}
2. Can we delete a BigCommerce Order on BigCommerce using BigCommerce API?
YES: Definitely!
HOW: Follow my instructions below and you will delete a BigCommerce Order on BigCommerce using BigCommerce API.
Step 1: Access to Postman
Open Postman, log in to your account and choose a workspace.
Step 2: Create a request
Select DELETE request and fill in the URL:
Replace [store_hash] with the store_hash generated on BigCommerce via the API path.
You also have to add the order ID of the order you want to delete
Step 3: Authenticate Parameters
In the Header section, you need to declare the following information:
- Accept: application/json
- Content-Type: application/json
- X-Auth-Token: Access token
Then press the send button to make the request
The result will be like this:
3. Can We Get a Count of BigCommerce Orders?
YES: Yes, we absolutely can!
HOW: I will show you through the steps below
Step 1: Access to Postman
Open Postman, log in to your account and choose a workspace.
Step 2: Create a request
Select GET request and fill in the URL:
Replace [store_hash] with the store_hash generated on BigCommerce via the API path.
Step 3: Authenticate Parameters
In the Header section, you need to declare the following information:
- Accept: application/json
- Content-Type: application/json
- X-Auth-Token: Access token
Then press the send button to make the request
You will receive a Count of BigCommerce Orders
4. Can we update a BigCommerce Order via API?
YES: Of Course!
Step 1: Select the order
First of all, choose the order that you want to update. You must have the order ID as well
Step 2: Open a new request
Now, open a new request in Postman and select PUT demand. Fill in the URL with the structure below into the box:
As above, you need to change the store hash and order ID before going to the next step.
Step 3: Authenticate Parameters
In the Header section, you need to declare the following information:
- Accept: application/json
- Content-Type: application/json
- X-Auth-Token: Access token
Step 4: Declare the body
In the Body section, click on “raw” to fill in the data; remember to change the “text” to “JSON.”
Required Fields: The same as when you create a new order.
Example code
{
“billing_address”: {
“first_name”: “Hi”,
“last_name”: “Hi”,
“street_1”: “abc Main Street”,
“city”: “Austin”,
“state”: “Texas”,
“zip”: “78751”,
“country”: “United States”,
“country_iso2”: “US”,
“email”: “[email protected]”
},
“products”: [
{
“name”: “Teddy Bear”,
“quantity”: 20,
“price_inc_tax”: 50,
“price_ex_tax”: 35
}
]
}
This is how the API will return the data at the end.
5. Can we retrieve all the orders in BigCommerce using BigCommerce API?
YES: I will show you in 3 steps
HOW: I will show you!
Step 1: Access to Postman
Open Postman, log in to your account and choose a workspace.
Step 2: Open a new request
Select GET request and fill in the URL:
Replace [store_hash] with the store_hash generated on BigCommerce via the API path.
Step 3: Authenticate Parameters
In the Header section, you need to declare the following information:
- Accept: application/json
- Content-Type: application/json
- X-Auth-Token: Access token
Then press the send button to make the request
You will see all the orders below:
