API

Overview
概述

  1. 先注册账号,然后问客服要API访问的KEY。参数名:ApiKey
  2. 使用:HTTP协议,JSON数据格式。http请求头(header)设置:Content-Type: application/json
  3. 统一默认请求方法:POST。
  4. 测试工具:https://(找客服)/swagger/ui/index
  5. 简单解释:
    接口地址:https://(找客服)
POST /api/UspsDom/AddFromAddress添加发货地址
POST /api/UspsDom/UpdateFromAddress修改发货地址
POST /api/UspsDom/RemoveFromAddress删除发货地址
POST /api/UspsDom/ListFromAddress列出所有发货地址
POST /api/UspsDom/Create创建运单信息(并且支付)
POST /api/UspsDom/GetLabel获取标签
POST /api/UspsDom/CancelLabel取消标签
POST /api/UspsDom/Update修改标签(特殊渠道)
POST /api/UspsDom/ConfirmLabel确认标签(特殊渠道)
POST /api/UspsDom/ScanForm获取ScanForm单据
  1. 流程:
    a) 添加发货地址,返回发货地址的ID,请保存记录Id。
    b) 购买运货单:1、创建运单信息,2、获取标签。
    c) 取消运货单:这里只是取消申请,是否结算,根据不同渠道结算周期不同。
    d) 查询标签状态:(还在测试中)
  2. 返回的统一数据格式:
参数类型说明举例
Codeint0表示成功,其它表示失败0
MsgString消息,或错误原因“Success”
Datajson对象数据数据,以下文档中的“返回数据”是指这个字段中的内容

8 特殊错误代码:

Code示例说明
7
{
  "Code": 7,
  "Data": null,
  "Msg": "暂停服务,服务器升级维护中!"
}
暂停服务,服务器需要进入更新维护

9 为什么地址中没有国家字段?答:因为业务范围是美国国内寄美国国内,所以默认都是US,省略了参数。

AddFromAddress
添加发货地址 (POST /api/UspsDom/AddFromAddress)

请求参数:

参数类型说明
ApiKeyString授权key
IsDefaultBool是否为默认发货地址,api调用可以忽略,使用文件导入用到。
NameString发货人或公司名称
PhoneString联系电话
Address1String地址第一行
CityString城市
StateString州代码
ZipCodeString邮编

示例:

{
  "ApiKey": "your-api-key",
  "Name": "ZDA Warehouse",
  "Phone": "13950789295",
  "Address1": "100 Main Street",
  "City": "Los Angeles",
  "State": "CA",
  "ZipCode": "90001"
}

UpdateFromAddress
查询发货地址

使用发货地址ID修改已保存的发货地址信息,字段与添加发货地址保持一致。

RemoveFromAddress
删除发货地址

传入 ApiKey 和发货地址 ID,删除不再使用的发货地址。

ListFromAddress
列出所有保存的发货地址

返回当前账号下已保存的发货地址列表。

Create
创建运单

创建运单信息并完成支付,成功后可继续调用 GetLabel 获取标签。

GetLabel
获取运单

根据运单号或创建接口返回的数据获取面单标签。

CancelLabel
取消运单申请

提交取消运单申请,最终结算以渠道规则和结算周期为准。

Update
修改运单或二次改单

特殊渠道使用,用于修改标签信息或二次改单。

ConfirmLabel
确认标签或预报面单

特殊渠道使用,用于确认标签或预报面单。

ScanForm
获取ScanForm单据

特殊渠道使用,用于获取 ScanForm 单据。