---
title: "Get details of a booked shipment"
method: GET
path: "/shipments/{bookedShipmentId}"
tags: ["shipments"]
---

# Get details of a booked shipment

`GET /shipments/{bookedShipmentId}`

ADD ENDPOINT DESCRIPTION HERE

## Path parameters

- `bookedShipmentId` integer, required

## Response `200`

successful operation

- BookedShipmentGet
  - `sellerId` integer
  - `shippingServiceId` integer
  - `request` ShippingOrderGet
    - `shipTo` 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.
    - `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.
    - `reference` string
    - `grossWeightKg` number — The gross weight of the shipment's main parcel in kg, which does not include the weight of any additional parcels.
    - `lengthM` number — The length of the shipment's main parcel in meters.
    - `widthM` number — The width of the shipment's main parcel in meters.
    - `heightM` number — The height of the shipment's main parcel in meters.
    - `totalWeight` number — The total weight of the shipment in kg, which is the sum of the weight of the main as well as all additional parcels in this shipment.
    - `totalVolume` number — The total volume of the shipment in m3, which is the sum of the volume of the main as well as all additional parcels in this shipment.
    - `shipmentDate` string, date-time
    - `invoiceNumber` string
    - `invoiceDate` string, date-time
    - `includeReturnLabel` boolean
    - `trackingEnabled` boolean
    - `userIdentifier` string
    - `cashOnDeliveryAmount` number
    - `cashOnDeliveryCurrency` Currency
      - `currencyCode` string
      - `defaultFractionDigits` integer
      - `numericCode` integer
      - `symbol` string
      - `displayName` string
      - `numericCodeAsString` string
    - `customsPositions` ExportPositionGet[]
      - `currency` Currency
        - `currencyCode` string
        - `defaultFractionDigits` integer
        - `numericCode` integer
        - `symbol` string
        - `displayName` string
        - `numericCodeAsString` string
      - `quantity` integer
      - `origin` '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'
      - `tariff` string
      - `warehouseSku` string
      - `contentDescription` string
      - `unNumber` string
      - `description` string
      - `pieceNetCustomsValue` number
      - `pieceNetWeightKg` number
    - `transportInsuranceAmount` number
    - `termsOfTrade` 'DAP' | 'DDP'
    - `additionalParcels` ShipmentParcelGet[]
      - `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>
    - `orderReference` string — Reference for the order from the customer shop system
  - `documents` ShipmentDocumentGet[]
    - `shipmentDocumentId` integer
    - `type` 'LABEL' | 'EXPORT_DOCUMENT' | 'NON_PRINT_EXPORT_DOCUMENT' | 'MANIFEST_DOCUMENT' | 'RETURN_LABEL'
  - `trackingDetails` TrackingDetailGet[]
    - `status` string
    - `created` string, date-time
    - `message` string
    - `rawTag` string
  - `id` integer
  - `created` string, date-time
  - `requestId` string
  - `trackingNumber` string
  - `additionalTrackingNumbers` AdditionalTrackingNumberGet[]
    - `trackingNumber` string
    - `reference` string
  - `returnTrackingNumber` string
  - `additionalReturnTrackingNumbers` AdditionalTrackingNumberGet[]
    - `trackingNumber` string
    - `reference` string
  - `shipmentIdentifier` string
  - `cancelledAt` string, date-time
  - `carrierCancelledAt` string, date-time
  - `shipTo` 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.
  - `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.
  - `parcelWeight` number
  - `parcelReference` string
  - `contentDescription` string
  - `trackingLink` string
  - `returnTrackingLink` string
  - `carrierSlug` string
  - `carrierName` string
  - `direction` string

---

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