edis restful api

Version 1.0

edis RESTful APIs

Authentication preparation

eDIS接口API调用前期鉴权准备步骤：

用户重新授权，获取新的refresh_token，参考eBay 获取授权指南：

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

用eBayID重新授权后的refresh_token调用eBay的鉴权token接口获取access_token。（API scope设置新增:https://api.ebay.com/oauth/scope/sell.edelivery）

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://api.ebay.com/sell/edelivery_international_shipping/v1
测试环境（测试环境包含示例测试数据，无需注册账号）	https://edisapi.ebay.com/sell/edelivery_international_shipping/test

Method	Path	OldPath	Description
GET	/actual_costs	GetActualCost	获取包裹运费及重量
GET	/address_preference	GetAddressPreferenceList	获取地址信息列表
POST	/address_preference	AddAddressPreference	新增地址偏好
GET	/agents	GetAgentList	获取EU代理人信息
GET	/battery_qualifications	GetBatteryQualList	获取带电资质认证信息列表
POST	/complaint	AddComplaint	新增超时揽收申诉
GET	/consign_preference	GetConsignPreferenceList	获取交运偏好列表
POST	/consign_preference	AddConsignPreference	新增交运偏好
GET	/dropoff_sites	GetDropoffSiteList	获取自送站点列表
GET	/handover_sheet	GetHandoverSheet	获取交接单打印详情
GET	/labels	GetLabel, GetLabels, GetLabelList	获取面单打印详情
POST	/package	AddNewPackage	指定物流服务多次上传包裹,一笔交易创建多个包裹
POST	/package/bulk_cancel_packages	CancelPackages	包裹取消
POST	/package/bulk_confirm_packages	ConfirmPackages	批量交运包裹
POST	/package/bulk_delete_packages	DeletePackages	删除包裹
GET	/package/{order_line_item_id}/item	GetItemPackageId	查询物品包裹ID
DELETE	/package/{package_id}	新增	单个删除包裹
GET	/package/{package_id}	GetPackageStatus,GetPackageDetail	获取包裹详情
POST	/package/{package_id}/cancel	新增	单个取消单号
POST	/package/{package_id}/clone	RecreatePackage	重新发货
POST	/package/{package_id}/confirm	ConfirmPackage	交运单个包裹
GET	/services	GetServiceList	获取物流服务列表
GET	/tracking	GetTrackingDetail	获取包裹物流跟踪信息

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(跟踪号) 以及 交易流水时间（开始）、交易流水时间（结束）不能同时为空）[原接口trackingNumbers]
tracking_numbers: string[]

// 交易流水开始时间：【2024-10-21 00:00:01】[原接口transBeginTime]
trans_begin_time: string

// 交易流水结束时间 【2024-10-21 00:00:01】[原接口transEndTime]
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
  }
}

响应示例

{
    "actualCosts": [
        {
            "actualWeight": 37.0,
            "amount": {
                "currency": "CNY",
                "value": "3.0"
            },
            "billingTime": "2025-01-14T06:31:08+08:00",
            "chargeMode": "01",
            "chargeWeight": 37.0,
            "costType": "04",
            "message": null,
            "remark": "退货处理费",
            "resultCode": null,
            "size": "-",
            "trackingNumber": "ES1002853222872000100000000N"
        }
    ]
}

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]
    }[]
  }
}

响应示例

{
    "addressPreferenceList": {
        "addresses": [
            {
                "addressId": "90000081",
                "city": "130200",
                "cityName": "TANGSHAN",
                "company": "mycompany",
                "contact": "tester",
                "countryCode": "CN",
                "countryName": "China",
                "district": "130204",
                "districtName": "GUYE DISTRICT",
                "phone": "13105511234",
                "name": "测试2407233",
                "postcode": "111222",
                "province": "130000",
                "provinceName": "HEBEI",
                "street1": "test1",
                "street2": "test2",
                "street3": "test3",
                "type": 0
            },
            {
                "addressId": "90000082",
                "city": "320100",
                "cityName": "NANJING",
                "company": "",
                "contact": "archer",
                "countryCode": "CN",
                "countryName": "China",
                "district": "320104",
                "districtName": "QINHUAI DISTRICT",
                "phone": "18878886888",
                "name": "测试发货地址",
                "postcode": "330330",
                "province": "320000",
                "provinceName": "JIANGSU",
                "street1": "Yingtian Aven Yanghu Lane",
                "street2": "Lianwei Company, No.80",
                "street3": "",
                "type": 0
            }
        ]
    }
}

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
    //※  手机号[原接口mobile]
    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]
  }
}

请求示例

{
  "shipFromAddress": {
    "city": "130200",
    "company": "mycompany",
    "contact": "tester",
    "countryCode": "CN",
    "district": "130204",
    "phone": "13105512134",
    "name": "测试0122",
    "postcode": "111222",
    "province": "130000",
    "street1": "test1",
    "street2": "test2",
    "street3": "test3",
    "type": "0"
  }
}

Responses

200 successful operation

application/json

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

响应示例

{
    "shipFromAddressId": {
        "addressId": "90000106"
    }
}

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)

// 页码，默认值：1[原接口pageNumber]
offset: integer

// 分页大小，默认值：50，最大值1000[原接口pageSize]
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
  }
}

