API Overview

本文档为ZYL对外标准接口文档，描述ZYL与外部系统之间的数据交换

API Specifications

Serial API List Description RequestFrom Server Type ClientKey TestUrl ProductionUrl 备注
01 物流单轨迹跟踪 获取包裹物流轨迹节点 ZYL HTTP + Json http://xinzhtech.com/track/v1/front/getOrdersTrack
02 提交订单 表单下单提交订单接口 ZYL HTTP + Json http://xinzhtech.com/oms/v1/Order/orderByApi
03 获取面单 根据订单号获取订单的面单 ZYL HTTP http://xinzhtech.com/oms/v1/OrderLabel/findOrderLabelByCode/{orderCode}/{labelType}/{userId}

API Technical Details

Field Formats
Communication Protocols HTTP
Method Post

Authorization and HTTP header

Field Description eg.
Content-Type application/json;charset=UTF-8 application/json;charset=UTF-8
ApiKey Vendor’s api key key-1234-7B08-4E69-915E-65C191F96B6D
Authorization Md5Utils.sign(Request URI “|” + ApiKey + “|” + SecretKey) Md5Utils.sign(/openapi/v1/order/label/info|key-1234-7B08-4E69-915E-65C191F96B6D|1234E67D-7E07-4A14-93F7-E2A9EA38EB1D)
TimeStamp Timestamp with millisecond. 1503560233000

General API Request Requirements

Field Description Type Max Length
timestamp Timestamp with millisecond. Long
messageId Serial number for each requests. String 100.0
data{} Detailed business fields Object

Request Example

{
  "timestamp":1503560233000,
  "messageId":"20220220001",
  "data":{
  }
}

General API Response Requirements

Field Description Type Max Length
code Result status code.See definition Integer
message Detailed business fields String 200.0
messageId Serial number for each requests. String 100.0
timestamp Timestamp with millisecond. Long
data{} Detailed business fields Object
errors[] Error details List< Object >

Successful Response

{
  "code":0,
  "message":"success",
  "timestamp":1503560234000,
  "messageId":"20220220001",
  "data":{
  },
  "errors":[]
}

UnSuccessful Response

{
  "code":4,
  "message":"数据错误",
  "timestamp":1503560234000,
  "messageId":"20220220001",
  "errors":[{ 
      "code":4019999,
      "message":"{propertyName}不能为空"
   },
  { 
      "code":4019998,
      "message":"{propertyName}格式错误"
   }]
}
作者：ZYL  创建时间：2023-07-19 13:06
最后编辑：conghui  更新时间：2025-12-16 17:30