edis restful api

Version 1.0

edis RESTful APIs

Authentication preparation

可参考eBay 鉴权指南：

https://developer.ebay.com/api-docs/static/oauth-auth-code-grant-request.html#

**API scope设置增加: **https://api.ebay.com/oauth/scope/sell.edelivery

用eBayID授权的token调用eBay的refresh token接口获取access_token。

curl --location --request POST 'https://api.ebay.com/identity/v1/oauth2/token'
--header 'Authorization: Basic ******<appid:调用eBay接口通用的appid>******'
--data-urlencode 'grant_type=refresh_token'
--data-urlencode 'refresh_token=******<refresh_token:eBayID授权token>******'
--data-urlencode 'scope=https://api.ebay.com/oauth/scope/sell.edelivery'

用access_token作为header call eDIS的API，以“批量打印面单”接口为示例：

curl --location --request GET '{num1}&tracking_numbers={type}&print_preference=nameZh,nameEn'
--header 'Authorization: Bearer *******<access_token>******'

Path Table

环境	HTTPS请求地址
正式环境	https://edisapi.ebay.com/sell/edelivery_international_shipping/v1
测试环境（测试环境包含示例测试数据，无需注册账号）	https://edisapi.ebay.com/sell/edelivery_international_shipping/test

Method	Path	Description
GET	/actual_costs	Get actual weight and cost for single or multiple packages
GET	/address_preference	Get all your ship-from address preferences
POST	/address_preference	Create ship-from address preference
GET	/agents	Get EU AR agent settings
GET	/battery_qualifications	Get all battery qualification list
POST	/complaint	Create complaint request
GET	/consign_preference	Get all your pickup address preferences
POST	/consign_preference	Create pickup-from address preference
GET	/dropoff_sites	Get all dropoff site address metadata
GET	/handover_sheet	Get handover sheet for single or multiple packages
GET	/labels	Get single or multiple labels
POST	/package	Create a package for the order
POST	/package/bulk_cancel_packages	Cancel multiple packages
POST	/package/bulk_confirm_packages	Confirm multiple packages
POST	/package/bulk_delete_packages	delete multiple packages
GET	/package/{order_line_item_id}/item	Get packageid through itemid and transactionid
DELETE	/package/{package_id}	Delete single package
GET	/package/{package_id}	Get package detail
POST	/package/{package_id}/cancel	Cancel single package
POST	/package/{package_id}/clone	Clone package for redelivery
POST	/package/{package_id}/confirm	Confirm single package
GET	/services	Get service list metadata
GET	/tracking	Get tracking event detail information

Path Details

[GET]/actual_costs

Summary

获取包裹运费及重量
Description

获取账户明细流水（按包裹查实际结算费用，支持批量）。
Security

sell_scope_auth
Tips

“※” 为必填值;

API调用curl示例：

curl --location --request GET '${域名地址}/actual_costs?tracking_numbers=${num1}&tracking_numbers=${num2}&trans_begin_time=${time1}&trans_end_time=${time2}'

Parameters(Query)

// 包裹跟踪号列表 注：（trackingNumbers(跟踪号) 以及 交易流水时间（开始）、交易流水时间（结束）不能同时为空）
tracking_numbers: string[]

// 交易流水开始时间：【2024-10-21 00:00:01】
trans_begin_time: string

// 交易流水结束时间 【2024-10-21 00:00:01】
trans_end_time: string

Responses

200 successful operation

application/json

{
  actualCosts: {
    // 包裹实际重量
    actualWeight: number©
    // 交易金额
    amount: {
      // 货币符号：CNY，HKD，TWD
      currency: string
     // price金额
      value: string
    }
    // 交易时间
    billingTime: string
    // 计费方式
    chargeMode: string
    // 计费重量
    chargeWeight: number
    // 扣费类型01=运费  02=国内退货费  03=国内销毁费 04=海关代收代付  05=重量差异 06=重复扣款 07=货物赔偿 
    costType: string
    // 指定结果消息
    message: string
    // 备注
    remark: string
    // 响应编码，详见附录响应编码说明
    resultCode: string
    // 包裹尺寸(cm)
    size: string
    // 包裹跟踪号
    trackingNumber: string
  }
}

201 Created
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[GET]/address_preference

Summary

获取地址信息列表
Description

获取已保存的地址信息列表。
Security

sell_scope_auth
Tips

“※” 为必填值

Responses

200 successful operation

application/json

{
  // 地址页面信息
  addressPreferenceList: {
    // 地址信息
    addresses: {
      // 地址ID
      addressId: string
      // 市编码
      city: string
      // 市名称
      cityName: string
      // 公司名称
      company: string
      // 联系人姓名
      contact: string
      // 国家或地区编码
      countryCode: string
      // 国家名称或地区名称
      countryName: string
      // 区县编码
      district: string
      // 区县名称
      districtName: string
      // 手机号
      phone: string
      // 地址名称
      name: string
      // 邮政编码
      postcode: string
      // 省或州编码
      province: string
      // 省或州名称
      provinceName: string
      // 街道地址1
      street1: string
      // 街道地址2
      street2: string
      // 街道地址3
      street3: string
      type: enum[0, 1]
    }[]
  }
}

