Get Started ابدأ الآن

Shipments الشحنات

NQL Shipment Creation إنشاء شحنة ناقل

NQL Shipment Update

NQL ASR - After Sales Returns Shipment Creation

NQL Shipment Tracking

NQL Multi-Shipment Tracking (copy)

NQL Print Label

Appendices ملاحق

Currency العملة

Load Type نوع الحمولة

Country-City codes رموز الدولة-المدينة

Sticker/Label size - حجم الملصق

New Collection 2162023

Naqel xConnect - Dec 18

GnTeq Shipping Engine

<p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgba(20, 23, 25, 0.84)">This Application Programming Interface (API) document is aimed at helping you connect your software &amp; online services to Naqel&apos;s shipping &amp; tracking platform. By using these APIs, you will be able to get the information that you need to get started with the integration.</span></p><p class="slate-p " >تهدف وثائق واجهة برمجة التطبيقات (API) هذه إلى مساعدتك في ربط برنامجك وخدماتك الإلكترونية بمنصة الشحن والتتبع الخاصة بـناقل. من خلال استخدام هذه الواجهات، ستتمكن من الحصول على المعلومات اللازمة للبدء في عملية الربط.</p><p class="slate-p " ></p>

This Application Programming Interface (API) document is aimed at helping you connect your software & online services to Naqel's shipping & tracking platform. By using these APIs, you will be able to get the information that you need to get started with the integration.

تهدف وثائق واجهة برمجة التطبيقات (API) هذه إلى مساعدتك في ربط برنامجك وخدماتك الإلكترونية بمنصة الشحن والتتبع الخاصة بـناقل. من خلال استخدام هذه الواجهات، ستتمكن من الحصول على المعلومات اللازمة للبدء في عملية الربط.

<p class="slate-p " ></p><p class="slate-p " >These APIs authorize users to تتيح هذه الواجهات للمستخدمين الصلاحية للقيام بما يلي:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Creation Shipment إنشاء شحنة</div></li><li class="slate-li " ><div style="position:relative">Update Shipment تحديث شحنة</div></li><li class="slate-li " ><div style="position:relative">Track a single shipment تتبع شحنة واحدة</div></li><li class="slate-li " ><div style="position:relative">Track multi-shipments تتبع عدة شحنة</div></li><li class="slate-li " ><div style="position:relative">Print Label طباعة ملصق</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

These APIs authorize users to تتيح هذه الواجهات للمستخدمين الصلاحية للقيام بما يلي:

Field

Data Type

Required

Description

الوصف

ClientContact <Object> معلومات الاتصال للعميل

قائمة تفاصيل الفاتورة التجارية

<Int> M —> It is the DeclareValue CurrencyID, if DeclareValue is > 0, then CurrencyID is mandatory, otherwise it's optional 

رمز العملة لرقم قيمة التصريح، إذا كانت قيمة التصريح أكبر من 0، فإن رمز العملة إلزامي، وإلا فهو اختياري

<String> <int> M —>  (1 on Account حساب) (5 COD الدفع عند الاستلام)

<Int> M —> Number of shipment package pieces 

<Double> M —> The weight of the shipment 

<String> O —> Any instruction can be mentioned here 

يمكن ذكر أي تعليمات توصيل هنا

<Double> M —> If the billing type is 5 (COD), you should mention how much amount should be collected from consignee. Item Price + Delivery Service Cost + Shipment Value VAT. If the billing type is 1 pass 0. إ

ذا كان نوع الفوترة 5 (الدفع عند الاستلام)، يجب ذكر المبلغ الذي يجب جمعه من المستلم. سعر العنصر + تكلفة خدمة التوصيل + ضريبة القيمة المضافة على قيمة الشحنة. إذا كان نوع الفوترة 1، يجب تمرير 0

<Bool> M —> The default value is False, and Naqel salesman will arrange a time to pick up the shipment daily. If true, system will create the booking, and you should save the BookingRefNo in your database for any further query.  False 

وسيقوم مندوب مبيعات ناقل بترتيب وقت لاستلام الشحنة يوميًا. إذا كانت القيمة True، سينشئ النظام الحجز، ويجب عليك حفظ رقم مرجع الحجز (BookingRefNo) في قاعدة البيانات الخاصة بك لأي استفسار لاحق.

