GET api/v1/Shipments/{shipmentId}
Retrieves the Shipment identified by id
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| shipmentId | ShipmentID |
Define this parameter in the request URI. |
Response Information
ShipmentsDTO
Response body formats
application/json, text/json
Sample:
{
"ShipmentID": 1,
"Title": "sample string 2",
"TransportMode": "sample string 3",
"MovementType": "sample string 4",
"ServiceType": "sample string 5",
"State": "sample string 6",
"ChargesFor": "sample string 7",
"FreightTerms": "sample string 8",
"INCOTerms": {
"Terms": "sample string 1",
"Place": "sample string 2"
},
"ShipmentDeclared": {
"Value": "sample string 1",
"Currency": "sample string 2"
},
"Locations": {
"PlaceOfReceipt": {
"Location": {
"lat": 1.1,
"lng": 2.1
},
"Code": "sample string 1",
"Name": "sample string 2"
},
"PlaceOfDelivery": {
"Location": {
"lat": 1.1,
"lng": 2.1
},
"Code": "sample string 1",
"Name": "sample string 2"
},
"PortOfLoading": {
"Location": {
"lat": 1.1,
"lng": 2.1
},
"Code": "sample string 1",
"Name": "sample string 2"
},
"PortOfDischarge": {
"Location": {
"lat": 1.1,
"lng": 2.1
},
"Code": "sample string 1",
"Name": "sample string 2"
}
},
"PickupDetails": "sample string 9",
"LocalAddress": {
"Line1": "sample string 1",
"Line2": "sample string 2",
"Place": "sample string 3",
"City": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"StateProvince": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"Country": {
"Code": "sample string 1",
"Name": "sample string 1 - sample string 2"
},
"PostalCode": "sample string 4",
"Location": {
"lat": 1.1,
"lng": 2.1
}
},
"Cargos": [
{
"CargoID": 1,
"CargoType": "sample string 1",
"Commodity": "sample string 2",
"PackageTypeCode": "sample string 3",
"NumberOfPackages": 4,
"HSCode": [
{
"Name": "sample string 2 - sample string 1",
"Code": "sample string 2"
},
{
"Name": "sample string 2 - sample string 1",
"Code": "sample string 2"
},
{
"Name": "sample string 2 - sample string 1",
"Code": "sample string 2"
}
],
"NetWeight": {
"Value": 1.0,
"UOM": "sample string 1"
},
"GrossWeight": {
"Value": 1.0,
"UOM": "sample string 1"
},
"GrossVolume": {
"Value": 1.0,
"UOM": "sample string 1"
},
"Dimensions": {
"Length": 1.0,
"Width": 1.0,
"Height": 1.0,
"UOM": "sample string 1"
},
"Remarks": "sample string 5",
"Hazmat": [
{
"HazmatID": 1,
"IMOClassCode": "sample string 1",
"UNDGNumber": "sample string 2",
"ProperShippingName": "sample string 3",
"PackingGroupCode": "sample string 4",
"FlashpointTemperature": {
"Value": 1.0,
"UOM": "sample string 1"
},
"SpecialInstruction": "sample string 5"
},
{
"HazmatID": 1,
"IMOClassCode": "sample string 1",
"UNDGNumber": "sample string 2",
"ProperShippingName": "sample string 3",
"PackingGroupCode": "sample string 4",
"FlashpointTemperature": {
"Value": 1.0,
"UOM": "sample string 1"
},
"SpecialInstruction": "sample string 5"
},
{
"HazmatID": 1,
"IMOClassCode": "sample string 1",
"UNDGNumber": "sample string 2",
"ProperShippingName": "sample string 3",
"PackingGroupCode": "sample string 4",
"FlashpointTemperature": {
"Value": 1.0,
"UOM": "sample string 1"
},
"SpecialInstruction": "sample string 5"
}
],
"Reefer": [
{
"ReeferID": 1,
"Temperature": {
"Min": 1.0,
"Max": 2.0,
"UOM": "sample string 3"
},
"Humidity": 1.0,
"SpecialInstruction": "sample string 1"
},
{
"ReeferID": 1,
"Temperature": {
"Min": 1.0,
"Max": 2.0,
"UOM": "sample string 3"
},
"Humidity": 1.0,
"SpecialInstruction": "sample string 1"
},
{
"ReeferID": 1,
"Temperature": {
"Min": 1.0,
"Max": 2.0,
"UOM": "sample string 3"
},
"Humidity": 1.0,
"SpecialInstruction": "sample string 1"
}
]
},
{
"CargoID": 1,
"CargoType": "sample string 1",
"Commodity": "sample string 2",
"PackageTypeCode": "sample string 3",
"NumberOfPackages": 4,
"HSCode": [
{
"Name": "sample string 2 - sample string 1",
"Code": "sample string 2"
},
{
"Name": "sample string 2 - sample string 1",
"Code": "sample string 2"
},
{
"Name": "sample string 2 - sample string 1",
"Code": "sample string 2"
}
],
"NetWeight": {
"Value": 1.0,
"UOM": "sample string 1"
},
"GrossWeight": {
"Value": 1.0,
"UOM": "sample string 1"
},
"GrossVolume": {
"Value": 1.0,
"UOM": "sample string 1"
},
"Dimensions": {
"Length": 1.0,
"Width": 1.0,
"Height": 1.0,
"UOM": "sample string 1"
},
"Remarks": "sample string 5",
"Hazmat": [
{
"HazmatID": 1,
"IMOClassCode": "sample string 1",
"UNDGNumber": "sample string 2",
"ProperShippingName": "sample string 3",
"PackingGroupCode": "sample string 4",
"FlashpointTemperature": {
"Value": 1.0,
"UOM": "sample string 1"
},
"SpecialInstruction": "sample string 5"
},
{
"HazmatID": 1,
"IMOClassCode": "sample string 1",
"UNDGNumber": "sample string 2",
"ProperShippingName": "sample string 3",
"PackingGroupCode": "sample string 4",
"FlashpointTemperature": {
"Value": 1.0,
"UOM": "sample string 1"
},
"SpecialInstruction": "sample string 5"
},
{
"HazmatID": 1,
"IMOClassCode": "sample string 1",
"UNDGNumber": "sample string 2",
"ProperShippingName": "sample string 3",
"PackingGroupCode": "sample string 4",
"FlashpointTemperature": {
"Value": 1.0,
"UOM": "sample string 1"
},
"SpecialInstruction": "sample string 5"
}
],
"Reefer": [
{
"ReeferID": 1,
"Temperature": {
"Min": 1.0,
"Max": 2.0,
"UOM": "sample string 3"
},
"Humidity": 1.0,
"SpecialInstruction": "sample string 1"
},
{
"ReeferID": 1,
"Temperature": {
"Min": 1.0,
"Max": 2.0,
"UOM": "sample string 3"
},
"Humidity": 1.0,
"SpecialInstruction": "sample string 1"
},
{
"ReeferID": 1,
"Temperature": {
"Min": 1.0,
"Max": 2.0,
"UOM": "sample string 3"
},
"Humidity": 1.0,
"SpecialInstruction": "sample string 1"
}
]
},
{
"CargoID": 1,
"CargoType": "sample string 1",
"Commodity": "sample string 2",
"PackageTypeCode": "sample string 3",
"NumberOfPackages": 4,
"HSCode": [
{
"Name": "sample string 2 - sample string 1",
"Code": "sample string 2"
},
{
"Name": "sample string 2 - sample string 1",
"Code": "sample string 2"
},
{
"Name": "sample string 2 - sample string 1",
"Code": "sample string 2"
}
],
"NetWeight": {
"Value": 1.0,
"UOM": "sample string 1"
},
"GrossWeight": {
"Value": 1.0,
"UOM": "sample string 1"
},
"GrossVolume": {
"Value": 1.0,
"UOM": "sample string 1"
},
"Dimensions": {
"Length": 1.0,
"Width": 1.0,
"Height": 1.0,
"UOM": "sample string 1"
},
"Remarks": "sample string 5",
"Hazmat": [
{
"HazmatID": 1,
"IMOClassCode": "sample string 1",
"UNDGNumber": "sample string 2",
"ProperShippingName": "sample string 3",
"PackingGroupCode": "sample string 4",
"FlashpointTemperature": {
"Value": 1.0,
"UOM": "sample string 1"
},
"SpecialInstruction": "sample string 5"
},
{
"HazmatID": 1,
"IMOClassCode": "sample string 1",
"UNDGNumber": "sample string 2",
"ProperShippingName": "sample string 3",
"PackingGroupCode": "sample string 4",
"FlashpointTemperature": {
"Value": 1.0,
"UOM": "sample string 1"
},
"SpecialInstruction": "sample string 5"
},
{
"HazmatID": 1,
"IMOClassCode": "sample string 1",
"UNDGNumber": "sample string 2",
"ProperShippingName": "sample string 3",
"PackingGroupCode": "sample string 4",
"FlashpointTemperature": {
"Value": 1.0,
"UOM": "sample string 1"
},
"SpecialInstruction": "sample string 5"
}
],
"Reefer": [
{
"ReeferID": 1,
"Temperature": {
"Min": 1.0,
"Max": 2.0,
"UOM": "sample string 3"
},
"Humidity": 1.0,
"SpecialInstruction": "sample string 1"
},
{
"ReeferID": 1,
"Temperature": {
"Min": 1.0,
"Max": 2.0,
"UOM": "sample string 3"
},
"Humidity": 1.0,
"SpecialInstruction": "sample string 1"
},
{
"ReeferID": 1,
"Temperature": {
"Min": 1.0,
"Max": 2.0,
"UOM": "sample string 3"
},
"Humidity": 1.0,
"SpecialInstruction": "sample string 1"
}
]
}
],
"Containers": [
{
"ContainerID": 1,
"ContainerTypeCode": "sample string 1",
"NumberOfContainers": 2,
"IsShipperOwned": true
},
{
"ContainerID": 1,
"ContainerTypeCode": "sample string 1",
"NumberOfContainers": 2,
"IsShipperOwned": true
},
{
"ContainerID": 1,
"ContainerTypeCode": "sample string 1",
"NumberOfContainers": 2,
"IsShipperOwned": true
}
],
"Services": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Remarks": "sample string 10",
"Created": null,
"Updated": {
"AgentID": 1,
"AgentIDAsText": "1",
"AgentName": null,
"ContactID": 0,
"ContactIDAsText": "0",
"ContactName": null,
"Datetime": null,
"DatetimeAsText": null
}
}
application/xml, text/xml
Sample:
<ShipmentsDTO>
<ShipmentID>1</ShipmentID>
<Title>sample string 2</Title>
<TransportMode>sample string 3</TransportMode>
<MovementType>sample string 4</MovementType>
<ServiceType>sample string 5</ServiceType>
<State>sample string 6</State>
<ChargesFor>sample string 7</ChargesFor>
<FreightTerms>sample string 8</FreightTerms>
<INCOTerms>
<Terms>sample string 1</Terms>
<Place>sample string 2</Place>
</INCOTerms>
<ShipmentDeclared>
<Value>sample string 1</Value>
<Currency>sample string 2</Currency>
</ShipmentDeclared>
<Locations>
<PlaceOfReceipt>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
<Location>
<lat>1.1</lat>
<lng>2.1</lng>
</Location>
</PlaceOfReceipt>
<PlaceOfDelivery>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
<Location>
<lat>1.1</lat>
<lng>2.1</lng>
</Location>
</PlaceOfDelivery>
<PortOfLoading>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
<Location>
<lat>1.1</lat>
<lng>2.1</lng>
</Location>
</PortOfLoading>
<PortOfDischarge>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
<Location>
<lat>1.1</lat>
<lng>2.1</lng>
</Location>
</PortOfDischarge>
</Locations>
<PickupDetails>sample string 9</PickupDetails>
<LocalAddress>
<Line1>sample string 1</Line1>
<Line2>sample string 2</Line2>
<Place>sample string 3</Place>
<City>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</City>
<StateProvince>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</StateProvince>
<Country>
<Code>sample string 1</Code>
<Name>sample string 1 - sample string 2</Name>
</Country>
<PostalCode>sample string 4</PostalCode>
<Location>
<lat>1.1</lat>
<lng>2.1</lng>
</Location>
</LocalAddress>
<Cargos>
<CargoID>1</CargoID>
<CargoType>sample string 1</CargoType>
<Commodity>sample string 2</Commodity>
<PackageTypeCode>sample string 3</PackageTypeCode>
<NumberOfPackages>4</NumberOfPackages>
<HSCode>
<Code>sample string 2</Code>
<Name>sample string 2 - sample string 1</Name>
</HSCode>
<HSCode>
<Code>sample string 2</Code>
<Name>sample string 2 - sample string 1</Name>
</HSCode>
<HSCode>
<Code>sample string 2</Code>
<Name>sample string 2 - sample string 1</Name>
</HSCode>
<NetWeight>
<Value>1</Value>
<UOM>sample string 1</UOM>
</NetWeight>
<GrossWeight>
<Value>1</Value>
<UOM>sample string 1</UOM>
</GrossWeight>
<GrossVolume>
<Value>1</Value>
<UOM>sample string 1</UOM>
</GrossVolume>
<Dimensions>
<Length>1</Length>
<Width>1</Width>
<Height>1</Height>
<UOM>sample string 1</UOM>
</Dimensions>
<Remarks>sample string 5</Remarks>
<Hazmat>
<HazmatID>1</HazmatID>
<IMOClassCode>sample string 1</IMOClassCode>
<UNDGNumber>sample string 2</UNDGNumber>
<ProperShippingName>sample string 3</ProperShippingName>
<PackingGroupCode>sample string 4</PackingGroupCode>
<FlashpointTemperature>
<Value>1</Value>
<UOM>sample string 1</UOM>
</FlashpointTemperature>
<SpecialInstruction>sample string 5</SpecialInstruction>
</Hazmat>
<Hazmat>
<HazmatID>1</HazmatID>
<IMOClassCode>sample string 1</IMOClassCode>
<UNDGNumber>sample string 2</UNDGNumber>
<ProperShippingName>sample string 3</ProperShippingName>
<PackingGroupCode>sample string 4</PackingGroupCode>
<FlashpointTemperature>
<Value>1</Value>
<UOM>sample string 1</UOM>
</FlashpointTemperature>
<SpecialInstruction>sample string 5</SpecialInstruction>
</Hazmat>
<Hazmat>
<HazmatID>1</HazmatID>
<IMOClassCode>sample string 1</IMOClassCode>
<UNDGNumber>sample string 2</UNDGNumber>
<ProperShippingName>sample string 3</ProperShippingName>
<PackingGroupCode>sample string 4</PackingGroupCode>
<FlashpointTemperature>
<Value>1</Value>
<UOM>sample string 1</UOM>
</FlashpointTemperature>
<SpecialInstruction>sample string 5</SpecialInstruction>
</Hazmat>
<Reefer>
<ReeferID>1</ReeferID>
<Temperature>
<Min>1</Min>
<Max>2</Max>
<UOM>sample string 3</UOM>
</Temperature>
<Humidity>1</Humidity>
<SpecialInstruction>sample string 1</SpecialInstruction>
</Reefer>
<Reefer>
<ReeferID>1</ReeferID>
<Temperature>
<Min>1</Min>
<Max>2</Max>
<UOM>sample string 3</UOM>
</Temperature>
<Humidity>1</Humidity>
<SpecialInstruction>sample string 1</SpecialInstruction>
</Reefer>
<Reefer>
<ReeferID>1</ReeferID>
<Temperature>
<Min>1</Min>
<Max>2</Max>
<UOM>sample string 3</UOM>
</Temperature>
<Humidity>1</Humidity>
<SpecialInstruction>sample string 1</SpecialInstruction>
</Reefer>
</Cargos>
<Cargos>
<CargoID>1</CargoID>
<CargoType>sample string 1</CargoType>
<Commodity>sample string 2</Commodity>
<PackageTypeCode>sample string 3</PackageTypeCode>
<NumberOfPackages>4</NumberOfPackages>
<HSCode>
<Code>sample string 2</Code>
<Name>sample string 2 - sample string 1</Name>
</HSCode>
<HSCode>
<Code>sample string 2</Code>
<Name>sample string 2 - sample string 1</Name>
</HSCode>
<HSCode>
<Code>sample string 2</Code>
<Name>sample string 2 - sample string 1</Name>
</HSCode>
<NetWeight>
<Value>1</Value>
<UOM>sample string 1</UOM>
</NetWeight>
<GrossWeight>
<Value>1</Value>
<UOM>sample string 1</UOM>
</GrossWeight>
<GrossVolume>
<Value>1</Value>
<UOM>sample string 1</UOM>
</GrossVolume>
<Dimensions>
<Length>1</Length>
<Width>1</Width>
<Height>1</Height>
<UOM>sample string 1</UOM>
</Dimensions>
<Remarks>sample string 5</Remarks>
<Hazmat>
<HazmatID>1</HazmatID>
<IMOClassCode>sample string 1</IMOClassCode>
<UNDGNumber>sample string 2</UNDGNumber>
<ProperShippingName>sample string 3</ProperShippingName>
<PackingGroupCode>sample string 4</PackingGroupCode>
<FlashpointTemperature>
<Value>1</Value>
<UOM>sample string 1</UOM>
</FlashpointTemperature>
<SpecialInstruction>sample string 5</SpecialInstruction>
</Hazmat>
<Hazmat>
<HazmatID>1</HazmatID>
<IMOClassCode>sample string 1</IMOClassCode>
<UNDGNumber>sample string 2</UNDGNumber>
<ProperShippingName>sample string 3</ProperShippingName>
<PackingGroupCode>sample string 4</PackingGroupCode>
<FlashpointTemperature>
<Value>1</Value>
<UOM>sample string 1</UOM>
</FlashpointTemperature>
<SpecialInstruction>sample string 5</SpecialInstruction>
</Hazmat>
<Hazmat>
<HazmatID>1</HazmatID>
<IMOClassCode>sample string 1</IMOClassCode>
<UNDGNumber>sample string 2</UNDGNumber>
<ProperShippingName>sample string 3</ProperShippingName>
<PackingGroupCode>sample string 4</PackingGroupCode>
<FlashpointTemperature>
<Value>1</Value>
<UOM>sample string 1</UOM>
</FlashpointTemperature>
<SpecialInstruction>sample string 5</SpecialInstruction>
</Hazmat>
<Reefer>
<ReeferID>1</ReeferID>
<Temperature>
<Min>1</Min>
<Max>2</Max>
<UOM>sample string 3</UOM>
</Temperature>
<Humidity>1</Humidity>
<SpecialInstruction>sample string 1</SpecialInstruction>
</Reefer>
<Reefer>
<ReeferID>1</ReeferID>
<Temperature>
<Min>1</Min>
<Max>2</Max>
<UOM>sample string 3</UOM>
</Temperature>
<Humidity>1</Humidity>
<SpecialInstruction>sample string 1</SpecialInstruction>
</Reefer>
<Reefer>
<ReeferID>1</ReeferID>
<Temperature>
<Min>1</Min>
<Max>2</Max>
<UOM>sample string 3</UOM>
</Temperature>
<Humidity>1</Humidity>
<SpecialInstruction>sample string 1</SpecialInstruction>
</Reefer>
</Cargos>
<Cargos>
<CargoID>1</CargoID>
<CargoType>sample string 1</CargoType>
<Commodity>sample string 2</Commodity>
<PackageTypeCode>sample string 3</PackageTypeCode>
<NumberOfPackages>4</NumberOfPackages>
<HSCode>
<Code>sample string 2</Code>
<Name>sample string 2 - sample string 1</Name>
</HSCode>
<HSCode>
<Code>sample string 2</Code>
<Name>sample string 2 - sample string 1</Name>
</HSCode>
<HSCode>
<Code>sample string 2</Code>
<Name>sample string 2 - sample string 1</Name>
</HSCode>
<NetWeight>
<Value>1</Value>
<UOM>sample string 1</UOM>
</NetWeight>
<GrossWeight>
<Value>1</Value>
<UOM>sample string 1</UOM>
</GrossWeight>
<GrossVolume>
<Value>1</Value>
<UOM>sample string 1</UOM>
</GrossVolume>
<Dimensions>
<Length>1</Length>
<Width>1</Width>
<Height>1</Height>
<UOM>sample string 1</UOM>
</Dimensions>
<Remarks>sample string 5</Remarks>
<Hazmat>
<HazmatID>1</HazmatID>
<IMOClassCode>sample string 1</IMOClassCode>
<UNDGNumber>sample string 2</UNDGNumber>
<ProperShippingName>sample string 3</ProperShippingName>
<PackingGroupCode>sample string 4</PackingGroupCode>
<FlashpointTemperature>
<Value>1</Value>
<UOM>sample string 1</UOM>
</FlashpointTemperature>
<SpecialInstruction>sample string 5</SpecialInstruction>
</Hazmat>
<Hazmat>
<HazmatID>1</HazmatID>
<IMOClassCode>sample string 1</IMOClassCode>
<UNDGNumber>sample string 2</UNDGNumber>
<ProperShippingName>sample string 3</ProperShippingName>
<PackingGroupCode>sample string 4</PackingGroupCode>
<FlashpointTemperature>
<Value>1</Value>
<UOM>sample string 1</UOM>
</FlashpointTemperature>
<SpecialInstruction>sample string 5</SpecialInstruction>
</Hazmat>
<Hazmat>
<HazmatID>1</HazmatID>
<IMOClassCode>sample string 1</IMOClassCode>
<UNDGNumber>sample string 2</UNDGNumber>
<ProperShippingName>sample string 3</ProperShippingName>
<PackingGroupCode>sample string 4</PackingGroupCode>
<FlashpointTemperature>
<Value>1</Value>
<UOM>sample string 1</UOM>
</FlashpointTemperature>
<SpecialInstruction>sample string 5</SpecialInstruction>
</Hazmat>
<Reefer>
<ReeferID>1</ReeferID>
<Temperature>
<Min>1</Min>
<Max>2</Max>
<UOM>sample string 3</UOM>
</Temperature>
<Humidity>1</Humidity>
<SpecialInstruction>sample string 1</SpecialInstruction>
</Reefer>
<Reefer>
<ReeferID>1</ReeferID>
<Temperature>
<Min>1</Min>
<Max>2</Max>
<UOM>sample string 3</UOM>
</Temperature>
<Humidity>1</Humidity>
<SpecialInstruction>sample string 1</SpecialInstruction>
</Reefer>
<Reefer>
<ReeferID>1</ReeferID>
<Temperature>
<Min>1</Min>
<Max>2</Max>
<UOM>sample string 3</UOM>
</Temperature>
<Humidity>1</Humidity>
<SpecialInstruction>sample string 1</SpecialInstruction>
</Reefer>
</Cargos>
<Containers>
<ContainerID>1</ContainerID>
<ContainerTypeCode>sample string 1</ContainerTypeCode>
<NumberOfContainers>2</NumberOfContainers>
<IsShipperOwned>true</IsShipperOwned>
</Containers>
<Containers>
<ContainerID>1</ContainerID>
<ContainerTypeCode>sample string 1</ContainerTypeCode>
<NumberOfContainers>2</NumberOfContainers>
<IsShipperOwned>true</IsShipperOwned>
</Containers>
<Containers>
<ContainerID>1</ContainerID>
<ContainerTypeCode>sample string 1</ContainerTypeCode>
<NumberOfContainers>2</NumberOfContainers>
<IsShipperOwned>true</IsShipperOwned>
</Containers>
<Services>sample string 1</Services>
<Services>sample string 2</Services>
<Services>sample string 3</Services>
<Remarks>sample string 10</Remarks>
<Created />
<Updated>
<AgentID>1</AgentID>
<AgentName />
<ContactID>0</ContactID>
<ContactName />
</Updated>
</ShipmentsDTO>