# Boxc Orders API

**Canonical:** https://apis.io/apis/boxc/boxc-orders-api/  
**Provider:** Boxc — https://apis.io/providers/boxc/  
**Base URL:** https://api.boxc.com/v1  
**Documentation:** https://docs.boxc.com/

Boxc Orders API is one of 22 APIs that [Boxc](https://apis.io/providers/boxc/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The Orders resource allows you to create, read, update, and delete orders that are meant to be fulfilled by BoxC. If you wish to manually create an order for a third party shop you must provide the `shop.id` and `shop.order_id`. Neither property can be updated. The system will push tracking information to the shop when the order is fulfilled if both properties are set. Clients can force which warehouse is used for order fulfillment by setting the `warehouse.id` property. ### Order Status The following table lists all possible states of an order indicated by its `status` property. Updating an order that is 'Ready' will reset its status to 'Processing' and restore product quantities until it's processed by the system again. | Status | Description | |--------|-------------| | Backordered | There is insufficient quantity for one or more line items. The system will change the status once more inventory is added. | | Exception | There is a problem with the order such as missing or invalid information. The user must correct the problem before the order can be processed by the system. | | Holding | The order is being delayed from processing by the user. | | Processing | The order is waiting for the system to process it. Default state. | | Ready | The order is assigned to a warehouse for packing and quantities were deducted. | | Packing | One or more line items are being packed. <em>It can't be edited in this state</em>. | | Partial | The order was partially fulfilled. The remaining line items will be fulfilled when more inventory arrives. | | Fulfilled | The order was completely fulfilled. | | Archived | The system archives orders that were fulfilled at least 90 days in the past. | ### Pruning Orders The system routinely prunes or closes out orders in the system more than **365 days** ago. The start time is based on the `placed_at` and not the `created` datetime. What happens to the order depends on its current state at the time of pruning. - Unfulfilled (not Packing, Partial, Fulfilled) orders are deleted. - Partially fulfilled orders (Holding, Packing, Partial) are bumped to Fulfilled. - Orders in Packing have their unfulfilled line items and fulfillment objects deleted, and are bumped to Fulfilled.

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/boxc/refs/heads/main/openapi/boxc-orders-api-openapi.yml
- **Swagger** — https://raw.githubusercontent.com/api-evangelist/boxc/refs/heads/main/openapi/_original/boxc-openapi-original.yml
- **Documentation** — https://docs.boxc.com/
- **APIReference** — https://docs.boxc.com/

## Other Boxc APIs (12)

- [Boxc CalculateDuty API](https://apis.io/apis/boxc/boxc-calculateduty-api/)
- [Boxc Classify API](https://apis.io/apis/boxc/boxc-classify-api/)
- [Boxc Credentials API](https://apis.io/apis/boxc/boxc-credentials-api/)
- [Boxc CustomsProducts API](https://apis.io/apis/boxc/boxc-customsproducts-api/)
- [Boxc EntryPoints API](https://apis.io/apis/boxc/boxc-entrypoints-api/)
- [Boxc Estimate API](https://apis.io/apis/boxc/boxc-estimate-api/)
- [Boxc Inbound API](https://apis.io/apis/boxc/boxc-inbound-api/)
- [Boxc Invoices API](https://apis.io/apis/boxc/boxc-invoices-api/)
- [Boxc Labels API](https://apis.io/apis/boxc/boxc-labels-api/)
- [Boxc Manifests API](https://apis.io/apis/boxc/boxc-manifests-api/)
- [Boxc Overpacks API](https://apis.io/apis/boxc/boxc-overpacks-api/)
- [Boxc Products API](https://apis.io/apis/boxc/boxc-products-api/)

## Tags

Order

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/boxc/boxc-orders-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/boxc/.