Skip to content

Latest commit

 

History

History
25 lines (22 loc) · 2.47 KB

File metadata and controls

25 lines (22 loc) · 2.47 KB

# ScPublicV3ScpPostReturnsCreateNewReturnRequest

Properties

Name Type Description Notes
fromAddress \Toppy\Sendcloud\V3\Model\AddressWithRequiredFields
toAddress \Toppy\Sendcloud\V3\Model\AddressWithRequiredFields
shipWith \Toppy\Sendcloud\V3\Model\ReturnsShipWith
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\ParcelItemReturnsCreate[] List of items contained in this return. Required outside EU. [optional]
sendTrackingEmails bool When true Sendcloud will send out the default track and trace emails [optional] [default to false]
brandId int The ID of the brand this return belongs to. To find the brand ID, refer to the Retrieve a list of brands endpoint. [optional]
totalInsuredValue \Toppy\Sendcloud\V3\Model\ReturnsPrice [optional]
orderNumber string Identifier of the order associated with this return [optional]
totalOrderValue \Toppy\Sendcloud\V3\Model\PriceWithAnyCurrency [optional]
externalReference string Unique reference for this return, generated by the user [optional]
customsInvoiceNr string Customs invoice number. This field is required if it's an international return [optional]
deliveryOption \Toppy\Sendcloud\V3\Model\ReturnsDeliveryOption [optional]
customsInformation \Toppy\Sendcloud\V3\Model\ParcelCustomsInformation [optional]
applyRules bool When set to `true`, return rules will be applied. Note that rules take precedence over the values provided in the request. For instance, if a contract is specified in one of the applied rules, the contract value provided in the request will be ignored. [optional] [default to false]

[Back to Model list] [Back to API list] [Back to README]