List Roadway Orders - listRoadOrders()

List Roadway Orders

The listRoadOrders method on the Horoz Logistics E-Export Integration is a function that returns the list of road orders transmitted to the Horoz Logistics system to the client. Important information about the listRoadOrders() method and things to be considered when querying road orders from the Horoz Logistics system are listed below for the information of clients.

• listRoadOrders() method is a RESFtul web service method that receives data in JSON format with POST method.

• When querying for road orders from the Horoz system with the listRoadOrders() method, the information about the order must be passed to the body part of the method in the JSON data type. The processKey information of the client should be passed to the header part of the method in parameter type. The submission made with the listRoadOrders() method must be encoded as UTF-8 and transmitted to Horoz Logistics E-Export Integration Web service.

• The listRoadOrders() method in the export integration web service receives customerOrderNumber, startDate and endDate values as parameters in JSON format as a POST method.

• The method returns to the client the expected information for the order and/or orders in the list returned to the client in response to the received request parameters.

• When querying orders with the listRoadOrders() method, querying can be done only on the basis of the customer order number, or querying can be done by giving only the start and end date range.

• The time difference between the values passed to the startDate and endDate parameters can be up to 30 days.

• listRoadOrders() returns 2 different arrayList structures, orderDetail and orderTrackingDetail. orderDetail returns information about the product information within the order, while orderTrackingDetail returns the shipping tracking information of the order to the client on a carrier bases.

---

POST listRoadOrders()

ENDPOINT

http://b2btest.horoz.com.tr:7801/eexport_test/v1/listRoadOrders

Parameter Descriptions & Rules

The following table shows the input and output parameters of the listRoadOrders() operation and their The types and formats of the parameters are listed.

Fields

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
startDate	Start date	Date	-	inBody Request	Optional
endDate	End date	Date	-	inBody Request	Optional

Example Request

 { 
    "customerOrderNumber": "805716833763", 
    "startDate": null, 
    "endDate": null 
 }

Example Response

  {
    "response": {
      "responseCode": "STA-100",
      "responseMessage": "ISLEM BASARILI",
      "listRoadOrders": {
        "orders": [
          {
            "companyName": "TEST İHRACAT",
            "customerOrderNumber": "805716833763",
            "shippingType": "EKONOMİ",
            "deliveryType": "KALDIRIM ÖNÜ",
            "recordType": "PARSİYEL",
            "receptionType": "receivedFromAddress",
            "orderDate": "2022-01-21 11:26:32",
            "senderTitle": "TEST İHRACAT",
            "outletLocationType": "YURT İÇİ",
            "senderCountry": "TÜRKİYE",
            "senderCityName": "ADIYAMAN",
            "senderPostCode": "34001",
            "senderAddress": "SARDUNYA MAHALLESİ, PAPATYA SOKAK NO:26/1 İSTANBUL/ÜMRANİYE",
            "senderFloor": null,
            "senderApartment": null,
            "senderOfficialPerson": "YETKİLİ",
            "senderPhone1": "+904444444444",
            "senderPhone2": "+905555555555",
            "senderEmail": "kemal.tekcin@horoz.com.tr",
            "recipientTitle": "ALICI BARKOD TEST 3",
            "destinationLocationType": "YURT DIŞI",
            "recipientCountry": "İNGİLTERE",
            "recipientCityName": "BRADFORD",
            "recipientPostCode": null,
            "recipientAddress": "ADRES BARKOD TEST 3",
            "recipientFloor": null,
            "recipientApartment": null,
            "recipientOfficialPerson": "YETKİLİ",
            "recipientPhone1": "+443",
            "recipientPhone2": null,
            "recipientEmail": null,
            "orderNote": null,
            "step": 6,
            "paymentMethod": "PEŞİN",
            "invoiceNumber": "F3",
            "invoiceDate": 300,
            "invoiceCurrency": "EUR",
            "shippingAmount": 0,
            "totalQuantity": 2,
            "totalDesi": 66.666,
            "dsvOrderNumber": "40257145990018370676",
            "upsOrderNumber": "1Z64V11F6890023811",
            "approveState": "UNAPPROVED",
            "approver": null,
            "approveDate": null,
            "exportType": null,
            "isAtr": "yes",
            "isInsured": null,
            "isYdg": null,
            "isCustomService": null,
            "orderDetail": [
              {
                "rowNumber": 1,
                "productCode": "B101",
                "productName": "B KOLİ",
                "productGroupName": "MOBİLYA",
                "quantity": 2,
                "desi": 33.333,
                "netWeight": 22,
                "grossWeight": 25,
                "productAmount": 0,
                "montageState": "N",
                "numberOfContainers": 2,
                "masterRowNumber": 1,
                "isComponentProduct": "N"
              }
            ],
            "orderTrackingDetail": [
              {
                "trackingCompany": "DSV",
                "trackingNumber": "40257145990018370676",
                "trackingUrl": "https://mydsv.com/track-shipment"
              },
              {
                "trackingCompany": "UPS",
                "trackingNumber": "1Z64V11F6890023811",
                "trackingUrl": "https://www.ups.com/track?loc=en_US&requester=ST/"
              }
            ]
          }
        ]
      }
    }
  }

---

Service Responses

You can access the successful/unsuccessful service responses here.