--- title: "Get a specific shipment" method: GET path: "/shipments/{id}" tags: ["Shipments"] --- # Get a specific shipment `GET /shipments/{id}` Retrieves a specific shipment by its unique identifier ## Path parameters - `id` string, required ## Response `200` OK - ShipmentDto - `guid` string, nullable - `type` string, nullable - `createdOn` string, nullable - `number` string, nullable - `createdByName` string, nullable - `version` integer - `modeOfTransportation` ModeOfTransportationDto - `code` string, nullable - `description` string, nullable - `method` 0 | 1 | 2 | 3 | 4 | 5 - `default` boolean - `modeOfTransportCode` string, nullable - `issuedBy` EntityDto - `guid` string, nullable - `name` string, nullable - `code` string, nullable - `address` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `issuedByAddress` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `issuedByName` string, nullable - `shipperName` string, nullable - `shipperAddress` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `shipper` EntityDto - `guid` string, nullable - `name` string, nullable - `code` string, nullable - `address` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `consigneeName` string, nullable - `consigneeAddress` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `consignee` EntityDto - `guid` string, nullable - `name` string, nullable - `code` string, nullable - `address` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `destinationAgentName` string, nullable - `destinationAgentAddress` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `destinationAgent` EntityDto - `guid` string, nullable - `name` string, nullable - `code` string, nullable - `address` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `carrier` EntityDto - `guid` string, nullable - `name` string, nullable - `code` string, nullable - `address` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `carrierName` string, nullable - `carrierAddress` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `notes` string, nullable - `waybillNotes` string, nullable - `items` ItemDto[], nullable - `guid` string, nullable - `type` string, nullable - `version` integer - `status` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 - `package` PackageDto - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 - `code` string, nullable - `name` string, nullable - `weight` WeightValueDto - `value` number, double - `unit` 0 | 1 | 2 | 3 | 4 | 5 - `volume` VolumeValueDto - `value` number, double - `unit` 0 | 1 | 2 | 3 | 4 - `packageName` string, nullable - `pieces` string, nullable - `weight` WeightValueDto - `value` number, double - `unit` 0 | 1 | 2 | 3 | 4 | 5 - `volume` VolumeValueDto - `value` number, double - `unit` 0 | 1 | 2 | 3 | 4 - `unitaryValue` MoneyValueDto - `value` number, double - `currency` string, nullable - `totalValue` MoneyValueDto - `value` number, double - `currency` string, nullable - `description` string, nullable - `partNumber` string, nullable - `model` string, nullable - `serialNumber` string, nullable - `lotNumber` string, nullable - `measurementUnits` MeasurementUnitsDto - `weightUnit` 0 | 1 | 2 | 3 | 4 | 5 - `volumeUnit` 0 | 1 | 2 | 3 | 4 - `lengthUnit` 0 | 1 | 2 | 3 | 4 | 5 - `creatorNetworkID` integer - `charges` ChargeDto[], nullable - `guid` string, nullable - `type` 0 | 1 - `description` string, nullable - `quantity` number, double - `price` MoneyValueDto - `value` number, double - `currency` string, nullable - `amount` MoneyValueDto - `value` number, double - `currency` string, nullable - `taxAmount` MoneyValueDto - `value` number, double - `currency` string, nullable - `status` 0 | 1 | 2 | 3 - `isPrepaid` boolean - `isThirdPartyCharge` boolean - `events` EventDto[], nullable - `date` string, nullable - `details` string, nullable - `location` string, nullable - `includeInTracking` boolean - `division` EntityDto - `guid` string, nullable - `name` string, nullable - `code` string, nullable - `address` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `totalPieces` integer, nullable - `totalWeight` WeightValueDto - `value` number, double - `unit` 0 | 1 | 2 | 3 | 4 | 5 - `totalVolume` VolumeValueDto - `value` number, double - `unit` 0 | 1 | 2 | 3 | 4 - `totalValue` MoneyValueDto - `value` number, double - `currency` string, nullable - `totalVolumeWeight` VolumeWeightValueDto - `value` number, double - `unit` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 - `chargeableWeight` WeightValueDto - `value` number, double - `unit` 0 | 1 | 2 | 3 | 4 | 5 - `releaseType` string, nullable - `descriptionOfGoods` string, nullable - `originPort` PortDto - `code` string, nullable - `name` string, nullable - `country` CountryDto - `code` string, nullable - `method` MethodType[], nullable - `subdivision` string, nullable - `remarks` string, nullable - `destinationPort` PortDto - `code` string, nullable - `name` string, nullable - `country` CountryDto - `code` string, nullable - `method` MethodType[], nullable - `subdivision` string, nullable - `remarks` string, nullable - `receiptPort` PortDto - `code` string, nullable - `name` string, nullable - `country` CountryDto - `code` string, nullable - `method` MethodType[], nullable - `subdivision` string, nullable - `remarks` string, nullable - `deliveryPort` PortDto - `code` string, nullable - `name` string, nullable - `country` CountryDto - `code` string, nullable - `method` MethodType[], nullable - `subdivision` string, nullable - `remarks` string, nullable - `status` 0 | 1 | 2 | 3 | 4 | 5 - `direction` 0 | 1 - `layoutType` 0 | 1 | 2 - `estimatedArrivalDate` string, nullable - `actualArrivalDate` string, nullable - `estimatedDepartureDate` string, nullable - `actualDepartureDate` string, nullable - `notifyParty` EntityDto - `guid` string, nullable - `name` string, nullable - `code` string, nullable - `address` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `notifyPartyName` string, nullable - `notifyPartyAddress` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `intermediateConsignee` EntityDto - `guid` string, nullable - `name` string, nullable - `code` string, nullable - `address` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `intermediateConsigneeName` string, nullable - `intermediateConsigneeAddress` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `importer` EntityDto - `guid` string, nullable - `name` string, nullable - `code` string, nullable - `address` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `billingClient` EntityDto - `guid` string, nullable - `name` string, nullable - `code` string, nullable - `address` AddressDto - `street` string[], nullable - `city` string, nullable - `state` string, nullable - `zipCode` string, nullable - `country` CountryDto - `code` string, nullable - `description` string, nullable - `contactName` string, nullable - `contactPhone` string, nullable - `contactPhoneExtension` string, nullable - `contactFax` string, nullable - `contactEmail` string, nullable - `portCode` string, nullable - `executedPlace` string, nullable - `executedCityCode` string, nullable - `declaredValue` string, nullable - `bookingNumber` string, nullable - `customerReferenceNumber` string, nullable - `amsWaybill` string, nullable - `masterGUID` string, nullable - `masterNumber` string, nullable - `receivedAtNetworkID` integer - `originPortSchedule` string, nullable - `destinationPortSchedule` string, nullable - `url` string, nullable - `hasAttachments` boolean - `attachments` AttachmentDto[], nullable - `name` string, nullable - `description` string, nullable - `extension` string, nullable - `size` integer - `isImage` boolean - `identifier` integer - `isInternal` boolean - `bookingStatus` 0 | 1 | 2 | 3 - `airShipmentInfo` AirShipmentDto - `airWayBillNumber` string, nullable - `flightNumber` string, nullable - `declareValueForCustoms` string, nullable - `oceanShipmentInfo` OceanShipmentDto - `billOfLadingNumber` string, nullable - `vesselName` string, nullable - `voyageIdentification` string, nullable - `groundShipmentInfo` GroundShipmentDto - `billOfLadingNumber` string, nullable - `vehicleNumber` string, nullable - `carrierTrakingNumber` string, nullable - `driverName` string, nullable ## Other responses - `400` — Bad Request - `404` — Not Found --- [API](https://skmtc.net/magayacloud/apis/msc-api-proof-of-concept.md) · [All operations](https://skmtc.net/magayacloud/apis/msc-api-proof-of-concept/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/magayacloud/msc-api-proof-of-concept/revisions/9dbc3818a965/schema)