Get the details of a consignment
Path Parameters
- Type: stringFormat: uuidconsignment
Id required
Responses
- application/json
Request Example for get/v1/consignments/{consignmentId}
curl https://api.consignlyhq.com/v1/consignments/123e4567-e89b-12d3-a456-426614174000
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"client": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": null,
"name": null,
"code": null,
"email": null,
"relationship": "enum (Client = 1, Carrier = 2)",
"status": "enum (Inactive = 1, Active = 2)"
},
"type": "enum (PointToPoint = 0, Inwards = 1, Outwards = 2)",
"status": "enum (Complete = 0, Pending = 1, ReadyToPick = 2, ReadyToDispatch = 3, ReadyToReceive = 4, InProgress = 5, Closed = 6, InTransit = 7, Draft = 8, Void = -2, Open = -1)",
"isVoid": true,
"consignmentNumber": null,
"idempotencyKey": null,
"externalId": null,
"referenceNumber": null,
"dateEntered": "date (YYYY-MM-DD)",
"expectedArrivalDateTime": "datetime (YYYY-MM-DDTHH:MM:SSZ)",
"expectedDispatchDateTime": "datetime (YYYY-MM-DDTHH:MM:SSZ)",
"expectedDeliveryDateTime": "datetime (YYYY-MM-DDTHH:MM:SSZ)",
"actualDispatchDateTime": "datetime (YYYY-MM-DDTHH:MM:SSZ)",
"actualReceiveDateTime": "datetime (YYYY-MM-DDTHH:MM:SSZ)",
"warehouse": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": null,
"code": null,
"status": "enum (Active = 1, Inactive = 2)",
"addressId": "123e4567-e89b-12d3-a456-426614174000",
"latitude": 1,
"longitude": 1,
"timezoneId": null
},
"carrier": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": null,
"name": null,
"code": null,
"email": null,
"relationship": "enum (Client = 1, Carrier = 2)",
"status": "enum (Inactive = 1, Active = 2)"
},
"carrierReferenceNumber": null,
"carrierRunNumber": null,
"carrierRunOrdinal": null,
"originAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "enum (Adhoc = 0, Warehouse = 1, PartnerOrigin = 2, PartnerConsignee = 3, ContainerYard = 4, ExternalWarehouse = 5)",
"name": null,
"code": null,
"email": null,
"phone": null,
"streetAddress": null,
"suburb": null,
"city": null,
"state": null,
"postCode": null,
"country": null,
"latitude": null,
"longitude": null
},
"originAddressAttention": null,
"destinationAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "enum (Adhoc = 0, Warehouse = 1, PartnerOrigin = 2, PartnerConsignee = 3, ContainerYard = 4, ExternalWarehouse = 5)",
"name": null,
"code": null,
"email": null,
"phone": null,
"streetAddress": null,
"suburb": null,
"city": null,
"state": null,
"postCode": null,
"country": null,
"latitude": null,
"longitude": null
},
"destinationAddressAttention": null,
"destinationAuthorityToLeave": true,
"defaultDispatchWarehouseLocation": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": null
},
"defaultReceiveWarehouseLocation": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": null
},
"containerSize": "enum (TenFoot = 1, TwentyFoot = 2, FortyFoot = 3, FortyFiveFoot = 4)",
"containerType": "enum (GeneralPurpose = 1, GeneralPurposeHighCube = 2, Refrigerated = 3, RefrigeratedHighCube = 4, RefrigeratedNotOperating = 5, RefrigeratedNotOperatingHighCube = 6, OpenTop = 7, OpenTopHighCube = 8, FlatRack = 9, FlatRackHighCube = 10, Tank = 11, TankHighCube = 12)",
"containerNumber": null,
"containerSealNumber": null,
"containerTareWeightKG": null,
"containerGrossWeightKG": null,
"containerStatus": "enum (Pending = 1, Received = 2, Returned = 3)",
"containerReceivedDate": "date (YYYY-MM-DD)",
"containerReturnedDate": "date (YYYY-MM-DD)",
"containerYard": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": null,
"name": null,
"streetAddress": null,
"suburb": null,
"city": null,
"state": null,
"postCode": null,
"country": null,
"latitude": 1,
"longitude": 1
},
"containerYardReference": null,
"containerVesselName": null,
"containerVoyage": null,
"dischargeShippingPort": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": null,
"name": null,
"country": null
},
"loadShippingPort": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": null,
"name": null,
"country": null
},
"deliveryInstructions": null,
"pickingInstructions": null,
"receiversReference": null,
"sendersReference": null,
"poNumber": null,
"soNumber": null,
"sourceIntegrationType": "enum (Custom = 1, Xero = 2, Icos = 3, Zapier = 4, Myob = 5, Gofreight = 6, GoSweetSpot = 8, Hercules = 9, Ignition = 10, Webhooks = 11, M2X = 12, NetSuite = 13, BusinessCentral = 14, Starshipit = 15, MachShip = 16, MyobAcumatica = 17, PrinterBridge = 18, Trifecta = 19, NavBridge = 20, ANC = 21, Hitrak = 22)",
"ediStatus": null,
"metrics": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "enum (WeightKG = 0, VolumeM3 = 1, Quantity = 2, UnitType = 3, VirtualPallets = 4, VirtualPalletPartThereof = 5, Items = 6)",
"unitType": null,
"value": 1
}
],
"consumables": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"consumableTypeId": "123e4567-e89b-12d3-a456-426614174000",
"consumableTypeName": null,
"value": 1
}
],
"tasks": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"taskTypeId": "123e4567-e89b-12d3-a456-426614174000",
"taskTypeName": null,
"value": 1
}
],
"notes": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"note": null,
"displayOnPrintOut": true,
"attachmentCount": 1
}
],
"pods": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"eventUtc": "datetime (YYYY-MM-DDTHH:MM:SSZ)",
"signatoryName": null,
"externalUrl": null
}
],
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": null,
"partnerProduct": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": null,
"name": null,
"lengthMM": null,
"heightMM": null,
"widthMM": null,
"isVolumeAutoCalculated": true,
"volumeM3": 1,
"weightKG": 1,
"isSerialRequired": true,
"serialTrackingMode": "enum (None = 1, FullCapture = 2, ReleaseCapture = 3)",
"productGroupId": "123e4567-e89b-12d3-a456-426614174000",
"productGroupName": null,
"productUnitTypeId": null,
"productUnitTypeName": null,
"isDangerousGood": true,
"dgProperShippingName": null,
"dgTechnicalName": null,
"dgPackagingGroup": "enum (I = 1, II = 2, III = 3)",
"dgHazchemEac": null,
"dgUnNumber": null,
"dgFlashpointDegC": null,
"dgMarinePollutant": null,
"dgPhLevel": null,
"barcode": null,
"gtin": null
},
"batch": null,
"bestBeforeDate": null,
"expiryDate": null,
"packagingDate": null,
"productionDate": null,
"sellByDate": null,
"quantity": 1,
"volumeM3": 1,
"weightKG": 1,
"receivedQuantity": 1,
"receivedVolumeM3": 1,
"receivedWeightKG": 1,
"receivedPercent": 1,
"heldQuantity": 1,
"heldVolumeM3": 1,
"heldWeightKG": 1,
"heldPercent": 1,
"pickedQuantity": 1,
"pickedVolumeM3": 1,
"pickedWeightKG": 1,
"pickedPercent": 1,
"dispatchedQuantity": 1,
"dispatchedVolumeM3": 1,
"dispatchedWeightKG": 1,
"dispatchedPercent": 1,
"consignmentLogisticUnitId": null,
"externalId": null,
"attributes": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productAttributeId": "123e4567-e89b-12d3-a456-426614174000",
"productAttributeName": null,
"description": null
}
],
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"quantity": 1,
"volumeM3": 1,
"weightKG": 1,
"serial": null,
"receivedQuantity": 1,
"receivedVolumeM3": 1,
"receivedWeightKG": 1,
"receivedPercent": 1,
"heldQuantity": 1,
"heldVolumeM3": 1,
"heldWeightKG": 1,
"heldPercent": 1,
"pickedQuantity": 1,
"pickedVolumeM3": 1,
"pickedWeightKG": 1,
"pickedPercent": 1,
"dispatchedQuantity": 1,
"dispatchedVolumeM3": 1,
"dispatchedWeightKG": 1,
"dispatchedPercent": 1
}
]
}
],
"logisticUnits": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"logisticUnitNumber": null,
"referenceNumber": null,
"carrierReference": null,
"ssccNumber": null,
"tareWeightKG": 1,
"grossWeightKG": 1,
"lengthMM": null,
"widthMM": null,
"heightMM": null,
"quantity": 1,
"volumeM3": 1,
"weightKG": 1,
"receivedQuantity": 1,
"receivedPercent": 1,
"heldQuantity": 1,
"heldPercent": 1,
"pickedPercent": 1,
"pickedQuantity": 1,
"dispatchedPercent": 1,
"dispatchedQuantity": 1,
"packageType": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": null
}
}
],
"serviceTypes": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": null,
"code": null
}
],
"jobs": [
{
"status": "enum (Draft = 1, ReadyToStart = 2, InProgress = 3, Complete = 4, Cancelled = 5, Incomplete = -2, Open = -1)",
"jobId": "123e4567-e89b-12d3-a456-426614174000",
"position": 1,
"reference": null,
"dueDateTime": "datetime (YYYY-MM-DDTHH:MM:SSZ)",
"jobNumber": null,
"priority": "enum (Normal = 2, High = 3, Urgent = 4)",
"type": "enum (WavePick = 1, Replenishment = 2)",
"description": null,
"wavePickStyle": "enum (ParallelPicking = 1, BulkPicking = 2)"
}
],
"consignmentTracking": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"carrierName": null,
"status": "enum (Unknown = 0, Printed = 1, Dispatched = 2, InTransit = 3, OutForDelivery = 4, Delivered = 5, PickupInStore = 6, AttemptedDelivery = 7, Exception = 8, AwaitingCollection = 9, Cancelled = 10, Manifested = 11)",
"trackingUrl": null,
"trackingNumber": null,
"integrationName": null,
"createdUtc": "datetime (YYYY-MM-DDTHH:MM:SSZ)",
"modifiedUtc": "datetime (YYYY-MM-DDTHH:MM:SSZ)",
"lastUpdatedDate": "date (YYYY-MM-DD)"
}
]
}