Skip to main content

Delivery Details Listing - listShippingDetails()

Delivery Details Listing​

listShippingDetails() method is the method that enables the tracking of the cargo status, on delivery basis, of the delivery data, sent to the Horoz Logistics system by the client through the Horoz Logistics Domestic Distribution Integration as part of the Horoz Logistics Domestic Distribution Cargo Tracking Integration , within the Horoz Logistics distribution operation life cycle. Important information and the points to be taken into consideration during the course of performance of inquiry of the cargo tracking data on the basis of the customer order through the Horoz system are listed submitted below in the form of a list for the information of the clients by means of the listShippingDetails() method.

  • listShippingDetails() method is a RESFtul web service method that retrieves data in JSON format using the GET method by entering the delivery number as a parameter to the web service URL from the client.

  • When tracking cargo on order basis from the Horoz Logistics system by means of the listShippingDetails() method, the delivery number details for the order must be entered into the method as a parameter. In addition, the processKey details about the client must be entered into as a parameter type in the header of the method.

  • listShippingDetails() method returns cargo tracking data to the client on delivery basis under 3 different structures, namely shippingDeliveryState, listOfShipments and listOfMovements.

  • By means of the fields incorporated into it, the shippingDeliveryState structure returns the order number, cargo tracking number, the ATF number details about the last delivery attempt within the order, the sender details, the recipient details, total physical transportable quantity details and delivery status details about the delivery to the client.

  • By means of the fields incorporated into it, the listOfShipments structure returns the product code, product name, quantity, weight and desi details about the ATF for the last delivery attempt within the relevant order to the client.

  • By means of the fields incorporated into it, the listOfMovements structure returns the cargo tracking status of the respective order within the Horoz Logistics Domestic Distribution Operational Life Cycle in a history model, in chronological order, including the order number, ATF number, delivery type, sender details, recipient details, quantity, desi, cargo tracking status, cargo tracking status date, delivery status and amount details to the client.

  • • The cargoTrackingNumber details, returned to the client within the listShippingDetails() method, is a unique number whereby cargo tracking can be ensured on the merchant web portal through the shipment tracking screen available on www.horoz.com.tr and/or the cargo URL, namely https://app3.horoz.com.tr.

  • The status details, returned to the client under the movements arrayList available in the listShippingDetails() method returns the current cargo tracking status for the respective delivery to the client. The default (not customized on company basis) cargo tracking status and descriptions, returned to the client in the status field, are given in the table below.

STATUSDESCRIPTION
BEKLİYORRefers to the status that the goods are received and that a barcode label is created for the delivery. (Entry cannot be cancelled)
GİRİŞShipment has been initiated, and it has arrived at a transfer point. (Entry cannot be cancelled)
ÇIKIŞShipment has been initiated, and it has departed from the transfer point. (Entry cannot be cancelled)
TESLİM SORUNIt has been out for delivery and it has not been delivered and an issue is entered. (Entry cannot be cancelled)
TESLİMIt has been out for delivery, and delivered successfully. (Entry cannot be cancelled)

  • The deliveryProblem details, returned to the client under the movements arrayList available in the listShippingDetails() method, returns to the client the details about the possible delivery problem entered in the respective ATF in case the respective shipment could not be delivered to the final recipient. The details and the explanations about the possible delivery problems are given in the table below.

  • listShippingDetails() method is a cargo tracking method that is available for use by all domestic distribution integration stakeholders of Horoz Logistics. For the purpose of managing the request traffic coming to the respective method and ensuring optimum use of the method, the use of the method by the clients is controlled by limiting it with an hourly frequency control. The respective method is allowed to be called by the clients once every hour at a 5-minute interval. For the calls outside such ranges, clients will receive an error message to read as New query can be made after DD.MM.YYYY HH24:MI:SS..

GET listShippingDetails()​

ENDPOINT

http://b2btest.horoz.com.tr:7801/listsrestservice_test/v1/listShippingDetails

Parameter Descriptions & Rules​

The following table lists the input and output parameters of the listShippingDetails() process and the types and formats of such parameters.

FieldsDescriptionData TypeLengthField LocationRequirement
processKeyThe processKey details identified for the clientstring100HeaderMandatory
requestNumberOrder numberstring50Header ParametersMandatory

Service Responses​

Response CodeResponse MessageDescription
STA-100Kayit islemi basariliIt refers to the fact that the shipment cancellation process is successful.
ERR-20002Yeni sorgulama DD.MM.YYYY HH24:MI:SS tarihinden sonra yapılabilir.This response is returned due to the frequency control for the service. It is stated that inquiries can be made after the specified date.
ERR-20004TALEP NUMARASI BULUNAMADI - Key: X TalepNo: X Method: listShippingDetailsIt refers to the fact that the order to be queried has not been created in the system or the goods with respect to the order have not been received yet.