201 Created
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[POST]/address_preference

Summary

新增地址偏好
Description

用于保存用户的地址信息预设，包括发货地址。
Security

sell_scope_auth
Tips

“※” 为必填值

RequestBody

application/json

{
  shipFromAddress: {
    //※  城市编码 请参考地址编码说明
    city: string
    // 公司名称
    company: string
    //※  联系人姓名 
    contact: string
    //※  国家或地区编码（目前仅支持中国大陆和中国香港地区：CN、HK） 
    countryCode: string
    //※  区县编码请参考地址编码说明
    district: string
    //※  手机号
    phone: string
    //※  地址名称
    name: string
    // 邮政编码，非香港地区必填
    postcode: string
    //※  省或州编码 请参考地址编码说明
    province: string
    //※  街道地址1
    street1: string
    // 街道地址2
    street2: string
    // 街道地址3
    street3: string
    //※ 地址类型。枚举类型：AddressTypeEnum，可用值：SHIP_FROM_ADDRESS(0) - 发货地址
    type: enum[0, 1]
  }
}

Responses

200 successful operation

application/json

{
  // 新增地址结果
  shipFromAddressId: {
    // 地址ID
    addressId: string
  }
}

201 Created
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[GET]/agents

Summary

获取EU代理人信息
Description

增加API，用以查询卖家所有的EU代理人列表。返回姓名、手机号、地址信息以及偏好列表。
Security

sell_scope_auth
Tips

“※” 为必填值

Parameters(Query)

// 分页大小，默认值：50，最大值1000
offset: integer

// 页码，默认值：1
limit: integer

Responses

200 OK

application/json

{
  // 地址页面信息
  agentList: {
    agents: {
      // 代理商名称
      arName: string,
      // 代理商地址
      agentAddress: string,
      agentName: string,
      // 代理商电话
      agentPhone: string,
      agentPreferences: {
        // 易趣账号
        ebayId: string,
        // EU代理人偏好列表，交运国家
        shippingCountry: string
      }[]
    }[],
    // 当前页跳转地址
    href: string,
    // 下一页跳转地址
    next: string,
    // 上一页跳转地址
    prev: string,
    // 页码
    limit: integer,
    // 当前分页大小
    offset: integer,
    // 总数
    total: integer
  }
}

201 Created
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确

[GET]/battery_qualifications

Summary

获取带电资质认证信息列表
Description

获取有效的带电资质认证信息。注：响应参数中的带电类型为枚举类型,请参考带电类型枚举(LiBatteryTypeEnum)说明
Security

sell_scope_auth
Tips

“※” 为必填值

Parameters(Query)

//分页大小，默认值：50，最大值1000
offset: integer

//页码，默认值：1
limit: integer

Responses

200 successful operation

application/json

{
  // 电池资质页面信息
  batteryQualificationList: {
    // 当前页跳转地址
    href: string,
    // 下一页跳转地址
    next: string,
    // 上一页跳转地址
    prev: string,
    // 页码
    limit: integer,
    // 当前分页大小
    offset: integer,
    // 总数
    total: integer,
    // 电池相关信息
    qualifications: {
      // 电池类型
      batteryType: enum[0, 1, 2, 3, 4, 5, 8],
      // 资质ID
      elecQualificationId: string,
      // 资质名称
      elecQualificationName: string,
      // 有效期截止日期
      expireDate: string,
      // 备注
      remark: string
    }[]
  }
}

SDK枚举名	接口枚举值	中文描述
NO_BATTERY	0
LITHIUM_ION_BATTERY_PACKED_WITH_EQUIPMENT	1	配套锂离子电池
LITHIUM_ION_BATTERY_CONTAINED_IN_EQUIPMENT	2	内置锂离子电池
LITHIUM_METAL_BATTERY_PACKED_WITH_EQUIPMENT	3	配套锂金属电池
LITHIUM_METAL_BATTERY_CONTAINED_IN_EQUIPMENT	4	内置锂金属电池
DRY_PACKED_WITH_EQUIPMENT	5	配套干电池
SPECIAL_GOODS_WITH_NO_BATTERY	8	特货（不含电池）

201 Created
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[POST]/complaint

Summary

新增超时揽收申诉
Description

用于对某个交运偏好发起申诉。仅支持上门揽收类型的交运偏好且只能申诉最近3天。
Security

sell_scope_auth
Tips

“※” 为必填值

RequestBody

application/json

