Web service URL: BASE_URL/api/Order Method Action: POST
Consolidate offline order (POST)
Creates an order in offline mode. Additional parcels can be added until the order is activated
Similar with an Order request,with additional below parameter.
This function is available only for specific carriers.
Parameters[] :
| Name | Type | Required | Description |
| ConsolidateOrder | boolean | Yes | defines if the order can be consolidated |
Add aditional parcels (POST)
Adds additional parcels to an eligible consolidated order
Web service URL: BASE_URL/api/offlineorder/add Method Action: POST
| Name | Type | Required | Description |
| courier | string | Yes | courierId |
| courierShipmentId | string | Yes | courier awb number |
Parcel[] :
| Name | Type | Required | Description |
| SequenceNo | integer | Yes | parcel number |
| Weight | Decimal | Yes | Value in kilograms |
| Type | string | Yes | Envelope (1), Parcel (2), Pallet (3) |
| Reference1 | string[100] | Yes | Reference for parcel |
| CustomerBarcode | string | No | custom barcode |
| Size | Size[] | Yes | parcel dimensions |
Size[] :
| Name | Type | Required | Description |
| Width | Double | Yes | value in centimeters |
| Length | Double | Yes | value in centimeters |
| Height | Double | Yes | value in centimeters |
Example Request Add to Consolidate
[
{
"courier": "1",
"courierShipmentId": "TSXX100364RA",
"Parcels": [
{
"SequenceNo": 2,
"Size": {
"Width": 10.0,
"Height": 10.0,
"Length": 10.0
},
"Weight": 5,
"Type": 2,
"Reference1": "123",
},
{
"SequenceNo": 3,
"Size": {
"Width": 10.0,
"Height": 10.0,
"Length": 10.0
},
"Weight": 7,
"Type": 2,
"Reference1": "123",
}
]
}
]Example Request with Consolidate parameter:
{
"ServiceId": 1,
"CourierId": 1,
"ShipmentDate": "2024-01-16T00:00:00+00:00",
"ShipmentDateEnd": "2024-01-16T00:00:00+00:00",
"AddressTo": {
"Name": "Test Offline",
"ContactPerson": "Test Offline",
"Country": "RO",
"CountyName": "BUCURESTI",
"LocalityName": "București",
"AddressText": "Strada Soveja 75",
"PostalCode": "012303",
"Phone": "+0722222222",
"Email": "ceva@test.com"
},
"Payment": 1,
"Content": {
"EnvelopeCount": 0,
"ParcelsCount": 1,
"PalettesCount": 0,
"TotalWeight": 1,
"Contents": "Garments and/or shoes inside.",
"OversizedPackage": false,
"Parcels": [
{
"SequenceNo": 1,
"Size": {
"Width": 10,
"Height": 10,
"Length": 10
},
"Weight": 1,
"Type": 2,
"Reference1": "Reference1",
"Reference2": "Reference2",
"Reference3": "Reference3"
}
]
},
"Extra": {},
"Parameters": {
"Async": true,
"GetParcelsBarcodes": true,
"IncludeCourierResponse": false,
"IncludePriceBreakdown": false,
"IncludeAddressInResponse": false,
"ConsolidateOrder": true
},
"ExternalClientLocation": "offlineRO",
"Observation": "Garments and/or shoes inside."
}