Boxc Overpacks API
The Overpacks resource allows a user to combine many Shipments into one object for faster clearance with BoxC and Customs. An overpack can be a carton, container, pallet, or bag. Regardless, it must contain an overpack label on the outside. Empty overpacks are routinely purged from the system.When creating an overpack it's recommended to provide one or more shipment ID, label ID, or tracking numbers in the request. The overpack will inherit the first shipment's (`n`) attributes like the `entry_point`, `service`, `terms`, etc. All shipments require identical attributes to be a part of the same overpack. Errors will be returned if the `n + 1` shipments do not match the first one. An error message will be present in the `shipments` array for each shipment that fails while creating or updating overpacks. Shipments that pass validation will still be added in the same request.The system will calculate the routing and other applicable carrier logic to determine the physical appearance of the label. Some carriers require custom messaging on the labels while others require a completely different label altogether. The system handles this logic on your behalf.**Note:** Shipments without labels and cancelled shipments can't be added to overpacks.The overpack(s) must be dropped off at the BoxC collection center indicated by the `entry_point`. Some entry points do not require overpacking and the system will prevent you from creating one. Deleting an overpack unassigns all shipments from it.**Note:** A client won't be able to print an overpack label until at least one shipment is assigned to it.
Boxc Overpacks API is one of 22 APIs that Boxc publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Overpacks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 5 operations across 2 paths, and defines 16 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 Overpacks 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 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The Overpacks resource allows a user to combine many Shipments into one object for faster clearance with BoxC and Customs. An overpack can be a carton, container, pallet, or bag.…
Schemas 16
The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are overpack (21 properties), overpack-list (20 properties), not-found (4 properties), bad-request (4 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 Overpacks 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.