Karayolu Siparişleri Listeleme - listRoadOrders()

Karayolu Siparişleri Listeleme

Horoz Lojistik E-İhracat Entegrasyonu üzerinde bulunan listRoadOrders metodu, Horoz Lojistik sistemine iletilmiş karayolu siparişlerinin listesini istemciye dönen fonksiyondur. listRoadOrders() metodu ile ilgili önemli bilgiler ve Horoz Lojistik sisteminden karayolu siparişleri sorgulanırken dikkat edilmesi gerekenler liste halinde aşağıda istemcilerin bilgisine sunulmuştur.

listRoadOrders() metodu POST yöntem ile JSON formatta veri alan, bir RESFtul web servis metodudur.
listRoadOrders() metodu ile Horoz sisteminden karayolu siparişleri için sorgulama yaparken, siparişe ait bilgiler metodun body kısmına JSON veri tipinde geçilmelidir. İstemciye ait processKey bilgisi metodun header kısmına parametre tipinde geçilmelidir. listRoadOrders() metodu ile yapılan gönderim UTF-8 olarak encode edilerek Horoz Lojistik E-İhracat Entegrasyonu Web servisine iletilmelidir.
İhracat entegrasyon web servisi içerisinde bulunan listRoadOrders() metodu, parametre olarak customerOrderNumber, startDate ve endDate değerlerini JSON formatta POST method olarak alır.
İlgili metot alınan istek parametrelerinin karşılığında istemciye yanıt olarak dönen listedeki sipariş ve/veya siparişler için beklenen bilgileri istemciye döner.
listRoadOrders() metodu ile siparişler sorgulanırken, sadece müşteri sipariş numarası bazında sorgulama yapılabileceği gibi, sadece başlangıç ve bitiş tarihi aralığı verilerek sorgulama yapılabilir.
startDate ve endDate parametrelerine geçilen değerler arasındaki zaman farkı en fazla 30 gün olabilir.
listRoadOrders() dönüşlerinde orderDetail ve orderTrackingDetail olmak üzere 2 ayrı arrayList yapısı bulunur. orderDetail sipariş bünyesindeki ürün bilgilerine ait bilgileri dönerken, orderTrackingDetail siparişin kargo takip bilgilerini nakliyeci bazında istemciye döner.

POST listRoadOrders()

ENDPOINT

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

Parametre Açıklamaları & Kuralları

Aşağıdaki tabloda listRoadOrders() işleminin giriş ve çıkış parametreleri ve bu parametrelerin tür ve formatları listelenmiştir.

Alanlar
Örnek İstek
Örnek Cevap

Parametre	Açıklama	Veri Tipi	Uzunluk	Alan Yeri	Zorunluluk
`processKey`	İstemci için tanımlanan `processKey` bilgisi	string	100	Header	Zorunlu
`customerOrderNumber`	Müşteri sipariş numarası	string	100	inBody Request	Opsiyonel
`startDate`	Başlangıç tarihi	Date	-	inBody Request	Opsiyonel
`endDate`	Bitiş tarihi	Date	-	inBody Request	Opsiyonel

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

  {
    "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/"
              }
            ]
          }
        ]
      }
    }
  }

Servis Cevapları

Servise ait başarılı/başarısız servis cevaplarına buradan erişebilirsiniz.