<Bool> M —> The default value is True, means system will generate a barcode for each box, and your operation should print the stickers and stick them in the boxes. If you change the value to False, system will not generate any barcode for pieces, but our courier will put stickers on the boxes once he picked up the shipment.

القيمة الافتراضية هي True، مما يعني أن النظام سيقوم بإنشاء رمز شريطي لكل صندوق، ويجب على قسم العمليات لديك طباعة الملصقات ووضعها على الصناديق. إذا قمت بتغيير القيمة إلى False، فلن يقوم النظام بإنشاء أي رمز شريطي للقطع، ولكن مندوب التوصيل لدينا سيضع الملصقات على الصناديق بعد استلامه للشحنة.

تاريخ التسليم الموعود من

تاريخ التسليم الموعود إلى

يرجى الرجوع إلى الملحق

<Double> O —>Shipment Value for Customs purpose. It is optional only if DeclareValue = 0, if DeclareValue > 0 it is mandatory to create Commercial Invoice. See Client Commercial Invoice in Table28 .

قيمة الشحنة لأغراض الجمارك. إنها اختيارية فقط إذا كانت قيمة التصريح = 0، وإذا كانت قيمة التصريح > 0 فإنه من الضروري إنشاء فاتورة تجارية. راجع فاتورة العميل التجارية في الجدول 28.

<String> M —> You Shipment Reference Number [Order Number]  رقم مرجع شحنتك [رقم الطلب]

<Double> O —> Shipment width default as 1 - عرض الشحنة الافتراضي هو 1

<Double> O —> Shipment length default as 1 - طول الشحنة الافتراضي هو 1

<Double> O —> Shipment height default as 1 - ارتفاع الشحنة الافتراضي هو 1

 - حجم الشحنة الافتراضي هو 0.1

<Double> O —> Pass a value if you want to have Naqel insurance on your shipments. Otherwise, pass 0. Please refer to agreement for insurance terms مرر قيمة إذا كنت ترغب في الحصول على تأمين ناقل لشحناتك. وإلا، مرر 0. يرجى الرجوع إلى الاتفاقية لشروط التأمين

<String> O —> The value of Client Specific Data قيمة البيانات الخاصة بالعميل

<Double> M —> The value of Custom Duty Goods VAT Amount قيمة ضريبة القيمة المضافة على السلع الجمركية

<Bool> M —> The default value is false, in case of custom duty pay by consignee you can change it to true. 

القيمة الافتراضية هي false، وفي حالة دفع الرسوم الجمركية من قبل المستلم، يمكنك تغييرها إلى true

itempieceslist <Object> قائمة قطع المنتجات
itemPieces <Object> قطع المنتجات

<Int> M —> It is the DeclareValue CurrencyID, if DeclareValue is > 0, then CurrencyID is mandatory, otherwise it's optional

<Int> M —> Number of shipment package pieces

<Double> M —> The weight of the shipment

<String> O —> Any instruction can be mentioned here

<Double> M —> If the billing type is 5, you should mention how much amount should be collected from consignee. Item Price + Delivery Service Cost + Shipment Value VAT. If the billing type is 1 pass 0.

<Bool> M —> The default value is False, and Naqel salesman will arrange a time to pick up the shipment daily. If true, system will create the booking, and you should save the BookingRefNo in your database for any further query.

<String> M —> You Shipment Reference Number [Order Number] 

<Double> O —> Shipment width default as 1

<Double> O —> Shipment length default as 1

<Double> O —> Shipment height default as 1

<Double> O —> Pass a value if you want to have Naqel insurance on your shipments. Otherwise, pass 0. Please refer to agreement for insurance terms

<String> O —> The value of Client Specific Data

<Double> M —> The value of Custom Duty Goods VAT Amount

itempieceslist <Object>
itemPieces <Object>

<p class="slate-p " ></p><h3 class="slate-h3 " ><span style="color:#000000"><strong class="slate-bold">Body Parameters</strong></span></h3><p class="slate-p " ><span style="color:#000000">ClientInfo&lt;Object&gt;</span></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:137px;">Field</div><div style="width:99px;">Data Type</div><div style="width:83px;">Required</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:137px"><col style="width:99px"><col style="width:83px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ClientID</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Int</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >M</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Naqel Client ID</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000">Password</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000">String</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >M</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000">API Password</span></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Version</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >M</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >API Version</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"><span style="color:#000000"><strong class="slate-bold">WaybillNo </strong></span><span style="color:#000000">&lt;String&gt; M —&gt; Waybill</span></p><p class="slate-p " ></p><h1 class="slate-h1 " >cURL</h1><p class="slate-p " ></p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">XML</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"><?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <TraceByWaybillNo xmlns="http://tempuri.org/">
      <ClientInfo> 
        <ClientID>*******</ClientID>
        <Password>*******</Password>
        <Version>*******</Version>
      </ClientInfo>
      <WaybillNo>*******</WaybillNo>
    </TraceByWaybillNo>
  </soap:Body>
