shipping_write
Arguments
required
The overbox label to buy.
Show fields
Show fields
required
The first-mile carrier to buy the label on. Must be one
overboxServices lists for the service.String!
required
Unique key for this purchase (max 400 characters). Retrying with the same key returns the overbox the first call bought instead of buying another, even when the first call failed with
OVERBOX_NOT_RECORDED or timed out; a retry while that first call is still running fails with PURCHASE_IN_PROGRESS, and the same key with a different request fails with IDEMPOTENCY_KEY_REUSED. Always retry a purchase with its own key: if the first call stopped after the label was bought, a retry five minutes later recovers that label instead of buying another. Start a new key only for a new purchase.required
The outer box.
Show fields
Show fields
required
The box’s height.
required
The box’s length.
required
The packed box’s total weight.
required
The box’s width.
required
The consolidator to ship the box to. Must be one
overboxServices lists.ID
The
Location the box ships from. It sets the label’s from-address and limits the parcels sealed inside to that location’s. Omit to ship from your account address and seal parcels from every location.[ID!]
The labeled packages to seal into this box (max 200):
CarrierShipmentTracker ids for labels bought with purchaseCarrierShipment, or Tracker ids for labels bought in Redo’s shipping app. Each must be a label bought on this consolidator, not voided, and not already sealed in another overbox; otherwise nothing is bought and the purchase fails with SHIPMENT_NOT_FOUND or SHIPMENT_NOT_ELIGIBLE, naming the id. Omit or send an empty list to seal the parcels labeled for this consolidator from the same ship-from location since its previous overbox.Returns
required
An overbox: one outer box, with its own first-mile label, that carries many labeled parcels to a consolidator (APC or ePost Global) in one shipment.
Show fields
Show fields
required
The first-mile carrier the overbox label was bought on.
The outer box’s dimensions, as declared on the label.
Show fields
Show fields
Float
The height, in
unit.Float
The length, in
unit.required
The unit all three measurements are expressed in.
Float
The width, in
unit.String!
required
The consolidator’s induction center the overbox ships to, as configured for your account (e.g. EWR).
ID!
required
The id of this overbox shipment.
String!
required
URL of the printable overbox label, a 4x6 PDF when rendering succeeds and otherwise the carrier’s own label file.
The labeled parcels sealed inside the box: those labeled for this consolidator from the same ship-from location since its previous overbox. Empty for a location’s first overbox.Requires:
shipping_readShow fields
Show fields
ArgumentsFields
String
Forward pagination cursor — returns parcels after it.
String
Backward pagination cursor — returns parcels before it.
Int
Forward pagination: returns the first N parcels (max 100, default 25). Use with
after; mutually exclusive with last/before.Int
Backward pagination: returns the last N parcels (max 100, default 25). Use with
before; mutually exclusive with first/after.required
The list of edges (each a node plus its pagination
cursor).Show fields
Show fields
String!
required
Opaque cursor for this item; pass to
after/before to page from here.required
The item at this edge.
required
Pagination metadata for the current page.
Show fields
Show fields
String
Cursor of the last edge in this page; pass to
after to page forward.Boolean!
required
Whether more items exist after this page (drives forward pagination with
first/after).Boolean!
required
Whether more items exist before this page (drives backward pagination with
last/before).String
Cursor of the first edge in this page; pass to
before to page backward.required
The consolidator the overbox ships to.
required
Where the overbox label is in its lifecycle.
String!
required
The first-mile carrier’s tracking number for the box.
The first-mile carrier’s latest status for the box. Null until the carrier first scans it.
The outer box’s weight, as declared on the label.
Show fields
Show fields
required
The unit the value is expressed in.
Float!
required
The numeric magnitude of the weight.
Example
mutation {
overboxShipmentPurchase(input: { ... }) {
carrier
fulfillmentCenter
id
labelUrl
parcels {
nodes {
addedAt
trackingNumber
}
pageInfo { hasNextPage endCursor }
}
purchasedAt
service
status
# ...
}
}