Jedex Api Documentation

Version 1.0

Summary

Jedex provides a simple and secure API interface, enabling you to quickly connect to your platform or system. We provide a sandbox environment for your integration and testing.

Environment

Sandbox Environment
https://sandbox.je-dex.com/api
Production Environment
https://www.je-dex.com/api

Authentication

Jedex Api use api_key to verify your identity. *Note: Sandbox and production environments have different keys, Please remember your key and do not reveal it to others.

API

create

Submit new order to Jedex.
URL: POST /v1/create
Request Body Schema: application/json
Request Parameters:
Field Format Description
api_key String Mandatory License Key
reference_id String, up to 100 characters Reference number of your business
pkg_weight Float, up to 2 decimal places. E.g.: 2.5 Mandatory
pkg_description String, up to 100 characters Mandatory
consignor_name String, up to 100 characters Mandatory
pick_mobile String, up to 30 characters Mandatory The mobile number of consignor
pick_country Integer, please refer the API regions Mandatory The country id of consignor
pick_province Integer, please refer the API regions Mandatory The province id of consignor
pick_city Integer, please refer the API regions Mandatory The city id of consignor
pick_district Integer, please refer the API regions Mandatory The district id of consignor
pick_address String, up to 200 characters Mandatory The detailed address of consignor
pick_lat_lng String, up to 100 characters. E.g.: 24.711330,46.665522 Mandatory The latitude & longitude of consignor position on Google map, separated by a comma
consignee_name String, up to 100 characters Mandatory The name of consignee
delivery_mobile String, up to 30 characters Mandatory The mobile number of consignee
delivery_country Integer, please refer the API regions Mandatory The country id of consignee
delivery_province Integer, please refer the API regions Mandatory The province id of consignee
delivery_city Integer, please refer the API regions Mandatory The city id of consignee
delivery_district Integer, please refer the API regions Mandatory The district id of consignee
delivery_address String, up to 200 characters Mandatory The detailed address of consignee
delivery_lat_lng String, up to 100 characters. E.g.: 24.711330,46.665522 Mandatory The latitude & longitude of consignee position on Google map, separated by a comma
Response:
Field Format Description
status Integer Result code of response
msg String Error message
data Object Data payload of response
├ order_sn String(16 characters) Jedex unique order number
└ reference_id String Reference number of your business

check_addr

Check the pickup and delivery addresses to get whether they are supported by Jedex. Check the distance between pickup address and delivery address which should not exceed the distance limitation.
URL: POST /v1/check_addr
Request Body Schema: application/json
Request Parameters:
Field Format Description
api_key String Mandatory License Key
pick_country Integer, please refer the API regions Mandatory The country id of consignor
pick_province Integer, please refer the API regions Mandatory The province id of consignor
pick_city Integer, please refer the API regions Mandatory The city id of consignor
pick_district Integer, please refer the API regions Mandatory The district id of consignor
pick_lat_lng String, up to 100 characters. E.g.: 24.711330,46.665522 Mandatory The latitude & longitude of consignor position on Google map, separated by a comma
delivery_country Integer, please refer the API regions Mandatory The country id of consignee
delivery_province Integer, please refer the API regions Mandatory The province id of consignee
delivery_city Integer, please refer the API regions Mandatory The city id of consignee
delivery_district Integer, please refer the API regions Mandatory The district id of consignee
delivery_lat_lng String, up to 100 characters. E.g.: 24.711330,46.665522 Mandatory The latitude & longitude of consignee position on Google map, separated by a comma
Response:
Field Format Description
status Integer Result code of response
msg String Error message
data Object Data payload of response
├ pick_lat_lng String The latitude & longitude of consignor
└ delivery_lat_lng String The latitude & longitude of consignee

check_addr

Check the address information with multi pickup addresses.
URL: POST /v1/check_addr
Request Body Schema: application/json
Request Parameters:
Field Format Description
api_key String Mandatory License Key
multi_pick[] Array The pickup address array
├ pick_country Integer, please refer the API regions Mandatory The country id of consignor
├ pick_province Integer, please refer the API regions Mandatory The province id of consignor
├ pick_city Integer, please refer the API regions Mandatory The city id of consignor
├ pick_district Integer, please refer the API regions Mandatory The district id of consignor
└ pick_lat_lng String, up to 100 characters. E.g.: 24.711330,46.665522 Mandatory The latitude & longitude of consignor position on Google map, separated by a comma
delivery_country Integer, please refer the API regions Mandatory The country id of consignee
delivery_province Integer, please refer the API regions Mandatory The province id of consignee
delivery_city Integer, please refer the API regions Mandatory The city id of consignee
delivery_district Integer, please refer the API regions Mandatory The district id of consignee
delivery_lat_lng String, up to 100 characters. E.g.: 24.711330,46.665522 Mandatory The latitude & longitude of consignee position on Google map, separated by a comma
Response:
Field Format Description
status Integer Result code of response
msg String Error message
data Array Data payload of response
├ status Integer Check result for one pair of address info
├ msg String Error message
└ data Array Data of one pair of address info
├ pick_lat_lng String The latitude & longitude of consignor
└ delivery_lat_lng String The latitude & longitude of consignee

tracking

Tracking an express order.
URL: POST /v1/tracking
Request Body Schema: application/json
Request Parameters:
Field Format Description
api_key String Mandatory License Key
order_sn String(16 characters) Mandatory Jedex unique order number
Response:
Field Format Description
status Integer Result code of response
msg String Error message
data Array Data payload of response
├ order_sn String(16 characters) Jedex unique order number
├ reference_id String, up to 100 characters Reference number of your business
└ tracking Array Tracking information
├ status Integer Order status
├ event String Express event
└ time String, E.g.: 2021-06-12T09:02:51+0000 Event time with format ISO8601

status

Get the latest status of an express order.
URL: POST /v1/status
Request Body Schema: application/json
Request Parameters:
Field Format Description
api_key String Mandatory License Key
order_sn String(16 characters) Mandatory Jedex unique order number
Response:
Field Format Description
status Integer Result code of response
msg String Error message
data Array Data payload of response
├ status Integer Order status
└ time String, E.g.: 2021-06-12T09:02:51+0000 Event time with format ISO8601

waybill

Get the express order waybill PDF.
URL: POST /v1/waybill
Request Body Schema: application/json
Request Parameters:
Field Format Description
api_key String Mandatory License Key
order_sn String(16 characters) Mandatory Jedex unique order number
Response:
Field Format Description
status Integer Result code of response
msg String Error message
data String PDF data as base64 encoded string

cancel

Cancel an order. Only new order could be canceled.
URL: POST /v1/cancel
Request Body Schema: application/json
Request Parameters:
Field Format Description
api_key String Mandatory License Key
order_sn String(16 characters) Mandatory Jedex unique order number
Response:
Field Format Description
status Integer Result code of response
msg String Error message

regions

Get supported region information.
URL: POST /v1/regions
Request Body Schema: application/json
Request Parameters:
Field Format Description
api_key String Mandatory License Key
Response:
Field Format Description
status Integer Result code of response
msg String Error message
data[] Array Data payload of response
├ id Integer Region ID
├ name_en String Region name in English
├ name_ar String Region name in Arabic
├ parent_id Integer Region's parent ID
└ type String Region type, country, province, city or district

Response Code

Code Description
1 Successful
-1 Failed
-100 Partner platform forbidden or license key is incorrect
-101 Package is overweight
-102 The areas are not supported or the distance is beyond the limitation

Order Status

Status Description
200 Submitted
210 Picking
220 Already picked up and delivering
230 Delivered
300 Cancelled