{
  complaintRequest: {
    //※ 申诉日期 yyyy-MM-dd 【例：2020-06-01】
    complaintDate: string
    //※  申诉原因 固定值：UNCOLLECTED，(意为揽收员未上门取件) 
    complaintReason: string
    // 申诉类型 ABNORMAL_COLLECTION_COMPLAINT(0)-揽收异常申诉; LOST_PACKAGE_COMPLAINT(1)-丢包申诉; 
    complaintType: enum[0, 1]
    // 受影响的包裹单号列表 在申诉类型为丢包时必填
    affectedPackages: string[]
    //※ 交运偏好id
    preferenceId: integer
    // 补充说明
    remark: string
  }
}

Responses

200 successful operation

application/json

{
  complaintResult: {
    // 响应消息
    message: string
    // 响应编码
    resultCode: string
  }
}

201 Created
206 部分处理成功，需要根据响应data部分resultCode分析
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[GET]/consign_preference

Summary

获取交运偏好列表
Description

获取用户的交运偏好信息。
Security

sell_scope_auth
Tips

“※” 为必填值

Responses

200 successful operation

application/json

{
  // 地址页面信息
  consignPreferenceList: {
    // 交运偏好
    consignPreferences: {
      // 交运偏好ID
      consignPreferenceId: string,
      // 自送站点ID
      dropoffSiteId: string,
      // 交运偏好名称
      consignPreferenceName: string,
      // 揽收地址
      pickupAddress: {
        // 市编码
        city: string,
        // 市名称
        cityName: string,
        // 公司名称
        company: string,
        // 联系人姓名
        contact: string,
        // 国家或地区编码
        countryCode: string,
        // 国家或地区名称
        countryName: string,
        // 区县编码
        district: string,
        // 区县名称
        districtName: string,
        // 手机号
        phone: string,
        // 地址名称
        name: string,
        // 邮政编码
        postcode: string,
        // 省或州编码
        province: string,
        // 省或州名称
        provinceName: string,
        // 街道地址1
        street1: string,
        // 街道地址2
        street2: string,
        // 街道地址3
        street3: string
      },
      // 揽收时间段，枚举类型：PickUpTimeTypeEnum，可用值：TIME_14_16(1) - 14:00-16:00；TIME_16_18(2) - 16:00-18:00
      pickupTime: enum[1, 2],
      // 交运方式，枚举类型：ConsignTypeEnum，可用值：PICK_UP(0) - 上门揽收；DROP_OFF(1) - 卖家自送
      type: enum[0, 1, 2]
    }[]
  }
}

201 Created
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[POST]/consign_preference

Summary

新增交运偏好
Description

用于保存用户交运信息预设，交运方式可选择上门揽收或卖家自送，上门揽收预设包括揽收地址和揽收时间段等信息，卖家自送预设包括自送站点等信息
Security

sell_scope_auth
Tips

“※” 为必填值

RequestBody

application/json

{
  consignAddress: {
    // 站点ID,当交运方式为卖家自送或智慧仓时必填
    dropoffSiteId: string
    //※ 交运偏好名称
    consignPreferenceName: string
    // 上门揽收地址，当交运方式为上门揽收时必填
    pickupAddress: {
      //※ 市编码 请参考地址编码说明
      city: string
      // 公司名称
      company: string
      //※ 联系人姓名
      contact: string
      //※ 国家或地区编码（目前支持中国大陆：CN，当交运方式为卖家自送时，支持中国香港地区：HK
      countryCode: string
      //※ 区县编码 请参考地址编码说明
      district: string
      //※ 手机号
      phone: string
      //※ 地址名称
      name: string
      //※ 邮政编码
      postcode: string
      //※ 省或州编码 请参考地址编码说明
      province: string
      //※ 街道地址1
      street1: string
      // 街道地址2
      street2: string
      // 街道地址3
      street3: string
    }
    // 揽收时间段，枚举类型：PickUpTimeTypeEnum，可用值：TIME_14_16(1) - 14:00-16:00；TIME_16_18(2) - 16:00-18:00；当交运方式为上门揽收时必填
    pickupTime: enum[1, 2]
    //※  交运方式，枚举类型：ConsignTypeEnum，可用值：PICK_UP(0) - 上门揽收；DROP_OFF(1) - 卖家自送；FORWARD_DEPLOYMENT(2)-智慧仓 
    type: enum[0, 1, 2]
  }
}

Responses

200 successful operation

application/json

{
  // 响应
  consignAddressId: {
    // 交运偏好ID
    consignPreferenceId: string
  }
}

201 Created
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[GET]/dropoff_sites

Summary

获取自送站点列表
Description

获取所有自送站点信息列表。
Security

sell_scope_auth
Tips

“※” 为必填值

Parameters(Query)

//分页大小，默认值：50，最大值1000
offset: integer

//页码，默认值：1
limit: integer

Responses

200 successful operation

application/json

