ShipmentChanges
The class to describe the ShipmentChanges business object.
| Name | Description | Type | Additional information |
|---|---|---|---|
| SynchronizeParameters |
Gets or sets a value indicating whether the parameters are synchronized. |
boolean |
None. |
| SynchronizeShippingLabels |
Gets or sets a value indicating whether the packages are synchronized. |
boolean |
None. |
| LastCarrierUpdate |
The timestamp of the last status check with the Carrier. |
date |
None. |
| CarrierName |
The name of the Carrier used. |
string |
None. |
| ShipperTrackingUrl |
Gets or sets the shipper tracking URL. |
string |
None. |
| DeliveredDate |
The timestamp the complete Shipment was delivered. This timestamp is based on the DeliveryDate of all containing labels/packages. |
date |
None. |
| Params |
Gets or sets the shipment parameters. |
Collection of CarrierParameter |
None. |
| ShippingLabels |
Gets or sets the shipment packages. |
Collection of ShippingLabel |
None. |
| Id |
Gets or sets the identifier. |
integer |
Must be 0 |
| TrackingCode |
Gets or sets the tracking code. |
string |
Max length: 2147483647 |
| CreateTimestamp |
Gets or sets the create timestamp. |
date |
Required |
| ShopId |
Gets or sets the Shop identifier. |
integer |
Required |
| OrderId |
Gets or sets the Order identifier. |
integer |
None. |
| CarrierAccountId |
Gets or sets the Carrier account. |
integer |
Required |
| ShipmentStatusId |
The status Id of the Shipment. Possible values: NotPlanned = 1, Planned = 2, Shipping = 3, Delivered = 4, Cancelled = 5, Exception = 6, Deleted = 7, Partiallydelivered = 8, |
integer |
None. |
| ShipmentStatus |
The status of the Shipment. |
string |
None. |
| IsReturn |
Indicates whether the Shipment is a return shipment. |
boolean |
Required |