响应示例

    "agentList": {
        "agents": [
            {
                "arName": "测试EU",
                "agentAddress": "street",
                "agentName": "测试EU",
                "agentPhone": "490373",
                "agentPreferences": [
                    {
                        "ebayId": "archer1_5",
                        "shippingCountry": "GB"
                    }
                ]
            }
        ],
        "href": null,
        "next": null,
        "prev": null,
        "limit": 10,
        "offset": 1,
        "total": 1
    }
}

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

[GET]/battery_qualifications

Summary

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

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

sell_scope_auth
Tips

“※” 为必填值

Parameters(Query)

// 页码，默认值：1[原接口pageNumber]
offset: integer

// 分页大小，默认值：50，最大值1000[原接口pageSize]
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
    }[]
  }
}

响应示例

{
    "batteryQualificationList": {
        "href": null,
        "next": null,
        "prev": null,
        "limit": 50,
        "offset": 1,
        "total": 1,
        "qualifications": [
            {
                "batteryType": 4,
                "elecQualificationId": "16276950515904",
                "elecQualificationName": "test",
                "expireDate": "2026-01-11 11:32:15",
                "remark": ""
            }
        ]
    }
}

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]
    // 受影响的包裹单号列表 在申诉类型为丢包时必填[原接口effectedPackages]
    affectedPackages: string[]
    //※ 交运偏好id
    preferenceId: integer
    // 补充说明
    remark: string
  }
}

请求示例

{
  "complaintRequest": {
    "complaintDate": "2025-01-20",
    "complaintReason": "UNCOLLECTED",
    "complaintType": 0,
    "affectedPackages": [1662829405772185676],
    "preferenceId": 2000039,
    "remark": ""
  }
}

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]
    }[]
  }
}

响应示例

{
    "consignPreferenceList": {
        "consignPreferences": [
            {
                "consignPreferenceId": "2000052",
                "consignPreferenceName": "test0115",
                "pickupAddress": {
                    "city": "110100",
                    "cityName": "BEIJING",
                    "company": "mycompany",
                    "contact": "tester",
                    "countryCode": "CN",
                    "countryName": "China",
                    "district": "110111",
                    "districtName": "FANGSHAN DISTRICT",
                    "phone": "13105511234",
                    "name": "addrtest1721380174",
                    "postcode": "123456",
                    "province": "110000",
                    "provinceName": "BEIJING",
                    "street1": "test1中",
                    "street2": "test2",
                    "street3": ""
                },
                "type": 0
            },
            {
                "consignPreferenceId": "2000051",
                "dropoffSiteId": "OF001",
                "consignPreferenceName": "智慧仓11",
                "pickupAddress": null,
                "type": 2
            },
            {
                "consignPreferenceId": "2000050",
                "dropoffSiteId": "OF001",
                "consignPreferenceName": "智慧仓",
                "pickupAddress": null,
                "type": 2
            },
            {
                "consignPreferenceId": "2000049",
                "consignPreferenceName": "test250113",
                "pickupAddress": {
                    "city": "110100",
                    "cityName": "BEIJING",
                    "company": "mycompany",
                    "contact": "tester",
                    "countryCode": "CN",
                    "countryName": "China",
                    "district": "110111",
                    "districtName": "FANGSHAN DISTRICT",
                    "phone": "13105511234",
                    "name": "addrtest1721380174",
                    "postcode": "123456",
                    "province": "110000",
                    "provinceName": "BEIJING",
                    "street1": "test1中",
                    "street2": "test2",
                    "street3": ""
                },
                "type": 0
            },
            {
                "consignPreferenceId": "2000041",
                "consignPreferenceName": "test1721380174",
                "pickupAddress": {
                    "city": "110100",
                    "cityName": "BEIJING",
                    "company": "mycompany",
                    "contact": "tester",
                    "countryCode": "CN",
                    "countryName": "China",
                    "district": "110111",
                    "districtName": "FANGSHAN DISTRICT",
                    "phone": "13105511234",
                    "name": "addrtest1721380174",
                    "postcode": "123456",
                    "province": "110000",
                    "provinceName": "BEIJING",
                    "street1": "test1中",
                    "street2": "test2",
                    "street3": ""
                },
                "type": 0
            },
            {
                "consignPreferenceId": "2000040",
                "dropoffSiteId": "DP08106",
                "consignPreferenceName": "自送测试",
                "pickupAddress": null,
                "type": 1
            },
            {
                "consignPreferenceId": "2000039",
                "consignPreferenceName": "测试使用",
                "pickupAddress": {
                    "city": "320100",
                    "cityName": "NANJING",
                    "company": "",
                    "contact": "archer",
                    "countryCode": "CN",
                    "countryName": "China",
                    "district": "320104",
                    "districtName": "QINHUAI DISTRICT",
                    "phone": "18878886888",
                    "name": "测试使用",
                    "postcode": "330330",
                    "province": "320000",
                    "provinceName": "JIANGSU",
                    "street1": "1865创意园",
                    "street2": "",
                    "street3": ""
                },
                "type": 0
            }
        ]
    }
}

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
    //※ 交运偏好名称[原接口name]
    consignPreferenceName: string
    // 上门揽收地址，当交运方式为上门揽收时必填
    pickupAddress: {
      //※ 市编码 请参考地址编码说明
      city: string
      // 公司名称
      company: string
      //※ 联系人姓名
      contact: string
      //※ 国家或地区编码（目前支持中国大陆：CN，当交运方式为卖家自送时，支持中国香港地区：HK
      countryCode: string
      //※ 区县编码 请参考地址编码说明
      district: string
      //※ 手机号[原接口mobile]
      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]
  }
}