{
  // 服务信息
  dropoffSiteList: {
    // 服务页面信息
    dropoffSites: {
      // 市
      city: string,
      // 联系人信息
      contact: string,
      // 国家
      country: string,
      // 区县
      district: string,
      // 站点ID
      dropoffSiteId: string,
      // 手机号码
      phone: string,
      // 站点名称
      name: string,
      // 省
      province: string,
      // 街道地址1
      street1: string,
      // 街道地址2
      street2: string,
      // 街道地址3
      street3: string,
      // 站点类型
      type: string
    }[],
    // 当前页跳转地址
    href: string,
    // 下一页跳转地址
    next: string,
    // 上一页跳转地址
    prev: string,
    // 页码
    limit: integer,
    // 当前分页大小
    offset: integer,
    // 总数
    total: integer
  }
}

201 Created
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[GET]/handover_sheet

Summary

获取交接单打印详情
Description

获取交接单信息，用于打印。
Security

sell_scope_auth
Tips

“※” 为必填值

API调用curl示例：

curl --location --request GET '${域名地址}/handover_sheet?tracking_numbers=${num1}&tracking_numbers=${num2}'

Parameters(Query)

//※ 包裹跟踪号列表，至少有一个跟踪号
tracking_numbers: string[]

Responses

200 successful operation

application/json

{
  handoverSheet: {
    // base64编码字符
    base64Str: string
  }
}

201 Created
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[GET]/labels

Summary

获取面单打印详情
Description

用于打印详情单，呼叫成功后会返回标签流。
Security

sell_scope_auth
Tips

“※” 为必填值

API调用curl示例：

curl --location --request GET '${域名地址}/labels?tracking_numbers=${num1}&tracking_numbers=${num2}&page_size=${type}&print_preference=nameZh,nameEn'

Parameters(Query)

//※ 包裹跟踪号
tracking_numbers: string[]

//※ 标签格式，枚举类型：PaperTypeEnum，可用值： A4(0) - 适用于打印A4格式标签，THERMAL_PAPER(1) - 适用于打印4寸的热敏标签纸格式标签
page_size: string

// 需要打印的字段，为空时按打印偏好打印，否则按所选择需要打印的字段使用逗号拼接字符串，如：（nameZh,nameEn,property,remark,skuPrice）
print_preference: string

Responses

200 OK

application/json

{
  labels: {
    // base64编码字符
    base64Str: string
    // 响应消息
    message: string
    // 响应编码，详见附录响应编码说明
    resultCode: string
    // 包裹跟踪号
    trackingNumber: string
  }
}

201 Created
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确

[POST]/package

Summary

指定物流服务多次上传包裹,一笔交易创建多个包裹
Description

eBay国际物流平台用户通过调用该方法上传需要发货的包裹信息，eBay国际物流平台返回申请到的包裹追踪号。每次呼叫只限上传一个包裹，一个包裹可以包含多个物品。每个物品都必须为在eBay 成交的物品。
Security

sell_scope_auth
Tips

“※” 为必填值

RequestBody

application/json

