---
title: "Book shipments for orders stored in shop"
method: POST
path: "/shipments/bookShopAsync"
tags: ["shipments"]
---

# Book shipments for orders stored in shop

`POST /shipments/bookShopAsync`

ADD ENDPOINT DESCRIPTION HERE

## Request body

- BookShopAsyncRequest
  - `requestUUID` string — 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.
  - `reference` string — 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.
  - `shippingServiceGroupId` integer, required — shipping service group from which to load the shipping services to use.
  - `shipFrom` ShipmentDeliveryAddress
    - `name` string — Name of the recipient. <br>Usually this is the first and lastname of the recipient.
    - `company` string — Name of the company.
    - `phone` string — Phone number of the recipient. <br>The phone number is usually optional.
    - `email` string — E-Mail address of the recipient.
    - `zip` string — ZIP Code of the recipient <br>The ZIP code is optional for some countries, but required for most.
    - `city` string, required — City of the recipient. <br>The city should always be specified.
    - `state` string — State of the recipient. <br>This is not required for most countries, but required in some (eg: United States).
    - `countryIso2` string
    - `street` string, required — Street (or Address Line 1) of the recipient. <br>This field should always be specified.
    - `street2` string — Street (or Address Line 2) of the recipient. <br>This field is optional.
    - `latitude` number, double — Latitude of the address. <br>This field is optional and used for some carriers to optimize the delivery process.
    - `longitude` number, double — Longitude of the address. <br>This field is optional and used for some carriers to optimize the delivery process.
  - `lengthM` number — Optional length <em>(in meters)</em> of the shipment.
  - `widthM` number — Optional width <em>(in meters)</em> of the shipment.
  - `heightM` number — Optional height <em>(in meters)</em> of the shipment.
  - `mailTo` string, 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.
  - `shopId` integer, required — ID of the shop from which the order data can be retrieved.
  - `orderIdentifiers` string[], 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.
  - `parcelHeight` number — The height of the packaging material used in <code>m</code>. <br>Value is rounded to three decimal places.
  - `parcelWidth` number — The width of the packaging material used in <code>m</code>. <br>Value is rounded to three decimal places.
  - `parcelLength` number — The length of the packaging material used in <code>m</code>. <br>Value is rounded to three decimal places.
  - `parcelWeight` number, 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).
  - `contentWeight` number — 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.
  - `exportFulfillment` boolean — If set to true, the fulfillment data (tracking number and provider) are transmitted to the shop system after the label was created.
  - `hideEmailAddress` boolean — 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 `default`

successful operation

---

[API](https://skmtc.net/writechoiceorg/apis/connector.md) · [All operations](https://skmtc.net/writechoiceorg/apis/connector/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/writechoiceorg/connector/versions/7ce09a4b2a4e/schema)