shipping API document

Table of Contents
INTRODUCTION ............................................................................................................................... 2
SECURITY ......................................................................................................................................... 2
FUNCTIONAL APIs ............................................................................................................................ 2
FORWARD ORDER BOOKING (POST) ................................................................................................................... 2
RETURN ORDER BOOKING (POST) ....................................................................................................................... 4
PRINT SHIPPING LABEL (GET) .............................................................................................................................. 6
ORDER TRACKING (GET) ...................................................................................................................................... 6
Webhook – Order status push ............................................................................................................................ 8
APPENDIX ...................................................................................................................................... 10
GLOSSARY ......................................................................................................................................................... 10
INTRODUCTION
The objective of this document is to help the reader thoroughly understand the Logistiq shipping API. This API will
enable client’s system to establish direct communication with LOGISTIQ’s system. Using this API, Logistiq allows the
client to access its shipping & tracking systems in an automated way and provides a secure mode of interaction
between systems.

SECURITY
Logistiq provides best in class security methods for all its applications and APIs,
- We use Firebase Authentication to create and manage users that use their email addresses and passwords to
sign in. This ensures that all the requests submitted by the users will be authenticated using their email address
and password.
- We use Nginx Ingress, which exposes HTTP and HTTPS routes from outside the cluster to services within the
cluster. Traffic routing is controlled by rules defined on the Ingress resource. HTTPS is used to ensure all
transmissions are encrypted.
- We use Cloudflare, a global network, to make the connection secure, private, fast, and reliable. It ensures security
of the APIs & Internet applications.

FUNCTIONAL APIs
FORWARD ORDER BOOKING (POST)
Forward order is defined as an order which is to be picked up from client warehouse and to be delivered to the end
customer’s doorstep. This API allows the client to book the forward order with Logistiq by providing full details of
the shipment, pick-up & drop-off.
URL: https://{{BASE_URL}}/auth/api/v2/orders/order-create

Request Payload Response

{ {
"additional": { "meta": {
"delivery_type": "FORWARD", "success": true,
"status": 200,
"async": true,
"message": "Success"
"label": true,
},
"order_date": "2022-06-09T22:29:41",
"result": {
"vendor_code": "ADDR12182_1467", "status": true,
"duty_fee_paid_by": "", "waybill": "290307446492",
"rvp_reason": null "reference_number": "LogistiqTest_0004",
}, "courier_partner_id": 79,
"pickup_info": { "courier_name": "Test_CP_Forward",
"landmark": null, "security_key": "",
"state": "Muharraq Island",
"sort_code": null,
"label": "url to download awb",
"address": ","513 ‫ﺪ ﻋﻤﺎرە‬Z‫ﺪاﻟﻤﺠ‬U‫ ﻋ‬RS‫اﻻﻣ‬
"alphaAwb": "ALPH000000407925"
"country_code": "BH",
}
"time": "2022-06-15T12:51:18", }
"name": ","eg f ‫رﻏﺪ اﻟﺤﺮ‬
"phone": "8001111090",
"phone_code": "+966",
"email": "[email protected]",
"city": "Muharraq",
"postal_code": "Busaiteen"
},
"drop_info": {
 "email": "[email protected]",
"name": "Abrar Alkadhim",
"landmark": "",
"address": "10c 3633",
"city": "Muharraq",
"state": "Muharraq Island",
"country_code": "BH",
"postal_code": "Busaiteen",
"phone": "542144333",
"phone_code": "+966"
},
"return_info": {
"landmark": null,
"state": "Muharraq Island",
"address": ","513 ‫ﺪ ﻋﻤﺎرە‬Z‫ﺪاﻟﻤﺠ‬U‫ ﻋ‬RS‫اﻻﻣ‬
"country_code": "BH",
"time": null,
"name": ","eg f ‫رﻏﺪ اﻟﺤﺮ‬
"phone": "8001111090",
"phone_code": "+966",
"email": "[email protected]",
"city": "Muharraq",
"postal_code": "Busaiteen"
},
"tax_info": null,
"shipment_details": {
"weight": "10",
"breadth": "10",
"height": "10",
"length": "10",
"invoice_value": "400",
"cod_value": "20",
"order_type": "COD",
"invoice_number": "3003373690",
"invoice_date": "2022-06-07",
"reference_number": "LogistiqTest_0004",
"currency_code": "SAR",
"items": [
{
"sku": "700202510203",
v S ‫"اﻟﻔﺴﺎﺗ‬,
"description": "‫ﺴﺴﻮارات‬x‫اﻻ‬wu
"quantity": "1.0000",
"price": "44.3500"
},
{
"sku": "700083142902",
 "description": "‫ﺴﺴﻮارات‬x‫اﻻ‬wuv S ‫"اﻟﻔﺴﺎﺗ‬,
"quantity": "1.0000",
"price": "52.1700"
},
{
"sku": "700227980302",
"description": "‫ﺴﺴﻮارات‬x‫اﻻ‬wu v S ‫"اﻟﻔﺴﺎﺗ‬,
"quantity": "1.0000",
"price": "65.2200"
},
{
"sku": "1000060302",
"description": "‫ﺴﺴﻮارات‬x‫اﻻ‬wu v S ‫"اﻟﻔﺴﺎﺗ‬,
"quantity": "1.0000",
"price": "65.2200"
},
{
"sku": "700227980402",
"description": ","‫ﺴﺴﻮارات‬x‫اﻻ‬wu v S ‫اﻟﻔﺴﺎﺗ‬
"quantity": "5.0000",
"price": "23.2200"
},
{
"sku": "1000060804",
v S ‫اﻟﻔﺴﺎﺗ‬
"description": ","‫ﺴﺴﻮارات‬x‫اﻻ‬wu
"quantity": "2.0000",
"price": "33.2200"
}
]
}
}