请求示例

{
  "consignAddress": {
    "consignPreferenceName": "test0122",
    "pickupAddress": {
      "city": "110100",
      "company": "mycompany",
      "contact": "tester",
      "countryCode": "CN",
      "district": "110111",
      "phone": "13105511234",
      "name": "addrtest001",
      "postcode": "123456",
      "province": "110000",
      "street1": "测试",
      "street2": "test2",
      "street3": ""
    },
    "pickupTime": 1,
    "type": "0"
  }
}

Responses

200 successful operation

application/json

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

响应示例

{
    "consignAddressId": {
        "consignPreferenceId": "2000053"
    }
}

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)

// 页码，默认值：1[原接口pageNumber]
offset: integer

// 分页大小，默认值：50，最大值1000[原接口pageSize]
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,
      // 站点类型：FORWARDDEPLOYMENT- 智慧仓 ；DROP_OFF - 自送站点
      type: string
    }[],
    // 当前页跳转地址
    href: string,
    // 下一页跳转地址
    next: string,
    // 上一页跳转地址
    prev: string,
    // 当前分页大小
    limit: integer,
    // 页码
    offset: integer,
    // 总数
    total: integer
  }
}

响应示例

{
    "dropoffSiteList": {
        "dropoffSites": [
            {
                "city": "340100",
                "contact": "刘强",
                "country": "CN",
                "district": "340111",
                "dropoffSiteId": "01219",
                "phone": "13611717798",
                "name": "JD合肥包河营业部",
                "province": "340000",
                "street1": "安徽省合肥市包河区明康丹桂园14栋102京东快递",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "410300",
                "contact": "赵智",
                "country": "CN",
                "district": "410305",
                "dropoffSiteId": "0154686",
                "phone": "15003798881",
                "name": "JD洛阳九都营业部",
                "province": "410000",
                "street1": "河南省洛阳市涧西区南昌路街道王府井",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "130600",
                "contact": "吴丽",
                "country": "CN",
                "district": "130606",
                "dropoffSiteId": "02063",
                "phone": "15733218478",
                "name": "JD保定指挥营营业部",
                "province": "130000",
                "street1": "河北省保定市莲池区北三环东湖庄园（B区）",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "130100",
                "contact": "张赛",
                "country": "CN",
                "district": "130105",
                "dropoffSiteId": "02293",
                "phone": "17718480613",
                "name": "JD石家庄联强营业部",
                "province": "130000",
                "street1": "河北省石家庄新华区新华路街道女人世界底商京东物流",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "131100",
                "contact": "周健",
                "country": "CN",
                "district": "131127",
                "dropoffSiteId": "0331886",
                "phone": "15003185703",
                "name": "JD衡水景县营业部",
                "province": "130000",
                "street1": "景安大街马庄路口南行10米原君客来饭店",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "411100",
                "contact": "梁治华",
                "country": "CN",
                "district": "411104",
                "dropoffSiteId": "0394776",
                "phone": "18839572926",
                "name": "JD漯河沙南营业部",
                "province": "410000",
                "street1": "河南省漯河市召陵区燕山路与漓江路交叉口聚龙停车厂内",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "440600",
                "contact": "江湛昌",
                "country": "CN",
                "district": "440606",
                "dropoffSiteId": "0398375",
                "phone": "15012444397",
                "name": "JD佛山东乐营业部",
                "province": "440000",
                "street1": "广东省佛山市顺德区大良街道办事处近良社区居民委员会永和路一巷5号",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "410100",
                "contact": "张一男",
                "country": "CN",
                "district": "410102",
                "dropoffSiteId": "0427326",
                "phone": "16637138138",
                "name": "JD郑州中原营业部",
                "province": "410000",
                "street1": "河南省郑州市中原区棉纺路桐柏路方圆经纬小区103商铺",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "320100",
                "contact": "唐保健",
                "country": "CN",
                "district": "320114",
                "dropoffSiteId": "0462110",
                "phone": "13151566745",
                "name": "JD南京玉兰路营业部",
                "province": "320000",
                "street1": "江苏省南京市雨花台区玉兰路88号",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "320600",
                "contact": "朱森浩",
                "country": "CN",
                "district": "320602",
                "dropoffSiteId": "05769",
                "phone": "15895911524",
                "name": "JD南通振兴营业部",
                "province": "320000",
                "street1": "南通市经济技术开发区星港湾花园西门京东快递",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "411700",
                "contact": "武海洋",
                "country": "CN",
                "district": "411702",
                "dropoffSiteId": "1004",
                "phone": "13393994440",
                "name": "驻马店驿城营业部",
                "province": "410000",
                "street1": "河南省驻马店市驿城区中华路与学院路南200米路东",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "340700",
                "contact": "胡丽",
                "country": "CN",
                "district": "340702",
                "dropoffSiteId": "1014",
                "phone": "17356245079",
                "name": "铜陵铜都营业部",
                "province": "340000",
                "street1": "铜陵市铜官区翠湖一路交警二大队隔壁院内（原铜都阀门厂）",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "341300",
                "contact": "尹成玉",
                "country": "CN",
                "district": "341302",
                "dropoffSiteId": "1021",
                "phone": "0557-3926283",
                "name": "宿州埇桥营业部",
                "province": "340000",
                "street1": "安徽省宿州市经济开发区外环南路平安医院楼下",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "341500",
                "contact": "王军",
                "country": "CN",
                "district": "341502",
                "dropoffSiteId": "1049",
                "phone": "18949655773",
                "name": "六安城东营业部",
                "province": "340000",
                "street1": "安徽省六安市金安区经济开发区文蔚路与文教路交叉口西50米",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "340100",
                "contact": "杜崇伍",
                "country": "CN",
                "district": "340111",
                "dropoffSiteId": "1219",
                "phone": "0551-63812017",
                "name": "合肥包河营业部",
                "province": "340000",
                "street1": "安徽省合肥市包河区高铁路与北京路交口南100米同和明康丹桂园14栋102",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "321000",
                "contact": "尤宝雷",
                "country": "CN",
                "district": "321003",
                "dropoffSiteId": "132267",
                "phone": "0514-82159009",
                "name": "扬州安吉营业部",
                "province": "320000",
                "street1": "城区吉安路209号（吉安大厦）3-107",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "441900",
                "contact": "蔡中副",
                "country": "CN",
                "district": "441923",
                "dropoffSiteId": "140269",
                "phone": "18824215334",
                "name": "东莞大京九营业部",
                "province": "440000",
                "street1": "东莞市常平漱新村漱新综合市场路一号",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "440100",
                "contact": "郑泽霖",
                "country": "CN",
                "district": "440106",
                "dropoffSiteId": "145386",
                "phone": "15377804313",
                "name": "广州车陂营业部",
                "province": "440000",
                "street1": "广州市天河区车陂北街大岗北新建路大胜工业区B栋1楼",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "340600",
                "contact": "孙雪龙",
                "country": "CN",
                "district": "340602",
                "dropoffSiteId": "1497",
                "phone": "0561-3070311",
                "name": "淮北相王营业部",
                "province": "340000",
                "street1": "安徽省淮北市杜集区开渠中路69号中国矿业设备博览城59栋109号-112号",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "410300",
                "contact": "赵智",
                "country": "CN",
                "district": "410305",
                "dropoffSiteId": "154686",
                "phone": "15003798881",
                "name": "洛阳九都营业部",
                "province": "410000",
                "street1": "河南省洛阳市涧西区三山纬一路鸿都公寓",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "350400",
                "contact": "王衍钦",
                "country": "CN",
                "district": "350403",
                "dropoffSiteId": "1606",
                "phone": "15859286900",
                "name": "三明三元营业部",
                "province": "350000",
                "street1": "福建省三明市三元区长安路19号12号店",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "410900",
                "contact": "李锦帅",
                "country": "CN",
                "district": "410902",
                "dropoffSiteId": "1633",
                "phone": "18539351000",
                "name": "濮阳华龙营业部",
                "province": "410000",
                "street1": "河南省濮阳市华龙区京开道与老北环交叉口向东200米路北",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "410800",
                "contact": "李永超",
                "country": "CN",
                "district": "410811",
                "dropoffSiteId": "1635",
                "phone": "15803917751",
                "name": "焦作解放营业部",
                "province": "410000",
                "street1": "河南省焦作市建设东路古文化艺术品一条街14-5-6",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "411600",
                "contact": "王登峰",
                "country": "CN",
                "district": "411602",
                "dropoffSiteId": "1662",
                "phone": "13393939159",
                "name": "周口川汇营业部",
                "province": "410000",
                "street1": "河南省周口市川汇区城区交通路与龙源路交叉口南200米路西",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "411400",
                "contact": "李治亿",
                "country": "CN",
                "district": "411402",
                "dropoffSiteId": "1663",
                "phone": "15637030202",
                "name": "商丘梁园营业部",
                "province": "410000",
                "street1": "河南省商丘市梁园区八一路振兴路交叉口东南角院内",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "411200",
                "contact": "吕志毅",
                "country": "CN",
                "district": "411202",
                "dropoffSiteId": "1741",
                "phone": "0398-2600618",
                "name": "三门峡湖滨营业部",
                "province": "410000",
                "street1": "河南省三门峡市湖滨区城区黄河西路甘棠菜市场东侧",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "410600",
                "contact": "高继雷",
                "country": "CN",
                "district": "410611",
                "dropoffSiteId": "1742",
                "phone": "15346269991",
                "name": "鹤壁淇滨营业部",
                "province": "410000",
                "street1": "河南省鹤壁市淇滨区黎阳路东段823号中联通用厂内",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "419001",
                "contact": "李明明",
                "country": "CN",
                "district": "419103",
                "dropoffSiteId": "1931",
                "phone": "16639798096",
                "name": "济源营业部",
                "province": "410000",
                "street1": "河南省济源市金诺翡翠城21号楼4单元门面",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "130600",
                "contact": "吴丽",
                "country": "CN",
                "district": "130606",
                "dropoffSiteId": "2063",
                "phone": "15733218478",
                "name": "保定翠园营业部",
                "province": "130000",
                "street1": "河北省保定市莲池区徐河桥村富民路88号",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "130100",
                "contact": "谷金朋",
                "country": "CN",
                "district": "130105",
                "dropoffSiteId": "2293",
                "phone": "13103008693",
                "name": "石家庄联强营业部",
                "province": "130000",
                "street1": "河北省石家庄新华区新华路街道太和电子城",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "130100",
                "contact": "霍志健",
                "country": "CN",
                "district": "130110",
                "dropoffSiteId": "229307",
                "phone": "15810527528",
                "name": "JD石家庄鹿泉营业部",
                "province": "130000",
                "street1": "河北省石家庄市鹿泉区获鹿镇园盛街北头 京东物流站点",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "411500",
                "contact": "曹阳",
                "country": "CN",
                "district": "411503",
                "dropoffSiteId": "232159",
                "phone": "17637678397",
                "name": "信阳申城营业部",
                "province": "410000",
                "street1": "河南省信阳市平桥区平桥大道平桥电厂东200米路北京东物流信阳申城营业部",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "350800",
                "contact": "范烨中",
                "country": "CN",
                "district": "350802",
                "dropoffSiteId": "234004",
                "phone": "18650888055",
                "name": "龙岩北城营业部",
                "province": "350000",
                "street1": "龙岩市新罗区北城街道亚金富都15栋6单元1楼",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "130300",
                "contact": "付红霞",
                "country": "CN",
                "district": "130302",
                "dropoffSiteId": "252308",
                "phone": "13933516577",
                "name": "秦皇岛广顺营业部",
                "province": "130000",
                "street1": "河北省秦皇岛市海港区城区海滨路15号",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "340400",
                "contact": "方超",
                "country": "CN",
                "district": "340402",
                "dropoffSiteId": "258465",
                "phone": "0554-6906882",
                "name": "淮南东城营业部",
                "province": "340000",
                "street1": "安徽省淮南市大通区洛河镇建设北路西侧(原宫平家具厂楼下）",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "410400",
                "contact": "张起圣",
                "country": "CN",
                "district": "410403",
                "dropoffSiteId": "269708",
                "phone": "18639749107",
                "name": "平顶山皇台营业部",
                "province": "410000",
                "street1": "河南省平顶山市卫东区开发二路与叶宝路交叉口向西500米",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "110100",
                "contact": "杨柳",
                "country": "CN",
                "district": "110108",
                "dropoffSiteId": "281159",
                "phone": "17710782095",
                "name": "北京安宁里营业部",
                "province": "110000",
                "street1": "北京市海淀区清河小营尚艺墅KTV北20米 京东物流站点",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "320300",
                "contact": "王中秋",
                "country": "CN",
                "district": "320302",
                "dropoffSiteId": "2858",
                "phone": "0516-87767029",
                "name": "徐州汉城营业部",
                "province": "320000",
                "street1": "中共孤山社区居委会",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "350600",
                "contact": "吴晓伟",
                "country": "CN",
                "district": "350602",
                "dropoffSiteId": "289569",
                "phone": "15959654651",
                "name": "漳州岱山营业部",
                "province": "350000",
                "street1": "西洋坪村914号",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "350300",
                "contact": "翁吴达",
                "country": "CN",
                "district": "350303",
                "dropoffSiteId": "2991",
                "phone": "13950745502",
                "name": "莆田涵江营业部",
                "province": "350000",
                "street1": "福建省莆田市涵江区国欢镇新坡村中心村3号",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "131000",
                "contact": "赵常喆",
                "country": "CN",
                "district": "131003",
                "dropoffSiteId": "317",
                "phone": "18932602755",
                "name": "廊坊康庄营业部",
                "province": "130000",
                "street1": "河北省廊坊市广阳区春和花园北区幼儿园东侧",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "130500",
                "contact": "王智佳",
                "country": "CN",
                "district": "130582",
                "dropoffSiteId": "3174",
                "phone": "18632943777",
                "name": "邢台康桥营业部",
                "province": "130000",
                "street1": "河北省沙河市尚贤村东南机场路北侧",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "130200",
                "contact": "王帆",
                "country": "CN",
                "district": "130225",
                "dropoffSiteId": "3203",
                "phone": "15833467989",
                "name": "唐山乐亭营业部",
                "province": "130000",
                "street1": "河北唐山乐亭县乐安小区底商发展大道东侧65号",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "130400",
                "contact": "岳哈",
                "country": "CN",
                "district": "130404",
                "dropoffSiteId": "3287",
                "phone": "13363044733",
                "name": "邯郸复兴营业部",
                "province": "130000",
                "street1": "邯郸市复兴区复兴路河北启信集团后院",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "320500",
                "contact": "郁林川",
                "country": "CN",
                "district": "320508",
                "dropoffSiteId": "32907",
                "phone": "0512-62742131",
                "name": "JD苏州工业园区营业部",
                "province": "320000",
                "street1": "江苏省苏州市工业园区直属地区红枫路35号",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "131100",
                "contact": "周健",
                "country": "CN",
                "district": "131127",
                "dropoffSiteId": "331886",
                "phone": "15003185703",
                "name": "衡水景县营业部",
                "province": "130000",
                "street1": "河北省衡水景县紫旭东苑底商京东服务点",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "350900",
                "contact": "魏翔",
                "country": "CN",
                "district": "350922",
                "dropoffSiteId": "3724",
                "phone": "15105919127",
                "name": "宁德古田营业部",
                "province": "350000",
                "street1": "福建省宁德市古田县城东街道六一四东路35-10",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "410700",
                "contact": "韩振元",
                "country": "CN",
                "district": "410711",
                "dropoffSiteId": "3912",
                "phone": "13781932693",
                "name": "新乡凤泉营业部",
                "province": "410000",
                "street1": "河南省新乡市牧野区北环环宇立交桥向西800米路南京东",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "411100",
                "contact": "梁治华",
                "country": "CN",
                "district": "411104",
                "dropoffSiteId": "394776",
                "phone": "18839572926",
                "name": "漯河沙南营业部",
                "province": "410000",
                "street1": "河南省漯河市召陵区朱庄社区东双叶文具对面",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            },
            {
                "city": "120100",
                "contact": "谢鑫",
                "country": "CN",
                "district": "120116",
                "dropoffSiteId": "3964",
                "phone": "13132506633",
                "name": "天津滨海营业部",
                "province": "120000",
                "street1": "天津塘沽区香山道178号荣马物流园内A-1库",
                "street2": "",
                "street3": "",
                "type": "DROP_OFF"
            }
        ],
        "href": null,
        "next": null,
        "prev": null,
        "limit": 50,
        "offset": 1,
        "total": 757
    }
}

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)

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

