v6

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-09153208467.0 KB
shipments

Book shipments for orders stored in shop

ADD ENDPOINT DESCRIPTION HERE

post/shipments/bookShopAsync

Request body

requestUUIDstring

A unique identifier for the request. <br>Used for tracing and to prevent duplicate shipment bookings. <br>This value is optional, if not included, a random requestUUID is generated.

referencestring

A human readable reference for the request. <br>This will be included in the mail that is sent once the operation completes.<br>This value is optional, if not included, a random reference will be generated.

shippingServiceGroupIdinteger required

shipping service group from which to load the shipping services to use.

lengthMnumber

Optional length <em>(in meters)</em> of the shipment.

widthMnumber

Optional width <em>(in meters)</em> of the shipment.

heightMnumber

Optional height <em>(in meters)</em> of the shipment.

mailTostring required

e-Mail address to which the results will be sent. <br>Muliple e-mail addresses can be specified by separating them with a comma.

shopIdinteger required

ID of the shop from which the order data can be retrieved.

orderIdentifiersstring[] required

list of order identifiers for which the shipments need to get booked. <br>At least one order identifier needs to be specified. <br>Duplicate or empty order identifiers are not allowed.

parcelHeightnumber

The height of the packaging material used in <code>m</code>. <br>Value is rounded to three decimal places.

parcelWidthnumber

The width of the packaging material used in <code>m</code>. <br>Value is rounded to three decimal places.

parcelLengthnumber

The length of the packaging material used in <code>m</code>. <br>Value is rounded to three decimal places.

parcelWeightnumber required

The weight of the packaging material used in <code>kg</code>. <br>Should not contain the weight of the shipment's content (eg: products).

contentWeightnumber

Optional weight of the shipment's content in <code>kg</code>. <br>Should not contain the weight of the packaging material. <br>Use this field with care and in rare cases only, as it overrides the default weight calculation, which is based on the ordered product's weight. <br>Using this field can cause inconsistencies with the customs declaration and could result in errors during shipment booking.

exportFulfillmentboolean

If set to true, the fulfillment data (tracking number and provider) are transmitted to the shop system after the label was created.

hideEmailAddressboolean

If set to true, the shipment recipient's e-mail address is not transmitted to the carrier. <br>This means that the carrier is not able to contact the recipient of the shipment by e-mail.

Response

successful operation