--- title: "Book a return shipment label" method: POST path: "/returnApp/book" tags: ["returnApp"] --- # Book a return shipment label `POST /returnApp/book` ADD ENDPOINT DESCRIPTION HERE ## Request body - BookReturnRequest - `requestUUID` string, required — A unique identifier for the request.
Used for tracing and to prevent duplicate shipment bookings. - `hash` string, required — The hash that is used for booking return label. - `reference` string, required — A human readable reference for the request.
This will be included in the mail that is sent once the operation completes. - `shipFrom` ShipmentDeliveryAddress, required - `name` string — Name of the recipient.
Usually this is the first and lastname of the recipient. - `company` string — Name of the company. - `phone` string — Phone number of the recipient.
The phone number is usually optional. - `email` string — E-Mail address of the recipient. - `zip` string — ZIP Code of the recipient
The ZIP code is optional for some countries, but required for most. - `city` string, required — City of the recipient.
The city should always be specified. - `state` string — State of the recipient.
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.
This field should always be specified. - `street2` string — Street (or Address Line 2) of the recipient.
This field is optional. - `latitude` number, double — Latitude of the address.
This field is optional and used for some carriers to optimize the delivery process. - `longitude` number, double — Longitude of the address.
This field is optional and used for some carriers to optimize the delivery process. - `grossWeightKG` number, required — Weight of the return shipment. - `heightM` number — Height of the return shipment in meters. - `lengthM` number — Length of the return shipment in meters. - `widthM` number — Width of the return shipment in meters. - `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. - `invoiceNumber` string — Optional invoice number for the shipment. Only required for royal mail. - `invoiceDate` string — Optional invoice date for the shipment. Only required for royal mail. ## 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.
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. ## Changes - **2025-12-05** `9dd8e967f8e9` — 2 warning - removed the request property `customsPositions/items/barcode` - removed the optional property `messageKey` from the response with the `200` status [Change history](https://skmtc.dev/writechoiceorg/apis/connector/changes/returnApp/book/post.md) --- [API](https://skmtc.dev/writechoiceorg/apis/connector.md) · [All operations](https://skmtc.dev/writechoiceorg/apis/connector/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/writechoiceorg/connector/revisions/7ce09a4b2a4e/schema)