{
  // package information
  packageInfo: {
    //7月1日后，该字段才生效
    agentInfoRequest: {
      //EU代理人联系地址
      agentAddress: string
      //EU代理人姓名
      agentName: string
      //EU代理人联系电话
      agentPhone: string
    }
    //※ 交运偏好ID
    consignPreferenceId: string
    // 国贸条规，枚举类型：IncotermsTypeEnum，可用值:DDP(0) - 卖家承担关税；DDU(1) - 买家承担关税，为空时默认值为DDU
    incoterm: enum[0, 1]
    // item information
    items: {
      // eBay买家ID
      buyerId: string
      // 买家税号id
      buyerTaxId: string
      // 买家税号类型
      buyerTaxType: string
      // 卖家是否代缴税
      ebayCollectAndRemitTax: boolean
      // 卖家税号
      ebayCollectAndRemitTaxesValue: string
      // 买家eBay电邮
      email: string
      //※ eBay物品号
      listingId: string
      // eBay商品标题
      itemTitle: string
      // 买家eBay留言
      message: string
      // eBay合并订单时生成的一个新的Order ID
      orderId: string
      //※ eBay交易行ID，由ItemID和TransactionID的串联，通过连字符"-"将两个值分开，如121124971073-1094989827002
      orderLineItem: string
      // 买家PayPal电邮地址
      payPalEmail: string
      // 买家PayPal留言
      payPalMessage: string
      // 买家付款日期:例如-【2017-10-12T08:08:04+0800】
      paymentDate: string
      // 寄货数量，数量可输入值范围1-999
      postedQuantity: integer
      // 站点ID
      siteId: integer
      //※ SKU information
      sku: {
        //※ 单个商品申报价格，单位固定为美元，系统会根据收货地址的国家自动转换为该国家对应的货币单位.（汇率由ebay提供）
        price: {
	  // price字段对应币种，默认币种为美元
          currency: string
	  // price金额
          value: string
        }
        // 带电资质证书ID，若包裹带电则必填
        elecQualificationId: string
        fdcSkus: {
	  // 商品数量（SKUID与quantity需成对填写）
          quantity: integer
	  // 智慧仓商品库内编码（SKUID与quantity需成对填写）
          skuId: string
        }[]
        // 高度（cm）
        height: number
        // 长度（cm）
        length: number
        //※ 带电类型 请参考带电类型枚举(LiBatteryTypeEnum)说明
        liBatteryType: enum[0, 1, 2, 3, 4, 5, 8]
        //※ 英文申报名（只允许英文字母、数字、半角标点符号、空格）
        nameEn: string
        //※ 始发地申报名（中国始发至少包含一个中文字符）
        nameZh: string
        //※ 原产地 请参考原产地编码说明
        origin: string
        // 备注
        remark: string
        // SKU编号(SKU中有未传的必填字段时，会使用该预设SKU的信息)
        skuNumber: string
        // 关税代码
        tariffCode: string
        //※ 重量（单位：g）
        weight: number
        // 宽度（cm）
        width: number
        // 是否带锂电池（1.0版本）
        isLiBattery: boolean
      }
      // 卖出日期：2017-10-12T08:08:04+0800
      soldDate: string
      // 卖出总价,必须大于0.01
      soldPrice: {
          // price字段对应币种，默认币种为美元
          currency: string
	  // price金额
          value: string
      }
      // 卖出数量
      soldQuantity: integer
      //※ eBay交易号
      transactionId: string
    }[]
    // 包裹备注信息
    packageComment: string
    //※ 包裹高度（cm）
    packageHeight: number
    //※ 包裹长度（cm）
    packageLength: number
    // 包裹重量（g）
    packageWeight: number
    //※ 包裹宽度（cm）
    packageWidth: number
    //※ 物流服务ID，目前支持：ES标准、EE经济、EM迷你小包
    shippingServiceId: string
    //※ 发货地址ID（审核通过），日本始发非必填
    shipFromAddressId: string
    //※ 收货地址
    shipToAddress: {
      //※ 城市
      city: string
      // 公司
      company: string
      //※ 联系人
      contact: string
      //※ 国家代码 请参考地址编码说明
      countryCode: string
      // 国家名称
      countryName: string
      // 区
      district: string
      // 移动电话
      phone: string
      //※ 邮编，国家为法罗群岛、爱尔兰时可选
      postcode: string
      // 省,国家为美国时必选
      province: string
      //※ 街道地址1
      street1: string
      // 街道地址2
      street2: string
      // 街道地址3
      street3: string
    }
    //特别服信息，日本始发需填写
    specialServiceDetail: {
      //※ 包裹类型，枚举类型，可选值：LETTER（限定重量≤0.5KG），PAK（限定重量≤2.5KG），PACKAGE（限定重量68KG） 
      packagingType: string
      // 签名选项，枚举类型，可选值：ISR（非本人签名），DSR（本人签名），ASR（成人签名）
      signatureType: string
      // ELECTRONIC_TRADE_DOCUMENTS（使用ETD发送发票），Priority Alert PRIORITY_ALERT，Priority Alert Plus PRIORITY_ALERT_PLUS。Priority Alert PRIORITY_ALERT与Priority Alert Plus PRIORITY_ALERT_PLUS未互斥选项。
      specialServiceTypes: string[]
      // 保险金额及币种与 目的国币种一致
      insuranceFee: string
    }
    // 货物运输价值，币种与目的地国家的币种保持一致
    valueForCarriage: string
    //※ 5>=maxQuantityLimit>1
    maxQuantityLimit: integer
  }
}

以下为带电类型枚举的详细说明：

SDK枚举名	接口枚举值	中文描述
NO_BATTERY	0
LITHIUM_ION_BATTERY_PACKED_WITH_EQUIPMENT	1	配套锂离子电池
LITHIUM_ION_BATTERY_CONTAINED_IN_EQUIPMENT	2	内置锂离子电池
LITHIUM_METAL_BATTERY_PACKED_WITH_EQUIPMENT	3	配套锂金属电池
LITHIUM_METAL_BATTERY_CONTAINED_IN_EQUIPMENT	4	内置锂金属电池
DRY_PACKED_WITH_EQUIPMENT	5	配套干电池
SPECIAL_GOODS_WITH_NO_BATTERY	8	特货（不含电池）

Responses

200 successful operation

application/json

{
  // 包裹信息
  createPackageResult: { 
    // 预估运费金额
    estimateCost: {
      // 货币符号：CNY，HKD，TWD
      currency: string
      // price金额
      value: string
    }
    // 尾程单号，仅特快服务返回
    lastMileTrackingNumber: string
    // 包裹ID
    packageId: string
    // 支付金额，仅特快服务返回 
	paymentCost: {
      // 货币符号：CNY，HKD，TWD
      currency: string
      // price金额
      value: string
    }
    // 包裹跟踪号
    trackingNumber: string
  }
}