Responses

200 successful operation

application/json

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

响应示例

{
    "handoverSheet": {
        "base64Str": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9Db2xvclNwYWNlL0RldmljZVJHQi9TdWJ0eXBlL0ltYWdlL0h..."
    }
}

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)

//※ 包裹跟踪号[原接口trackingNumberList]
tracking_numbers: string[]

//※ 标签格式：A4- 适用于打印A4格式标签，THERMAL_PAPER - 适用于打印4寸的热敏标签纸格式标签[原接口pageSize]
page_size: string

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

Responses

200 OK

application/json

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

响应示例

{
    "labels": [
        {
            "base64Str": "JVBERi0xLjcKJeLjz9MKNSAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3Ro...",
            "message": "success",
            "resultCode": "200",
            "trackingNumber": null
        }
    ]
}

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[原接口incoterms]
    incoterm: enum[0, 1]
    // item information[原接口itemList]
    items: {
      // eBay买家ID
      buyerId: string
      // 买家税号id
      buyerTaxId: string
      // 买家税号类型
      buyerTaxType: string
      // 卖家是否代缴税
      ebayCollectAndRemitTax: boolean
      // 卖家税号
      ebayCollectAndRemitTaxesValue: string
      // 买家eBay电邮
      email: string
      //※ eBay物品号[原接口itemId]
      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[原接口postedQty]
      postedQuantity: integer
      // 站点ID
      siteId: integer
      //※ SKU information
      sku: {
        //※ 单个商品申报价格，单位固定为美元，系统会根据收货地址的国家自动转换为该国家对应的货币单位.（汇率由ebay提供）
        price: {
	  // price字段对应币种，默认币种为美元--currency,value为同时必填
          currency: string
	  // price金额--currency,value为同时必填
          value: string
        }
        // 带电资质证书ID，若包裹带电则必填[原接口elecQuaId]
        elecQualificationId: string
        fdcSkus: {
	  // 商品数量（SKUID与quantity需成对填写）[原接口qty]
          quantity: integer
	  // 智慧仓商品库内编码（SKUID与quantity需成对填写）
          skuId: string
        }[]
        // 高度（cm）
        height: number
        // 长度（cm）--【0.01<length<99.99】
        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--currency,value为同时必填，若为空，则价格对象赋值null即可【soldPrice:null】
      soldPrice: {
          // price字段对应币种，默认币种为美元
          currency: string
	  // price金额
          value: string
      }
      // 卖出数量[原接口soldQty]
      soldQuantity: integer
      //※ eBay交易号
      transactionId: string
    }[]
    // 包裹备注信息
    packageComment: string
    //※ 包裹高度（cm）
    packageHeight: number
    //※ 包裹长度（cm）
    packageLength: number
    // 包裹重量（g）
    packageWeight: number
    //※ 包裹宽度（cm）
    packageWidth: number
    //※ 物流服务ID，目前支持：ES标准、EE经济、EM迷你小包[原接口serviceId]
    shippingServiceId: string
    //※ 发货地址ID（审核通过），日本始发非必填
    shipFromAddressId: string
    //※ 收货地址
    shipToAddress: {
      //※ 城市
      city: string
      // 公司
      company: string
      //※ 联系人
      contact: string
      //※ 国家代码 请参考地址编码说明
      countryCode: string
      // 国家名称
      countryName: string
      // 区
      district: string
      // 移动电话[原接口mobile]
      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
    // 该笔交易的第几个包裹。用于“一笔交易上传多次包裹”拆包裹发货，首次创建包裹时该字段无需填写，当后面再次上传包裹，maxQuantityLimit为必填【5>=maxQuantityLimit>1】
    maxQuantityLimit: integer
  }
}

