Shipments
Get detailed shipment information
Retrieve comprehensive shipment details including items and containers.
get/api/v1/external/shipments/{shipmentId}/details
Request
- Base URLhttps://api.wove.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
shipmentIdstring required
Unique shipment identifier
Response
Detailed shipment information retrieved successfully
Example response
{
"data": {
"shipment": {
"creation": {
"source": "email"
},
"emailUpdates": {
"threads": 2
},
"sync": {
"method": "manual",
"status": "success",
"syncedBy": {
"name": "Jane Smith",
"email": "jane@example.com"
},
"tmsReference": "C00012345"
},
"id": "1014810279825727490",
"status": "draft",
"name": "External API Test Shipment",
"shipmentType": "LCL",
"commodity": "Electronics",
"portOfLoading": {
"portCode": "USLAX",
"portName": "Los Angeles",
"countryCode": "US"
},
"portOfDischarge": {
"portCode": "USLAX",
"portName": "Los Angeles",
"countryCode": "US"
},
"placeOfReceiptPort": {
"portCode": "USLAX",
"portName": "Los Angeles",
"countryCode": "US"
},
"placeOfReceiptAirport": {
"airportCode": "LAX",
"airportName": "Los Angeles International Airport",
"countryCode": "US"
},
"placeOfReceiptAddress": {
"address1": "123 Main St",
"address2": "Suite 100",
"city": "New York",
"province": "NY",
"postalCode": "10001",
"country": "US"
},
"placeOfDeliveryPort": {
"portCode": "USLAX",
"portName": "Los Angeles",
"countryCode": "US"
},
"placeOfDeliveryAirport": {
"airportCode": "LAX",
"airportName": "Los Angeles International Airport",
"countryCode": "US"
},
"placeOfDeliveryAddress": {
"address1": "123 Main St",
"address2": "Suite 100",
"city": "New York",
"province": "NY",
"postalCode": "10001",
"country": "US"
},
"documentCount": 5,
"carrier": {
"code": "MAEU",
"name": "Maersk Line"
},
"vessel": "MSC OSCAR",
"voyage": "123W",
"incoterm": "FOB",
"serviceType": "CY-CY",
"referenceNumbers": [
{
"id": "1014810279825727493",
"type": "booking",
"displayNumber": "BOOK-2024-001",
"cleanedNumber": "BOOK2024001"
}
]
},
"items": [
{
"id": "1014810279825727491",
"lineNumber": 1,
"sku": "SKU-12345",
"partNumber": "PN-67890",
"description": "Electronic Component",
"quantity": 100,
"unitOfMeasure": "PCS",
"unitPrice": 25.5,
"amount": 2550,
"currency": "USD",
"countryOfOrigin": "CN",
"hsCode": "8541.10.00",
"weight": 150.5,
"weightUnit": "KG",
"volume": 2.5,
"volumeUnit": "CBM",
"packageNumber": "PKG-001",
"dimensions": {
"length": 100,
"width": 50,
"height": 50,
"unit": "CM"
}
}
],
"containers": [
{
"id": "1014810279825727492",
"number": "MSKU1234567",
"size": "40",
"type": "HC",
"sizeType": "40HC",
"sealNumber": "SEAL123456",
"quantity": 1,
"packages": [
{
"id": "1014810279825727493",
"packageNumber": "PKG001",
"packageType": "CARTON",
"packageCount": 1,
"items": [
{
"id": "1014810279825727491",
"lineNumber": 1,
"sku": "SKU-12345",
"partNumber": "PN-67890",
"description": "Electronic Component",
"quantity": 100,
"unitOfMeasure": "PCS",
"unitPrice": 25.5,
"amount": 2550,
"currency": "USD",
"countryOfOrigin": "CN",
"hsCode": "8541.10.00",
"weight": 150.5,
"weightUnit": "KG",
"volume": 2.5,
"volumeUnit": "CBM",
"packageNumber": "PKG-001",
"dimensions": {
"length": 100,
"width": 50,
"height": 50,
"unit": "CM"
}
}
]
}
]
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.