Get shipment by id
The /shipment/{shipmentId} route can be used to retrieve a specific shipment by its identifier. A JSON object with the shipment will be return on success that will by default contain the 1st level of complex attributes, e.g. the list of events, operators,… attached to the shipment.
Retrieve shipment by id
Authorizations
Path parameters
shipmentIdstringRequired
Responses
200Success
application/json
400
Bad Request
application/json
401
Unauthorized Entity
application/json
422
Unprocessable Entity
application/json
get
GET /shipment/{shipmentId} HTTP/1.1
Host: api.one-record.fr
Authorization: Bearer JWT
Accept: */*
{
"shipmentId": "123e4567-e89b-12d3-a456-426614174000",
"departure": "text",
"departureCountry": "AD",
"arrival": "text",
"arrivalCountry": "AD",
"orderReference": "text",
"customerReference": "text",
"quantityExpected": 1,
"quantityTypeExpected": "AUT",
"grossWeightExpected": 1,
"grossWeightTaxableExpected": 1,
"volumeExpected": 1,
"quantityReal": 1,
"quantityTypeReal": "AUT",
"grossWeightReal": 1,
"grossWeightTaxableReal": 1,
"volumeReal": 1,
"mawbNumber": "text",
"hawbNumber": "text",
"hbl": "text",
"mbl": "text",
"goodsDescription": "text",
"fly": "text",
"ship": "text",
"isSecure": false,
"isDangerous": false,
"limitBoardingTime": "text",
"shippingReference": "text",
"assignations": [
"123e4567-e89b-12d3-a456-426614174000"
],
"anomalies": [
"123e4567-e89b-12d3-a456-426614174000"
],
"customs": [
"123e4567-e89b-12d3-a456-426614174000"
],
"details": [
"123e4567-e89b-12d3-a456-426614174000"
],
"documents": [
"123e4567-e89b-12d3-a456-426614174000"
],
"events": [
"123e4567-e89b-12d3-a456-426614174000"
],
"operators": [
"123e4567-e89b-12d3-a456-426614174000"
],
"securities": [
"123e4567-e89b-12d3-a456-426614174000"
],
"services": [
"123e4567-e89b-12d3-a456-426614174000"
],
"preparations": [
"123e4567-e89b-12d3-a456-426614174000"
],
"createdAt": null,
"updatedAt": null
}Last updated