Info
|
Similar with an pickup Order request, with the below mandatory specifications.
| Name | Type | Required | Description |
| courierId | integer | only available for Sameday(6) and FAN(3) | |
| addressFrom | Address[] | Yes | See object below |
| payment | integer | Yes | 2 (recipient) - sender payment not supported |
| includeCourierResponse | boolean | true for Sameday as PIN is retuned in courier response |
Address[] :
| Name | Type | Required | Description |
| name | string[64] | Yes | |
| contactPerson | string[100] | Yes | |
| country | string[2] | ||
| countyName | string | not mandatory if PostalCode is sent | |
| localityName | string | either LocalityName + CountyName or LocalityName + PostalCode | |
| addressText | string[100] | ||
| postalCode | string[50] | ||
| phone | string[64] | Yes | |
| string[100] | Yes | ||
| fixedLocationId | string | Yes | Innoship Fixed Location Id obtained using Get Fixed Locations Request (Location service) |
| courierFixedLocationId | string | Instead of FixedLocationId | Can be used instead of FixedLocationId if available. To use this field the CourierId is mandatory and the courierFixedLocationId is not validated by our system. |
Example Request:
{
"serviceId": 1,
"courierId": 6,
"shipmentDate": "2023-05-26T11:29:36+02:00",
"shipmentDateEnd": "2023-05-26T11:29:36+00:00",
"addressFrom": {
"name": "LockReturn TEST",
"contactPerson": "LockReturn TEST",
"country": "RO",
"countyName": "Bucuresti",
"localityName": "Bucuresti",
"addressText": "Str Stefan Stoika 27",
"postalCode": "012243",
"phone": "+40761479785",
"email": "avcc@yahoo.co.uk",
"fixedLocationId": "157"
},
"payment": 2,
"content": {
"envelopeCount": 0,
"parcelsCount": 1,
"palettesCount": 0,
"totalWeight": 1,
"contents": "Comanda",
"package": "box",
"oversizedPackage": false,
"parcels": [
{
"sequenceNo": 1,
"size": {
"width": 20,
"height": 10,
"length": 20
},
"weight": 1,
"type": 2,
"reference1": "91808259.1"
}
]
},
"extra": {
},
"parameters": {
"async": true,
"getParcelsBarcodes": true,
"includeCourierResponse": true,
"includePriceBreakdown": false,
"includeAddressInResponse": false
},
"externalClientLocation": "RO",
"externalOrderId": "locker88",
"metadata": "",
"sourceChannel": "",
"observation": ""
}Example API response with courier response included:
{
"clientOrderId": "6|1SDYLR1162395",
"courierShipmentId": "1SDYLR1162395",
"courier": 6,
"courierParcelsBarcodes": [
{
"sequenceNo": 1,
"barcode": "1SDYLR1162395001"
}
],
"price": {
"amount": 10.0,
"vat": 1.90,
"totalAmount": 11.90,
"currency": "RON"
},
"calculatedDeliveryDate": "2023-05-28T21:00:00Z",
"trackPageUrl": "https://track.innoship.io/ATvdQgskKEmV4wqKJK2mJA",
"courierResponse": {
"awbNumber": "1SDYLR1162395",
"awbCost": 10.0,
"parcels": [
{
"Position": 1,
"AwbNumber": "1SDYLR1162395001"
}
],
"pdfLink": "https://sameday-api.demo.zitec.com/api/awb/download/1SDYLR1162395",
"deliveryLogisticLocationId": "",
"deliveryLogisticLocation": "",
"pickupLogisticLocation": "TM_TIMISOARA_A04",
"pickupLogisticLocationId": "122",
"deliveryLogisticCircle": "",
"sortingHubId": "",
"sortingHub": "",
"lockerReturnChargeCode": "JAD7E8G",
"returnAwbs": null
},
"extra": {
"bankRepaymentCurrency": "RON",
"openPackage": false,
"saturdayDelivery": false,
"reference1": "91808259",
"returnOfDocuments": false,
"returnPackage": false
}
}