请求示例

{
  "packageInfo": {
    "agentInfoRequest": {
      "agentAddress": "",
      "agentName": "",
      "agentPhone": ""
    },
    "consignPreferenceId": "2000039",
    "incoterms": "0",
    "items": [
      {
        "buyerId": "joyzhe_jrjpzddv",
        "buyerTaxId": "",
        "buyerTaxType": "",
        "ebayCollectAndRemitTax": true,
        "ebayCollectAndRemitTaxesValue": "",
        "email": "",
        "listingId": "202512110019",
        "itemTitle": "",
        "message": "",
        "orderId": "",
        "orderLineItem": "202512110019-202512110019",
        "payPalEmail": "",
        "payPalMessage": "",
        "paymentDate": "2024-07-02T13:13:48.000+08:00",
        "postedQuantity": 3,
        "receivedAmount": 10,
        "siteId": 0,
        "sku": {
          "elecQualificationId": "",
          "fdcSkus": [
            {
              "quantity": 0,
              "skuId": ""
            }
          ],
          "height": 10,
          "isLiBattery": true,
          "length": 10,
          "liBatteryType": "0",
          "nameEn": "test",
          "nameZh": "测试",
          "origin": "CN",
          "price": {
            "currency": "GBP",
            "value": "10.113"
          },
          "remark": "",
          "skuNumber": "",
          "tariffCode": "",
          "weight": 50,
          "width": 10
        },
        "soldDate": "",
        "soldPrice": {
          "currency": "GBP",
          "value": "11.223"
        },
        "soldQty": 2,
        "transactionId": "202512110019"
      }
    ],
    "packageComment": "",
    "packageHeight": 10,
    "packageLength": 20,
    "packageWeight": 22,
    "packageWidth": 33,
    "shippingServiceId": "ES",
    "shipFromAddressId": "90000082",
    "shipToAddress": {
      "city": "Lancaster",
      "company": "",
      "contact": "Ute Brenner",
      "countryCode": "GB",
      "countryName": "United Kingdom",
      "district": "",
      "phone": "015754293519",
      "postcode": "78634-2231",
      "province": "Greater Manchester",
      "street1": "Quarryman",
      "street2": "",
      "street3": ""
    },
    "specialServiceDetail": {
      "insuranceFee": "",
      "packagingType": "",
      "signatureType": "",
      "specialServiceTypes": []
    },
    "valueForCarriage": ""
  }
}

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

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
  }
}

