Shipment

Type.

No description

Fields

•

ID!

Required

A unique identifier for the shipment

customsDocuments

•

[CustomsDocument!]!

Required

No description

customsSpec

•

CustomsSpec

No description

pddpSubmission

•

PddpSubmission

No description

amount

•

Decimal

The total calculated amount for all labels associated with this shipment

appliedRules

•

[ShipmentAppliedRule!]!

Required

Automation rules that were applied to this Shipment during creation

bookingNumber

•

String

Booking number for freight shipments

createdAt

•

DateTime!

Required

The date and time this Shipment was created

createdBy

•

ID!

Required

The user who created this Shipment

currencyCode

•

CurrencyCode

the currency of the shipment

declarationId

•

The declaration ID associated with this shipment

declaredValue

•

Decimal

The declared value (insurance) of the shipment

direction

•

ShipmentDirection!

Required

Whether this Shipment moves goods to the customer (OUTBOUND) or back from them (RETURN). Anything treating a Shipment as evidence of fulfillment — fulfillment progress, order status, tracking attribution, manifests — must filter to OUTBOUND.

exemption

•

String

Exemption code for shipments requiring an ITN

fulfillmentCenter

•

FulfillmentCenter

The FulfillmentCenter that was used to fulfill the Shipment.

itnNumber

•

String

ITN that was applied on the label request

order

•

Order

The Order associated with this Shipment

organization

•

ID!

Required

The organization that this Shipment belongs to

parties

•

[Party!]!

Required

All of the Partys involved with this Shipment

references

•

ShipmentReference

Optional references to be added on the Label and CI

serviceLevel

•

ServiceLevel!

Required

The ServiceLevel utilized by the Carrier for this Shipment

shipmentCartons

•

[ShipmentCarton!]!

Required

A list of ShipmentCartons related to this Shipment

shipmentConsolidation

•

ShipmentConsolidation

The ShipmentConsolidation this Shipment belongs to

shipmentDate

•

DateTime

The scheduled shipment date for this Shipment

shipmentType

•

ShipmentType!

Required

Indicates whether the Shipment is international or domestic

specialServices

•

[ShipmentSpecialService!]

A list of ShipmentSpecialServices to apply to this Shipment

status

•

ShipmentStatusType!

Required

The status of the shipment

statusTransitions

•

[ShipmentStatusTransition!]!

Required

A list of statuses of the shipment

tracking

•

Tracking

An optional master tracking

trackingDetails

•

[Tracking!]!

Required

All tracking details associated with this Shipment

Fields

Was this page helpful?