Road Order Status Listing- listRoadOrderStatus()
Road Order Status Listing
The listRoadOrderStatus method on the Horoz Logistics E-Export Integration is a function that returns the list of the cargo status of the orders transmitted to the Horoz system to the client. Important information about the listRoadOrderStatus()
method and the things to be considered when querying the cargo status of the road order in the Horoz system are listed below for the information of the clients.
-
The
listRoadOrderStatus()
method is aRESFtul
web service method that receives data inJSON
format viaPOST
method. -
When querying the cargo status of the road order from the Horoz system with the
listRoadOrderStatus()
method, the information about the order must be passed to the body part of the method in theJSON
data type. The processKey information of the client must be passed to the header part of the method in parameter type. The submission made with thelistRoadOrderStatus()
method must be encoded as UTF-8 and transmitted to Horoz Logistics E-Export Integration Web service. -
The
listRoadOrderStatus()
method in the E-Export integration web service receives customerOrderNumber as a parameter as aPOST
method inJSON
format. -
The method returns the expected cargo tracking information for the orders and/or orders in the list returned to the client in response to the received request parameters.
-
When querying the cargo tracking status of the orders with the
listRoadOrderStatus()
method, only the customer order number can be queried. Customer order number cannot be blank. The statuses returned in thelistRoadOrderStatus()
method are order based and product based statuses are not returned.
POST listRoadOrderStatus()
Parameter Descriptions & Rules
The following table shows the input and output parameters of the listRoadOrderStatus()
operation and their
The types and formats of the parameters are listed.
- Fields
- Example Request
- Example Response
PARAMETER | DESCRIPTION | DATA TYPE | LENGTH | FIELD LOCATION | REQUIRMENT |
---|---|---|---|---|---|
processKey | processKey information defined for the client | string | 100 | Header | Mandatory |
customerOrderNumber | Customer order number | string | 100 | inBody Request | Optional |
{
"customerOrderNumber": "805716833729"
}
{
"response": {
"responseCode": "STA-100",
"responseMessage": "ISLEM BASARILI",
"orderDeliveryState": {
"customerOrderNumber": "805716833729",
"senderTitle": "KALITE BARKOD ETIKET VE KAGIT SANAYI TICARET LIMITED SIRKETI",
"senderAddress": "GEBZE DEPO ADRES : BALCİK MERKEZ MAH. SİLE CAD. NO:20 GEBZE/KOCAELİ ? TURKEY",
"recipientTitle": "ANMELDER: KALITE BARKOD ETIKET VE KAGIT SANAYI TICARET LTDS",
"recipientAddress": "Amazon Fulfillment Center Kaltbandstrasse 4 44145 Dortmund",
"deliveryStatu": "TESLİM EDİLDİ",
"deliveryDate": "28.12.2022 10:00:14",
"deliveredName": "JANNISSOKKO"
},
"listOfMovements": {
"movements": [
{
"customerOrderNumber": "805716833729",
"movementType": "YURTDIŞI",
"movementCountry": "TÜRKİYE",
"stateHolder": "HOROZ",
"statu": "SİPARİŞ OLUŞTURULDU",
"statusBranch": "ALMANYA DİĞER",
"statusDate": "30.11.2022 09:40:54"
},
{
"customerOrderNumber": "805716833729",
"movementType": "YURTDIŞI",
"movementCountry": "TÜRKİYE",
"stateHolder": "HOROZ",
"statu": "DSV SİPARİŞ KAYDI OLUŞTURULDU",
"statusBranch": "ALMANYA DİĞER",
"statusDate": "30.11.2022 10:00:15"
}
]
}
}
}
All status information that can come to the “deliveryStatu” field is specified in the table below.
Response Code |
---|
DSV TURKEY ORDER ACCEPTANCE |
ORDER CONFIRMED |
DSV ORDER BARCODE RECEIVED |
DSV ORDER RECORD CREATED |
ORDER CREATED |
ORDER DELIVERED |
DELIVERY CANCELED |
DSV GERMANY WAREHOUSE ENTRANCE |
DSV GERMANY WAREHOUSE EXIT |
ON THE WAY FOR DELIVERY |
LEFT THE FACILITY |
ORDER DATA TRANSMITTED VIA INTEGRATION |
ORDER CANCELED |
DSV WAREHOUSE ENTRANCE |
DSV WAREHOUSE OUTLET |
ERROR: ORDER COULD NOT BE TRANSFERRED |
INTAKE SCREENING |
BUYER REFUSED DELIVERY |
LEFT THE FACILITY - ON THE WAY |
Service Responses
You can access the successful/unsuccessful service responses here.