Name | Type | Description | Notes |
---|---|---|---|
id | String | ||
createdAt | Date | ||
updatedAt | Date | ||
references | [String] | The the first reference of this pickup is generated by the system that created it. The references are supposed to be used in customer/human related communication. It is not a technical ID. | |
state | String | The current state of the object | |
costs | Number | The total costs (that is without taxes) of the shipment in the smallest unit of `currency`. For USD/EUR this would be cents, for GPB pence, etc. | |
incoterm | String | The incoterm of this Shipment | |
carrierKind | String | The kind of carrier for this Shipment | |
carrierName | String | The name of the carrier for this shipment. If `carrier_kind` is set to courier, the name must be one of `dhl`, `dhl_express`, `ups`, `gls`, `dpd`, `tnt`, `go`, `fedex`, `hermes`, `deutsche_post`, `bw_post`, `apc_overnight`, `royal_mail`. If `carrier_kind` is set to forwarder, the name of the forwarder is applicable. | |
carrierService | String | The booked carrier service for this shipment | |
deliveryContactEmail | String | The email address of the contact person at the delivery location. | |
deliveryContactPhone | String | The phone number of the contact person at the delivery location. | |
deliveryInstructions | String | The delivery instructions for this shipment. | |
deliveryRequirements | [String] | The delivery requirements for this Shipment. | |
whiteLabel | Boolean | Specifies whether the markings indicating the actual sender of the products should be removed before shipping. | |
expectedDeliveryAt | Date | The date on which this shipment should be delivered. | |
deliveredAt | Date | The date on which this shipment was delivered. |
waitingForCommission
(value:"waiting_for_commission"
)packed
(value:"packed"
)announced
(value:"announced"
)inTransit
(value:"in_transit"
)exception
(value:"exception"
)untrackable
(value:"untrackable"
)delivered
(value:"delivered"
)
CFR
(value:"CFR"
)CIF
(value:"CIF"
)CIP
(value:"CIP"
)CPT
(value:"CPT"
)DAP
(value:"DAP"
)DAT
(value:"DAT"
)DDP
(value:"DDP"
)EXW
(value:"EXW"
)FAS
(value:"FAS"
)FCA
(value:"FCA"
)FOB
(value:"FOB"
)
courier
(value:"courier"
)forwarder
(value:"forwarder"
)
forklift
(value:"forklift"
)