Boxc Orders API
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 StatusThe 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. It can't be edited in this state. || 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 OrdersThe 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.
Boxc Orders API is one of 22 APIs that Boxc publishes on the 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.
This API exposes 6 operations across 3 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 1.123.
Requests are made against a single base URL, https://api.boxc.com/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Boxc Orders API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (JWT).
It accepts HTTP bearer tokens (PrivilegedClient).
JWT— All operations require a JSON Web Token after completing an [OAuth2 flow](tag/Authentication).PrivilegedClient— Some clients require special privileges to use operations. No additional scope is needed.
Paths & Operations 6
Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
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 yo…
Schemas 28
The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are order (24 properties), fulfillment (12 properties), consignor (10 properties), to (10 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Boxc 12
Other APIs Boxc publishes across the network.
This is an independent, third-party profile of Boxc Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.