响应示例

{
    "createPackageResult": {
        "estimateCost": {
            "currency": "CNY",
            "value": "19.8748"
        },
        "packageId": "1666770281817702476",
        "trackingNumber": "ES1002853394192000100000000N"
    }
}

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[]
  }
}

请求示例

{
  "requests": {
    "packageIds": [1666775763930316876,1666776032758988876]
  }
}

Responses

200 successful operation

application/json

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

响应示例

{
    "responses": [
        {
            "message": "success",
            "packageId": "1666775763930316876",
            "resultCode": "200"
        },
        {
            "message": "success",
            "packageId": "1666776032758988876",
            "resultCode": "200"
        }
    ]
}

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[]
  }
}

请求示例

{
  "requests": {
    "packageIds": [1666775763930316876,1666776032758988876]
  }
}

Responses

200 successful operation

application/json

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

响应示例

{
    "responses": [
        {
            "message": "success",
            "packageId": "1666775763930316876",
            "resultCode": "200"
        },
        {
            "message": "success",
            "packageId": "1666776032758988876",
            "resultCode": "200"
        }
    ]
}

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[]
  }
}

请求示例

{
  "requests": {
    "packageIds": [1666770281817702476]
  }
}

Responses

200 successful operation

application/json

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

响应示例

{
    "responses": [
        {
            "message": "success",
            "packageId": "1666773223846707276",
            "resultCode": "200"
        }
    ]
  
}

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: enum[5, 0, 4, 1, 2, 3, 6, 9, 8, 11, 12, 13, 14, 99, 15, 16, 17]
    // 包裹跟踪号
    trackingNumber: string
  }[]
}

