Get a consignment

Retrieve a consignment with a specific consignment code.

If the consignment has been allocated, the associated carrier and carrier service information is also returned. You can use this information to plan your deliveries and keep your customers updated.
SecurityBasicAuth
Request
path Parameters

consignmentCode
required
string
Consignment identifier generated by Metapack.
Responses
200
Consignment details
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
get/consignments/{consignmentCode}
Request samples
Response samples
application/json
{"consignment": {"consignmentCode": "DMC4BY1V4HVY",
"measurementUnits": {"weight": "kg",
"measurement": "cm",
"volume": "ml"
},
"orders": [{"orderRef": "string",
"orderDate": "2019-08-24T14:15:22Z",
"value": {"amount": 0.1,
"currencyCode": "string"
},
"shippingCharge": {"amount": 0.1,
"currencyCode": "string"
},
"insuranceCharge": {"amount": 0.1,
"currencyCode": "string"
},
"otherCharge": {"amount": 0.1,
"currencyCode": "string"
}
}
],
"parcels": [{"parcelCode": "string",
"parcelIndex": 0,
"shipperRef": "cartonId-123456",
"packagingType": "string",
"weight": {"value": 0.1
},
"dimensions": {"height": 0.1,
"width": 0.1,
"depth": 0.1,
"diameter": 0.1
},
"value": {"amount": 0.1,
"currencyCode": "string"
},
"items": [{"itemRef": "string",
"harmonisedCode": "string",
"countryOfOrigin": "string",
"fabricContent": "string",
"description": "string",
"itemType": "string",
"quantity": 0,
"value": {"amount": 0.1
},
"weight": {"value": 0.1
},
"dangerousGoods": {"unId": "string",
"shippingName": "string",
"productClass": "1.2",
"packagingGroup": "string",
"measurementUnit": "string",
"packagingInstructions": "string",
"quantity": 0.1,
"packageType": "string",
"amount": 0.1,
"regulationAuthority": "string",
"regulationLevelCode": "string",
"transportationMeans": "string",
"reportableQuantity": true,
"radioActive": true,
"subRiskClass": "string",
"technicalName": "string",
"additionalInfo": "string",
"overPack": "string",
"packagingInstructionSection": "string"
},
"exportReferenceNumber": "string",
"exportLicenseNumber": "string",
"batteryChemCode": "string",
"references": {"property1": "string",
"property2": "string"
},
"taxesPaid": true
}
],
"deliveryLegs": [{"trackingIdentifier": "string",
"trackingURL": "string"
}
],
"carrier": {"identifier": "string"
}
}
],
"status": "unallocated",
"type": "delivery",
"sender": {"building": "string",
"floor": "string",
"addressLine1": "string",
"addressLine2": "string",
"postCode": "string",
"countryCode": "string",
"companyName": "string",
"city": "string",
"stateProvince": "string",
"timeZone": "string",
"type": "Residential",
"addressReference": "string",
"accountNumber": "string",
"code": "string",
"contact": {"name": "string",
"timeZone": "string",
"language": "string",
"email": "string",
"phone": "string"
},
"taxAndDuty": {"EORINumber": "string",
"IOSSNumber": "string",
"VATNumber": "string",
"TAXIDNumber": "string"
}
},
"recipient": {"building": "string",
"floor": "string",
"addressLine1": "string",
"addressLine2": "string",
"postCode": "string",
"countryCode": "string",
"companyName": "string",
"city": "string",
"stateProvince": "string",
"timeZone": "string",
"type": "Residential",
"addressReference": "string",
"accountNumber": "string",
"code": "string",
"contact": {"name": "string",
"timeZone": "string",
"language": "string",
"email": "string",
"phone": "string"
},
"taxAndDuty": {"EORINumber": "string",
"IOSSNumber": "string",
"VATNumber": "string",
"TAXIDNumber": "string"
}
},
"supportingAgents": {"property1": {"building": "string",
"floor": "string",
"addressLine1": "string",
"addressLine2": "string",
"postCode": "string",
"countryCode": "string",
"companyName": "string",
"city": "string",
"stateProvince": "string",
"timeZone": "string",
"type": "Residential",
"addressReference": "string",
"accountNumber": "string",
"code": "string",
"contact": {"name": "string",
"timeZone": "string",
"language": "string",
"email": "string",
"phone": "string"
},
"taxAndDuty": {"EORINumber": "string",
"IOSSNumber": "string",
"VATNumber": "string",
"TAXIDNumber": "string"
}
},
"property2": {"building": "string",
"floor": "string",
"addressLine1": "string",
"addressLine2": "string",
"postCode": "string",
"countryCode": "string",
"companyName": "string",
"city": "string",
"stateProvince": "string",
"timeZone": "string",
"type": "Residential",
"addressReference": "string",
"accountNumber": "string",
"code": "string",
"contact": {"name": "string",
"timeZone": "string",
"language": "string",
"email": "string",
"phone": "string"
},
"taxAndDuty": {"EORINumber": "string",
"IOSSNumber": "string",
"VATNumber": "string",
"TAXIDNumber": "string"
}
}
},
"deliveryInformation": {"cutOffDate": "2019-08-24T14:15:22Z",
"collectionWindow": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"deliveryWindow": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"service": {"carrierService": {"code": "string",
"name": "string",
"carrier": {"name": "string",
"code": "string"
}
}
},
"shippingCosts": {"property1": {"amount": 0.1,
"currencyCode": "string"
},
"property2": {"amount": 0.1,
"currencyCode": "string"
}
},
"legs": [{"trackingIdentifier": "string",
"trackingURL": "string",
"trackingLinks": {"carrier": "string"
}
}
]
},
"shipmentRef": "string",
"contractCondition": "string",
"attributes": {"cashOnDelivery": {"value": {"amount": 0.1,
"currencyCode": "string"
},
"paymentMethod": "string"
},
"contentType": "string",
"notificationType": "sms",
"flexibleDelivery": {"deliveryInstructions": "string",
"what3words": "string"
},
"incoterms": "string",
"insurance": {"amount": 0.1,
"currencyCode": "string"
},
"podRequired": "any"
},
"manifestGroupCode": "string",
"tags": ["string"
],
"allocatedDateTime": "2019-08-24T14:15:22Z",
"service": {"carrierService": {"code": "string",
"name": "string",
"carrier": {"name": "string",
"code": "string"
}
}
},
"carrierConsignmentCode": "string",
"pickingRef": "string",
"totalDiscountValue": {"amount": 0.1,
"currencyCode": "string"
},
"references": {"externalitemcode": "#123",
"externalordercode": "ABC123",
"specialProvision": "A123",
"senderUKIMSNumber": "123456789",
"recipientUKIMSNumber": "123456789"
},
"movementIndicator": "b2b",
"windsorNotAtRiskIndicator": true,
"isReturn": true,
"committedDeliveryWindow": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
}
},
"links": [{"operation": "GET",
"rel": "string",
"href": "string"
}
]
}