轻舟打单系统 - API文档
  1. 订单接口
轻舟打单系统 - API文档
  • 对接需知
  • 订单接口
    • 获取访问秘钥
      POST
    • 查询渠道
      POST
    • 费用试算
      POST
    • 创建订单
      POST
    • 取消订单
      POST
    • 查询订单
      POST
    • 打印标签
      POST
    • 推送标签
      POST
    • 查询轨迹
      POST
    • 查询基础资料
      POST
  1. 订单接口

查询订单

POST
http://prod-cn.your-api-server.com/api/getOrder
旧接口: /api/getTOrder

请求参数

Header 参数
Authorization
string 
必需
默认值:
Bearer eyJhbGciOiJIUzUxMiJ9.eyJkYXRlIjoxNzExMjg3NzUyNjE5LCJ0b2tlbiI6IjRlNTQzMDZhNDdhNGY3NGQ0YjZiN2VhOTlmNDZjMDhjIn0.q7cqP3xlSG1xY1WdTGO33u5z0fwpT3pxVeweX6EHgxnZCgtqWUpph6xZn6tt4KjYJoYOvFZ-1tDMbwXtEXDy1w
Body 参数application/json
orderData
object 
订单信息
必需
orderNo
string 
订单号
可选
与客户参考号二选一提交
customerNo
string 
客户参考号
可选
与订单号二选一提交
示例
{
    "orderData": {
        "orderNo": "ON2312241729000110",
        "customerNo": "customerNo001"
    }
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://prod-cn.your-api-server.com/api/getOrder' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orderData": {
        "orderNo": "ON2312241729000110",
        "customerNo": "customerNo001"
    }
}'

返回响应

🟢200成功
application/json
Body
code
integer 
状态编码
可选
参考对接需知状态码
message
string 
返回信息
可选
data
object 
可选
channel
string 
渠道编码
可选
通过系统基础数据接口查询值
customerNo
string 
客户参考号
可选
trackNo
string 
物流单号
可选
signature
string 
签名方式
可选
通过系统基础数据接口查询值
goodType
string 
货物类型
可选
通过系统基础数据接口查询值
declareType
string 
报关方式
可选
通过系统基础数据接口查询值
saleTerm
string 
销售条款
可选
通过系统基础数据接口查询值
exportReason
string 
出口原因
可选
通过系统基础数据接口查询值
insureType
string 
保险类型
可选
通过系统基础数据接口查询值
insureCost
string 
保险金额
可选
freightCost
string 
运费
可选
otherCost
string 
杂费
可选
productType
string 
物品类别
可选
通过系统基础数据接口查询值
taxPayType
string 
税金支付方式
可选
通过系统基础数据接口查询值
taxPayAccount
string 
税金支付账号
可选
freightPayType
string 
运费支付方式
可选
通过系统基础数据接口查询值
freightPayAccount
string 
运费支付账号
可选
orderNote
string 
内部备注
可选
labelMemo
string 
面单备注
可选
sender
object 
寄件人信息
可选
recipient
object 
收件人信息
可选
volumeList
array [object {7}] 
材积信息
可选
itemList
array [object {9}] 
物品申报信息
可选
status
string 
可选
draft:草稿;forecast:已预报;canceling:取消中;canceled:已取消;finish:已完结;
costList
object 
费用详情
必需
childNumberList
array[string]
子单号
必需
示例
{
    "code": 0,
    "message": "string",
    "data": {
        "channel": "string",
        "customerNo": "string",
        "trackNo": "string",
        "signature": "string",
        "goodType": "string",
        "declareType": "string",
        "saleTerm": "string",
        "exportReason": "string",
        "insureType": "string",
        "insureCost": "string",
        "freightCost": "string",
        "otherCost": "string",
        "productType": "string",
        "taxPayType": "string",
        "taxPayAccount": "string",
        "freightPayType": "string",
        "freightPayAccount": "string",
        "orderNote": "string",
        "labelMemo": "string",
        "sender": {
            "name": "string",
            "country": "string",
            "province": "string",
            "city": "string",
            "zipcode": "string",
            "tel": "string",
            "phone": "string",
            "company": "string",
            "address1": "string",
            "address2": "string"
        },
        "recipient": {
            "name": "string",
            "country": "string",
            "province": "string",
            "city": "string",
            "zipcode": "string",
            "company": "string",
            "tel": "string",
            "phone": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string"
        },
        "volumeList": [
            {
                "boxNo": "string",
                "boxLength": 0,
                "boxWidth": 0,
                "boxHeight": 0,
                "boxWeight": 0,
                "customerNo": "string",
                "boxPiece": 0
            }
        ],
        "itemList": [
            {
                "boxNo": "string",
                "sku": "string",
                "cnName": "string",
                "enName": "string",
                "customsCode": "string",
                "num": 0,
                "price": 0,
                "priceCurrency": "string",
                "weight": 0
            }
        ],
        "status": "string",
        "costList": {
            "costName": "string",
            "currency": "string",
            "cost": 0
        },
        "childNumberList": [
            "string"
        ]
    }
}
修改于 2025-05-07 05:51:00
上一页
取消订单
下一页
打印标签
Built with