Send delivery notice
During this process, delivery data for shipped data is reported to Channel Pilot Pro.
$deliveries= array();
$delivered = new CPDelivery("TEST_ORDER_ID_SHOP-1", "marketplace_1", true, "TEST_TRACK_NUMBER_1", "2014-05-28T11:27:07");
$delivered->carrierName = "DHL";
$deliveries[] = $delivered;
$delivered = new CPDelivery("TEST_ORDER_ID_SHOP-2", "marketplace_1", true, "TEST_TRACK_NUMBER_2", "2014-05-28T11:33:32");
$delivered->carrierName = "DHL";
$deliveries[] = $delivered;
$api = new ChannelPilotSellerAPI_v1_0("cpMerchantId", "cpApiToken");
$result = $api->registerDeliveries($deliveries);
API-Function - REGISTERDELIVERIES()
$result = $api->registerDeliveries($deliveries);
To send the delivery data to Channel Pilot Pro there is the function "registerDeliveries()". For each shipped order a CPDelivery-Object is created. This contains data like the tracking code or the name of the delivery company.
SOAP-UI description and samples for this function can be found here.
Sample data request:
[{
"orderHeader":{
"orderId":"TEST_ORDER_ID_SHOP-1",
"source":"marketplace_1",
"status":{
"identifier":"30",
"hasError":false,
"errorCode":0
}
},
"deliveryTime":"2014-05-28T11:27:07",
"isDeliveryCompleted":true,
"trackingNumber":"TEST_TRACK_NUMBER_1",
"title":"DHL",
"deliveredItems":[]
},{
"orderHeader":{
"orderId":"TEST_ORDER_ID_SHOP-2",
"source":"marketplace_1",
"status":{
"identifier":"30",
"hasError":false,
"errorCode":0
}
},
"deliveryTime":"2014-05-28T11:33:32",
"isDeliveryCompleted":true,
"trackingNumber":"TEST_TRACK_NUMBER_2",
"title":"DHL",
"deliveredItems":[]
}]
The response again contains the new status (30) of the order or an error message.
Sample data response:
{
"updateResults":[{
"orderHeader":{
"orderId":"TEST_ORDER_ID_SHOP-1",
"orderIdExternal":"TEST_ITEM_ID_MARKETPLACE-1",
"source":"marketplace_1",
"status":{
"identifier":"30",
"publicTitle":"Delivered",
"publicDescription":"Order was send",
"hasError":false
},
"orderTime":"2014-05-27T18:22:38+02:00"
},
"header":{
"resultCode":200,
"resultMessage":""
}
},{
"orderHeader":{
"orderId":"TEST_ORDER_ID_SHOP-2",
"orderIdExternal":"TEST_ITEM_ID_MARKETPLACE-2",
"source":"marketplace_1",
"status":{
"identifier":"30",
"publicTitle":"Versendet",
"publicDescription":"Order was send",
"hasError":false
},
"orderTime":"2014-05-27T21:37:02+02:00"
},
"header":{
"resultCode":200,
"resultMessage":""
}
}]
}