How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Boxc Shipments API

The Shipments resource allows a user to create, update, retrieve, and delete shipments. Only test shipments and shipments without labels can be deleted. Shipments with uncancelled or processed labels cannot be updated. All shipments require address verification on the shipping address. Cancelling a label will refund the cost. Test shipments and shipments without labels are routinely purged from the system.There are some weight and volumetric constraints for shipments that is dependant on the route. For example, if a Shipment's length + girth is greater than a certain size then the user is charged an additional fee per KG. The length is the measurement of the longest dimension, and girth is the distance around the thickest part (perpendicular to the length). If the Shipment's weight or volume exceeds the limit for a route an error will be returned.**Note:** Set the `overpack_id` to null when unassigning it from an overpack. You won't be allowed to update a labelled shipment beyond that.

Boxc Shipments API is one of 22 APIs that Boxc publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shipments. 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 40 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.

6 operations 3 paths 40 schemas 1 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.123
Base URL
https://api.boxc.com/v1
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Boxc Shipments 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, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Shipments 6

The Shipments resource allows a user to create, update, retrieve, and delete shipments. Only test shipments and shipments without labels can be deleted. Shipments with uncancelled…

GET
/shipments
GET /shipments
getShipments 11 params → 200400401403429
POST
/shipments
POST /shipments
addShipment body → 201400401403429500503
GET
/shipments/{id}
GET /shipments/{id}
getShipmentsById 3 params → 200401403404429
PUT
/shipments/{id}
PUT /shipments/{id}
updateShipment 1 param body → 200400401403404429500503
DELETE
/shipments/{id}
DELETE /shipments/{id}
deleteShipment 1 param → 200400401403404429500
PUT
/shipments/{id}/process
PUT /shipments/{id}/process
processShipment 1 param body → 200400401403404429500

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are shipment (49 properties), label (26 properties), line-item (16 properties), consignee (10 properties). Each schema is shown below with its type and property counts.

LineItem
consignor
object
Address and other details for the consignor (sender) which is used for customs clearance.
10 properties 5 required
rate-limit
Too Many Requests
RateLimit
Consignee
Forbidden
Event
event
object
The tracking history for this label in descending order. Set by the system.
10 properties
shipment-images
object
Lists URLs of images taken during transit and categorized by type of photo. URLs expire after a period of time so refer to the expires query parameter.
2 properties
LineItemCompliance
forbidden
Forbidden
to
object
The recipient's shipping address. This may or may not be the same as the consignee. Countries have different formatting rules and element requirements for addr…
10 properties 4 required
NotFound
PackageContents
internal-server-error
object
Processing Error
4 properties
ShipmentImages
ServiceUnavailable
To
Shipment
shipment-process-request
object
1 property
package
object
5 properties 4 required
Unauthorized
InternalServerError
unauthorized
Unauthorized
line-item-compliance
object
Additional compliance elements for the line item.
1 property
shipment
object
Shipment
49 properties 6 required
package-contents
object
3 properties 3 required
label
object
26 properties
BadRequest
not-found
object
Object not found or not owned by the user
4 properties
service-unavailable
object
The server cannot handle the request (because it is overloaded or down for maintenance). Generally, this is a temporary state.
4 properties
from
object
This will appear as the return address on labels. A default return address will be used if one isn't provided in the request. The country code must match to.co…
7 properties 4 required
ShipmentProcessRequest
line-item
object
Contents of the shipment.
16 properties 7 required
consignee
object
Details about the consignee / buyer. The system will use the shipping address as the consignee address if one isn't provided. Some countries require a tax / pa…
10 properties 4 required
bad-request
object
Validation error with the request
4 properties
Consignor
From
Label
Package

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

boxc-shipments-api-openapi.yml Raw ↑

Other APIs Boxc publishes across the network.

Boxc CalculateDuty API
Boxc Classify API
Boxc Credentials API
Boxc CustomsProducts API
Boxc EntryPoints API
Boxc Estimate API
Boxc Inbound API
Boxc Invoices API
Boxc Labels API
Boxc Manifests API
Boxc Orders API
Boxc Overpacks API
Where this information came from

This is an independent, third-party profile of Boxc Shipments 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.