Parcel
The class to describe the Parcel business object.
| Name | Description | Type | Additional information |
|---|---|---|---|
| LastCarrierUpdate |
The timestamp of the last status check with the Carrier. |
date |
None. |
| FirstDeliveryAttempt | date |
None. |
|
| ShipperTrackingUrl |
Gets or sets the shipper tracking URL. |
Collection of string |
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. |
| ShippingLabelFileId |
Gets or sets the Id to the file (pdf) containing the generated shippinglabel. |
integer |
None. |
| ShipFrom |
Gets the sender contact info |
ContactInfoAddress |
None. |
| ShipTo |
Gets the addressee contact info |
ContactInfoAddress |
None. |
| Id |
Gets or sets the identifier. |
integer |
Required |
| TrackingCode |
Gets or sets the tracking code. |
string |
Max length: 2147483647 |
| CreateTimestamp |
Gets or sets the create timestamp. |
date |
Required |
| ChangedTimestamp |
Gets the changed timestamp. |
date |
Required |
| CarrierName |
The name of the Carrier used. |
string |
None. |
| 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 |
| ParcelStatus |
The Parcel Status. |
ParcelStatusEnum |
None. |
| IsReturn |
Indicates whether the Parcel is a return shipment. |
boolean |
Required |