Search for consignments

Retrieve all consignments that meet specific search criteria.

If any consignments have 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

query Parameters

orderReference	string Return all consignments associated with a specific order identifier.
consignmentTrackingIdentifier	string Return all consignments associated with a specific consignment tracking identifier assigned by carrier allocation.
parcelTrackingIdentifier	string Return all consignments associated with a specific parcel tracking identifier.
parcelCode	string Return all consignments associated with a specific parcel code.

Responses

200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/consignments

Request samples

Response samples

application/json

[{"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"
},
"invoiceNumber": "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": {"return": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"postCode": "string",
"countryCode": "string",
"companyName": "string",
"type": "Business",
"contact": {"name": "string",
"email": "string",
"phone": "string"
}
},
"billing": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"postCode": "string",
"countryCode": "string",
"companyName": "string",
"type": "Business",
"contact": {"name": "string",
"email": "string",
"phone": "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",
"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,
"contractCondition": "string",
"isReturn": true,
"invoiceNumber": "string",
"committedDeliveryWindow": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
}
}
]