物流信息

物流上传接口

post

物流上传接口

Required scopes

This endpoint requires the following scopes:

Authorizations

Authorization

AuthorizationstringRequired

Query parameters

gatewayNointeger(8)Optional

网关号（当参数'tradeNo'为空时，'gatewayNo'和'orderNo'是必需的）；固定长度8位，如：10001001

lcCodestring(50)Optional

物流运输商代码；最大长度为50，如：TWTH

merNointeger(5)Optional

商户号；固定长度5位，如：10001

orderNostring(64)Optional

商户订单号（当参数'tradeNo'为空时，'gatewayNo'和'orderNo'是必需的）；最小长度为1，最大长度为64，如：12167001000000000001

trackingNostring(50)Optional

物流单号；最小长度为2，最大长度为50，如：1223212312

trackingWebstring(200)Required

物流网址；最小长度为2，最大长度为200，如：https://abc.com

tradeNostring(64)Optional

流水订单号（当'gatewayNo'或'orderNo'为空，则'tradeNo'必填）；最小长度为1，最大长度为64，如：2021092810011380477264

Header parameters

authorizationanyRequired

ACCESS_TOKEN，格式：Bearer ACCESS_TOKEN

request-idstring(20)Required

请求id，最小长度为1，最大长度为20，30分钟之内唯一

request-timestring(19)Required

请求时间，时间格式为 yyyy-MM-dd'T'HH:mm:ss ，请求误差不能超过30分钟

Responses

200

OK

*/*response body

post

/openApi/logistics

HTTPcURLJavaScriptPython

POST /openApi/logistics?trackingWeb=null HTTP/1.1
Host: {openApiUrl}
Authorization: YOUR_API_KEY
authorization: null
request-id: null
request-time: null
Accept: */*

200

OK

{
  "data": {
    "resultCode": "0000",
    "resultMessage": "SUCCESS",
    "tradeNo": 2.0210928100113805e+21
  },
  "result": {
    "code": "text",
    "message": "text"
  }
}

物流上传接口请求报文示例

uploadLogistics.sh

curl --request POST \
  --url https://{openApiUrl}/openApi/logistics \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'request-id: 58675' \
  --header 'request-time: 2022-05-21T23:59:59' \
  --header 'authorization:Bearer 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822' \
  --data 'merNo=12345&gatewayNo=12345001&tradeNo=2022042617331600244628&orderNo=20220426173311&trackingNo=7442543666&trackingWeb=www.yimei.com&lcCode=aCommerce'

物流上传接口

post

物流上传接口

Required scopes

This endpoint requires the following scopes:

Authorizations

Authorization

AuthorizationstringRequired

Query parameters

gatewayNointeger(8)Optional

网关号（当参数'tradeNo'为空时，'gatewayNo'和'orderNo'是必需的）；固定长度8位，如：10001001

lcCodestring(50)Optional

物流运输商代码；最大长度为50，如：TWTH

merNointeger(5)Optional

商户号；固定长度5位，如：10001

orderNostring(64)Optional

商户订单号（当参数'tradeNo'为空时，'gatewayNo'和'orderNo'是必需的）；最小长度为1，最大长度为64，如：12167001000000000001

trackingNostring(50)Optional

物流单号；最小长度为2，最大长度为50，如：1223212312

trackingWebstring(200)Required

物流网址；最小长度为2，最大长度为200，如：https://abc.com

tradeNostring(64)Optional

流水订单号（当'gatewayNo'或'orderNo'为空，则'tradeNo'必填）；最小长度为1，最大长度为64，如：2021092810011380477264

Header parameters

authorizationanyRequired

ACCESS_TOKEN，格式：Bearer ACCESS_TOKEN

request-idstring(20)Required

请求id，最小长度为1，最大长度为20，30分钟之内唯一

request-timestring(19)Required

请求时间，时间格式为 yyyy-MM-dd'T'HH:mm:ss ，请求误差不能超过30分钟

Responses

200

OK

*/*response body

post

/openApi/logistics

HTTPcURLJavaScriptPython

POST /openApi/logistics?trackingWeb=null HTTP/1.1
Host: {openApiUrl}
Authorization: YOUR_API_KEY
authorization: null
request-id: null
request-time: null
Accept: */*

200

OK

{
  "data": {
    "resultCode": "0000",
    "resultMessage": "SUCCESS",
    "tradeNo": 2.0210928100113805e+21
  },
  "result": {
    "code": "text",
    "message": "text"
  }
}

物流信息查询请求报文示例

logistics.sh

curl --request GET\
  --url https://{openApiUrl}/openApi/logistics/2022051618185700208077 \
  --header 'request-id: 58675' \
  --header 'request-time: 2022-05-21T23:59:59' \
  --header 'authorization:Bearer 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822' \

结果对象属性描述

property name	type	description
result	Object	请求响应对象
code	String	响应码
message	String	响应信息
data	Object	数据体
tradeNo	String	交易流水号
status	String	上传结果状态码
description	String	上传结果信息描述

物流信息查询

get

Required scopes

This endpoint requires the following scopes:

Authorizations

Authorization

AuthorizationstringRequired

Path parameters

tradeNosstring(2500)Required

交易流水号（多笔时以逗号 , 分割）;最小长度为1，最大长度为2500，如：2021050715591893808753,2021050715591893808723

Header parameters

authorizationanyRequired

ACCESS_TOKEN，格式：Bearer ACCESS_TOKEN

request-idstring(20)Required

请求id，最小长度为1，最大长度为20，30分钟之内唯一

request-timestring(19)Required

请求时间，时间格式为 yyyy-MM-dd'T'HH:mm:ss ，请求误差不能超过30分钟

Responses

200

OK

*/*response body

get

/openApi/logistics/{tradeNos}

HTTPcURLJavaScriptPython

GET /openApi/logistics/{tradeNos} HTTP/1.1
Host: {openApiUrl}
Authorization: YOUR_API_KEY
authorization: null
request-id: null
request-time: null
Accept: */*

200

OK

{
  "data": [
    {
      "gatewayNo": 1,
      "logisticsStatus": "text",
      "merNo": 1,
      "orderNo": "text",
      "tbLcCode": "text",
      "trackingNo": "text",
      "trackingWeb": "text",
      "tradeNo": "text"
    }
  ],
  "result": {
    "code": "text",
    "message": "text"
  }
}

结果对象属性描述

property name	type	description
result	Object	请求响应对象
code	String	响应码
message	String	响应信息
data	Object	数据体
merNo	Integer	商户号
gatewayNo	Integer	网关号
logisticsStatus	String	物流状态，Pending待查询、NotFound 查询不到 、InfoReceived 预报发货 、InTransit 运输途中 、ArrivedDelivery 到达待取 、Delivering 派送途中、Delivered 成功派送、Exception 包裹异常、DeliveryFailure 投递失败、Return 包裹退回
tbLcCode	String	物流运输商编号
trackingNo	String	物流单号
trackingWeb	String	物流网址
tradeNo	String	交易流水号