ParcelPresetCreateDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Input for creating a parcel preset.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
merchantId
required |
string (uuid) | The merchant that owns this preset. Required on create, and immutable afterwards: an update
that names a different merchant is refused rather than silently moving the preset.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
name
required |
string | Operator-facing name of the box, for example "Small box".
nullablemax length 128
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
weight
required |
number (double) | The packed weight of a parcel shipped in this box, in `weightUnit`. Positive.
greater than 0max 100000
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
weightUnit
required |
ShippingWeightUnit ShippingWeightUnit | The unit `weight` is expressed in.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
length
required |
number (double) | The longest outer dimension, in `dimensionUnit`. Positive.
greater than 0max 10000
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
width
required |
number (double) | The second outer dimension, in `dimensionUnit`. Positive.
greater than 0max 10000
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
height
required |
number (double) | The third outer dimension, in `dimensionUnit`. Positive.
greater than 0max 10000
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
dimensionUnit
required |
ShippingDimensionUnit ShippingDimensionUnit | The unit the three dimensions are expressed in.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
isDefault
required |
boolean | Whether this is the merchant's default preset. A merchant's first preset is the default
whatever this says; setting it on another preset moves the flag there. It cannot be switched
off on the current default while the merchant has other presets.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.