Skip to content

Latest commit

 

History

History
19 lines (16 loc) · 2.01 KB

File metadata and controls

19 lines (16 loc) · 2.01 KB

# ShipmentCommon

Properties

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
fromAddress \Toppy\Sendcloud\V3\Model\AddressWithRequiredFields
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\CustomsInformation [optional]

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