---
title: "Book a shipment label"
method: POST
path: "/shipments/book"
tags: ["shipments"]
---

# Book a shipment label

`POST /shipments/book`

ADD ENDPOINT DESCRIPTION HERE

## Request body

- BookRequest
  - `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.
  - `grossWeightKg` number, required — The total weight <em>(kilograms)</em> of the shipment including packaging.
  - `shipTo` ShipmentDeliveryAddress, required
    - `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.
  - `customsPositions` CustomsPosition[] — Optional customs positions for the shipment. Only required if shipping to countries for which export documents are required.
    - `description` string, required — Name or short description of product.
    - `quantity` integer, required — Number of pieces in shipment of product.
    - `pieceNetWeightKg` number, required — Net weight in kg per piece.
    - `pieceNetCustomsValue` number, required — Net customs value per piece in the currency.
    - `originCountryIso2` 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'CW' | 'BQ' | 'SX' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — The country of origin of the product.
    - `currency` string — The currency in which customs values are specified.
    - `tariffNumber` string — The tariff number (customs number).
    - `orderedSku` string — Optional value. The SKU of the position.
    - `unNumber` string — Optional value. The UN number of the position.
  - `sellerId` integer, required — The seller who is booking this shipment (required). <br>The booked shipment will show up in the history of this seller.
  - `invoiceNumber` string — The invoice number to be used for customs declaration.
  - `invoiceDate` string, date — The invoice date to be used for customs declaration.
  - `transportInsuranceAmount` number — Optional amount which should get insured when booking the shipment. <br>Note that most shipping services already have a basic insurance included. To use the already included insurance, you must not set this field to any value other than <code>null</code>.<br>Setting this field to a non <code>null</code> value will book an additional insurance.
  - `includeReturnLabel` boolean — Optional value setting whether a return labels should be included in addition to the main label or not.
  - `trackingEnabled` boolean — Optional value setting whether to turn on/off tracking functionality for shipment. Additional charges will apply when set to true.
  - `shipmentDate` string, date — Optional future or today's date when the shipment will be handed over to the carrier. If not specified, default's to today.
  - `termsOfTrade` 'DAP' | 'DDP' — Optional terms of trade. If not specified, default's <code>DAP</code>.
  - `additionalParcels` ShipmentParcelGet[] — Optional additional parcels for the shipment. Note that by default the request represent the primary parcel/package for this shipment, use this field only if is needed to add more packages for the shipment.
    - `weight` number, required — Parcel weight <em>(kilograms)</em> including packaging.
    - `length` number — Parcel package length <em>(meters)</em> <br>This field will be considered only if <b>width<b/> and <b>height<b/> are filled as well.
    - `width` number — Parcel package width <em>(meters)</em> <br>This field will be considered only if <b>length<b/> and <b>height<b/> are filled as well.
    - `height` number — Parcel package height <em>(meter)</em> <br>This field will be considered only if <b>length<b/> and <b>width<b/> are filled as well.
    - `reference` string — Parcel package reference for the current shipment <em>(meter)</em>
  - `userIdentifier` string — The userId of a third party app who booked the shipment.
  - `shopOrderIdentifier` string — Optional value. Identifies the order in the customer's shop.
  - `contentDescription` string — Optional description of the shipment contents.
  - `systemReference` string — Optional system reference, can be used to trace the shipment
  - `shipmentAttachments` ShipmentAttachmentPost[] — Optional attachments parameter
    - `fileName` string — Name for the attachment
    - `fileKey` string — Identifier of the file to be attached.
    - `mimeType` string — Mime type of the file
  - `cashOnDeliveryAmount` number — Optional COD total amount parameter. If the amount is greater than 0, it will be processed as a COD shipment
  - `cashOnDeliveryCurrency` string — The currency in which COD amount is specified.

## Response `200`

successful operation

- BookResponse
  - `status` 'OK' | 'ERROR' — Indicates whether the operation was successful or not.
  - `message` string — Optional additional information about the operation's result. <br>When the operation failed, this field includes more information about the error.
  - `bookedShipmentId` integer — ID of booked shipment
  - `trackingNumber` string — The tracking number of the booked shipment.
  - `trackingLink` string — The tracking link of the booked shipment. Note that some carriers do not immediately recognize shipments after they have been created
  - `labelUrls` string[] — List of URLs where the labels can be downloaded.
  - `documentUrls` string[] — List of URLs where additional documents, such as export documents, can be downloaded.

---

[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)