包裹状态枚举的详细说明：

状态码‌	‌状态名称‌	‌说明‌
5	DECLARED_FAILED	预申报未通过
0	PACKAGE_INFO_LACK	信息不完整
4	NO_USEFUL_SHIPPING	无可用物流方案
1	SELECTED_SHIPPING	待选择物流方案
2	APPLIED_TRACKING_CODE	待申请运单号
3	TO_BE_SHIPPED	待交运
6	TO_BE_RECEIVED	待取件
8	ON_SHIPPING	运输中
9	DELIVERED	已妥投
11	DELETED	已删除
12	SHIPPED_ERROR	物流状态异常
14	RETURNED	已退货
99	EXCEPTION	异常
15	FDCVALIDATIONFAILED	FDC验证失败
16	FDCVALIDATIONINPROGRESS	FDC验证正在进行中
17	DELIVERY_EXCEPTION	交付异常

响应示例

{
    "itemPackages": [
        {
            "packageId": "1662873004271206476",
            "packageStatus": 6,
            "trackingNumber": "ES1002853334055000100000000N"
        },
        {
            "packageId": "1666772614086656076",
            "packageStatus": 2,
            "trackingNumber": null
        },
        {
            "packageId": "1666775763930316876",
            "packageStatus": 2",
            "trackingNumber": null
        },
        {
            "packageId": "1666776032758988876",
            "packageStatus": 2,
            "trackingNumber": null
        }
    ]
}

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]
  }
}

包裹状态枚举的详细说明：

状态码‌	‌状态名称‌	‌说明‌
5	DECLARED_FAILED	预申报未通过
0	PACKAGE_INFO_LACK	信息不完整
4	NO_USEFUL_SHIPPING	无可用物流方案
1	SELECTED_SHIPPING	待选择物流方案
2	APPLIED_TRACKING_CODE	待申请运单号
3	TO_BE_SHIPPED	待交运
6	TO_BE_RECEIVED	待取件
8	ON_SHIPPING	运输中
9	DELIVERED	已妥投
11	DELETED	已删除
12	SHIPPED_ERROR	物流状态异常
14	RETURNED	已退货
99	EXCEPTION	异常
15	FDCVALIDATIONFAILED	FDC验证失败
16	FDCVALIDATIONINPROGRESS	FDC验证正在进行中
17	DELIVERY_EXCEPTION	交付异常

响应示例