RETURN ORDER BOOKING (POST)

Return order is defined as an order which is to be picked up from the end customer’s doorstep and to be delivered
to the client warehouse. This API allows the client to book the return order with Logistiq by providing full details of
the shipment, pick-up & drop-off.

URL: https://{{BASE_URL}}/auth/api/v2/orders/order-create

Request Payload Response

{ {
"additional": { "meta": {
"delivery_type": "RETURN", "success": true,
"async": true,
"status": 200,
"label": true,
"order_date": "2022-06-07T22:29:41",
"message": "Success"
"vendor_code": "ADDR12182_1467", },
"duty_fee_paid_by": "", "result": {
"rvp_reason": null "status": true,
}, "waybill": "215000603910",
"pickup_info": { "reference_number": "LogistiqTest_0003",
"landmark": null, "courier_partner_id": 82,
"state": "Muharraq Island",
"courier_name": "Test_CP_Reverse",
"address": ","513 ‫ﺪ ﻋﻤﺎرە‬Z‫ﺪاﻟﻤﺠ‬U‫ ﻋ‬RS‫اﻻﻣ‬
"security_key": "",
"country_code": "BH",
"time": "2022-06-10T12:51:18", "sort_code": null,
"name": ","eg f ‫رﻏﺪ اﻟﺤﺮ‬ "label": "url to download awb",
"phone": "8001111090", "alphaAwb": "ALPR000000002082"
"phone_code": "+966", }
"email": "[email protected]", }
"city": "Muharraq",
"postal_code": "Busaiteen"
},
"drop_info": {
"email": "[email protected]",
"name": "Abrar Alkadhim",
"landmark": "",
"address": "10c 3633",
"city": "Muharraq",
"state": "Muharraq Island",
"country_code": "BH",
"postal_code": "Busaiteen",
"phone": "542144333",
"phone_code": "+966"
},
"return_info": {
"landmark": null,
"state": "Muharraq Island",
"address": ","513 ‫ﺪ ﻋﻤﺎرە‬Z‫ﺪاﻟﻤﺠ‬U‫ ﻋ‬RS‫اﻻﻣ‬
"country_code": "BH",
"time": null,
"name": ","eg f ‫رﻏﺪ اﻟﺤﺮ‬
"phone": "8001111090",
"phone_code": "+966",
"email": "[email protected]",
"city": "Muharraq",
"postal_code": "Busaiteen"
},
"tax_info": null,
"shipment_details": {
"weight": "10",
"breadth": "10",
"height": "10",
"length": "10",
"invoice_value": "400",
"cod_value": "20",
"order_type": "COD",
"invoice_number": "3003373690",
"invoice_date": "2022-06-07",
"reference_number": "LogistiqTest_0003",
"currency_code": "SAR",
"items": [
{
"sku": "700202510203",
"description": ","‫ﺴﺴﻮارات‬x‫اﻻ‬wu v S ‫اﻟﻔﺴﺎﺗ‬
"quantity": "1.0000",
"price": "44.3500"
 },
{
"sku": "700083142902",
"description": ","‫ﺴﺴﻮارات‬x‫اﻻ‬wuv S ‫اﻟﻔﺴﺎﺗ‬
"quantity": "1.0000",
"price": "52.1700"
},
{
"sku": "700227980302",
"description": ","‫ﺴﺴﻮارات‬x‫اﻻ‬wu v S ‫اﻟﻔﺴﺎﺗ‬
"quantity": "1.0000",
"price": "65.2200"
},
{
"sku": "1000060302",
v S ‫اﻟﻔﺴﺎﺗ‬
"description": ","‫ﺴﺴﻮارات‬x‫اﻻ‬wu
"quantity": "1.0000",
"price": "65.2200"
},
{
"sku": "700227980402",
"description": ","‫ﺴﺴﻮارات‬x‫اﻻ‬wu v S ‫اﻟﻔﺴﺎﺗ‬
"quantity": "5.0000",
"price": "23.2200"
},
{
"sku": "1000060804",
"description": ","‫ﺴﺴﻮارات‬x‫اﻻ‬wu v S ‫اﻟﻔﺴﺎﺗ‬
"quantity": "2.0000",
"price": "33.2200"
}
]
}
}

