一、获取接口调用凭证
请求地址: https://oapi.668tms.com/gettoken
请求方法: GET
请求体与返回数据格式：JSON
Query参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| appkey | String | 是 | Z2307wieyiEWiwlo3 | 分配给第三方系统调用本系统的账号。 |
| appsecret | String | 是 | Rhifeh-weh2-hel9k | 密钥，客户方须谨慎保管，否则发生接口恶意调用与本系统无关。 |
返回参数
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| access_token | String | lifhio23hiafel3xxxx | 生成的access_token。 |
| expires_in | Number | 7200 | access_token的过期时间，单位秒。 |
| errmsg | String | ok | 返回码描述。 |
| errcode | Number | 0 | 返回码。 |
二、导入订单
请求地址: https://oapi.668tms.com/itms/order/create?access_token=ACCESS_TOKEN
请求方法: POST
请求体与返回数据格式：JSON
Query参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | AwExxxx | 调用获取接口调用凭证接口获得 |
Body参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| order_no | String | 是 | D220827398201 | 订单号 |
| e_order_no | String | 是 | A232028203823 | 电商系统订单号 |
| transport_mode | String | 是 | 海运 | 运输方式 |
| amount | Number | 是 | 720.55 | 订单金额 |
| amount_currency | String | 是 | CNY | 订单金额币种 |
| weight | Number | 是 | 110.87 | 订单重量 |
| weight_unit | String | 是 | kg | 订单重量单位 |
| transport_fee | Number | 是 | 2000 | 运费 |
| transport_fee_currency | String | 是 | CNY | 运费币种 |
| consigner_name | String | 是 | 张三 | 发件人姓名 |
| consigner_country | String | 是 | 中国 | 发件人国家 |
| consigner_province | String | 是 | 广东省 | 发件人省份或州 |
| consigner_city | String | 是 | 深圳市 | 发件人城市 |
| consigner_street | String | 是 | 福田保税区市花路5号 | 发件人街道 |
| consigner_mobile | String | 是 | 8613208278738 | 发件人联系电话或手机号 |
| consigner_zip | String | 否 | 518000 | 发件人邮政编码 |
| consignee_name | String | 是 | 李四 | 收件人姓名 |
| consignee_country | String | 是 | 泰国 | 收件人国家 |
| consignee_province | String | 是 | XXX | 收件人省份或州 |
| consignee_city | String | 是 | XXX | 收件人城市 |
| consignee_street | String | 是 | XXX | 收件人街道 |
| consignee_mobile | String | 是 | XXX | 收件人联系电话或手机号 |
| consignee_zip | String | 否 | XXX | 收件人邮政编码 |
| product_list | []ProductInfo | 是 | XXX | 收件人邮政编码 |
ProductInfo类型
| 名称 | 类型 | 示例值 | 描述 | 是否必填 |
|---|---|---|---|---|
| product_name | String | 太阳能电池板 | 中文品名。 | 是 |
| product_name_en | String | Solar Battery | 英文品名。 | 是 |
| sku | String | XXX | sku。 | 是 |
| price | Number | 5280.99 | 单价。 | 是 |
| customs_price | Number | 6302.29 | 报关单价。 | 是 |
| currency | String | CNY | 币种。 | 是 |
| quantity | Number | 500 | 商品数量。 | 是 |
| quantity_unit | String | 个 | 数量单位。 | 是 |
| customs_weight | Number | 200.5 | 报关重量。 | 是 |
| weight_unit | String | Kg | 重量单位。 | 是 |
| customs_code | String | XXX | 海关编码。 | 是 |
| is_liquid | Boolean | false | 是否液体。 | 是 |
| is_magnetic | Boolean | false | 是否带磁。 | 是 |
| is_electric | Boolean | true | 是否带电。 | 是 |
| texture | String | 发电材料 | 材质用途。 | 是 |
返回参数
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| errcode | Number | 0 | 返回码。0表示请求成功。 |
| errmsg | String | 不合法的access_token | 调用失败时返回的错误信息。 |
| result | OrderCreateResponse | 返回结果。 |
OrderCreateResponse类型
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| t_order_no | String | T02383982321 | 提单号。 |
三、获取订单运输详情
请求地址: https://oapi.668tms.com/itms/order/:t_order_no?access_token=ACCESS_TOKEN
请求方法: GET
请求体与返回数据格式：JSON
注意：:t_order_no代表实际的提单号，使用提单号替换后的地址为：https://oapi.668tms.com/itms/order/T028328003837?access_token=ACCESS_TOKEN
Query参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | AwExxxx | 调用获取接口调用凭证接口获得 |
返回参数
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| errcode | Number | 0 | 返回码。0表示请求成功。 |
| errmsg | String | 不合法的access_token | 调用失败时返回的错误信息。 |
| result | OrderInfoResponse | 返回结果。 |
OrderInfoResponse类型
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| order_no | String | D86282837291 | 订单号。 |
| e_order_no | String | E09323389821 | 电商订单号。 |
| t_order_no | String | T01498982221 | 提单号。 |
| order_status | String | 待处理 | 提单状态。 |
| waybill_no | String | J97268398728 | 运单号。 |
| track_list | []TrackInfo | 运单跟踪信息。 | |
| remark | String | 加急中！ | 备注。 |
TrackInfo类型
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| track_msg | String | 已到达广东深圳市集散中心 | 当前跟踪节点信息。 |
| track_time | String | 2021-01-20 14:30 | 当前节点所发生的时间。 |
注意:
提单状态有：待处理｜已拒绝｜待揽件｜已揽件｜运送中｜已取消｜已送达｜已关闭。
如果客户系统要取消订单是此状态为已关闭时才能被取消，已关闭代表已于线下协商取消该提单后由本系统操作员手动关闭该提单。
