---
title: "Get Multiple Shipments by ID"
method: POST
path: "/shipmentsbyid"
tags: ["ShipmentTrackingApi"]
---

# Get Multiple Shipments by ID

`POST /shipmentsbyid`

Retrieves multiple shipments by a list of shipment IDs, facilitating batch processing and management of shipments.

## Request body

- integer[]

## Response `200`

OK

- ClientAPIShipmentsResult
  - `status` 'OK' | 'Error' | 'ValidationFailed' — 0 = OK, 1 = Error, 2 = ValidationFailed
  - `validations` ClientAPIValidation[], nullable
    - `code` integer
    - `message` string, nullable
    - `params` object, nullable
  - `data` CNShipment[], nullable — List of shipments returned for the request.
    - `shipmentID` integer, nullable — Unique system-generated identifier for this shipment.
    - `cargoID` integer, nullable — Carrier-assigned cargo identifier.
    - `countryID` integer, nullable — Internal country identifier.
    - `centerID` integer, nullable — Internal distribution center identifier.
    - `parcelShop` CNParcelShop
      - `countryID` integer, nullable
      - `centerID` integer, nullable
      - `shortName` string, nullable
      - `remark` string, nullable
      - `delivery` boolean, nullable
      - `dropoff` boolean, nullable
      - `geoLat` number, double, nullable
      - `geoLong` number, double, nullable
      - `address` CNAddress
        - `addressID` string, nullable
        - `name` string, nullable
        - `countryPrefix` string, nullable
        - `zipCode` string, nullable
        - `place` string, nullable
        - `street` string, nullable
        - `houseNumber` integer, nullable
        - `houseNumberAddition` string, nullable
        - `addressText` string, nullable
        - `phone` string, nullable
        - `fax` string, nullable
        - `textPhone` string, nullable
        - `email` string, nullable
        - `language` string, nullable
        - `type` integer
        - `lat` number, double, nullable
        - `long` number, double, nullable
      - `psPlace` string, nullable
      - `psZipcode` string, nullable
      - `partner` string, nullable
      - `workingHours` CNWorkingHours[], nullable
        - `type` integer, nullable
        - `typeName` string, nullable
        - `from` string, nullable
        - `until` string, nullable
      - `isActive` boolean
      - `isGWO` boolean
      - `isPointPack` boolean
      - `oohType` 'ParcelShop' | 'Locker' | 'SafeBox' — 0 = ParcelShop, 1 = Locker, 2 = SafeBox
      - `isCodAllowed` boolean, nullable
      - `isExworkAllowed` boolean, nullable
    - `dropOffParcelShop` CNParcelShop
      - `countryID` integer, nullable
      - `centerID` integer, nullable
      - `shortName` string, nullable
      - `remark` string, nullable
      - `delivery` boolean, nullable
      - `dropoff` boolean, nullable
      - `geoLat` number, double, nullable
      - `geoLong` number, double, nullable
      - `address` CNAddress
        - `addressID` string, nullable
        - `name` string, nullable
        - `countryPrefix` string, nullable
        - `zipCode` string, nullable
        - `place` string, nullable
        - `street` string, nullable
        - `houseNumber` integer, nullable
        - `houseNumberAddition` string, nullable
        - `addressText` string, nullable
        - `phone` string, nullable
        - `fax` string, nullable
        - `textPhone` string, nullable
        - `email` string, nullable
        - `language` string, nullable
        - `type` integer
        - `lat` number, double, nullable
        - `long` number, double, nullable
      - `psPlace` string, nullable
      - `psZipcode` string, nullable
      - `partner` string, nullable
      - `workingHours` CNWorkingHours[], nullable
        - `type` integer, nullable
        - `typeName` string, nullable
        - `from` string, nullable
        - `until` string, nullable
      - `isActive` boolean
      - `isGWO` boolean
      - `isPointPack` boolean
      - `oohType` 'ParcelShop' | 'Locker' | 'SafeBox' — 0 = ParcelShop, 1 = Locker, 2 = SafeBox
      - `isCodAllowed` boolean, nullable
      - `isExworkAllowed` boolean, nullable
    - `client` CNClient
      - `clientID` integer, nullable
      - `clientName` string, nullable
      - `defaultGoodsDescription` string, nullable
    - `receiverDepo` CNDepo
      - `centerID` integer, nullable
      - `name` string, nullable
      - `abbreviatedName` string, nullable
    - `gwReceiverDepo` CNDepo
      - `centerID` integer, nullable
      - `name` string, nullable
      - `abbreviatedName` string, nullable
    - `receiverRoute` CNRoute
      - `routeID` integer, nullable
      - `name` string, nullable
    - `receiverRouteNumber` integer, nullable — Numeric route code for the delivery route.
    - `events` CNEvent[], nullable — List of tracking events recorded for this shipment.
      - `timeOfScan` string, date-time, nullable
      - `statusID` integer, nullable
      - `statusName` string, nullable
      - `statusDescription` string, nullable
      - `statusDescriptionEN` string, nullable
      - `scanDepo` CNDepo
        - `centerID` integer, nullable
        - `name` string, nullable
        - `abbreviatedName` string, nullable
      - `remark` string, nullable
      - `actualReceiver` string, nullable
    - `prices` CNPrice
      - `totalPrice` number, double, nullable — Total calculated price for the shipment.
    - `parent` CNShipment — recursive
    - `collies` CNShipment[], nullable — List of child packages (collies) when this is a master shipment.
    - `codDetails` CNCOD
      - `amount` number, double, nullable
      - `amountCurrency` number, double, nullable
      - `originalAmount` number, double, nullable
      - `originalAmountCurrency` number, double, nullable
      - `currency` string, nullable
      - `currencyType` 'National' | 'Euro' | 'CurrencyOfDestinationCountry' | 'MobilePaymentService' | 'CreditCard' | 'ReturnCashCRC' — 0 = National, 1 = Euro, 2 = CurrencyOfDestinationCountry, 3 = MobilePaymentService, 4 = CreditCard, 5 = ReturnCashCRC
      - `exchangeRate` number, double, nullable
      - `exchangeDate` string, nullable
      - `returnAccount` string, nullable
      - `returnAccountBank` string, nullable
    - `returnSticker` CNReturnSticker
      - `pkey` integer
      - `createTime` string, date-time, nullable
      - `returnCreateTime` string, date-time, nullable
      - `createdBy` integer, nullable
      - `returnCreatedBy` integer, nullable
      - `info` string, nullable
      - `fullID` string, nullable
      - `originalShipment` OriginalShipment
        - `fullCargoID` string, nullable
    - `isPickup` boolean, nullable — When true, the shipment was created as a pickup.
    - `sendDate` string, nullable — Date the shipment was sent (ISO 8601 format).
    - `createDate` string, nullable — Date the shipment was created (ISO 8601 format).
    - `isReturnDocument` boolean, nullable — When true, a return document is attached to this shipment.
    - `apiStatus` 'None' | 'Temp' | 'Commiting' | 'Importing' | 'Routed' | 'Printed' | 'Imported' | 'PickupRequested' | 'IsShipment' | 'Multicolli' | 'Single' | 'PickupCustomer' | 'PickupNonCustomer' | 'PickupSkipped' | 'FinalPrint' | 'IsMip' | 'IsCanceled' | 'Error' — 0 = None, 1 = Temp, 2 = Commiting, 4 = Importing, 8 = Routed, 32 = Printed, 64 = Imported, 128 = PickupRequested, 256 = IsShipment, 512 = Multicolli, 1024 = Single, 2048 = PickupCustomer, 4096 = PickupNonCustomer, 8192 = PickupSkipped, 16384 = FinalPrint, 32768 = IsMip, 65536 = IsCanceled, 1073741824 = Error
    - `colliNr` integer, nullable — Package sequence number within the master shipment (e.g., 1 of 3).
    - `pickupRemark` string, nullable — Remark for the courier at pickup (max 255 characters).
    - `deliveryRemark` string, nullable — Remark for the courier at delivery (max 255 characters).
    - `remark` string, nullable — General remark or contents description for the shipment (max 150 characters).
    - `cosignee` CNPerson
      - `name` string, nullable
      - `countryCode` string, nullable
      - `zipCode` string, nullable
      - `place` string, nullable
      - `street` string, nullable
      - `lineTelephone` string, nullable
      - `lineTelephone2` string, nullable
      - `long` string, nullable
      - `lat` string, nullable
      - `fax` string, nullable
      - `telephone` string, nullable
      - `email` string, nullable
      - `gsm` string, nullable
    - `sender` CNPerson
      - `name` string, nullable
      - `countryCode` string, nullable
      - `zipCode` string, nullable
      - `place` string, nullable
      - `street` string, nullable
      - `lineTelephone` string, nullable
      - `lineTelephone2` string, nullable
      - `long` string, nullable
      - `lat` string, nullable
      - `fax` string, nullable
      - `telephone` string, nullable
      - `email` string, nullable
      - `gsm` string, nullable
    - `unit` CNUnit
      - `unitID` integer, nullable — Internal identifier for the billing unit type.
      - `name` string, nullable — Full name of the billing unit (e.g., "Kilogram").
      - `abbreviatedName` string, nullable — Abbreviated name of the billing unit (e.g., "kg").
      - `description` string, nullable — Description of the billing unit and how it is applied.
    - `count` number, double, nullable — Number of billing units (e.g., weight in kg, number of pallets).
    - `declaredWeight` number, double, nullable — Weight declared by the sender at shipment creation.
    - `verifiedWeight` number, double, nullable — Weight verified by the carrier after measurement.
    - `cod` number, double, nullable — Cash-on-delivery amount to collect from the consignee.
    - `codToPay` number, double, nullable — Remaining COD amount yet to be collected.
    - `exWorks` number, double, nullable — Ex-works amount charged to the sender.
    - `exWorksToPay` number, double, nullable — Remaining ex-works amount yet to be paid.
    - `exWorksPickToPay` number, double, nullable — Ex-works pickup amount yet to be paid.
    - `exWorksType` integer, nullable — Ex-works collection type identifier. Must be 4 (PaidByReceiver).
    - `cppAmount` number, double, nullable — Cash-pickup-payment (CPP) amount the sender must pay. Omitted when the shipment has no CPP.
    - `cppCurrency` string, nullable — Currency of the CPP amount (e.g. EUR). Omitted when the shipment has no CPP or the currency is not set.
    - `cppCollectionStatus` string, nullable — CPP collection status: Collected, NotCollected, CollectionFailed, CollectionCancelled or CollectionRejected. Omitted when the shipment has no CPP.
    - `isCargo` boolean, nullable — When true, the shipment is classified as cargo type.
    - `isCanceled` boolean, nullable — When true, the shipment has been canceled.
    - `isPrinted` boolean, nullable — When true, the shipment label has been printed.
    - `isMaster` boolean, nullable — When true, this is a master shipment containing multiple collies.
    - `documentCollection` boolean, nullable — When true, document collection service is active for this shipment.
    - `notificationType` integer, nullable — Notification channel type for consignee delivery alerts (e.g., SMS, email).
    - `ref1` string, nullable — Customer reference 1 (max 35 characters).
    - `ref2` string, nullable — Customer reference 2 (max 35 characters).
    - `ref3` string, nullable — Customer reference 3 (max 35 characters).
    - `refInt` string, nullable — International customer reference (max 35 characters).
    - `multifunctionalBarcode` string, nullable — Primary barcode used for scanning and tracking this shipment.
    - `internationalBarcode` string, nullable — Barcode used for international routing.
    - `fullCargoID` string, nullable — Full cargo identifier including carrier prefix.
    - `sortingDepoAndRoute` string, nullable — Sorting depot and route code used for routing the shipment.
    - `pin` string, nullable — PIN code required for parcel locker or secure delivery.
    - `servicesLabel` string, nullable — Service codes label summarizing active services on the shipment.
    - `commissionType` 'None' | 'Document' | 'Item' | 'DocumentAndItem' — 0 = None, 1 = Document, 2 = Item, 3 = DocumentAndItem
    - `nesyBarcode` string, nullable
    - `nesyShipmentId` string, nullable
    - `barcode` string, nullable — Primary scanning barcode for this package.
    - `insuranceValue` number, double — Declared monetary value of the shipment for insurance purposes.
    - `insuranceCurrency` string, nullable — Currency of the declared insurance value.
  - `error` ClientAPIError
    - `code` integer
    - `message` string, nullable
    - `stackTrace` string, nullable
    - `innerException` ClientAPIError — recursive
    - `validations` ClientAPIValidation[], nullable
      - `code` integer
      - `message` string, nullable
      - `params` object, nullable
    - `messageParams` string[], nullable
    - `payload` JToken[]
  - `traceID` string, nullable — Unique trace identifier for debugging and support purposes.

---

[API](https://skmtc.dev/expressone/apis/client-api.md) · [All operations](https://skmtc.dev/expressone/apis/client-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/expressone/client-api/revisions/2acf7e4a5080/schema)