</soap:Envelope> </textarea><code class="language-xml keep-markup drop-tokens"></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " ></p><h3 class="slate-h3 " ><span style="color:#000000"><strong class="slate-bold">Body Parameters</strong></span></h3><p class="slate-p " ><span style="color:#000000">ClientInfo &lt;Object&gt;</span></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:137px;">Field</div><div style="width:99px;">Data Type</div><div style="width:83px;">Required</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:137px"><col style="width:99px"><col style="width:83px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ClientID</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Int</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >M</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Naqel Client ID</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000">Password</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000">String</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >M</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000">API Password</span></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Version</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >M</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >API Version</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"><span style="color:#000000"><strong class="slate-bold">WaybillNo </strong></span><span style="color:#000000">&lt;String&gt; M —&gt; Waybill</span></p><p class="slate-p " ></p><h1 class="slate-h1 " >cURL</h1><p class="slate-p " ></p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">XML</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"><?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <TraceByMultiWaybillNo xmlns="http://tempuri.org/">
      <ClientInfo>
        <ClientID>*******</ClientID>
        <Password>*******</Password>
        <Version>*******</Version>
      </ClientInfo>
      <WaybillNo>
       <int>*******</int> 
       <int>*******</int>
      </WaybillNo>
    </TraceByMultiWaybillNo>
  </soap:Body>
</soap:Envelope> </textarea><code class="language-xml keep-markup drop-tokens"></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " ></p><h3 class="slate-h3 " ><span style="color:#000000"><strong class="slate-bold">Body Parameters</strong></span></h3><p class="slate-p " ><span style="color:#000000">ClientContact &lt;Object&gt;</span></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:137px;">Field</div><div style="width:99px;">Data Type</div><div style="width:83px;">Required</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:137px"><col style="width:99px"><col style="width:83px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ClientID</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Int</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >M</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Naqel Client ID</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000">Password</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000">String</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >M</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000">API Password</span></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Version</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >M</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >API Version</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"><span style="color:#000000"><strong class="slate-bold">WaybillNo </strong></span><span style="color:#000000">&lt;String&gt; M —&gt; Waybill</span></p><p class="slate-p slate-indent-0" style="0px"><span style="color:#000000"><strong class="slate-bold">StickerSize </strong></span><span style="color:#000000">&lt;</span>StickerSize<span style="color:#000000">&gt; M —&gt; please refer to appendix F</span></p><p class="slate-p " ></p><h1 class="slate-h1 " >cURL</h1><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">XML</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"><?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetWaybillSticker xmlns="http://tempuri.org/">
      <clientInfo>
        <ClientAddress>
        </ClientAddress>
        <ClientContact>
        </ClientContact>
        <ClientID>*******</ClientID>
        <Password>*******</Password>
        <Version>*******</Version>
      </clientInfo>
      <WaybillNo>*******</WaybillNo>
      <StickerSize>*******</StickerSize>
    </GetWaybillSticker>
  </soap:Body>
</soap:Envelope> </textarea><code class="language-xml keep-markup drop-tokens"></code></pre></div><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(20, 23, 25)"><strong class="slate-bold">﻿</strong></span><a href="https://gnteq-my.sharepoint.com/:x:/p/sarah_makhamreh/EXO12s2eAnhFnMc8xqQo-ncBSc8tMfTiPBafZ6Phs3Bcqw?e=hzgoVb" target="_blank"><span style="color:rgb(109, 128, 236)">Appendix</span></a></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " >Below are the appendices referred to within the documentation فيما يلي الملاحق المشار إليها في الوثيقة:</p><p class="slate-p " ></p><p class="slate-p " ></p>

Below are the appendices referred to within the documentation فيما يلي الملاحق المشار إليها في الوثيقة:

Sections