| address |
string |
|
[optional] |
| address2 |
string |
An apartment or floor number that has been extracted from general address input. |
[optional] |
| addressDivided |
\Toppy\Sendcloud\V2\Model\AddressDivided |
|
[optional] |
| carrier |
\Toppy\Sendcloud\V2\Model\ParcelResponseShortCarrier |
|
[optional] |
| city |
string |
|
[optional] |
| companyName |
string |
|
[optional] |
| contract |
int |
Id of the contract that was used to create the parcel. |
[optional] |
| country |
\Toppy\Sendcloud\V2\Model\Country |
|
[optional] |
| customsInvoiceNr |
string |
Customs invoice number |
[optional] |
| customsShipmentType |
int |
Customs shipment type. Deprecated in favor of the `customs_information` object. * `0` - Gift * `1` - Documents * `2` - Commercial Goods * `3` - Commercial Sample * `4` - Returned Goods |
[optional] |
| data |
object |
|
[optional] |
| dateCreated |
string |
|
[optional] |
| dateUpdated |
string |
|
[optional] |
| dateAnnounced |
string |
|
[optional] |
| email |
string |
An email address of the person this parcel is supposed to be delivered to. |
[optional] |
| id |
int |
|
|
| insuredValue |
int |
|
[optional] |
| label |
\Toppy\Sendcloud\V2\Model\Label |
|
[optional] |
| name |
string |
|
[optional] |
| orderNumber |
string |
|
[optional] |
| shipmentUuid |
string |
|
[optional] |
| parcelItems |
\Toppy\Sendcloud\V2\Model\ParcelItem[] |
|
[optional] |
| postalCode |
string |
|
[optional] |
| externalReference |
string |
A reference to be assigned to this parcel. Must be unique across parcels. This field is used to create idempotence. |
[optional] |
| reference |
string |
A reference to be assigned to this parcel. Multiple parcels can have the same reference. |
[optional] [default to '0'] |
| shipment |
\Toppy\Sendcloud\V2\Model\Shipment |
|
[optional] |
| status |
\Toppy\Sendcloud\V2\Model\Status |
|
[optional] |
| documents |
\Toppy\Sendcloud\V2\Model\Documents[] |
An array of documents. A parcel can contain multiple documents, for instance labels and a customs form. This field returns an array of all the available documents for this parcel. |
[optional] |
| telephone |
string |
|
[optional] |
| toServicePoint |
string |
An id of service point to which the shipment is going to be shipped. |
[optional] |
| toState |
string |
Represents the state or province of a country. Countries that need a state are USA, Canada, Italy and Australia. e.g. America’s city of Los Angeles belongs to the California state: CA. Shipments to Italy need a province. e.g. Italy’s city of Rome belongs to Roma province: RM. |
[optional] |
| totalInsuredValue |
int |
|
[optional] |
| totalOrderValueCurrency |
string |
|
[optional] |
| totalOrderValue |
string |
|
[optional] |
| trackingNumber |
string |
Tracking number of the shipment. |
[optional] |
| trackingUrl |
string |
tracking url of this shipment. |
[optional] |
| weight |
string |
|
[optional] |
| type |
string |
Returns either ‘parcel’ or ‘letter’ by which you can determine the type of your shipment. |
[optional] |
| colliUuid |
string |
|
[optional] |
| colloNr |
int |
A number indicating the collo number within a shipment. For a non-multi-collo shipment, this value will always be 0. In a multi-collo shipment with 3 collos, this number will range from 0 to 2. |
[optional] |
| colloCount |
int |
A number indicating the number of collos within a shipment. For non-multi-collo shipments, this value will always be 1. |
[optional] |
| isReturn |
bool |
Indicates if the parcel correspond to a return. |
[optional] |
| awbTrackingNumber |
string |
Deutsche Post Global Mail only. This indicates the air waybill number of this box of Global Mail parcels. This will be only set once Finalize box has been called. |
[optional] |
| boxNumber |
int |
Deutsche Post Global Mail only. This indicates the box to which this parcel belongs. This will be only set for Global Mail parcels. |
[optional] |
| length |
string |
Parcel length in centimeters (will be used for volumetric weight calculation). Examples: “48” or “52.3” |
[optional] |
| width |
string |
Parcel width in centimeters (will be used for volumetric weight calculation). Examples: “48” or “52.3” |
[optional] |
| height |
string |
Parcel height in centimeters (will be used for volumetric weight calculation). Examples: “48” or “52.3” |
[optional] |
| shippingMethodCheckoutName |
string |
Shipping method name selected by buyer during the checkout |
[optional] |
| customsDeclaration |
object |
An object with available printers that lists available links to the created customs declaration form. (deprecated in favour of documents). |
[optional] |
| note |
string |
This field can be used to add additional notes regarding an order. The notes will not be displayed on a label, but will be displayed on both the Packing slips & Picking lists which you can use for Pack & Go feature. The value will not be shared with carriers. It may be used for packing instructions, such as "gift" or "do not send before monday". |
[optional] |
| errors |
\Toppy\Sendcloud\V2\Model\CarrierErrors |
|
[optional] |
| customsInformation |
\Toppy\Sendcloud\V2\Model\ParcelCustomsInformation |
|
[optional] |