Our API and Widget are designed to make order tracking a breeze. Whether you or your customers need to check the status of an order, our solution makes it easy and convenient.
We've made it easy for your customers to look up their order status with a PageBuilder widget. This pre-installed widget is a pre-styled form configured to use our API. It allows your customers to check the current status of their orders with just a few clicks. Simply place the widget in a visible area on your PageBuilder, and it's ready to use.
Our API seamlessly integrates with your website, allowing you to retrieve up-to-date information about your orders. All you need to do is send a POST request with the order number and billing zip code to our endpoint, and we'll return the information in a user-friendly JSON format. With the API, you can retrieve the current status of an order, without a need to build a middleware. See API documentation for more information.
Licence cost is $40.00 per one site. Terms and conditions apply.
If you have any questions, please, contact us via vlad@uts-ca.com or use our contact form.
Subscribe to our dev updates for no-nonsense emails on new app features and tools that keep your store running smoothly.
The Order Status API can be accessed via a `POST` request to the following endpoint:
https://guest-order-status.netlify.app/api//order/status
The route is limited to 5 requests per minute per IP address.
The request body must be provided as either `JSON` or `x-www-form-urlencoded` form with the following parameters:
Parameter | Type | Description |
|---|---|---|
| orderId | string | A BigCommerce order number |
| zip | string | The billing address zip code |
The API returns a JSON object with the following properties:
Property | Type | Description |
|---|---|---|
| id | integer | The order identifier |
| status | string | The order status |
| status_id | integer | The order status identifier |
| custom_status | string | The custom order status |
| date_created | string | The date the order was created |
| zip | string | The billing address zip code |
| total_inc_tax | string | The total amount of the order including tax |
| currency_code | string | The currency code used for the order |
| payment_method | string | The payment method used for the order |
| credit_card_type | string | The type of credit card used for the order |
| payment_provider_id | string | The payment provider identifier |
| payment_status | string | The payment status of the order |
| shipments | array | An array of shipments associated with the order |
The shipment objects have the following properties:
Property | Type | Description |
|---|---|---|
| date_created | string | The date the shipment was created |
| tracking_number | string | The shipment tracking number |
| shipping_method | string | The shipment method used |
| shipping_provider | string | The shipment provider used |
| tracking_carrier | string | The shipment tracking carrier |
| tracking_link | string | The shipment tracking link |
The following error codes and messages may be returned:
Status Code | Code | Message |
|---|---|---|
| 400 | MISSING_DATA_ERROR | Provide order id and billing zip code. |
| 404 | ORDER_NOT_FOUND_ERROR | Order does not exist. |
| 409 | ZIP_ERROR | Zip code does not match. |
| 403 | TRIAL_EXPIRED_ERROR | Trial expired, please select a plan. |
| 405 | GENERIC_ERROR | Method {method} Not Allowed |
| 426 | TOO_MANY_REQ_ERROR | Too many requests. |
| 500 | GENERIC_ERROR | BigCommerce API error |