Create a new consignment import
Body·
application/json
- Type: array object[] ·attachmentsdeprecated
A collection of attachment files for the consignment.
- Type: string | nullcarrier
Code The 3- or 4-digit code identifying the carrier.
- Type: string | nullcarrier
Reference The carrier's reference
- Type: string | nullclient
Code The client code.
- Type: integerenumconsignment
Type Integer numbers.
values- Point
To Point = 0 - Inwards = 1
- Outwards = 2
- Type: number | nullFormat: doublecontainer
Gross Weight K G The container gross weight in kilograms.
- Type: string | nullcontainer
Number The container number.
- Type: string | nullcontainer
Seal Number The container seal number.
- Type: integerenumcontainer
Size Integer numbers.
values- Ten
Foot = 1 - Twenty
Foot = 2 - Forty
Foot = 3 - Forty
Five Foot = 4
- Type: number | nullFormat: doublecontainer
Tare Weight K G The container tare weight in kilograms.
- Type: integerenumcontainer
Type Integer numbers.
values- General
Purpose = 1 - General
Purpose High Cube = 2 - Refrigerated = 3
- Refrigerated
High Cube = 4 - Refrigerated
Not Operating = 5
- Type: string | nullcontainer
Vessel Name The container's vessel's name.
Responses
- application/json
Request Example for post/v1/consignment-imports
curl https://api.consignlyhq.com/v1/consignment-imports \
--request POST \
--header 'Content-Type: application/json' \
--data '{
"idempotencyKey": null,
"consignmentType": "enum (PointToPoint = 0, Inwards = 1, Outwards = 2)",
"clientCode": null,
"referenceNumber": null,
"externalId": null,
"carrierCode": null,
"carrierReference": null,
"enteredDate": null,
"expectedArrivalDateTime": null,
"expectedDispatchDateTime": null,
"expectedDeliveryDateTime": null,
"originAddress": {
"code": null,
"name": null,
"email": null,
"phone": null,
"streetAddress": null,
"suburb": null,
"city": null,
"state": null,
"postCode": null,
"country": null,
"latitude": null,
"longitude": null
},
"originAddressAttention": null,
"destinationAddress": {
"code": null,
"name": null,
"email": null,
"phone": null,
"streetAddress": null,
"suburb": null,
"city": null,
"state": null,
"postCode": null,
"country": null,
"latitude": null,
"longitude": null
},
"destinationAddressAttention": null,
"destinationAuthorityToLeave": null,
"warehouseCode": 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,
"containerVesselName": null,
"containerVoyage": null,
"containerYardCode": null,
"containerYardReference": null,
"dischargeShippingPortCode": null,
"loadShippingPortCode": null,
"deliveryInstructions": null,
"pickingInstructions": null,
"receiversReference": null,
"sendersReference": null,
"poNumber": null,
"soNumber": null,
"serviceTypeCodes": [
""
],
"notes": [
{
"note": null,
"displayOnPrintOut": true,
"attachments": [
{
"fileName": null,
"contentType": null,
"content": null,
"downloadUrl": null
}
]
}
],
"products": [
{
"productCode": null,
"goodsDescription": null,
"batch": null,
"bestBeforeDate": null,
"expiryDate": null,
"packagingDate": null,
"productionDate": null,
"sellByDate": null,
"logisticUnitSsccNumber": null,
"logisticUnitReferenceNumber": null,
"isManualReconciliationRequired": true,
"criticalStockStatus": "enum (CriticalStock = 1, NonCriticalStock = 2)",
"attributes": [
{
"name": null,
"description": null
}
],
"items": [
{
"serial": null,
"quantity": 1,
"weightKG": null,
"volumeM3": null
}
]
}
]
}'
{
"consignmentId": "00000000-0000-0000-0000-000000000000"
}