---
title: "Search for booked shipments"
method: GET
path: "/shipments"
tags: ["shipments"]
---

# Search for booked shipments

`GET /shipments`

ADD ENDPOINT DESCRIPTION HERE

## Query parameters

- `query` string
- `sort` string
- `page` integer
- `searchAfter` string
- `pageSize` integer

## Response `200`

successful operation

- BookedShipmentSummary[]
  - `bookedShipmentId` integer
  - `sellerId` integer
  - `shippingServiceId` integer
  - `trackingNumber` string
  - `trackingLink` string
  - `returnTrackingNumber` string
  - `returnTrackingLink` string
  - `shipmentIdentifier` string
  - `reference` string
  - `direction` string
  - `shipToCountry` string
  - `shipToZip` string
  - `shipToCompany` string
  - `shipToName1` string
  - `shipToName2` string
  - `carrierSlug` string
  - `shipFromCountry` string
  - `shipFromZip` string
  - `shipFromCompany` string
  - `shipFromName1` string
  - `shipFromName2` string
  - `weight` 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.
  - `volume` 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.
  - `lengthM` number — Length of the shipment in meters.
  - `widthM` number — Width of the shipment in meters.
  - `heightM` number — Height of the shipment in meters.
  - `codAmount` number
  - `codCurrency` Currency
    - `currencyCode` string
    - `defaultFractionDigits` integer
    - `numericCode` integer
    - `symbol` string
    - `displayName` string
    - `numericCodeAsString` string
  - `sort` JsonNode
    - `float` boolean
    - `short` boolean
    - `nodeType` 'ARRAY' | 'BINARY' | 'BOOLEAN' | 'MISSING' | 'NULL' | 'NUMBER' | 'OBJECT' | 'POJO' | 'STRING'
    - `number` boolean
    - `double` boolean
    - `binary` boolean
    - `integralNumber` boolean
    - `boolean` boolean
    - `long` boolean
    - `int` boolean
    - `valueNode` boolean
    - `containerNode` boolean
    - `missingNode` boolean
    - `object` boolean
    - `pojo` boolean
    - `floatingPointNumber` boolean
    - `bigDecimal` boolean
    - `bigInteger` boolean
    - `textual` boolean
    - `array` boolean
    - `null` boolean
  - `trackingEnabled` boolean
  - `userIdentifier` string
  - `shipmentDate` string, date
  - `warehouseName` string
  - `created` string, date-time
  - `cancelledAt` string, date-time
  - `documents` ShipmentDocumentSummary[]
    - `shipmentDocumentId` integer
    - `type` string
  - `exportPositions` ExportPositionSummary[]
    - `quantity` integer
    - `warehouseSku` string
    - `unNumber` 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)