| Name | Type | Description | Notes |
|---|---|---|---|
| brandId | int | The `id` of the brand. Brands can be added through the Sendcloud platform and be retrieved (alongside their `id`) from the Retrieve a list of brands endpoint. | [optional] |
| shipWith | \Toppy\Sendcloud\V3\Model\ShipmentsShipWith | [optional] | |
| fromAddress | \Toppy\Sendcloud\V3\Model\AddressWithRequiredFields | [optional] | |
| toAddress | \Toppy\Sendcloud\V3\Model\AddressWithRequiredFields | ||
| toServicePoint | \Toppy\Sendcloud\V3\Model\ServicePoint | [optional] | |
| orderNumber | string | Order number generated manually or by shop system | [optional] |
| totalOrderPrice | \Toppy\Sendcloud\V3\Model\OptionalPrice | [optional] | |
| reference | string | A reference that will be stored on the Shipment and returned in your responses. This is not sent to the carrier. | [optional] |
| externalReferenceId | string | An optional reference can be provided by the API user; if included, it must be unique across shipments of the user. Using the same reference more than once will result in a 409 HTTP status code and the associated object being returned. | [optional] |
| validationMethods | string[] | A list of additional address validations to apply. At present, the only supported validation service is Here, and it is used exclusively for transactional contracts. To enable this feature, contract_id must be explicitly set and must reference a transactional contract. | [optional] |
| customsInformation | \Toppy\Sendcloud\V3\Model\CustomsInformationWithOptionalFields | [optional] | |
| labelDetails | \Toppy\Sendcloud\V3\Model\LabelDetails | [optional] | |
| deliveryDates | \Toppy\Sendcloud\V3\Model\DeliveryDates | [optional] | |
| parcels | \Toppy\Sendcloud\V3\Model\MulticolloParcelsArrayRequestWithOptionalFieldsParcelsInner[] | Represents each package of the shipment. Each carrier can have its own number of parcels limit per shipment, otherwise there is a restriction to a maximum of 50 parcels (default). | [optional] |
| applyShippingDefaults | bool | When set to `true`, the "Default weight", "Preferred shipping method" and "Default export reason" shipping defaults will be applied, if they were not provided by the request payload. Note that the request payload values and shipping rules take precedence over these defaults. | [optional] [default to true] |
| applyShippingRules | bool | When set to `true`, shipping rules will be applied. <Info> Note that rules take precedence over the values provided in the request payload and over the shipping defaults. For instance, if a contract is specified in one of the applicable rules for the shipment that is being requested, the contract value provided in the request payload will be ignored. Also keep in mind that since orders created by the API do not appear in the Sendcloud platform's Incoming Orders overview, not all shipping rules can be applied. </Info> | [optional] [default to true] |
| deliveryIndicator | string | Free text that is intended for applying the Checkout Delivery Method condition in shipping rules. Learn more about Shipping rules. | [optional] |