201 Created
206 部分处理成功，需要根据响应data部分resultCode分析
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。
33 错误的参数，需要检查请求参数是否正确

[POST]/package/bulk_cancel_packages

Summary

多个包裹取消
Description

用于取消订单，只有状态为待交运、待取件、运输中的包裹支持取消，其中取消运输中的包裹需要物流商确认，取消成功的包裹会回到待申请运单号状态。
Security

sell_scope_auth
Tips

“※” 为必填值

RequestBody

application/json

{
  requests: {
    //※ 需要取消的包裹ID列表
    packageIds: string[]
  }
}

Responses

200 successful operation

application/json

{
  // confirm result
  responses: {
    // 指定结果消息
    message: string
    // 包裹ID
    packageId: string
    // 指定结果code
    resultCode: string
  }
}

201 Created
206 部分处理成功，需要根据响应data部分resultCode分析
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[POST]/package/bulk_confirm_packages

Summary

交运多个包裹
Description

用于确认订单，确认订单成功之后，订单会上传到物流商的系统当中。
Security

sell_scope_auth
Tips

“※” 为必填值

RequestBody

application/json

{
  requests: {
    //※ 需要交运的包裹ID
    packageIds: string[]
  }
}

Responses

200 successful operation

application/json

{
  // confirm result
  responses: {
    // 指定结果消息
    message: string
    // 包裹ID
    packageId: string
    // 指定结果code
    resultCode: string
  }
}

201 Created
206 部分处理成功，需要根据响应data部分resultCode分析
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[POST]/package/bulk_delete_packages

Summary

删除多个包裹
Description

用于删除没有申请运单号的订单，申请运单号成功的订单需要取消后才能删除。
Security

sell_scope_auth
Tips

“※” 为必填值

RequestBody

application/json

{
  requests: {
    //※ 需要删除的包裹ID列表
    packageIds: string[]
  }
}

Responses

200 successful operation

application/json

{
  // delete result
  responses: {
    // 指定结果消息
    message: string
    // 包裹ID
    packageId: string
    // 指定结果code
    resultCode: string
  }
}

201 Created
206 部分处理成功，需要根据响应data部分resultCode分析
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[GET]/package/{order_line_item_id}/item

Summary

查询物品包裹ID
Description

用于根据orderLineItemId查询一个物品的包裹ID和包裹跟踪号。
Security

sell_scope_auth
Tips

“※” 为必填值

Responses

200 successful operation

application/json

{
  itemPackages: {
    // 包裹ID
    packageId: string
    // 包裹当前状态
    packageStatus: string
    // 包裹跟踪号
    trackingNumber: string
  }[]
}

201 Created
206 部分处理成功，需要根据响应data部分resultCode分析
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[DELETE]/package/{package_id}

Summary

删除单个包裹
Description

使用此方法删除包。只支持删除没有跟踪号的包裹。对于有快递单号的包裹，请先取消后再删除。
Security

sell_scope_auth
Tips

“※” 为必填值

Responses

200 successful operation

application/json

{
}

201 Created
206 部分处理成功，需要根据响应data部分resultCode分析
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[GET]/package/{package_id}

Summary

获取包裹详情
Description

用于获取包裹的详细信息。
Security

sell_scope_auth
Tips

“※” 为必填值

Responses

200 successful operation

application/json

