LabelCreateDetailInput

Input.

No description

Fields

accountNumber

•

String

Optional carrier account number for the label. For Japan Post, this is the merchant's hyphen-formatted deferred-payment customer number (NNNNNNNNNN-NNNNNN-NNNNNNNNNN-NNNNNN), which the service splits into the four laterPayNumber* API slots on the Code 52 request. When omitted, the label is created without deferred-payment parameters. Format is carrier-specific.

brokers

•

[LabelBrokerInput!]

Customs broker information for international shipments

carrier

•

LabelCarrierCode!

Required

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

certificateNumber

•

String

Certificate number for customs

contentsType

•

String

Optional contents type of the shipment. If not provided, the landed cost endUse will be used.

customerReference

•

String

Optional customer reference to apply on the label and CI

customsOption

•

LabelCustomsOptionInput

Customs option for international shipments.

customsRemarks

•

String

Customs or invoice remarks

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

etdDetail

•

LabelEtdDetailInput

Electronic Trade Documents configuration for paperless international shipping

freightDetail

•

LabelFreightDetailInput

Freight shipment details for FedEx Freight services

guaranteeCode

•

LabelGuaranteeCode

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

importerOfRecord

•

LabelImporterOfRecordInput

Importer of record information for international shipments

invoiceNumber

•

String

Optional invoice number to apply on the label and CI.

isNonCommercial

•

Boolean

Whether the shipment contains non-commercial goods

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

licenseNumber

•

String

Export/import license number for customs

masterTracking

•

LabelMasterTrackingInput

Master tracking information for MPS (Multiple Piece Shipment) child shipments

nonDelivery

•

LabelNonDeliveryInput

Instructions for handling non-deliverable shipments

orderId

•

Optional ID of the Order the label is associated with. May be omitted when the upstream caller has populated all label-relevant fields directly on this input (declarationId, terms, guaranteeCode, items with currency/hsCode/COO, etc.). Carriers must opt in via supportsOrderless() — orderless requests for non-supporting carriers are rejected.

packages

•

[LabelPackageInput!]!

Required

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

paymentConditions

•

String

Free-text payment conditions for customs invoice

purchaseOrderNumber

•

String

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

references

•

[LabelReferenceInput!]

Optional reference fields for the shipment

sequenceNumber

•

Int

Sequence number for MPS packages

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.

shipmentDate

•

DateTime

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

shipmentDeclarationStatement

•

String

Custom declaration statement for this shipment, takes priority over org-level settings

shipmentId

•

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

specialInstructions

•

String

Optional special instructions to send to the carrier

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

thirdPartyAccount

•

String

Third party account number for billing

totalPackageCount

•

Int

Total package count for MPS shipments

Fields

Was this page helpful?