Académique Documents
Professionnel Documents
Culture Documents
version
Revision
numbe Reviser Revised contents
date
r
V1.0 JD 2017-11-20
Formal environment: ISV software on-line use environment, the entry of this
environment is consistent with the formal test environment, but after the
application on-line, traffic restrictions will be opened, the specific traffic related to
the application category, such as the application of service market category,
restrict API calls to 1 million times per day.
2 Common parameters and invocation
examples
signature algorithm
Sign is the signature value generated by the request string and the secret key
according to a certain signature method, which is used to prevent the parameters
from being tampered with in the transmission process. The specific signature
method is as follows:
Step 1 : Sort all request parameters according to ASCII code list of parameter
names.
Such as: Sort access_token,app_key,method,timestamp,v into
access_token,app_key,method,timestamp,v
Step 2: Splice all parameter names and values (no cross-lines are allowed during
splicing, no spaces are allowed in other places except in the middle of date and
time, and the order of parameters in param_json should be consistent with the
order of incoming data when requesting)
Such as:access_tokenxxxapp_keyxxxmethodxxxxxxtimestampxxxxxxvx
Step 3:Place appSecret at both ends of the string
Such as:appSecret+ access_tokenxxxapp_keyxxxmethodxxxxxxtimestampxxxxxxvx
+appSecret
Step 4: Encrypt with MD5, and convert summary results into capitals using
hexadecimal representation,Such as:
md5(appSecret+ access_tokenxxxapp_keyxxxmethodxxxxxxtimestampxxxxxxvx
+appSecret)
JAVA Signature Sample Code
1) Setting parameters
access_token=yourtoken
app_key=yourappkey
method=jd.order.search
timestamp=2017-04-20 11:10:04
v=2.0
param_json=["test"]
param_json=["test"]
timestamp=2017-04-20 11:10:04
v=2.0
4) Generate signature
Assume appsecret of app is yourappSecret,The signature result is:
hex(md5(yourappSecret + Parameter names and values spliced sequentially+
yourappSecret)) = “91DEBBFBAA3245A88445F99E55FC214D”
Parcels
Jingdong Logistics Platform receives the order information from the order system,
transforms the order into Jingdong waybill, and generates the internal waybill
number (ddl). Logistics service provider subscribes to the [package delivery]
message service, after receiving the message, calls the [pull the waybill] interface
to pull the waybill information and package information from JD. Logistics service
providers check the information received by the waybill, call the interface of
"waybill feedback" to inform whether the Beijing-East waybill has been
successfully received or not, if fail, to give the abnormal information. If the service
provider's Logistics Bill Number can be feedback immediately after receiving the
bill of lading(Tracking No is also called waybillNo), the service provider's Bill
Number trackingNo will also be returned to JD.
【message ID】
pushdown-channel
【Message trigger condition】
Jingdong receives the order information from the order system, converts the
order into an internal order, and triggers the push pushdown-channel message.
【Message structure】
Field name Meaning Type Whether Notes (examples)
(length) must
ddl Jingdong 64 Y
Waybill No.
orderSource Order 20 N Used to
source differentiate
different order
sources. For
example, JD.com,
joybuy.com, etc.
orderNumber Jingdong 80 N JD internal order
Order No. number in order
system
orderType Document int Y 0: Feedback by
type big package. 1:
Feedback by small
package. Default 0
orderCreateTime Create DateTime N
order time
【Example of message】
{
“ddl”: “57140102278”,
"orderSource":"JD.com",
"orderNumber":"57140102278",
"orderType":"0",
"orderCreateTime":"2018-03-15 11:20:32"
}
【SDK Download】
It is suggested that Logistics providers use the SDK provided by JDWL to receive
messages, SDK Download Link:
【API】
jingdong.isc.magellan.createOrder
【Sservice request parameters】
Field name Meaning Type Whether Notes (examples)
(length) must
ddl Jingdong 64 Y 57140102278
waybill
No.
user Service 20 Y
provider
registers
JDWL
account
【Request example】
{
“ddl”: “57140102278”,
“user”:”isvAccount”
}
【Response content】
Field name Meaning Type Whether Notes
(length) must (examples)
ddl Jingdong Waybill 64 M
No.
orderSource Waybill source 20 M 01-jd.com
02-
joybuy.com
03-JD.id
04-JD.th
05-其他
serviceCode Service Provider 20 M
Channel Number
serviceName Service Provider 100 M
Channel Name
serviceSubCode Channel sub- 20 O
option id
serviceSubName Channel 100 O
Suboption Name
incoterm Trade terms 10 O
customerAccount Customer 20 M
Number in Service
Provider System
of Jingdong
sellerAccount Businessmen'own 20 O
accounts
trackingNo Service Provider 40 O
Waybill No.
facility Consignor site 20 O/M
code
transInstruction Send instructions 255 O
ifDiscard If unable to 10 M Default is
deliver properly, yes
whether to
destroy
isCOD Whether cash on 10 M Y/N default
delivery is N
codValue The amount of double O/M If isCOD =
cash on delivery Y,this one is
must fill
currentCarrierCode Present Carrier 20 M
nextCarrierCode Downstream 20 O
Carrier
msgType Message type 4 M 01-Add 02-
Update 03-
Delete
bigBagParcelQty Number of small long O
packages under
large packages
parcel.parcelNumber Package number 64 M
parcel.weight Package weight double M
parcel.weightUnit Package weight 2 O
unit
parcel.volume Package volume double O/M
parcel.length Package length double O/M
parcel.width Package width double O/M
parcel.height Package height double O/M
parcel.dimensionUnit Length unit 3 O/M
parcel.declareValue Customs double M
declaration value
parcel.declareCurrency Currency of 3 M
Customs
Declaration Value
parcel.bigBagId Large package ID 64 O
parcel.hawbOrAwb Master bill 64 O
number/ Odd
number
receiver.name Odd number 50 M
receiver.cyrillicName Name of the 60 O
receiver's ID Card
receiver.taxId Receiver's Tax 20 O
Number
receiver.nationalNumber Receiver's ID 10 O
number
receiver.nationalIssueDate Date of issuance date O
of receiver's
identity card
receiver.passportNumber Passport No. 64
receiver.passportIssueDate Date of issuance date
of passport
receiver.postcode Receiver's 16 O
postcode
receiver.phone Receiver's phone 20 O
receiver.mobile Receiver's mobile 20 M
receiver.email Receiver's email 50 O
receiver.country Receiver's country 10 M
receiver.province Receiver's 10 M
province/state
receiver.city Receiver's city 10 M
receiver.district Receiver's district 10 O
receiver.street1 Receiver's street1 100 M
receiver.street2 Receiver's street2 100 O
receiver.street3 Receiver's street3 100 O
receiver.company Receiver's 100 O
company
sender.name Sender's name 50 O
sender.postcode Sender's postcode 16 O
sender.phone Sender's phone 20 O
sender.mobile Sender's mobile 20 O
sender.email Sender's email 50 O
sender.country Sender's country 10 O
sender.province Sender's 10 O
province/state
sender.city Sender's city 10 O
sender.district Sender's district 10 O
sender.street1 Sender's street1 100 O
sender.street2 Sender's street2 100 O
sender.street3 Sender's street3 100 O
sender.company Sender's company 100 O
collect.name Collect's name 50 O
collect.postcode Collect's postcode 16 O
collect.phone Collect's phone 20 O
collect.mobile Collect's mobile 20 O
collect.email Collect's email 50 O
collect.country Collect's country 10 O
collect.province Collect's province 10 O
collect.city Collect's city 10 O
collect.district Collect's district 10 O
collect.street1 Collect's street1 100 O
collect.street2 Collect's street2 100 O
collect.street3 Collect's street3 100 O
collect.company Collect's company 100 O
retreat.name Retreat's name 50 O
retreat.postcode Retreat's 16 O
postcode
retreat.phone Retreat's phone 20 O
retreat.mobile Retreat's mobile 20 O
retreat.email Retreat's email 50 O
retreat.country Retreat's country 10 O
retreat.province Retreat's province 10 O
retreat.city Retreat's city 10 O
retreat.district Retreat's district 10 O
retreat.street1 Retreat's street1 100 O
retreat.street2 Retreat's street2 100 O
retreat.street3 Retreat's street3 100 O
retreat.company Retreat's 100 O
company
goodsList.goodsDto.itemNo Item number 20 O/M
goodsList.goodsDto.sku Items SKU 30 O/M
number
goodsList.goodsDto.htsCode HS CODE 64 O/M
goodsList.goodsDto.description Goods description 50 O/M
goodsList.goodsDto.chnDescription Chinese 50 O/M
Description of
Goods
goodsList.goodsDto.cnName Chinese Name of 50 O/M
goods
goodsList.goodsDto.enName English Name of 50 O/M
goods
goodsList.goodsDto.count Quantity of goods int O/M
goodsList.goodsDto.weight Unit weight of double O/M
goods
goodsList.goodsDto.weightUnit Unit of weight for 3 O/M
goods
goodsList.goodsDto.declareValue Customs double O/M
clearance price
goodsList.goodsDto.declareCurrency The currency of 3 O/M
customs clearance
price
goodsList.goodsDto.origin Origin of goods 50 O/M
goodsList.goodsDto.batteryType Type of charge 4 M 0-
Commodity
non-live
(default) 1-
live 2-pure
electricity
goodsList.goodsDto.ifHazmat Whether 4 M
dangerous goods
goodsList.goodsDto.ifFluid Whether liquid 4 M
goodsList.goodsDto.isCellphone Whether Mobile 4 M
Phone Products
goodsList.goodsDto.imei Mobile IMEI 32 O
number
goodsList.goodsDto.warehouseNo The number of 32 O
outgoing
warehouse
goodsList.goodsDto.platform The electronic 64 O
business platform
where purchasing
goodsList.goodsDto.url Purchase link 100 O/M
【API】
jingdong.isc.magellan.orderStatus
【Business Request Parameters】
Field name Meaning Type Whether Notes (examples)
(length) must
ddl Jingdong 64 Y
waybill No.
user Service 20 Y
provider
registers JDWL
account
validation Verification int Y 0 Failure 1
result Success
type Distinguishing int Y 0: Feedback by
big packet big package. 1:
feedback from Feedback by small
ssmall packet package. Default
feedback 0
trackingNo Waybill No. 40 N
message Supplementary 255 N
information
【Example of request】
{
“ddl”: “57140102278”,
“user”:”isvAccount”
“validation”: “0”,
“type”:”0”,
“trackingNo”: “”,
“message”: ” Postal Codes Can't Be Empty”
}
【Response's content】
Field name Meaning Type Whether Notes (examples)
(length) must
status status 10 Y SUCCESS
exception Abnormal 255 N
informatio
n
【message ID】
batch-pushdown-channel
【Triggering message’s condition】
Jingdong receives the order information from the order system and converts the
order into an internal transport order in Jingdong ,and trigger batch-pushdown-
channel message.
【Example of message】
{
“ddlList”:“{[57140102278, 57140102279, 57140102280, 57140102281,
57140102282]}”,
"orderSource":"JD.com",
"orderNumberList":{[57140102278, 57140102279, 57140102280, 57140102281,
57140102282]},
"orderType":"sales order",
"orderCreateTime":"2018-03-15 11:20:32"
}
【Download of SDK】
It is suggested that Logistics providers use the SDK provided by JDWL to receive
messages, SDK Download Link:
【API】
jingdong.isc.magellan.createOrders
【The Parameters of Service Request】
Field name Meaning Type Whether Notes (examples)
(length) must
ddlList Jingdong 80 Y Separation of
waybill multiple numbers
number by English commas
(multiple)
user Service 20 Y
provider
registers
JDWL
account
【Example of Request】
{
“ddlList”: {[57140102278, 57140102279, 57140102280, 57140102281,
57140102282]},
“user”:”isvAccount”
}
【Content of Response】
Message format is the same as Content of Response,which in 3.1.3.The
outermost layer returns list. See the example for details.
【Example of Response】
{
"dataList": [
{
"ddl": "J0320180529000000001",
"orderSource": "02",
"serviceCode": "UBI.CN2AU.AUPOST",
"serviceName": "China-Australia STI",
"serviceSubCode": "Non-Tracking",
"serviceSubName": "",
"incoterm": "",
"customerAccount": "8700843423",
"sellerAccount": "abs132114339",
"trackingNo": "ABC123456789001",
"facility": "230031",
"transInstruction": "keep up",
"ifDiscard": "Y",
"isCOD":"Y",
"codValue": "18.32",
"currentCarrierCode": "CEVA",
"nextCarrierCode": "CEVA",
"msgType": "01",
"parcel": {
"parcelNumber": "57291195170-1-1",
"weight": "20.9",
"weightUnit": "kg",
"volume": "30",
"length": "10",
"width": "10",
"height": "10",
"dimensionUnit": "cm",
"declareValue": "18.32",
"declareCurrency": "USD",
"bigBagId":"3242231",
"hawbOrAwb": "sde223e1"
},
"receiver": {
"name": "Tom.k",
"cyrillicName":"Bob",
"taxId": "10003535248989",
"nationalNumber": "110103199129923232",
"nationalIssueDate": "1993-02-02",
"passportNumber": "CN11010319880505714124",
"passportIssueDate": "1995-08-02",
"postcode": "10005",
"phone": "1111111",
"mobile": "212-222-0111",
"email": "bin@team.com",
"country": "UNITED STATES OF AMERICA",
"province": "LA",
"city": "San Francisco",
"district": "St.",
"street1": "200 Bumborah Point Rd",
"street2": "St. Peters",
"street3": "Lotus Street",
"company": "apple corperation"
},
"sender": {
"name": "Wang Lin",
"postcode": "100055",
"phone": "2131231",
"mobile": "1123333333313",
"email": "wanglin@team.com",
"country": "CN",
"province": "441402",
"city": "beijing",
"district": "dongcheng",
"street1": "qianmen street",
"street2": "qiananmen street",
"street3": "",
"company": "Teamsun"
},
"collect": {
"name": "zhang min",
"postcode": "100055",
"phone": "2131231",
"mobile": "1123333333313",
"email": "zhangmin@team.com",
"country": "CN",
"province": "441402",
"city": "beijing",
"district": "dongcheng",
"street1": " No. 6 Lianhuachi East Road",
"street2": "",
"street3": "",
"company": ""
},
"retreat": {
"name": "huohuo",
"postcode": "100055",
"phone": "2131231",
"mobile": "1123333333313",
"email": "huohuo@team.com",
"country": "US",
"province": "441402",
"city": "new york",
"district": "",
"street1": "",
"street2": "",
"street3": "",
"company": ""
},
"goodsList": {
"goodsDto": [
{
"itemNo": "00001",
"sku": "6474114",
"htsCode":"88000000",
"description": "PHONE",
"nativeDescription":" Mobile phone (must contain local characters) ",
"cnName": " IPhone",
"enName": "iPhone",
"count": "1",
"weight": "0.1",
"weightUnit": "kg",
"declareValue": "400",
"declareCurrency": "USD",
"origin": "CN",
"batteryType": "1",
"ifHazmat": "N",
"ifFluid": "N",
"isCellphone":"Y",
"imei":"322A342432B32",
"warehouseNo": "",
"platform": "www.jd.com",
"url": "https://item.jd.com/?cateId=12260&itemId=1130389"
},
{
"itemNo": "00002",
"sku": "6474120",
"htsCode":"88000001",
"description": "TOY",
"nativeDescription":" Toys (must contain local characters) ",
"cnName": " LEGO ",
"enName": "lego architecture",
"count": "2",
"weight": "0.4",
"weightUnit": "kg",
"declareValue": "200",
"declareCurrency": "USD",
"origin": "US",
"batteryType": "0",
"ifHazmat": "N",
"ifFluid": "N",
"isCellphone":"N",
"imei":"",
"warehouseNo": "",
"platform": "www.jd.com",
"url": "https://item.jd.com/?cateId=12260&itemId=1130129"
}
]
}
},
{
"ddl": "J0320180529000000002",
"orderSource": "02",
"serviceCode": "UBI.CN2AU.AUPOST",
"serviceName": "China-Australia STI",
"serviceSubCode": "Non-Tracking",
"serviceSubName": "",
"incoterm": "",
"customerAccount": "8700843423",
"sellerAccount": "abs132114339",
"trackingNo": "ABC123456789001",
"facility": "230031",
"transInstruction": "keep up",
"ifDiscard": "Y",
"isCOD":"Y",
"codValue": "18.32",
"currentCarrierCode": "CEVA",
"nextCarrierCode": "CEVA",
"msgType": "01",
"parcel": {
"parcelNumber": "57291195170-1-1",
"weight": "20.9",
"weightUnit": "kg",
"volume": "30",
"length": "10",
"width": "10",
"height": "10",
"dimensionUnit": "cm",
"declareValue": "18.32",
"declareCurrency": "USD",
"bigBagId":"3242231",
"hawbOrAwb": "sde223e1"
},
"receiver": {
"name": "Tom.k",
"cyrillicName":"Bob",
"taxId": "10003535248989",
"nationalNumber": "110103199129923232",
"nationalIssueDate": "1993-02-02",
"passportNumber": "CN11010319880505714124",
"passportIssueDate": "1995-08-02",
"postcode": "10005",
"phone": "1111111",
"mobile": "212-222-0111",
"email": "bin@team.com",
"country": "UNITED STATES OF AMERICA",
"province": "LA",
"city": "San Francisco",
"district": "St.",
"street1": "200 Bumborah Point Rd",
"street2": "St. Peters",
"street3": "Lotus Street",
"company": "apple corperation"
},
"sender": {
"name": "Wang Lin",
"postcode": "100055",
"phone": "2131231",
"mobile": "1123333333313",
"email": "wanglin@team.com",
"country": "CN",
"province": "441402",
"city": "beijing",
"district": "dongcheng",
"street1": "qianmen street",
"street2": "qiananmen street",
"street3": "",
"company": "Teamsun"
},
"collect": {
"name": "zhang min",
"postcode": "100055",
"phone": "2131231",
"mobile": "1123333333313",
"email": "zhangmin@team.com",
"country": "CN",
"province": "441402",
"city": "beijing",
"district": "dongcheng",
"street1": " No. 6 Lianhuachi East Road",
"street2": "",
"street3": "",
"company": ""
},
"retreat": {
"name": "huohuo",
"postcode": "100055",
"phone": "2131231",
"mobile": "1123333333313",
"email": "huohuo@team.com",
"country": "US",
"province": "441402",
"city": "new york",
"district": "",
"street1": "",
"street2": "",
"street3": "",
"company": ""
},
"goodsList": {
"goodsDto": [
{
"itemNo": "00001",
"sku": "6474114",
"htsCode":"88000000",
"description": "PHONE",
"nativeDescription":" Mobile phone (must contain local characters)",
"cnName": "IPhone",
"enName": "iPhone",
"count": "1",
"weight": "0.1",
"weightUnit": "kg",
"declareValue": "400",
"declareCurrency": "USD",
"origin": "CN",
"batteryType": "1",
"ifHazmat": "N",
"ifFluid": "N",
"isCellphone":"Y",
"imei":"322A342432B32",
"warehouseNo": "",
"platform": "www.jd.com",
"url": "https://item.jd.com/?cateId=12260&itemId=1130389"
},
{
"itemNo": "00002",
"sku": "6474120",
"htsCode":"88000001",
"description": "TOY",
"nativeDescription":" Toys (must contain local characters)",
"cnName": " LEGO",
"enName": "lego architecture",
"count": "2",
"weight": "0.4",
"weightUnit": "kg",
"declareValue": "200",
"declareCurrency": "USD",
"origin": "US",
"batteryType": "0",
"ifHazmat": "N",
"ifFluid": "N",
"isCellphone":"N",
"imei":"",
"warehouseNo": "",
"platform": "www.jd.com",
"url": "https://item.jd.com/?cateId=12260&itemId=1130129"
}
]
}
}],
"message":" Success",
"success":true
}
【API】
jingdong.isc.magellan.orderListStatus
【The Parameters of Service Request】
Field name Meaning Type Whether Notes (examples)
(length) must
ddl Jingdong 64 Y
waybill No.
user Service 20 Y
provider
registers JDWL
account
validation Verify Result int Y 0 Failure 1
Success
type Distinguishing int Y 0: Feedback by
Big Packet’s big package. 1:
Feedback from Feedback by small
Small package. Default
Packet’s 0
Feedback
trackingNo Waybill No. 40 N
message Supplementary 255 N
information
【Example of Request】
{
[{
“ddl”: “57140102278”,
“user”:”isvAccount”
“validation”: “0”,
“type”:”0”,
“trackingNo”: “”,
“message”: ” postcodes can't be empty”
},{
“ddl”: “57140102279”,
“user”:”isvAccount”
“validation”: “0”,
“type”:”0”,
“trackingNo”: “”,
“message”: ” The name of the addressee shall not be less than two
characters”
}]
}
【Message ID】
batch-cancel-channel
【Example of message】
{
[{
“ddl”: “57140102278”,
“reason”: ” User cancelled”
},{
“ddl”: “57140102279”,
“reason”: ” Error in order information entry”
}]
}
【SDK Download】
It is suggested that logistics business use the SDK provided by JDWL to receive
messages and download links for SDK:
Logistics service providers receive JD's waybill information, if they can't return to
the service providers' waybill number immediately, then after confirming the
waybill number, in subsequent links (e.g. after receiving and weighing), they call
the interface of "feedback waybill number" to feedback the service providers'
waybill number to JD.
3.4.2 Invoking the API of [Batch Bill Feedback]
【API】
jingdong.isc.magellan.createTrackingNumber
【The Parameters of Service Request】
Field name Meaning Type Whether Notes (examples)
(length) must
ddl Jingdong 64 Y
waybill
No.
trackingNo Service 40 Y
Provider
Transport
Bill No.
user Service 20 Y
provider
registers
JDWL
account
【Example of Request】
{
“ddl”: “57140102278”,
“trackingNo”: “ABC213345454”,
“user”:”isvAccount”
}
【Content of Response】
Field name Meaning Type Whether Notes (examples)
(length) must
status state 10 Y SUCCESS
exception abnormal 255 N
informatio
n
【Message ID】
jd_ept_print_label
【Conditions for message triggering】
JD EC warehouse operator clicks the "Download Form" button to trigger the
jd_ept_print_label message.
【Message structure】
Field name Meaning Type Whether Notes (examples)
(length) must
trackingNo waybill 40 Y
No.
pageSize express int Y
sheet size
fileType file type 5 Y
【Message sample】
{
"trackingNo":"ABF139199231312",
"pageSize":"1 ",
"fileType":"PDF"
}
【SDK Download】
It is suggested that logistics business use the SDK provided by JDWL to receive
messages and download links for SDK:
【Example of Request】
{
“ddl”:”56567832123,
“trackingNo”: “ABC213345454”,
“user”:”isvAccount”,
“resource”:
“iVBORw0KGgoAAAANSUhEUgAAAkAAAAMTCAIAAADGlT+MAAAAAXNSR0I
Ars4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAA
P+lSURBVHhe7H0FYFzH0f97x6hDMTMzWRaZ2THHiR1qkjZUSJu0X/lLv6T9p03
SJg0zGmNmW2wxMzNLp7vTMd+7/5zOdhxbtmVLsiXrbV3nfLdv3+xvZnd2Z2d
nUIvFguAFRwBHAEcARwBHYL4hQJhvBOP04gjgCOAI4AjgCFgRwBUYLgc4AjgC
OAI4AvMSAfR6E2JfX19+fj6NRpuXHcKJxhHAEcARwBGYMwjo9XpPT8/k5OTZo
GgSBVZWVlZTUxMcHGw0GmfjlXibOAI4AjgCOAILAQEURcfHx3U63a5du2ajv5
MosMrKyo6OjrCwMIPBMBuvxNvEEcARwBHAEVgICBAIBFBgEolk27Zts9HfyRVY
e3t7aGgorsBmA3G8TRwBHAEcgQWCgE2BQZklBYY7cSw “,
“type”:”pdf”
}
【Content of Response】
Field name Meaning Type Whether Notes (examples)
(length) must
status state 10 Y SUCCESS
exception abnormal 255 N
information
Logistics service providers collect parcels and carry out warehousing and
weighing. Invoking [Weight Fee] interface to feed back the package weighing
information to JD.
【API】
jingdong.isc.magellan.weigh
【The Parameters of Service Request】
Field name Meaning Type Whether Notes (examples)
(length) must
ddl Jingdong 64 Y/N This must be filled
waybill No. in when type = 1
user Service 20 Y
provider
registers
JDWL
account
type the int Y 0: Feedback by big
dimension package. 1:
of Feedback by small
feedback package. Default 0
trackingNo Service 40 Y
Provider’
s waybill
No.
bigBagId Large 40 Y/N This must be filled
package’ in when type = 0
s number
weight Weight double Y
weightUnit Unit of 3 Y
weight
length length double Y/N This is not required
when type = 0
width width double Y/N This is not required
when type = 0
height height double Y/N This is not required
when type = 0
dimensionUnit Unit of 3 Y/N This is not required
length when type = 0
amount Freight double N
currency Currency 3 N/Y If amount is not
empty, then current
must be filled in
【Example of Request】
{
“ddl”: “SO4235231111”,
“user”:”isvAccount”,
“type”: “1”,
“trackingNo”: “ABC213345454”,
“bigBagId” : “”,
“weight”: “8.67”,
“weightUnit”: “kg”,
“length”: “12.00”,
“width”: “20.21”,
“height”: “8.09”,
“dimensionUnit”: “cm”,
“amount”: “”,
“currency”: “”
}
【Content of Response】
Field name Meaning Type Whether Notes (examples)
(length) must
status state 10 Y SUCCESS
exception abnormal 255 N
informatio
n
3.7Waybill’s Tracking
When the logistics service provider receives the update status of the
package , invoking the [Waybill Tracking] Interface , Feedback to JD for
package’s tracking information。
【API】
jingdong.isc.magellan.tracking
【The Parameters of Service Request】
Field name Meaning Type Whether Notes (examples)
(length) must
ddl Jingdong 64 Y/N This item must
waybill No. be filled in when
type = 1
user Service 20 Y
provider
registers JDWL
account
type The dimension int Y 0: Feedback by
of feedback big package. 1:
Feedback by
small package.
Default 0
trackingNo Service 40 Y
Provider’s
waybill No.
exchangeNo Transfer of 40 N
application
forms no.
eventCode Event code 5 Y
eventDescription Event 255 N
description
eventTime Event time 19 Y yyyy-MM-dd HH:
mm:ss
eventTimeZone Time zone of 10 Y
event
occurrence
destCountry Country of 3 N
destination
reasonCode Special Cause 3 N
Code
bigBagId Large 40 Y/N This must be
package’s filled in when
number type = 0
flightNum Flight number 40 N
vesselNum Ship number 40 N
containerNum Container 40 N
number
hawbOrMawb Odd 40 N
number/Maste
r bill number
【Example of Request】
{
“ddl”:”565678743”,
“user”:”isvAccount”,
“type”: “1”,
“trackingNo”: “ABC213345454”,
“exchangeNo”: “”,
“eventCode”: “DP”,
“eventDescription”: “departure from origin port”,
“eventTime”: “2018-03-22 14:33:20”,
“eventTimeZone”: “UTC+8”,
“destCountry”: “CN”,
“reasonCode”: “”,
“bigBagId”: “”,
“flightNum”: “CA7321”,
“vesselNum”: “BYd1213”,
“containerNum”: “hd321432152”,
“hawbOrMawb”: “31312”
}
【Content of Response】
Field name Meaning Type Whether Notes (examples)
(length) must
status state 10 Y SUCCESS
exception abnormal 255 N
informatio
n
Receiving carrier subscribes [Receiving Task Delivery] message service, Once the
export channels of Jingdong have been allocated to receiving carrier, this
subscription message will be posted , then the receiving carrier will invoke
[Receive Collecting Tasks] to receive the collecting tasks ,and return the result of
receiving task to Jingdong through [receiving task feedback].
【Message ID】
collect_task_channel
【Conditions for message triggering】
Jingdong receives the order information from the order system. When the channel
has the first kilometer to collect, it sends this message.
【Message structure】
Field name Meaning Type Whether Notes (examples)
(length) must
ddl Jingdong 64 Y
waybill
No.
orderCreateTime Order DateTime N
creatie
time
【Example of message】
【SDK Download】
It is suggested that logistics business receive messages use the SDK provided by
JDWL and download links for SDK:
【API】
jingdong.isc.magellan.createCollectTask
【The Parameters of Service Request】
Field name Meaning Type Whether Notes (examples)
(length) must
ddl Jingdong 64 Y
waybill
No.
user Service 20 Y
provider
registers
JDWL
account
【Example of Request】
{
“ddl”: “57140102278”,
“user”:”isvAccount”
}
【Content of Response】
Field Mus Remarks
t
inpu
t
Message type Y Create/Cancel
Magellan waybill Y
number
Business Parcel Y JD.th POP Order , Merchant package number= Thailand
Number Qinglong order no.;
JD.id POP Order, Merchant package number = Indonesia
Qinglong order no.;
Whether with Y If this channel can only take ordinary goods, then in this
electric channels field to send ‘N’ to the carrier, others cases send ’Y’.
Package weight N
Unit of package N
weight
Receiving channel Y
coding
Name of sender N Before the POP transformation, the sender's address
company information was taken from the address in Magellanic
Shop ID Y merchant's master data, allowing Chinese addresses.
Sender’s name Y
Sender’s Y
telephone
Sender’s country Y
Sender’s province Y
Sender’s city Y
Sender’s area N
Sender’s street Y
Sender’s Y
postcodes
Warehouse Y Within the system, a receiving address is maintained for
number each EC distribution center, allowing Chinese input.
Recipient’s name Y
Recipient’s Y
telephone
Recipient’s Y
country
Recipient’s Y
province
Recipient’s city Y
Recipient’s area N
Recipient’s street Y
Recipient’s Y
postcode
【Response example】
【API】
jingdong.isc.magellan.orderListStatus
【The Parameters of Service Request】
Field name Meaning Type Whether Notes (examples)
(length) must
ddl Jingdong 64 Y
waybill No.
user Service 20 Y
provider
registers JDWL
account
validation Verification int Y 0 Failure 1
result Success
message Supplementary 255 N
information
【Example of Request】
【Content of Response】
Field name Meaning Type Whether Notes (examples)
(length) must
status state 10 Y SUCCESS
exception abnormal 255 N
informatio
n
When the logistics service provider receives the update status of the
package , invoking the [Waybill Tracking] Interface , Feedback to JD for
package’s tracking information。
【API】
jingdong.isc.magellan.tracking
【The Parameters of Service Request】
Field name Meaning Type Whether Notes (examples)
(length) must
ddl Jingdong 64 Y
waybill No.
user Service 20 Y
provider
registers
JDWL
account
eventCode Event code 5 Y
eventDescription Event 255 N
descriptio
n
eventTime Time of 19 Y yyyy-MM-dd HH:m
Incident m:ss
eventTimeZone Time zone 10 Y example UTC+08
of event
occurrence
reasonCode Special 3 N
Cause
Code
【Example of Request】
【Content of Response】
Field name Meaning Type Whether Notes (examples)
(length) must
status state 10 Y SUCCESS
exception abnormal 255 N
informatio
n
Logistics service providers collect parcels and carry out warehousing and
weighing. Invoking the [Weighting charges] interface to feed back the package
weighing information to JD.
【API】
jingdong.isc.magellan.weigh
【The Parameters of Service Request】
Field Mus Remarks
t
Inpu
t
Shipment batch Y ZY+ warehouse number
number (Header) + yyyyMMdd + 000 + 5-bit serial number
The batch number will not be repeated
To EC Warehouse Y warehouse number
(Header)
Delivery big Y [][YW-JD][DATE][][0000]
package’s
number (Item)
Delivery big Y YW weight, KG, keep three decimal points,
package’s gross accurate to 1g
weight (Item)
Unit of Y KG
weight(Item)
Magellan waybill Y
number(Sub Item)
Merchant package Y JD.th POP Order , Merchant package
number(Sub Item) number= Thailand Qinglong order no.;
JD.id POP Order, Merchant package number
= Indonesia Qinglong order no.;
Small packet Y YW weight YW must transmit,keep three
weight (Sub Item) decimal points, accurate to 1g
Unit of small Y KG
packet weight
(Sub Item)
【Example of Request】
【Content of Response】
Field name Meaning Type Whether Notes (examples)
(length) must
status state 10 Y SUCCESS
exception abnormal 255 N
informatio
n