{
    "packageDetail": {
        "agentInfoResponse": {
            "agentAddress": "street",
            "agentName": "测试EU",
            "agentPhone": "490373"
        },
        "consignPreferenceId": "2000039",
        "incoterm": 0,
        "items": [
            {
                "buyerId": "joyzhe_jrjpzddv",
                "soldPrice": {
                    "currency": "USD",
                    "value": "3.0"
                },
                "listingId": "202412110019",
                "itemTitle": "Clear White Quartz Crystal Cluster Mineral Specimen 135g",
                "orderId": "cfb2fe36-fd25-4b7b-bb87-4d56456f0c3e",
                "orderLineItem": "202412110019-202412110019",
                "paymentDate": "2025-01-13T16:15:17+08:00",
                "postedQuantity": 1,
                "sku": {
                    "price": {
                        "currency": "GBP",
                        "value": "10.11"
                    },
                    "height": 10.0,
                    "length": 10.0,
                    "liBatteryType": 0,
                    "nameEn": "test",
                    "nameZh": "测试",
                    "origin": "CN",
                    "remark": "",
                    "skuNumber": "",
                    "tariffCode": "",
                    "weight": 50.0,
                    "width": 50.0,
                    "isLiBattery": false
                },
                "soldDate": "2025-01-13T16:15:17+08:00",
                "soldQuantity": 1,
                "transactionId": "202412110019"
            }
        ],
        "packageComment": "",
        "packageHeight": 10.0,
        "packageId": "1662829405772185676",
        "packageLength": 20.0,
        "packageWeight": 22.0,
        "packageWidth": 33.0,
        "shippingServiceId": "ES",
        "shipFromAddressId": "90000082",
        "shipToAddress": {
            "city": "Lancaster",
            "contact": "Ute Brenner",
            "countryCode": "GB",
            "countryName": "United Kingdom",
            "phone": "015754293519",
            "postcode": "78634-2231",
            "province": "Greater Manchester",
            "street1": "Quarryman",
            "street2": ""
        },
        "specialServiceDetail": {},
        "valueForCarriage": "",
        "packageStatus": 6
    }
}

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

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
  }
}

响应示例

{
    "clonePackageResult": {
	"packageId": "1662829405232185676",
	"trackingNumber": "ES1002853222872000100000000N"
    }
}

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
  }
}

响应示例

{
    "confirmResult": {
        "packageId": "1666779915032985676"
    }
}

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[原接口pageNumber]
offset: integer

// 分页大小，默认值：50，最大值100[原接口pageSize]
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
    }[]
  }
}

响应示例

{
    "serviceList": {
        "href": null,
        "next": null,
        "prev": null,
        "limit": 50,
        "offset": 1,
        "total": 2,
        "services": [
            {
                "descriptionEn": "<p class="MsoNormal" ...</p>",
                "descriptionHk": "<p class="MsoNormal" ...</p>",
                "descriptionZh": "<p class="MsoNormal" ...</p>",
                "directions": [
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "US"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "GB"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "PR"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "GU"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "AT"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "BE"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "CH"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "CZ"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "DK"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "FR"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "HU"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "IE"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "IT"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "NL"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "PL"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "PT"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "SE"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "AU"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "DE"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "VI"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "CA"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "NZ"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "GR"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "HR"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "ES"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "FI"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "NO"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "IS"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "SI"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "MT"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "LV"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "RO"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "SK"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "EE"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "BG"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "LT"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "MD"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "LU"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "CY"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "BA"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "RS"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "MK"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "AL"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "ME"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "BY"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "LI"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "SM"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "AD"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "TR"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "MC"
                    },
                    {
                        "batteryType": "0,2,4",
                        "from": "CN",
                        "to": "FO"
                    }
                ],
                "incoterm": 0,
                "maxLength": null,
                "maxTotalLength": null,
                "maxWeight": null,
                "nameEn": "Standard",
                "nameHk": "標準",
                "nameZh": "标准",
                "shippingServiceId": "ES"
            },
            {
                "descriptionEn": "<p class="MsoNormal" ...</p>",
                "descriptionHk": "<p class="MsoNormal" ...</p>",
                "descriptionZh": "<p class="MsoNormal" ...</p>",
                "directions": [
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "DE"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "GB"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "ES"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "PL"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "BE"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "CH"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "NL"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "FR"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "AD"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "AL"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "BA"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "BG"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "CY"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "CZ"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "EE"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "FO"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "GR"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "HR"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "HU"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "IS"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "LI"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "LT"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "LU"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "LV"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "MC"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "PT"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "RO"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "RS"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "SE"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "SI"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "SK"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "SM"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "TR"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "AT"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "DK"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "IT"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "NO"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "FI"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "AU"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "MT"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "MD"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "ME"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "MK"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "IE"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "CA"
                    }
                ],
                "incoterm": 0,
                "maxLength": null,
                "maxTotalLength": null,
                "maxWeight": null,
                "nameEn": "Economy",
                "nameHk": "經濟",
                "nameZh": "经济",
                "shippingServiceId": "EE"
            }
        ]
    }
}

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)

//※ 包裹跟踪号[原接口trackingNumber]
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
  }[]
}

响应示例

{
    "trackingDetails": [
        {
	    	"trackingNumber":"ES1002853222872000100000000N",
            "city": null,
            "country": "HK",
            "descriptionEn": "Departed from Origin Country",
            "descriptionZh": "始发地出发",
            "district": null,
            "eventPostalCode": "7707",
            "eventTime": "2025-01-13T03:24:00+08:00",
            "province": null,
            "status": "FIRST_SCAN"
        }
    ]
}

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