Verify whether shipping rules can be applied

Verify whether an Unallocated consignment can be allocated using the specified shipping rules.

SecurityBasicAuth

Request

Request Body schema: application/json

required	object (ConsignmentRequest) One or more items going from the same origin to the same destination being despatched on the same date using the same carrier service.
	object (ShippingRules) For each consignment, you have the option to define specific allocation parameters for that consignment, or you can reuse a predefined allocation rule that you created previously.

Responses

200

A subscribed carrier service is available at this time for consignment and its shipping rules

204

A subscribed carrier service is not available at this time for consignment and its shipping rules

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/consignment-validation

Request samples

application/json

{"consignment": {"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"
}
}
],
"references": {"externalitemcode": "#123",
"externalordercode": "ABC123",
"specialProvision": "A123",
"senderUKIMSNumber": "123456789",
"recipientUKIMSNumber": "123456789"
},
"measurementUnits": {"weight": "kg",
"measurement": "cm",
"volume": "ml"
},
"shipmentRef": "string",
"parcels": [{"shipperRef": "ref-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
}
]
}
],
"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"
},
"type": "delivery",
"manifestGroupCode": "string",
"tags": ["string"
],
"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",
"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",
"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",
"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",
"code": "string",
"contact": {"name": "string",
"timeZone": "string",
"language": "string",
"email": "string",
"phone": "string"
},
"taxAndDuty": {"EORINumber": "string",
"IOSSNumber": "string",
"VATNumber": "string",
"TAXIDNumber": "string"
}
}
},
"totalDiscountValue": {"amount": 0.1,
"currencyCode": "string"
},
"pickingRef": "string",
"movementIndicator": "b2b",
"windsorNotAtRiskIndicator": true,
"isReturn": true,
"committedDeliveryWindow": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
}
},
"shippingRules": {"collectionSlots": {"acceptable": [{"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
}
],
"unacceptable": [{"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
}
]
},
"deliverySlots": {"acceptable": [{"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
}
],
"unacceptable": [{"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
}
]
},
"collectionDays": {"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true
},
"deliveryDays": {"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true
},
"carrierServices": ["string"
],
"code": "string"
}
}

Response samples

application/json

{"errorCode": "string",
"message": "string",
"systemMessage": "string",
"traceID": "string",
"timestamp": "2019-08-24T14:15:22Z"
}