{
  // package information
  packageDetail: {
    agentInfoResponse: {
      // EU代理人联系地址
      agentAddress: string
      // EU代理人姓名
      agentName: string
      // EU代理人联系电话
      agentPhone: string
    }
    // 交运偏好ID
    consignPreferenceId: string
    // 国贸条规，枚举类型：IncotermsTypeEnum，可用值：DDP(0) - 卖家承担关税；DDU(1) - 买家承担关税；为空时默认值为DDU
    incoterm: enum[0, 1]
    // item information
    items: {
      // eBay买家ID
      buyerId: string
      // 买家税号id
      buyerTaxId: string
      // 买家税号类型
      buyerTaxType: string
      // 卖出总价,必须大于0.01
      soldPrice: {
	// price字段对应币种，默认币种为美元
        currency: string
	// price金额
        value: string
      }
      // 卖家是否代缴税
      ebayCollectAndRemitTax: boolean
      // 卖家税号
      ebayCollectAndRemitTaxesValue: string
      // 买家eBay电邮
      email: string
      // eBay物品号
      listingId: string
      // eBay商品标题
      itemTitle: string
      // 买家eBay留言
      message: string
      // eBay合并订单时生成的一个新的Order ID
      orderId: string
      // eBay交易行ID
      orderLineItem: string
      // 买家PayPal电邮地址
      payPalEmail: string
      // 买家PayPal留言
      payPalMessage: string
      // 买家付款日期：【2017-10-12T08:08:04 +0800】
      paymentDate: string
      // 寄货数量，不能为0
      postedQuantity: integer
      // 站点ID
      siteId: integer
      // SKU information
      sku: {
        // 申报价格货币
	price: {
          // price字段对应币种，默认币种为美元
          currency: string
          // price金额
          value: string
        }
        // 带电资质ID
        elecQualificationId: string
        fdcSkus: {
          // 商品数量
          quantity: integer
	  // 智慧仓商品库内编码
          skuId: string
        }[]
        // 高度（cm）
        height: number
        // 长度（cm）
        length: number
        // 带电类型 请参考带电类型枚举(LiBatteryTypeEnum)说明
        liBatteryType: enum[0, 1, 2, 3, 4, 5, 8]
        // 英文申报名
        nameEn: string
        // 中文申报名
        nameZh: string
        // 原产地
        origin: string
        // 申报价格
        price: number
        // 备注
        remark: string
        // SKU编号
        skuNumber: string
        // 关税代码
        tariffCode: string
        // 重量（单位：g）
        weight: number
        // 宽度（cm）
        width: number
        // 是否带锂电池（1.0版本）
        isLiBattery: boolean
      }
      // 卖出日期：【2017-10-12T08:08:04+0800】
      soldDate: string
      // 
      soldPrice: number
      // 卖出数量
      soldQuantity: integer
      // eBay交易号
      transactionId: string
    }[]
    // 尾程单号
    lastMileTrackingNumber: string
    // 包裹备注信息
    packageComment: string
    // 包裹高度（cm）
    packageHeight: number
    // 包裹ID
    packageId: string
    // 包裹长度（cm）
    packageLength: number
    // 包裹重量（g）
    packageWeight: number
    // 包裹宽度（cm）
    packageWidth: number
    // 支付金额 
    paymentCost: {
      // price字段对应币种，默认币种为美元
      currency: string
      // price金额
      value: string
    }
    // 物流服务ID
    shippingServiceId: string
    //发货地址ID
    shipFromAddressId: string
    // 收货地址
    shipToAddress: {
      // 城市
      city: string
      // 公司
      company: string
      // 联系人
      contact: string
      // 国家代码
      countryCode: string
      // 国家名称
      countryName: string
      // 区
      district: string
      // 移动电话
      phone: string
      // 移动电话
      postcode: string
      // 省
      province: string
      // 街道地址1
      street1: string
      // 街道地址2
      street2: string
      // 街道地址3
      street3: string
    }
    //特别服信息
    specialServiceDetail: {
      // 包裹类型，枚举类型，可选值：LETTER（限定重量≤0.5KG），PAK（限定重量≤2.5KG），PACKAGE（限定重量68KG） 
      packagingType: string
      // 签名选项，枚举类型，可选值：ISR（非本人签名），DSR（本人签名），ASR（成人签名）
      signatureType: string
      // 特别服务类型，枚举类型，支持多选：SATURDAY_DELIVERY（星期六递送），SATURDAY_PICKUP（星期六取件），ELECTRONIC_TRADE_DOCUMENTS（使用ETD发送发票），Priority Alert PRIORITY_ALERT，Priority Alert Plus PRIORITY_ALERT_PLUS。Priority Alert PRIORITY_ALERT与Priority Alert Plus PRIORITY_ALERT_PLUS未互斥选项。
      specialServiceTypes: string[]
      //保险金额及币种与目的国币种一致
      insuranceFee: string
    }
    // 货物运输价值，币种与目的地国家的币种保持一致
    valueForCarriage: string
    // 包裹状态
    packageStatus: enum[5, 0, 4, 1, 2, 3, 6, 9, 8, 11, 12, 13, 14, 99, 15, 16, 17]
  }
}

以下为带电类型枚举的详细说明：

SDK枚举名	接口枚举值	中文描述
NO_BATTERY	0
LITHIUM_ION_BATTERY_PACKED_WITH_EQUIPMENT	1	配套锂离子电池
LITHIUM_ION_BATTERY_CONTAINED_IN_EQUIPMENT	2	内置锂离子电池
LITHIUM_METAL_BATTERY_PACKED_WITH_EQUIPMENT	3	配套锂金属电池
LITHIUM_METAL_BATTERY_CONTAINED_IN_EQUIPMENT	4	内置锂金属电池
DRY_PACKED_WITH_EQUIPMENT	5	配套干电池
SPECIAL_GOODS_WITH_NO_BATTERY	8	特货（不含电池）

201 Created
206 部分处理成功，需要根据响应data部分resultCode分析
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[POST]/package/{package_id}/cancel

Summary

取消单个包裹
Description

用于取消订单，只有状态为待交运、待取件、运输中的包裹支持取消，其中取消运输中的包裹需要物流商确认，取消成功的包裹会回到待申请运单号状态。
Security

