| fromAddress |
\Toppy\Sendcloud\V3\Model\AddressWithRequiredFields |
|
|
| toAddress |
\Toppy\Sendcloud\V3\Model\AddressWithRequiredFields |
|
|
| shippingProduct |
\Toppy\Sendcloud\V3\Model\ShippingProductsRef |
|
|
| dimensions |
\Toppy\Sendcloud\V3\Model\ReturnsDimension |
|
[optional] |
| weight |
\Toppy\Sendcloud\V3\Model\ReturnsWeight |
|
|
| colloCount |
int |
The number of collos this return consists of |
[optional] [default to 1] |
| parcelItems |
\Toppy\Sendcloud\V3\Model\ParcelItemReturnsDetails[] |
List of items contained in this return. Required outside the EU. |
[optional] |
| sendTrackingEmails |
bool |
When `true`, Sendcloud will send out the default track and trace emails |
[default to false] |
| brandId |
int |
The ID of the brand this Return belongs to. |
[optional] |
| labelUrl |
string |
URL to download the label. This can be `null` because it might not be announced yet. Deprecated in favour of the `label` field. |
[optional] |
| label |
\Toppy\Sendcloud\V3\Model\ReturnLabel |
|
[optional] |
| labelCost |
\Toppy\Sendcloud\V3\Model\ReturnsPrice |
|
[optional] |
| insurance |
bool |
Whether the return parcel is insured |
[optional] |
| trackingNumber |
string |
This can be null because it might not be announced yet. |
[optional] |
| trackingUrl |
string |
URL to track your return. This can be null because it might not be announced yet. |
[optional] |
| isCancellable |
bool |
Whether the incoming parcel of this return can be cancelled |
|
| statusHistory |
\Toppy\Sendcloud\V3\Model\DetailedTrackingBlobStatus[] |
List with the timeline of your return status |
|
| createdAt |
\DateTime |
Date and time of creation of this return |
|
| deliveredAt |
float |
A unix timestamp indicating the delivery time of this return. Deprecated in favour of the `delivered_at_iso` field. |
[optional] |
| deliveredAtIso |
\DateTime |
Date and time of delivery of this return |
[optional] |
| reason |
\Toppy\Sendcloud\V3\Model\ReturnReason |
|
[optional] |
| refund |
\Toppy\Sendcloud\V3\Model\ReturnRefund |
|
[optional] |
| returnFee |
\Toppy\Sendcloud\V3\Model\PriceWithAnyCurrency |
|
[optional] |
| orderNumber |
string |
Order number filled by the user |
[optional] |
| contract |
int |
ID of the contract used to ship this return |
[optional] |
| customsInvoiceNr |
string |
Customs invoice number |
[optional] |
| customsShipmentType |
int |
Customs shipment type * `0` - Gift * `1` - Documents * `2` - Commercial Goods * `3` - Commercial Sample * `4` - Returned Goods |
[optional] |
| deliveryOption |
\Toppy\Sendcloud\V3\Model\ReturnsDeliveryOption |
|
[optional] |
| images |
\Toppy\Sendcloud\V3\Model\ReturnImagesInner[] |
Images uploaded when creating a return via the Return Portal |
[optional] |
| status |
string |
The current status of the return |
[optional] |
| customsInformation |
\Toppy\Sendcloud\V3\Model\ParcelCustomsInformation |
|
[optional] |
| errors |
\Toppy\Sendcloud\V3\Model\ErrorObject[] |
This array will contain errors such as carrier announcement errors. |
[optional] [readonly] |