Filter handling units by reference or by S)ONE ID and get a list of handling units : general information, information on shipments, transports and events. An handling unit corresponds to a container or a good.
Sample request :
GET /handling-units?reference=AAAU1234566&spi=CNI1234567890&limit=5&offset=0&desc=true
Query parameters
-
Handling unit reference with which to filter.
Default value is empty.
-
Handling unit ID with which to filter. ID corresponds to the single passage identificator in S)ONE.
Default value is empty.
-
Boolean that indicates the sort order. If it is set to true, results will be sorted by descending order.
Default value is
false. -
Number of results to be returned. Max value is 10.
Maximum value is
10. Default value is5. -
Index of the first returned result.
Default value is
0.
GET
/handling-units
curl \
-X GET https://soget-api-integration.azure-api.net/api-tracing-libelle/v1/handling-units \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Ocp-Apim-Subscription-Key: $API_KEY"
Response examples (200)
{
"total": 3,
"returned": 1,
"first": 42,
"items": [
{
"reference": "AAAU1234566",
"pswId": "CNI0000000001",
"freightFamily": "Container",
"sizeType": {
"code": "45G1",
"description": "GP/AERATION PASSIVE SUPERIEURE"
},
"packagingCode": {
"code": "PK",
"description": "Package"
},
"measures": {
"quantity": 10,
"weight": {
"tare": {
"value": 13030,
"unit": "KGM"
},
"grossWeight": {
"value": 13030,
"unit": "KGM"
},
"netWeight": {
"value": 13030,
"unit": "KGM"
}
},
"volume": {
"value": 13030,
"unit": "KGM"
},
"remainingQuantity": 4,
"availableQuantity": 3,
"reportedQuantity": 6,
"remainingWeight": {
"value": 13030,
"unit": "KGM"
}
},
"indicators": {
"hazardous": true,
"empty": true,
"reefer": true,
"pollutant": true,
"fumigation": true,
"quarantine": true,
"outOfGauge": true
},
"references": [
{
"type": "Rank",
"value": "20NL050BC243E2C8A0"
}
],
"customsFlag": "Unknown",
"huLocation": {
"place": {
"code": "MTDF",
"name": "Terminal de France"
},
"location": {
"code": "MTDF",
"name": "Terminal de France"
}
},
"actors": {
"freightAgent": {
"code": "CCGM",
"name": "CMA CGM"
},
"freightForwarder": {
"code": "CCGM",
"name": "CMA CGM"
}
},
"temperatures": {
"setPoint": -1,
"rangeMin": -5,
"rangeMax": 2
},
"shipments": [
{
"documentReference": "HLCUEUR2002APIK9",
"documentId": "DAI0000387547",
"documentType": {
"code": 705,
"name": "Bill of lading"
},
"documentDate": "2020-05-07T12:38:54.000Z",
"originLocation": {
"code": "FRLEH",
"name": "Le Havre"
},
"destinationLocation": {
"code": "FRLEH",
"name": "Le Havre"
},
"processingIndicator": "Unknown",
"merchantHaulage": true
}
],
"transport": {
"meansName": "MSC GRAND",
"voyageId": "VOS0019102839",
"mode": {
"code": 1,
"name": "Maritime transport"
},
"meansNationality": {
"name": "France",
"alphaCode3": "FRA"
},
"voyageDates": {
"eta": "2024-05-04T09:42:00+00:00",
"etd": "2024-05-04T09:42:00+00:00",
"ata": "2024-05-04T09:42:00+00:00",
"atd": "2024-05-04T09:42:00+00:00"
},
"schedulePlace": {
"code": "FRLEH",
"name": "Le Havre"
},
"meansType": {
"code": "1 MVE",
"name": "vehicle carrier"
},
"meansId": [
{
"type": "IMONumber",
"name": "9360142"
}
],
"arrivalScheduleReference": "BA649R",
"departureScheduleReference": "BA649A"
},
"events": [
{
"eventWay": "In",
"eventType": {
"code": "DIR",
"name": "Discharged"
},
"eventDate": "2024-05-04T09:42:00+00:00",
"eventPlace": {
"code": "MTDF",
"name": "Terminal de France"
},
"eventLocation": {
"code": "MTDF",
"name": "Terminal de France"
},
"eventTransportMode": {
"code": 1,
"name": "Maritime transport"
}
}
],
"hazardousItems": [
{
"imoClass": {
"code": "1.1",
"description": "Substances and articles which have a mass explosion hazard"
},
"limitedQuantity": true
}
],
"emptyReturn": {
"dueDate": "2022-11-19T22:00:00.000Z",
"finishDateEarliest": "2022-11-20T22:00:00.000Z",
"finishDateLatest": "2022-11-21T22:00:00.000Z"
}
}
]
}
Response examples (400)
{
"status": "NotFound",
"timestamp": "2022-11-17T15:40:39.838Z",
"code": "R001",
"message": "No handling unit was found"
}
Response examples (404)
{
"status": "NotFound",
"timestamp": "2022-11-17T15:40:39.838Z",
"code": "R001",
"message": "No handling unit was found"
}