sell_scope_auth
Tips

“※” 为必填值

Responses

200 successful operation

application/json

{
}

201 Created
206 部分处理成功，需要根据响应data部分resultCode分析
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[POST]/package/{package_id}/clone

Summary

重新发货
Description

用于重新发货。重新发货成功之后会返回一个新的跟踪号和一个新的包裹ID，并且包裹会进入待交运状态。只有交运成功后的包裹才能使用此功能。同一个交易，最多重发四次。
Security

sell_scope_auth
Tips

“※” 为必填值

Responses

200 successful operation

application/json

{
  clonePackageResult: {
    // 尾程单号，仅特快服务返回
    lastMileTrackingNumber: string
    // 新的包裹ID
    packageId: string
    // 支付金额，仅特快服务返回
    paymentCost: {
      // price字段对应币种，默认币种为美元
      currency: string
      // price金额
      value: string
    }
    // 新的包裹跟踪号
    trackingNumber: string
  }
}

201 Created
206 部分处理成功，需要根据响应data部分resultCode分析
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[POST]/package/{package_id}/confirm

Summary

交运单个包裹
Description

使用此方法确认单个包裹的发货顺序。确认后，预估费用将冻结在您的钱包中，同时将提交提取请求。
Security

sell_scope_auth
Tips

“※” 为必填值

Responses

200 successful operation

application/json

{
  // confirm result
  confirmResult: {
    // 需要交运的包裹ID
    packageId: string
  }
}

201 Created
206 部分处理成功，需要根据响应data部分resultCode分析
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[GET]/services

Summary

获取物流服务列表
Description

获取所有的物流服务列表。
Security

sell_scope_auth
Tips

“※” 为必填值

Parameters(Query)

// 页码，默认值：1
offset: integer

// 分页大小，默认值：50，最大值100
limit: integer

Responses

200 successful operation

application/json

{
  // service page information
  serviceList: {
    // 当前页跳转地址
    href: string,
    // 下一页跳转地址
    next: string,
    // 上一页跳转地址
    prev: string,
    // 页码
    limit: integer,
    // 当前分页大小
    offset: integer,
    // 总数
    total: integer,
    // service information
    services: {
      // 物流服务描述（英文）
      descriptionEn: string
      // 物流服务描述（中文繁体）
      descriptionHk: string
      // 物流服务描述（日文）
      descriptionJp: string
      // 物流服务描述（中文）
      descriptionZh: string
      // 路向
      directions: {
        // 带电类型集合 例：1,2,3。请参考带电类型枚举(LiBatteryTypeEnum)说明
        batteryType: string
        // 起始国家代码
        from: string
        // 目标国家代码
        to: string
      }[]
      // 国贸条规，可用值:DDP-卖家承担关税 DDU-买家承担关税 为空时默认值为DDU
      incoterm: integer
      // 最大单边长（cm）
      maxLength: number
      // 三边之和上限（cm）
      maxTotalLength: number
      // 最大承载重量（g）
      maxWeight: number
      // 物流服务名称（英文）
      nameEn: string
      // 物流服务名称（中文繁体）
      nameHk: string
      // 物流服务名称（日文）
      nameJp: string
      // 物流服务名称（中文）
      nameZh: string
      // 物流服务ID
      shippingServiceId: string
    }[]
  }
}

201 Created
206 部分处理成功，需要根据响应data部分resultCode分析
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。

[GET]/tracking

Summary

获取包裹物流跟踪信息
Description

获取包裹的物流跟踪信息。
Security

sell_scope_auth
Tips

“※” 为必填值

API调用curl示例：

curl --location --request GET '${域名地址}/tracking?tracking_number=${num}'

Parameters(Query)

//※ 包裹跟踪号
tracking_number: string

Responses

200 successful operation

application/json

{
  // tracking status information
  trackingDetails: {
    // 包裹跟踪号
    trackingNumber: string
    // 包裹所在市
    city: string
    // 包裹所在国家
    country: string
    // 英文描述
    descriptionEn: string
    // 中文描述
    descriptionZh: string
    // 包裹所在区县
    district: string
    // 包裹所在地邮编
    eventPostalCode: string
    // 时间
    eventTime: string
    // 包裹所在省/州
    province: string
    // 物流跟踪状态
    status: string
  }[]
}

201 Created
206 部分处理成功，需要根据响应data部分resultCode分析
401 认证失败，需要检查凭证是否正确
403 Forbidden
404 资源不存在，需要检查URI是否正确
405 资源的方法不支持，需要检查Http method是否正确
406 请求接收的数据类型不支持，需要检查Accept请求头
415 请求数据格式不正确，需要检查Content-Type请求头
500 业务处理错误，需要根据子错误代码分析
503 服务不可用，服务器目前无法使用（由于超载或停机维护），通常只是暂时状态。