| Name | Description | Type | Additional information |
|---|---|---|---|
| ShipmentId |
Sets the (Order)Shipment identifier. By setting this value, the Parcel will be added to the OrderShipment. |
integer |
None. |
| ReturnId |
Sets the (Order)Return identifier. By setting this value, the Parcel will be added to the OrderReturn. |
integer |
None. |
| 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. |
| FirstDeliveryAttempt |
The timestamp of the first delivery attempt. Note, not all Carrier support this field. |
date |
None. |
| GoodsDescription | string |
Max length: 50 |
|
| DeliveredDate |
The timestamp the complete Parcel 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. |
| ShipFrom |
Gets the sender contact info |
ContactInfoAddress |
None. |
| ShipTo |
Gets the addressee contact info |
ContactInfoAddress |
None. |
| Id |
Gets or sets the identifier. |
integer |
Must be 0 (for insert operations) |
| TrackingCode |
Gets or sets the tracking code. |
string |
Max length: 2147483647 |
| TrackingUrl |
Optionally specify the full tracking url. When not specified the Carrier implementation will have to compose the url from the TrackinCode. |
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 |
| OrderShipmentId |
Identifier of related shipment |
integer |
None. |
| ParcelStatus |
The Parcel Status. |
ParcelStatusEnum |
None. |
| IsReturn |
Indicates whether the Parcel is a return shipment. |
boolean |
Required |
| ErrorMessage |
When set, the last status update experienced an technical error |
string |
Max length: 2147483647 |