Allocate a consignment with contract condition
Contract Conditions
We have introduced a new concept in Delivery Manager whereby Shippers can now pass us information relating to the contract that they wish to ship against. This feature will remove the necessity for creating Virtual Warehouses.
Shippers can now create distinct Contract conditions that contain the contracts they require to be considered for allocation. Contract condition will be provided on our suite of API calls for our system to correctly allocate against the Contract itself to be shipped against.
Workflow
The default workflow is for a contract to be allocated to the consignments by matching the Warehouse and Carrier Service combination. If, however you would like to specifically tell Delivery Manager the contract to use you can now pass a contract condition in your request.
This ability to link a contract to a contract condition is switched off by DEFAULT. For further details, please contact Metapack Support to switch this on for you. Once this has been activated you will now have the ability to allocate multiple contracts for the same warehouse/service combination and at the contract level you will be able to assign a contract condition against your contract. If this toggle and switched on and you have not assigned a contract condition to a multi contract using same warehouse combination your allocations will fail as Delivery Manager will NOT know which contract to ship against.
From the set-up section-contract conditions you will be able to view all your existing contract conditions but also create new Conditions. Contract Conditions may contain more than one contract IF the service combination allows. It is not possible to assign the same services under 2 contract conditions.
Example request
POST /shipping/v1/consignments HTTP/1.1
Host: api.metapack.com
API-Key: Basic Base64-encoded <username>:<password>
Content-Type: application/json
{
"consignment": {
"contractCondition" : "CONDITION_CODE_1",
"measurementUnits": {
"weight": "kg",
"measurement": "cm",
"volume": "ml"
},
"orders": [
{
"orderRef": "help-centre-1",
"value": {
"amount": 10,
"currencyCode": "GBP"
}
}
],
"shipmentRef": "shipperRef1",
"sender": {
"code": "default",
"addressLine1": "200 GRAY'S INN RD",
"addressLine2": "4TH FLOOR",
"postCode": "WC1X 8XZ",
"countryCode": "GBR",
"companyName": "test",
"city": "London",
"stateProvince": null,
"contact": {
"name" : "help test",
"email": "help@metapack.com",
"phone": "0612345678"
}
},
"recipient": {
"addressLine1": "200 Grays Inn",
"addressLine2": "London",
"postCode": "WC1X 8XC",
"countryCode": "GBR",
"companyName": "METAPACK LIMITED",
"city": "London",
"stateProvince": "",
"timeZone": "Europe/London",
"type": "business",
"contact": {
"name" : "help test",
"email": "help@metapack.com",
"phone": "0612345678"
}
},
"supportingAgents": {
"return": {
"addressLine1": "200 Grays Inn",
"addressLine2": " 4TH FLOOR",
"city": "London",
"postCode": "WC1 8XC",
"countryCode": "GBR",
"companyName": "return wh",
"type": "business",
"addressReference": "",
"contact": {
"name": "test",
"email": "help@metapack.com",
"phone": "+23312345678"
}
}
},
"parcels": [
{
"shipperRef": "1213",
"packagingType": "BAG",
"weight": {
"value": 1
},
"dimensions": {
"height": 10,
"width": 12,
"depth": 10
},
"value": {
"amount": 12,
"currencyCode": "GBP"
},
"items": [
{
"itemRef": "prod1",
"harmonisedCode": "1",
"countryOfOrigin": "GBR",
"fabricContent": "1",
"description": "prod1",
"itemType": "1",
"quantity": 1,
"value": {
"amount": 10
},
"exportReferenceNumber": null,
"exportLicenseNumber": null,
"batteryChemCode": null,
"weight": {
"value": 1
},
"dangerousGoods": {
"unId": "11",
"shippingName": "ship",
"productClass": "dangerous",
"packagingGroup": "12",
"measurementUnit": "12",
"packagingInstructions": "instruction",
"packagingInstructionSection": "22222",
"quantity": 1,
"packagingType": "bag",
"amount": 1,
"regulationAuthority": "ra",
"regulationLevelCode": "1",
"transportationMeans": "12",
"reportableQuantity": true,
"radioActive": false,
"subRiskClass": "22",
"technicalName": "222",
"additionalInfo": "22222",
"overPack": "1111"
}
}
]
}
],
"type": "delivery",
"tags": [
"cust1",
"cust2",
"cust3",
"cust4",
"cust5",
"cust6",
"cust7",
"cust8",
"cust9",
"cust10"
]
},
"shippingRules": {
"carrierServices": [
"RMFIRSTSTL"
]
}
}