shipping_write
Arguments
required
The shipment and selected rate to buy.
Show fields
Show fields
String!
required
Carrier of the selected rate, as returned by the quote.
String!
required
Carrier account the selected rate was quoted on.
String
Unique key for this purchase (max 400 characters). Retrying with the same key returns the original result instead of buying twice. Keys expire; do not reuse one for a new purchase. If omitted, every call buys a new label.
required
The shipment to buy a label for.
Show fields
Show fields
Total declared contents. Required by carriers that want a declaration even with no customs items.
Customs declaration. Required for international shipments; carriers reject them without one.
Boolean
Assigns who is billed for duties and import taxes: the sender (DDP) or the recipient (DAP). Does not affect the quoted or charged rate — duties are billed separately after the shipment moves. Omit to leave the choice to your carrier configuration.
required
Ship-from address.
required
The parcels in the shipment (max 5).
Return address, if different from the ship-from address.
Tax identifiers for the shipment, e.g. an IOSS number for EU-bound goods.
required
Ship-to address.
String!
required
Service level of the selected rate, as returned by the quote.
Returns
required
A purchased carrier shipment and its package labels.
Show fields
Show fields
String!
required
Carrier the label was bought from.
String!
required
Carrier service level bought.
ID!
required
The id of this shipment.
required
Example
mutation {
purchaseCarrierShipment(input: { ... }) {
carrier
service
shipmentId
}
}