Input.

LabelCreateDetailInput

No description

Fields

carrier

•

LabelCarrierCode!

Required

Carrier being used to create the label i.e. FEDEX, UPS, USPS, APC, DIRECT_LINK

declarationId

•

ID of the Declaration to use to clear the shipment into the US. Not required for non-US destinations.

declaredValue

•

Decimal

The declared value (insurance) of the shipment

guaranteeCode

•

LabelGuaranteeCode

Indicates whether the duties and taxes for this shipment are guaranteed by Zonos.

invoiceNumber

•

String

Optional invoice number to apply on the label and CI.

itnExemption

•

String

Optional ITN exemption to apply to the label. Only one of itnExemption or itnNumber can be applied.

itnNumber

•

String

Optional ITN number to apply to the label. Only one of itnExemption or itnNumber can be applied.

labelFileType

•

LabelFileType

Type of label file to be returned. PDF or ZPL

labelSize

•

LabelSize

Size of the label to be returned. FOUR_BY_SIX or FOUR_BY_EIGHT

orderId

•

ID!

Required

The ID of the Order the label is associated with.

packages

•

[LabelPackageInput!]!

Required

Packages to create labels for, dictates how many labels are returned.

purchaseOrderNumber

•

String

Optional purchase order number to apply on the label and CI.

serviceLevelDetail

•

ServiceLevelDetailInput!

Required

The service level code to be used to create the label.

shipFrom

•

LabelLocationInput!

Required

Details about the origin location and contact

shipTo

•

LabelLocationInput!

Required

Details about the destination location and contact

shipmentConsolidationId

•

String

Optional ID of the shipment batch with the external carrier

shipmentData

•

DateTime

Optional shipment date to be used for future-day shipping.

shipmentId

•

Optional ID of the Shipment this Label will be associated with.

specialServices

•

LabelSpecialServiceInput

Includes details about special services requested for the label.

terms

•

LabelTermType!

Required

The terms this label is being created under i.e. DAP or DDP

Was this page helpful?