PRINT SHIPPING LABEL (GET)

In general, the shipping label is generated & sent as a response of the Order Booking API. But in case the client wants
to access the shipping labels of the existing shipments, this API allows them to access the older shipping labels up to
30 days using the order/shipment ID. The API response provides a URL to download the PDF file of the shipping label.
URL / API END POINT Response
{
{{Base_URL}}/allocation/api/v1/tracking/print-cp- "label": "url to download awb",
label?awb=ALPH0000000XXXXX "status": true
}

ORDER TRACKING (GET)

It allows client to track the end-to-end journey of the shipment including all the touch points. This API provides
complete information of all the actions performed on the shipment with the details of – status, location, time and
the user who performed the action.

URL / API END POINT Response

{
{{Base_URL}}/allocation/api/v1/tracking/order- {
details?alpha_awb= ALPH000000001028 "status": true,
"data": {
 "referance_awb": "ALPH000000001028",
"expected_delivery_date": null,
"customer_details": {
"name": "Mohammed",
"email": "[email protected]",
"calling_code": "+966",
"phone": "1000000000",
"address": "Al riyad",
"state": "Al-Madinah Al-Monawarah",
"city": "Al Mahd",
"country": "SA",
"postal_code": "Al Mahd"
},
"order_details": {
"brand_reference_number": "Ft12355",
"invoice_number": "12321412123",
"invoice_value": 2000.0,
"order_type": "COD",
"cod_value": 2000.0,
"qty": 2000.0,
"description": "Baby Care|Diaper",
"current-stage": {
"stage_code": 201,
"stage": "BOOKED",
"date": "2022-05-27T10:45:01.133204Z"
}
},
"tracking_history": [
{
"status_code": 201,
"status_name": "BOOKED",
"date": "2022-03-31T06:09:33.284201Z",
"status_sequence": 1,
"updates": []
},
{
"status_code": 203,
"status_name": "PICKED-UP",
"date": "2022-03-30T11:17:44.152452Z",
"status_sequence": 2,
"updates": [
{
"status": "PICKED_UP",
"date": "2022-03-30T11:17:44.152452Z",
"created_date": "2022-03-
30T11:17:44.157836Z",
"created_by": null,
"scanned_by":
"0AgEWrnvj6goMw8VP87Q5LLFTDz2",
"scanned_location": "Dubai Marina Tower",
"status_remark": "Order Picked-Up",
"additional_remark": null,
"visibility": true
}
]
},
{
"status_code": 204,
 "status_name": "IN-TRANSIT",
"date": null,
"status_sequence": 3,
"updates": []
},
{
"status_code": 205,
"status_name": "DELIVERED",
"date": null,
"status_sequence": 4,
"updates": []
}
]
}
}

Webhook – Order status push

Logistiq is using the webhook to push the real time order status updates to the client system. We allow our clients
to configure their webhook URL in our system, which will be used to push all the order status updates. Following are
the list of all the order statuses we push to the client system.
Status ID Status Name Shipment Direction
101 BOOKED Forward
102 UNASSIGNED Forward
103 ASSIGNED Forward
104 CANCELLED Forward
105 PICKED_UP Forward
106 IN_HUB Forward
107 MANIFESTED Forward
108 READY_TO_SHIP Forward
109 DISPATCHED Forward
110 INTRANSIT Forward
111 OUT_FOR_DELIVERY Forward
112 DELIVERED Forward
113 PARTIALLY_RETURNED Forward
114 RETURNED Forward
115 ON_HOLD Forward
116 LOST Forward
117 DAMAGED Forward
118 SHIPMENT_DELAYED Forward
119 SHIPMENT_HELD Forward
120 NDR Forward
121 NOT_SERVICEABLE Forward
122 FAILED_DELIVERY Forward
123 CANCELLED_ORDER Forward
124 CREATED Return
125 OUT_FOR_PICKUP Return
126 PICKED_UP Return
127 INTRANSIT Return
128 IN_HUB Return
129 MANIFESTED Return
130 UNASSIGNED Return
131 ASSIGNED Return
132 DELIVERED Return
133 RETURN_CANCELLED Return
134 ON HOLD Return
135 LOST Return
136 DAMAGED Return
137 SHIPMENT_DELAYED Return
138 SHIPMENT_HELD Return
139 PICKUP_FAILED Return
140 OUT_FOR_DELIVERY Return
141 UNMAPPED_FORWARD Forward
142 UNMAPPED_RETURN Return
143 PICKUP_PENDING Forward
144 PICKUP_PENDING Return
145 PICKUP FAILED Forward
146 NOT_SERVICEABLE Forward
147 RTO_REQUESTED Forward
148 RTO_OUT_FOR_DELIVERY Forward
149 RTO_DELIVERED Forward
150 RTO_FAILED Forward
151 CONTACT_CUSTOMER_CARE Forward
152 CONTACT_CUSTOMER_CARE Return
153 RTO_INTRANSIT Forward
154 OUT_FOR_PICKUP Forward
155 RTO_CONACT_CUSTOMER_CARE Forward
156 RTO_CONACT_CUSTOMER_CARE Return
157 AWB_REGISTERED Forward
158 AWB_REGISTERED Return
159 EXPIRED Forward
160 EXPIRED Return
161 EXCHANGE_PICKUP Forward
162 EXCHANGE_PICKUP Return
163 EXCHANGE_INTRANSIT Forward
164 EXCHANGE_INTRANSIT Return
165 EXCHANGE_DELIVERED Forward
166 EXCHANGE_DELIVERED Return
167 FAILED_DELIVERY Return
168 RTO Forward
169 RTO_SHIPMENT_DELAY Forward
170 NOT_SERVICEABLE Return
APPENDIX
GLOSSARY
Object Field Data type Required Allowed values Description
delivery_type str Mandatory FORWARD/RETURN Delivery Type of the Order
async boolean Optional true/false
label boolean Optional true/false
additional order_date datetime Optional datetime Order Creation Date
vendor_code str Optional str Vendor Code
Duty_fee_paid_by str Optional str Duty Fee Paid By
Rvp_reason str Optional str RVP Reason
landmark str Optional Str(max_length = 100) Pickup address landmark
state str Mandatory Str(max_length = 100) Pickup address state
address str Mandatory Str(max_length = 100) Pickup address
country_code str Mandatory Str(max_length = 100) Pickup address country
code
time datetime Mandatory datetime Pickup time
Pickup_info name str Mandatory Str(max_length = 100) Pick up name
phone str Mandatory Str(max_length = 15) Pickup address phone
number
phone_code str Mandatory Str(max_length = 4) Pickup address phone code
email str Mandatory Str(max_length = 100) Pickup email detail
city str Mandatory Str(max_length = 100) Pickup address city
postal_code str Mandatory Str(max_length = 100) Pickup address postal code
email str Mandatory Str(max_length = 100) Drop info email address
name str Mandatory Str(max_length = 100) Drop address name info
landmark str Mandatory Str(max_length = 100) Drop address landmark info
address str Mandatory Str(max_length = 100) Drop address info
city str Mandatory Str(max_length = 100) Drop address city into
Drop_info state str Mandatory Str(max_length = 100) Drop address state info
country_code str Mandatory Str(max_length = 100) Drop address county code
postal_code str Mandatory Str(max_length = 100) Drop address postal code
phone str Mandatory Str(max_length = 15) Drop address phone
number
phone_code str Mandatory Str (max_length = 4) Drop address phone code
landmark str Optional Str(max_length = 100) Return address landmark
info
state str Mandatory Str(max_length = 100) Return address state info
address str Mandatory Str(max_length = 100) Return address
country_code str Mandatory Str(max_length = 100) Return address county code
time datetime Mandatory Datetime Return address pickup time
return_info name str Mandatory Str(max_length = 100) Return address name info
phone str Mandatory Str(max_length = 15) Return address phone
number
phone_code str Mandatory Str(max_length = 4) Return address phone code
email str Mandatory Str(max_length = 100) Return address email
city str Mandatory Str(max_length = 100) Return address city info
postal_code str Mandatory Str(max_length = 100) Return address postal code
tax_info Str Optional Str(max_length = 100) Tax info
weight float Mandatory Float Weight of the shipment
breadth float Mandatory Float Breadth of the shipment
height float Mandatory Float Height of the shipment
shipment_details length float Mandatory Float Length of the shipment
invoice_value float Mandatory Float Invoice value of the order
cod_value float Mandatory Float Cod value of the order
order_type str Mandatory COD/PREPAID Order type
invoice_number str Optional Str(max_length = 100) Invoice number of order
invoice_date datetime Optional datetime Invoice generated date
reference_number str Mandatory Str(max_length = 100) Brand reference Number
currency_code str Mandatory Str (max_length = 4) Currency code
items list Mandatory list List of the items in an order
sku str Mandatory Str(max_length = 255) Id of the shipment
description Str Mandatory Str(max_length = 255) Description of the order to
be delivered
quantity float Mandatory Float Quantity per sku
price float Mandatory Float Price of the item