shipping_read
Arguments
required
The shipment to quote rates for.
Show fields
Show fields
Total declared contents. Required by carriers that want a declaration even with no customs items.
Show fields
Show fields
String!
required
Plain-language description of everything in the shipment.
required
Total declared value of the shipment.
Customs declaration. Required for international shipments; carriers reject them without one.
Show fields
Show fields
AES exemption to cite when your account files by exemption. Ignored if your account files by ITN; defaults to
NOEEI_30_37_A.String
Description of the contents to print on the form. Defaults to your configured description, or the item descriptions joined together.
What the shipment holds. Defaults to
MERCHANDISE.required
The declared lines (max 100).
String
Internal Transaction Number for a shipment you filed with AES, e.g. “AES X20260827123456”. Used only if your account is configured to file by ITN.
What to do if the shipment cannot be delivered. Defaults to
RETURN.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
required
The parcels in the shipment (max 5).
Show fields
Show fields
Tax identifiers for the shipment, e.g. an IOSS number for EU-bound goods.
Show fields
Show fields
required
Which party the identifier belongs to.
required
Country of the authority that issued it.
required
The kind of identifier.
String!
required
The identifier itself.
Returns
required
Quoted rates plus any carrier messages from the quote.
Show fields
Show fields
required
required
The purchasable rates.
Show fields
Show fields
String!
required
Carrier offering this rate.
String!
required
Carrier account this rate was quoted on.
Int
Carrier’s estimated days in transit, when provided.
String!
required
Carrier service level of this rate.
Example
mutation {
getShippingLabelQuotes(input: { ... })
}