通过

Easyship （独立发布者） （预览版）

Easyship 提供强大的服务，可向网站添加无麻烦的全球发货选项，以及仓库、ERP 或平台的端到端发货功能。

此连接器在以下产品和区域中可用：

服务 Class 区域
Copilot Studio 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域 ：
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部（DoD）
Power Apps 高级 除以下各项外的所有 Power Apps 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
Power Automate 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
联系人​​
Name 特洛伊·泰勒
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
连接器元数据
发布者 特洛伊·泰勒
网站 https://www.easyship.com/
隐私策略 https://www.easyship.com/legal/privacy
类别 业务管理;商业

正在创建连接

连接器支持以下身份验证类型：
默认 用于创建连接的参数。 所有区域 不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name 类型 Description 必选
API 访问令牌（格式为：Bearer APIAccessToken） securestring API 访问令牌（格式为：持有者 APIAccessToken）用于此 API True

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

列出所有发货

检索所有发货的列表。
列出所有框

检索所有可用快递箱的列表。
创建发货

创建和检索有关发货的信息。
删除发货（V1）

删除并收到发货删除的确认。
更新仓库状态

更新发货的仓库状态。 仅适用于在 Easyship 集成仓库之一完成的货物。
更新发货

更新发货详细信息。
获取发货

获取发货的详细信息。
获取可用的取件槽（V1）

将在当地时间和未来 7 天内计算特定快递员的可用取件槽。 然后，可以使用“请求取件”作请求取件。
获取检查点

检索发货检查点的详细信息。
获取费率和税款

检索潜在发货的发货报价列表。
获取跟踪状态

检索发货的跟踪状态。
获取项目类别

检索使用类别的发货类别列表和滑行。
请求取件 （V1）

创建取件时，将直接向快递公司发出取件请求，该请求将返回参考号。 联系快递员的客户服务时，可以使用参考号。 必须选择取件槽;可以使用“获取可用取件槽”作找到即将推出的取件槽。
购买发货标签 （V1）

购买和检索有关发货标签的信息。

列出所有发货

操作 ID:
ListAllShipments

检索所有发货的列表。

参数

名称 密钥 必需 类型 说明
简易发货 ID
 easyship_shipment_id string

Easyship 发货唯一标识符。
平台订单号
 platform_order_number string

平台订单号。
页
 page integer

页面。
每页
 per_page integer

每页的编号。
创建自
 created_at_from string

从中创建的。
创建时间到
 created_at_to string

创建位置。
在发件人处确认
 confirmed_at_from string

确认从中。
确认到
 confirm_at_to string

确认到该位置。
标签从
 label_generated_at_from string

标签从中生成。
生成到的标签
 label_generated_at_to string

生成到的标签。
发货状态
 shipment_state string

发货状态。
取件状态
 pickup_state string

取件状态。
传递状态
 delivery_state string

传递状态。
标签状态
 label_state string

标签状态。
仓库状态
 warehouse_state string

仓库状态。

返回

名称 路径 类型 说明
发货
 shipments array of object
简易发货 ID
 shipments.easyship_shipment_id string

Easyship 发货唯一标识符。
创建时间
 shipments.created_at string

创建位置。
已更新时间
 shipments.updated_at string

更新时间。
标签付费
 shipments.label_paid_at string

该标签的付费位置。
生成的标签
 shipments.label_generated_at string

生成的位置。
订单创建时间
 shipments.order_created_at string

创建的订单。
地址
 shipments.origin_address.line_1 string

地址。
地址行 2
 shipments.origin_address.line_2 string

地址行 2。
State
 shipments.origin_address.state string

省/市/自治区。
City
 shipments.origin_address.city string

城市。
邮政编码
 shipments.origin_address.postal_code string

邮政编码。
国家/地区代码
 shipments.origin_address.country_alpha2 string

国家/地区代码。
联系人姓名
 shipments.origin_address.contact_name string

联系人姓名。
公司名称
 shipments.origin_address.company_name string

公司名称。
联系人电话
 shipments.origin_address.contact_phone string

联系人电话号码。
联系电子邮件地址
 shipments.origin_address.contact_email string

联系人电子邮件地址。
地址
 shipments.sender_address.line_1 string

地址。
地址行 2
 shipments.sender_address.line_2 string

地址行 2。
State
 shipments.sender_address.state string

省/市/自治区。
City
 shipments.sender_address.city string

城市。
邮政编码
 shipments.sender_address.postal_code string

邮政编码。
国家/地区代码
 shipments.sender_address.country_alpha2 string

国家/地区代码。
联系人姓名
 shipments.sender_address.contact_name string

联系人姓名。
公司名称
 shipments.sender_address.company_name string

公司名称。
联系人电话
 shipments.sender_address.contact_phone string

联系人电话号码。
联系电子邮件地址
 shipments.sender_address.contact_email string

联系人电子邮件地址。
地址
 shipments.return_address.line_1 string

地址。
地址行 2
 shipments.return_address.line_2 string

地址行 2。
State
 shipments.return_address.state string

省/市/自治区。
City
 shipments.return_address.city string

城市。
邮政编码
 shipments.return_address.postal_code string

邮政编码。
国家/地区代码
 shipments.return_address.country_alpha2 string

国家/地区代码。
联系人姓名
 shipments.return_address.contact_name string

联系人姓名。
公司名称
 shipments.return_address.company_name string

公司名称。
联系人电话
 shipments.return_address.contact_phone string

联系人电话号码。
联系电子邮件地址
 shipments.return_address.contact_email string

联系人电子邮件地址。
地址
 shipments.destination_address.line_1 string

地址。
地址行 2
 shipments.destination_address.line_2 string

地址行 2。
State
 shipments.destination_address.state string

省/市/自治区。
City
 shipments.destination_address.city string

城市。
邮政编码
 shipments.destination_address.postal_code string

邮政编码。
国家/地区代码
 shipments.destination_address.country_alpha2 string

国家/地区代码。
联系人姓名
 shipments.destination_address.contact_name string

联系人姓名。
公司名称
 shipments.destination_address.company_name string

公司名称。
联系人电话
 shipments.destination_address.contact_phone string

联系人电话号码。
联系电子邮件地址
 shipments.destination_address.contact_email string

联系人电子邮件地址。
平台名称
 shipments.order_data.platform_name string

平台名称。
平台订单号
 shipments.order_data.platform_order_number string

平台订单号。
订单标记列表
 shipments.order_data.order_tag_list array of string

订单标记列表
卖方说明
 shipments.order_data.seller_notes string

卖方指出。
买家备注
 shipments.order_data.buyer_notes string

买家指出。
设置为住宅
 shipments.set_as_residential boolean

是否设置为住宅。
Consignee 税务 ID
 shipments.consignee_tax_id string

受托人税务标识符。
EEI 参考
 shipments.eei_reference string

EEI 参考。
Incoterms
 shipments.incoterms string

incoterms。
被保险
 shipments.insurance.is_insured boolean

是否被保险。
已保险金额
 shipments.insurance.insured_amount integer

被保险金额。
已保险货币
 shipments.insurance.insured_currency string

被保险货币。
包裹
 shipments.parcels array of object
总实际权重
 shipments.parcels.total_actual_weight float

总实际权重。
海关总值
 shipments.parcels.total_customs_value float

海关总值。
总维度权重
 shipments.parcels.total_dimensional_weight float

总维度权重。
总体积重量
 shipments.parcels.total_volumetric_weight float

总体积重量。
ID
 shipments.parcels.box.id string

唯一标识符。
Courier Umbrella 名称
 shipments.parcels.box.courier_umbrella_name string

快递伞名称。
Name
 shipments.parcels.box.name string

名称。
Slug
 shipments.parcels.box.slug string

唠叨
外部长度
 shipments.parcels.box.outer_length float

外部长度。
外部宽度
 shipments.parcels.box.outer_width float

外部宽度。
外部高度
 shipments.parcels.box.outer_height float

外部高度。
Weight
 shipments.parcels.box.weight integer

权重。
物品
 shipments.parcels.items array of object
Description
 shipments.parcels.items.description string

说明。
类别
 shipments.parcels.items.category string

类别。
SKU
 shipments.parcels.items.sku string

SKU。
数量
 shipments.parcels.items.quantity integer

数量。
实际权重
 shipments.parcels.items.actual_weight integer

实际权重。
维度权重
 shipments.parcels.items.dimensional_weight integer

维度权重。
体积重量
 shipments.parcels.items.volumetric_weight integer

体积重量。
源货币
 shipments.parcels.items.origin_currency string

原点货币。
原点海关值
 shipments.parcels.items.origin_customs_value integer

原点海关值。
声明货币
 shipments.parcels.items.declared_currency string

声明的货币。
申报海关值
 shipments.parcels.items.declared_customs_value integer

申报的海关值。
长度
 shipments.parcels.items.dimensions.length integer

长度。
宽度
 shipments.parcels.items.dimensions.width integer

宽度。
高度
 shipments.parcels.items.dimensions.height integer

高度。
海关总值
 shipments.total_customs_value float

海关总值。
总实际权重
 shipments.total_actual_weight float

总实际权重。
总维度权重
 shipments.total_dimensional_weight float

总维度权重。
总体积重量
 shipments.total_volumetric_weight float

总体积重量。
发货状态
 shipments.shipment_state string

发货状态。
取件状态
 shipments.pickup_state string

取件状态。
传递状态
 shipments.delivery_state string

传递状态。
标签状态
 shipments.label_state string

标签状态。
仓库状态
 shipments.warehouse_state string

仓库状态。
跟踪
 shipments.trackings array of object
跟踪编号
 shipments.trackings.tracking_number string

跟踪编号。
本地跟踪编号
 shipments.trackings.local_tracking_number string

本地跟踪编号。
备用跟踪号
 shipments.trackings.alternate_tracking_number string

备用跟踪号。
腿号
 shipments.trackings.leg_number integer

腿号。
Handler
 shipments.trackings.handler string

处理程序。
跟踪状态
 shipments.trackings.tracking_state string

跟踪状态。
跟踪页面 URL
 shipments.tracking_page_url string

跟踪页 URL 地址。
寄送文档
 shipments.shipping_documents array of

发货文档。
货币
 shipments.currency string

货币。
ID
 shipments.selected_courier.id string

唯一标识符。
率
 shipments.rates array of object
Courier ID
 shipments.rates.courier_id string

信使唯一标识符。
Courier 名称
 shipments.rates.courier_name string

信使名称。
最小交付时间
 shipments.rates.min_delivery_time integer

最短的传递时间。
最大交付时间
 shipments.rates.max_delivery_time integer

最长传递时间。
价值货币排名
 shipments.rates.value_for_money_rank integer

货币排名的价值。
传递时间排名
 shipments.rates.delivery_time_rank integer

传递时间排名。
发货费用
 shipments.rates.shipment_charge float

发货费用。
燃油附加费
 shipments.rates.fuel_surcharge float

燃油附加费。
远程区域附加费
 shipments.rates.remote_area_surcharge integer

偏远地区附加费。
超大附加费
 shipments.rates.oversized_surcharge integer

超大附加费。
其他服务附加费
 shipments.rates.additional_services_surcharge integer

额外的服务附加费。
住宅完整费用
 shipments.rates.residential_full_fee integer

住宅全额费用。
住宅折扣费
 shipments.rates.residential_discounted_fee integer

住宅折扣费。
发货费用总计
 shipments.rates.shipment_charge_total float

发货费用总计。
仓库处理费
 shipments.rates.warehouse_handling_fee integer

仓库处理费。
保险费
 shipments.rates.insurance_fee integer

保险费。
营业税
 shipments.rates.sales_tax integer

销售税。
省销售税
 shipments.rates.provincial_sales_tax integer

省级销售税。
DDP 处理费
 shipments.rates.ddp_handling_fee integer

DDP 处理费用。
导入税款
 shipments.rates.import_tax_charge integer

进口税。
导入关税费用
 shipments.rates.import_duty_charge integer

进口关税。
总费用
 shipments.rates.total_charge float

总费用。
高于阈值
 shipments.rates.is_above_threshold boolean

是否高于阈值。
Incoterms
 shipments.rates.incoterms string

incoterms。
估计的进口税
 shipments.rates.estimated_import_tax integer

估计的进口税。
估计的导入关税
 shipments.rates.estimated_import_duty integer

估计的进口关税。
可用交接选项
 shipments.rates.available_handover_options string

可用的交接选项。
跟踪分级
 shipments.rates.tracking_rating integer

跟踪分级。
Easyship Rating
 shipments.rates.easyship_rating integer

Easyship 评级。
信使备注
 shipments.rates.courier_remarks string

快递员的讲话。
付款收件人
 shipments.rates.payment_recipient string

付款收件人。
Code
 shipments.rates.discount.code string

代码。
金额
 shipments.rates.discount.amount integer

金额。
到期时间
 shipments.rates.discount.expires_at string

过期时间。
百分比
 shipments.rates.discount.percentage string

百分比。
有效的 Incoterms
 shipments.rates.effective_incoterms string

有效的内行。

列出所有框

操作 ID:
ListAllBoxes

检索所有可用快递箱的列表。

返回

名称 路径 类型 说明
盒
 boxes array of object
ID
 boxes.id string

唯一标识符。
Courier Umbrella 名称
 boxes.courier_umbrella_name string

快递伞名称。
Name
 boxes.name string

名称。
Slug
 boxes.slug string

唠叨
外部长度
 boxes.outer_length float

外部长度。
外部宽度
 boxes.outer_width float

外部宽度。
外部高度
 boxes.outer_height float

外部高度。
Weight
 boxes.weight float

权重。

创建发货

操作 ID:
CreateAShipment

创建和检索有关发货的信息。

参数

名称 密钥 必需 类型 说明
地址
 line_1 string

地址。
地址行 2
 line_2 string

地址行 2。
State
 state string

省/市/自治区。
City
 city string

城市。
邮政编码
 postal_code string

邮政编码。
国家/地区代码
 country_alpha2 string

国家/地区代码。
联系人姓名
 contact_name string

联系人姓名。
公司名称
 company_name string

公司名称。
联系人电话
 contact_phone string

联系人电话号码。
联系电子邮件地址
 contact_email string

联系人电子邮件地址。
地址
 line_1 string

地址。
地址行 2
 line_2 string

地址行 2。
State
 state string

省/市/自治区。
City
 city string

城市。
邮政编码
 postal_code string

邮政编码。
国家/地区代码
 country_alpha2 string

国家/地区代码。
联系人姓名
 contact_name string

联系人姓名。
公司名称
 company_name string

公司名称。
联系人电话
 contact_phone string

联系人电话号码。
联系电子邮件地址
 contact_email string

联系人电子邮件地址。
地址
 line_1 string

地址。
地址行 2
 line_2 string

地址行 2。
State
 state string

省/市/自治区。
City
 city string

城市。
邮政编码
 postal_code string

邮政编码。
国家/地区代码
 country_alpha2 string

国家/地区代码。
联系人姓名
 contact_name string

联系人姓名。
公司名称
 company_name string

公司名称。
联系人电话
 contact_phone string

联系人电话号码。
联系电子邮件地址
 contact_email string

联系人电子邮件地址。
地址
 line_1 string

地址。
地址行 2
 line_2 string

地址行 2。
State
 state string

省/市/自治区。
City
 city string

城市。
邮政编码
 postal_code string

邮政编码。
国家/地区代码
 country_alpha2 string

国家/地区代码。
联系人姓名
 contact_name string

联系人姓名。
公司名称
 company_name string

公司名称。
联系人电话
 contact_phone string

联系人电话号码。
联系电子邮件地址
 contact_email string

联系人电子邮件地址。
设置为住宅
 set_as_residential boolean

是否设置为住宅。
Consignee 税务 ID
 consignee_tax_id string

受托人税务标识符。
EEI 参考
 eei_reference string

EEI 参考。
Incoterms
 incoterms string

incoterms。
被保险
 is_insured boolean

是否被保险。
已保险金额
 insured_amount integer

被保险金额。
已保险货币
 insured_currency string

被保险货币。
平台名称
 platform_name string

平台名称。
平台订单号
 platform_order_number string

平台订单号。
订单标记列表
 order_tag_list array of string

订单标记列表。
卖方说明
 seller_notes string

卖方指出。
买家备注
 buyer_notes string

买家指出。
所选信使 ID
 selected_courier_id string

所选的快递标识符。
允许 Courier 回退
 allow_courier_fallback boolean

是否允许快递回退。
应用发货规则
 apply_shipping_rules boolean

是否应用了发货规则。
Weight
 weight string

权重。
尺寸
 dimensions string

维度。
Format
 format string

格式。
标签
 label string

标签。
商业发票
 commercial_invoice string

商业发票。
包装单
 packing_slip string

包装单。
购买标签
 buy_label boolean

是否购买标签。
购买标签同步
 buy_label_synchronous boolean

标签是否同步购买。
总实际权重
 total_actual_weight float

总实际权重。
Slug
 slug string
长度
 length integer

长度。
宽度
 width integer

宽度。
高度
 height integer

高度。
Description
 description string

说明。
类别
 category string

类别。
SKU
 sku string

SKU。
数量
 quantity integer

数量。
长度
 length string

长度。
宽度
 width string

宽度。
高度
 height string

高度。
实际权重
 actual_weight integer

实际权重。
声明货币
 declared_currency string

声明的货币。
申报海关值
 declared_customs_value integer

申报的海关值。

返回

名称 路径 类型 说明
状态
 status string

状态。
Errors
 errors array of

错误。
简易发货 ID
 shipment.easyship_shipment_id string

Easyship 发货标识符。
创建时间
 shipment.created_at string

创建位置。
已更新时间
 shipment.updated_at string

在更新时。
标签付费
 shipment.label_paid_at string

该标签的付费位置。
生成的标签
 shipment.label_generated_at string

生成的标签。
订单创建时间
 shipment.order_created_at string

创建的订单。
地址
 shipment.origin_address.line_1 string

地址。
地址行 2
 shipment.origin_address.line_2 string

地址行 2。
State
 shipment.origin_address.state string

省/市/自治区。
City
 shipment.origin_address.city string

城市。
邮政编码
 shipment.origin_address.postal_code string

邮政编码。
国家/地区代码
 shipment.origin_address.country_alpha2 string

国家/地区代码。
联系人姓名
 shipment.origin_address.contact_name string

联系人姓名。
公司名称
 shipment.origin_address.company_name string

公司名称。
联系人电话
 shipment.origin_address.contact_phone string

联系人电话号码。
联系电子邮件地址
 shipment.origin_address.contact_email string

联系人电子邮件地址。
地址
 shipment.sender_address.line_1 string

地址。
地址行 2
 shipment.sender_address.line_2 string

地址行 2。
State
 shipment.sender_address.state string

省/市/自治区。
City
 shipment.sender_address.city string

城市。
邮政编码
 shipment.sender_address.postal_code string

邮政编码。
国家/地区代码
 shipment.sender_address.country_alpha2 string

国家/地区代码。
联系人姓名
 shipment.sender_address.contact_name string

联系人姓名。
公司名称
 shipment.sender_address.company_name string

公司名称。
联系人电话
 shipment.sender_address.contact_phone string

联系人电话号码。
联系电子邮件地址
 shipment.sender_address.contact_email string

联系人电子邮件地址。
地址
 shipment.return_address.line_1 string

地址。
地址行 2
 shipment.return_address.line_2 string

地址行 2。
State
 shipment.return_address.state string

省/市/自治区。
City
 shipment.return_address.city string

城市。
邮政编码
 shipment.return_address.postal_code string

邮政编码。
国家/地区代码
 shipment.return_address.country_alpha2 string

国家/地区代码。
联系人姓名
 shipment.return_address.contact_name string

联系人姓名。
公司名称
 shipment.return_address.company_name string

公司名称。
联系人电话
 shipment.return_address.contact_phone string

联系人电话号码。
联系电子邮件地址
 shipment.return_address.contact_email string

联系人电子邮件地址。
地址
 shipment.destination_address.line_1 string

地址。
地址行 2
 shipment.destination_address.line_2 string

地址行 2。
State
 shipment.destination_address.state string

省/市/自治区。
City
 shipment.destination_address.city string

城市。
邮政编码
 shipment.destination_address.postal_code string

邮政编码。
国家/地区代码
 shipment.destination_address.country_alpha2 string

国家/地区代码。
联系人姓名
 shipment.destination_address.contact_name string

联系人姓名。
公司名称
 shipment.destination_address.company_name string

公司名称。
联系人电话
 shipment.destination_address.contact_phone string

联系人电话号码。
联系电子邮件地址
 shipment.destination_address.contact_email string

联系人电子邮件地址。
平台名称
 shipment.order_data.platform_name string

平台名称。
平台订单号
 shipment.order_data.platform_order_number string

平台订单号。
订单标记列表
 shipment.order_data.order_tag_list array of string

订单标记列表。
卖方说明
 shipment.order_data.seller_notes string

卖方指出。
买家备注
 shipment.order_data.buyer_notes string

买家指出。
设置为住宅
 shipment.set_as_residential boolean

是否设置为住宅。
Consignee 税务 ID
 shipment.consignee_tax_id string

受托人税务标识符。
EEI 参考
 shipment.eei_reference string

EEI 参考。
Incoterms
 shipment.incoterms string

incoterms。
被保险
 shipment.insurance.is_insured boolean

是否被保险。
已保险金额
 shipment.insurance.insured_amount integer

被保险金额。
已保险货币
 shipment.insurance.insured_currency string

被保险货币。
包裹计数
 shipment.parcels_count integer

包裹计数。
包裹
 shipment.parcels array of object
总实际权重
 shipment.parcels.total_actual_weight float

总实际权重。
海关总值
 shipment.parcels.total_customs_value float

海关总值。
总维度权重
 shipment.parcels.total_dimensional_weight float

总维度权重。
总体积重量
 shipment.parcels.total_volumetric_weight float

总体积重量。
ID
 shipment.parcels.box.id string

唯一标识符 。
Slug
 shipment.parcels.box.slug string

唠叨
长度
 shipment.parcels.box.length integer

长度。
宽度
 shipment.parcels.box.width integer

宽度。
高度
 shipment.parcels.box.height integer

高度。
items
 shipment.parcels.items array of object
Description
 shipment.parcels.items.description string

说明。
类别
 shipment.parcels.items.category string

类别。
SKU
 shipment.parcels.items.sku string

SKU。
数量
 shipment.parcels.items.quantity integer

数量。
实际权重
 shipment.parcels.items.actual_weight integer

实际权重。
维度权重
 shipment.parcels.items.dimensional_weight integer

维度权重。
体积重量
 shipment.parcels.items.volumetric_weight integer

体积重量。
源货币
 shipment.parcels.items.origin_currency string

原点货币。
原点海关值
 shipment.parcels.items.origin_customs_value integer

原点海关值。
声明货币
 shipment.parcels.items.declared_currency string

声明的货币。
申报海关值
 shipment.parcels.items.declared_customs_value integer

申报的海关值。
长度
 shipment.parcels.items.dimensions.length integer

长度。
宽度
 shipment.parcels.items.dimensions.width integer

宽度。
高度
 shipment.parcels.items.dimensions.height integer

高度。
海关总值
 shipment.total_customs_value float

海关总值。
总实际权重
 shipment.total_actual_weight float

总实际权重。
总维度权重
 shipment.total_dimensional_weight float

总维度权重。
总体积重量
 shipment.total_volumetric_weight float

总体积重量。
发货状态
 shipment.shipment_state string

发货状态。
取件状态
 shipment.pickup_state string

取件状态。
传递状态
 shipment.delivery_state string

传递状态。
标签状态
 shipment.label_state string

标签状态。
仓库状态
 shipment.warehouse_state string

仓库状态。
跟踪
 shipment.trackings array of object
跟踪编号
 shipment.trackings.tracking_number string

跟踪编号。
本地跟踪编号
 shipment.trackings.local_tracking_number string

本地跟踪编号。
备用跟踪号
 shipment.trackings.alternate_tracking_number string

备用跟踪号。
腿号
 shipment.trackings.leg_number integer

腿号。
Handler
 shipment.trackings.handler string

处理程序。
跟踪状态
 shipment.trackings.tracking_state string

跟踪状态。
跟踪页面 URL
 shipment.tracking_page_url string

跟踪页 URL。
寄送文档
 shipment.shipping_documents array of object
类别
 shipment.shipping_documents.category string

类别。
必选
 shipment.shipping_documents.required boolean

是否需要。
页面大小
 shipment.shipping_documents.page_size string

页面大小。
Format
 shipment.shipping_documents.format string

格式。
Base64 编码字符串
 shipment.shipping_documents.base64_encoded_strings array of string

Base64 编码的字符串。
URL
 shipment.shipping_documents.url string

URL 地址。
货币
 shipment.currency string

货币。
ID
 shipment.selected_courier.id string

唯一标识符。
率
 shipment.rates array of object
Courier ID
 shipment.rates.courier_id string

快递标识符。
Courier 名称
 shipment.rates.courier_name string

信使名称。
最小交付时间
 shipment.rates.min_delivery_time integer

最短的传递时间。
最大交付时间
 shipment.rates.max_delivery_time integer

最长传递时间。
价值货币排名
 shipment.rates.value_for_money_rank integer

货币排名的价值。
传递时间排名
 shipment.rates.delivery_time_rank integer

传递时间排名。
发货费用
 shipment.rates.shipment_charge float

发货费用。
燃油附加费
 shipment.rates.fuel_surcharge float

燃油附加费。
远程区域附加费
 shipment.rates.remote_area_surcharge integer

偏远地区附加费。
超大附加费
 shipment.rates.oversized_surcharge integer

超大附加费。
其他服务附加费
 shipment.rates.additional_services_surcharge integer

额外的服务附加费。
住宅完整费用
 shipment.rates.residential_full_fee integer

住宅全额费用。
住宅折扣费
 shipment.rates.residential_discounted_fee integer

住宅折扣费。
发货费用总计
 shipment.rates.shipment_charge_total float

发货费用总计。
仓库处理费
 shipment.rates.warehouse_handling_fee integer

仓库处理费。
保险费
 shipment.rates.insurance_fee integer

保险费。
营业税
 shipment.rates.sales_tax integer

销售税。
省销售税
 shipment.rates.provincial_sales_tax integer

省级销售税。
DDP 处理费
 shipment.rates.ddp_handling_fee integer

DDP 处理费用。
导入税款
 shipment.rates.import_tax_charge integer

导入税更改。
导入关税费用
 shipment.rates.import_duty_charge integer

进口关税。
总费用
 shipment.rates.total_charge float

总费用。
高于阈值
 shipment.rates.is_above_threshold boolean

是否高于阈值。
Incoterms
 shipment.rates.incoterms string

incoterms。
估计的进口税
 shipment.rates.estimated_import_tax integer

估计的进口税。
估计的导入关税
 shipment.rates.estimated_import_duty integer

估计的进口关税。
可用交接选项
 shipment.rates.available_handover_options string

可用的交接选项。
跟踪分级
 shipment.rates.tracking_rating integer

跟踪分级。
Easyship Rating
 shipment.rates.easyship_rating integer

Easyship 评级。
信使备注
 shipment.rates.courier_remarks string

快递员的讲话。
付款收件人
 shipment.rates.payment_recipient string

付款收件人。
Code
 shipment.rates.discount.code string

代码。
金额
 shipment.rates.discount.amount integer

金额。
到期时间
 shipment.rates.discount.expires_at string

过期时间。
百分比
 shipment.rates.discount.percentage string

百分比。
有效的 Incoterms
 shipment.rates.effective_incoterms string

有效的内行。

删除发货（V1）

操作 ID:
DeleteAShipment

删除并收到发货删除的确认。

参数

名称 密钥 必需 类型 说明
简易发货 ID
 easyship_shipment_id True string

Easyship 发货标识符。

返回

名称 路径 类型 说明
状态
 status string

状态。

更新仓库状态

操作 ID:
UpdateWarehouseState

更新发货的仓库状态。 仅适用于在 Easyship 集成仓库之一完成的货物。

参数

名称 密钥 必需 类型 说明
简易发货 ID
 easyship_shipment_id string

Easyship 发货唯一标识符。
仓库状态
 warehouse_state string

仓库状态。
Message
 message string

消息。
序列号
 serial_number string

序列号。

返回

名称 路径 类型 说明
Message
 message array of object
简易发货 ID
 message.easyship_shipment_id string

Easyship 发货唯一标识符。
仓库状态已更新
 message.warehouse_state_updated string

更新的仓库状态。

更新发货

操作 ID:
UpdateAShipment

更新发货详细信息。

参数

名称 密钥 必需 类型 说明
简易发货 ID
 easyship_shipment_id True string

Easyship 发货标识符。
目标国家/地区代码
 destination_country_alpha2 string

目标国家/地区代码。
目标城市
 destination_city string

目的地城市。
目标名称
 destination_name string

目标名称。
目标地址
 destination_address_line_1 string

目标地址。
目标电话号码
 destination_phone_number string

目标电话号码。
Description
 description string

说明。
实际权重
 actual_weight float

实际权重。
高度
 height integer

高度。
宽度
 width integer

宽度。
长度
 length integer

长度。
类别
 category string

类别。
声明货币
 declared_currency string

声明的货币。
申报海关值
 declared_customs_value integer

申报的海关值。
SKU
 sku string

SKU。
平台名称
 platform_name string

平台名称。
平台订单号
 platform_order_number string

平台订单号。
所支付的税款
 taxes_duties_paid_by string

所支付的税款和关税。
被保险
 is_insured boolean

是否被保险。
所选信使 ID
 selected_courier_id string

所选的快递标识符。
目标邮政编码
 destination_postal_code integer

目标邮政编码。
目标状态
 destination_state string

目标状态。
目标地址行 2
 destination_address_line_2 string

目标地址行 2。
目标电子邮件地址
 destination_email_address string

目标电子邮件地址。

返回

名称 路径 类型 说明
创建时间
 shipment.created_at string

创建位置。
已更新时间
 shipment.updated_at string

在更新时。
简易发货 ID
 shipment.easyship_shipment_id string

Easyship 发货标识符。
目标名称
 shipment.destination_name string

目标名称。
目标地址
 shipment.destination_address_line_1 string

目标地址。
目标地址行 2
 shipment.destination_address_line_2 string

目标地址行 2。
目标城市
 shipment.destination_city string

目的地城市。
目标状态
 shipment.destination_state string

目标状态。
目标邮政编码
 shipment.destination_postal_code string

目标邮政编码。
目标电话号码
 shipment.destination_phone_number string

目标电话号码。
目标电子邮件地址
 shipment.destination_email_address string

目标电子邮件地址。
平台名称
 shipment.platform_name string

平台名称。
平台订单号
 shipment.platform_order_number string

平台订单号。
海关总值
 shipment.total_customs_value float

海关总值。
总实际权重
 shipment.total_actual_weight float

总实际权重。
总维度权重
 shipment.total_dimensional_weight float

总维度权重。
总体积重量
 shipment.total_volumetric_weight float

总体积重量。
被保险
 shipment.is_insured boolean

是否被保险。
货币
 shipment.currency string

货币。
Name
 shipment.origin_country.name string

名称。
国家/地区代码
 shipment.origin_country.alpha2 string

国家/地区代码。
Name
 shipment.destination_country.name string

名称。
国家/地区代码
 shipment.destination_country.alpha2 string

国家/地区代码。
物品
 shipment.items array of object
ID
 shipment.items.id string

唯一标识符。
Description
 shipment.items.description string

说明。
SKU
 shipment.items.sku string

SKU。
宽度
 shipment.items.width integer

宽度。
长度
 shipment.items.length integer

长度。
高度
 shipment.items.height integer

高度。
实际权重
 shipment.items.actual_weight float

实际权重。
维度权重
 shipment.items.dimensional_weight float

维度权重。
体积重量
 shipment.items.volumetric_weight float

columetric 权重。
申报海关值
 shipment.items.declared_customs_value integer

申报的海关值。
声明货币
 shipment.items.declared_currency string

声明的货币。
原点海关值
 shipment.items.origin_customs_value float

原点海关值。
源货币
 shipment.items.origin_currency string

原点货币。
类别
 shipment.items.category string

类别。
Name
 shipment.box.name string

名称。
长度
 shipment.box.length integer

长度。
宽度
 shipment.box.width integer

宽度。
高度
 shipment.box.height integer

高度。
ID
 shipment.selected_courier.id string

唯一标识符。
Name
 shipment.selected_courier.name string

名称。
最小交付时间
 shipment.selected_courier.min_delivery_time integer

最短的传递时间。
最大交付时间
 shipment.selected_courier.max_delivery_time integer

最长传递时间。
发货费用
 shipment.selected_courier.shipment_charge float

发货费用。
燃油附加费
 shipment.selected_courier.fuel_surcharge float

燃油附加费。
远程区域附加费
 shipment.selected_courier.remote_area_surcharge integer

偏远地区附加费。
发货费用总计
 shipment.selected_courier.shipment_charge_total float

发货费用总计。
仓库处理费
 shipment.selected_courier.warehouse_handling_fee integer

仓库处理费。
保险费
 shipment.selected_courier.insurance_fee integer

保险费。
导入税款
 shipment.selected_courier.import_tax_charge integer

进口税。
导入关税费用
 shipment.selected_courier.import_duty_charge integer

进口关税。
DDP 处理费
 shipment.selected_courier.ddp_handling_fee integer

DDP 处理费用。
总费用
 shipment.selected_courier.total_charge float

总费用。
高于阈值
 shipment.selected_courier.is_above_threshold boolean

是否高于阈值。
有效的 Incoterms
 shipment.selected_courier.effective_incoterms string

有效的内行。
估计的进口税
 shipment.selected_courier.estimated_import_tax integer

估计进口税。
估计的导入关税
 shipment.selected_courier.estimated_import_duty integer

估计的进口关税。
Courier Does Pickup
 shipment.selected_courier.courier_does_pickup boolean

快递员是否取件。
Courier Dropoff URL
 shipment.selected_courier.courier_dropoff_url string

信使删除 URL 地址。
信使备注
 shipment.selected_courier.courier_remarks string

快递员的讲话。
付款收件人
 shipment.selected_courier.payment_recipient string

付款收件人。
率
 shipment.rates array of object
Courier ID
 shipment.rates.courier_id string

快递标识符。
Courier 名称
 shipment.rates.courier_name string

信使名称。
最小交付时间
 shipment.rates.min_delivery_time integer

最短的传递时间。
最大交付时间
 shipment.rates.max_delivery_time integer

最长传递时间。
价值货币排名
 shipment.rates.value_for_money_rank integer

货币排名的价值。
传递时间排名
 shipment.rates.delivery_time_rank integer

传递时间排名。
发货费用
 shipment.rates.shipment_charge float

发货费用。
燃油附加费
 shipment.rates.fuel_surcharge float

燃油附加费。
远程区域附加费
 shipment.rates.remote_area_surcharge integer

偏远地区附加费。
发货费用总计
 shipment.rates.shipment_charge_total float

发货费用总计。
仓库处理费
 shipment.rates.warehouse_handling_fee integer

仓库处理费。
保险费
 shipment.rates.insurance_fee integer

保险费。
DDP 处理费
 shipment.rates.ddp_handling_fee integer

DDP 处理费用。
导入税款
 shipment.rates.import_tax_charge integer

导入税更改。
导入关税费用
 shipment.rates.import_duty_charge integer

进口关税。
总费用
 shipment.rates.total_charge float

总费用。
高于阈值
 shipment.rates.is_above_threshold boolean

是否高于阈值。
有效的 Incoterms
 shipment.rates.effective_incoterms string

有效的内行。
估计的进口税
 shipment.rates.estimated_import_tax integer

估计的进口税。
估计的导入关税
 shipment.rates.estimated_import_duty integer

估计的进口关税。
Courier Does Pickup
 shipment.rates.courier_does_pickup boolean

快递员是否取件。
Courier Dropoff URL
 shipment.rates.courier_dropoff_url string

信使删除 URL 地址。
跟踪分级
 shipment.rates.tracking_rating integer

跟踪分级。
Easyship Rating
 shipment.rates.easyship_rating float

Easyship 评级。
信使备注
 shipment.rates.courier_remarks string

快递员的讲话。
付款收件人
 shipment.rates.payment_recipient string

付款收件人。

获取发货

操作 ID:
GetAShipment

获取发货的详细信息。

参数

名称 密钥 必需 类型 说明
简易发货 ID
 easyship_shipment_id True string

Easyship 发货标识符。
Format
 format string

格式。
标签
 label string

标签。
商业发票
 commercial_invoice string

商业发票。
包装单
 packing_slip string

包装单。

返回

名称 路径 类型 说明
创建时间
 created_at string

创建时。
已更新时间
 updated_at string

更新时。
简易发货 ID
 easyship_shipment_id string

易货发货的提要器。
目标名称
 destination_name string

目标名称。
目标地址
 destination_address_line_1 string

目标地址。
目标地址行 2
 destination_address_line_2 string

目标地址行 2。
目标城市
 destination_city string

目的地城市。
目标状态
 destination_state string

目标状态。
目标邮政编码
 destination_postal_code string

目标邮政编码。
目标电话号码
 destination_phone_number string

目标电话号码。
目标电子邮件地址
 destination_email_address string

目标电子邮件地址。
订购说明
 order_notes string

订单说明。
订单创建时间
 order_created_at string

创建的订单。
平台名称
 platform_name string

平台名称。
平台订单号
 platform_order_number string

平台订单号。
海关总值
 total_customs_value float

海关总值。
总实际权重
 total_actual_weight float

总实际权重。
总维度权重
 total_dimensional_weight float

总维度权重。
总体积重量
 total_volumetric_weight float

总体积重量。
被保险
 is_insured boolean

是否被保险。
货币
 currency string

货币。
仓库状态
 warehouse_state string

仓库状态。
Name
 origin_country.name string

名称。
国家/地区代码
 origin_country.alpha2 string

国家/地区代码。
Name
 destination_country.name string

名称。
国家/地区代码
 destination_country.alpha2 string

国家/地区代码。
物品
 items array of object
ID
 items.id string

唯一标识符。
Description
 items.title string

说明。
SKU
 items.sku string

SKU。
宽度
 items.width integer

宽度。
长度
 items.length integer

长度。
高度
 items.height integer

高度。
实际权重
 items.actual_weight float

实际权重。
维度权重
 items.dimensional_weight float

维度权重。
体积重量
 items.volumetric_weight float

体积重量。
申报海关值
 items.declared_customs_value integer

申报的海关值。
声明货币
 items.declared_currency string

声明的货币。
原点海关值
 items.origin_customs_value float

原点海关值。
源货币
 items.origin_currency string

原点货币。
类别
 items.category string

类别。
Name
 box.name string

名称。
长度
 box.length integer

长度。
宽度
 box.width integer

宽度。
高度
 box.height integer

高度。
ID
 selected_courier.id string

唯一标识符。
Name
 selected_courier.name string

名称。
最小交付时间
 selected_courier.min_delivery_time integer

最短的传递时间。
最大交付时间
 selected_courier.max_delivery_time integer

最长传递时间。
发货费用
 selected_courier.shipment_charge float

发货费用。
燃油附加费
 selected_courier.fuel_surcharge float

燃油附加费。
远程区域附加费
 selected_courier.remote_area_surcharge integer

偏远地区附加费。
发货费用总计
 selected_courier.shipment_charge_total float

发货费用总计。
仓库处理费
 selected_courier.warehouse_handling_fee integer

仓库处理费。
保险费
 selected_courier.insurance_fee integer

保险费。
导入税款
 selected_courier.import_tax_charge integer

进口税。
导入关税费用
 selected_courier.import_duty_charge integer

进口关税。
DDP 处理费
 selected_courier.ddp_handling_fee integer

DDP 处理费用。
总费用
 selected_courier.total_charge float

总费用。
高于阈值
 selected_courier.is_above_threshold boolean

是否高于阈值。
有效的 Incoterms
 selected_courier.effective_incoterms string

有效的内行。
估计的进口税
 selected_courier.estimated_import_tax integer

估计的进口税。
估计的导入关税
 selected_courier.estimated_import_duty integer

估计的进口关税。
Courier Does Pickup
 selected_courier.courier_does_pickup boolean

快递员是否取件。
Courier Dropoff URL
 selected_courier.courier_dropoff_url string

信使删除 URL 地址。
信使备注
 selected_courier.courier_remarks string

快递员的讲话。
付款收件人
 selected_courier.payment_recipient string

付款收件人。
必选
 shipping_documents.label.required boolean

是否需要。
页面大小
 shipping_documents.label.page_size string

页面大小。
Format
 shipping_documents.label.format string

格式。
Base64 编码字符串
 shipping_documents.label.base64_encoded_strings array of string

Base64 编码的字符串。
URL
 shipping_documents.label.url string

URL 地址。
Message
 shipping_documents.label.message string

消息。
必选
 shipping_documents.commercial_invoice.required boolean

是否需要。
页面大小
 shipping_documents.commercial_invoice.page_size string

页面大小。
Format
 shipping_documents.commercial_invoice.format string

格式。
Base64 编码字符串
 shipping_documents.commercial_invoice.base64_encoded_strings array of

Base64 编码的字符串。
URL
 shipping_documents.commercial_invoice.url string

URL 地址。
必选
 shipping_documents.packing_slip.required boolean

是否需要。
页面大小
 shipping_documents.packing_slip.page_size string

页面大小。
Format
 shipping_documents.packing_slip.format string

格式。
Base64 编码字符串
 shipping_documents.packing_slip.base64_encoded_strings array of string

Base64 编码的字符串。
URL
 shipping_documents.packing_slip.url string

URL 地址。
必选
 shipping_documents.battery_form.required boolean

是否需要。
页面大小
 shipping_documents.battery_form.page_size string

页面大小。
Format
 shipping_documents.battery_form.format string

格式。
Base64 编码字符串
 shipping_documents.battery_form.base64_encoded_strings array of

Base64 编码的字符串。
URL
 shipping_documents.battery_form.url string

URL 地址。
必选
 shipping_documents.battery_caution_label.required boolean

是否需要。
页面大小
 shipping_documents.battery_caution_label.page_size string

页面大小。
Format
 shipping_documents.battery_caution_label.format string

格式。
Base64 编码字符串
 shipping_documents.battery_caution_label.base64_encoded_strings array of

Base64 编码的字符串。
URL
 shipping_documents.battery_caution_label.url string

URL 地址。

获取可用的取件槽（V1）

操作 ID:
GetAvailablePickupSlots

将在当地时间和未来 7 天内计算特定快递员的可用取件槽。 然后，可以使用“请求取件”作请求取件。

参数

名称 密钥 必需 类型 说明
Courier ID
 courier_id True string

快递标识符。

返回

名称 路径 类型 说明
Courier ID
 courier_id string

快递标识符。
Courier 名称
 courier_name string

信使名称。
Message
 message string

消息。
提供程序名称
 pickup.provider_name string

提供程序名称。
提供商客户服务电话
 pickup.provider_customer_service_phone string

提供商客户服务电话号码。

获取检查点

操作 ID:
GetCheckpoints

检索发货检查点的详细信息。

参数

名称 密钥 必需 类型 说明
简易发货 ID
 easyship_shipment_id True string

Easyship 发货唯一标识符。
平台订单号
 platform_order_number string

平台订单号。
页
 page integer

页面。
每页
 per_page integer

每页的编号。

返回

名称 路径 类型 说明
总页数
 total_page integer

总页数。
当前页
 current_page integer

当前页。
发货
 shipments array of object
简易发货 ID
 shipments.easyship_shipment_id string

Easyship 发货唯一标识符。
平台订单号
 shipments.platform_order_number string

平台订单号。
Origin
 shipments.origin string

原点。
目的地
 shipments.destination string

目标。
状态
 shipments.status string

状态。
跟踪编号
 shipments.tracking_number string

跟踪编号。
跟踪页面 URL
 shipments.tracking_page_url string

跟踪页 URL 地址。
Checkpoints
 shipments.checkpoints array of object
订单编号
 shipments.checkpoints.order_number integer

订单号。
Handler
 shipments.checkpoints.handler string

处理程序。
Message
 shipments.checkpoints.message string

消息。
位置
 shipments.checkpoints.location string

位置。
City
 shipments.checkpoints.city string

城市。
国家
 shipments.checkpoints.country_name string

国家/ 地区。
国家/地区代码
 shipments.checkpoints.country_iso3 string

国家/地区代码。
坐标
 shipments.checkpoints.coordinates array of

坐标。
State
 shipments.checkpoints.state string

省/市/自治区。
邮政编码
 shipments.checkpoints.postal_code string

邮政编码。
检查点时间
 shipments.checkpoints.checkpoint_time string

检查点时间。
主要状态
 shipments.checkpoints.primary_status string

主要状态。

获取费率和税款

操作 ID:
GetRatesTaxes

检索潜在发货的发货报价列表。

参数

名称 密钥 必需 类型 说明
地址
 line_1 string

地址。
地址行 2
 line_2 string

地址行 2。
State
 state string

省/市/自治区。
City
 city string

城市。
邮政编码
 postal_code string

邮政编码。
国家/地区代码
 country_alpha2 string

国家/地区代码。
地址
 line_1 string

地址。
地址行 2
 line_2 string

地址行 2。
State
 state string

省/市/自治区。
City
 city string

城市。
邮政编码
 postal_code string

邮政编码。
国家/地区代码
 country_alpha2 string

国家/地区代码。
Incoterms
 incoterms string

incoterms。
被保险
 is_insured boolean

是否被保险。
已保险金额
 insured_amount integer

被保险金额。
已保险货币
 insured_currency string

被保险货币。
应用发货规则
 apply_shipping_rules boolean

是否应用了发货规则。
Weight
 weight string

权重。
尺寸
 dimensions string

维度。
输出货币
 output_currency string

输出货币。
总实际权重
 total_actual_weight float

总实际权重。
Slug
 slug string

引用唠叨。
长度
 length integer

长度。
宽度
 width integer

宽度。
高度
 height integer

高度。
Description
 description string

说明。
类别
 category string

类别。
SKU
 sku string

SKU。
数量
 quantity integer

数量。
长度
 length string

长度。
宽度
 width string

宽度。
高度
 height string

高度。
实际权重
 actual_weight integer

实际权重。
声明货币
 declared_currency string

声明的货币。
申报海关值
 declared_customs_value integer

申报的海关值。

返回

名称 路径 类型 说明
率
 rates array of object
Courier ID
 rates.courier_id string

信使唯一标识符。
Courier 名称
 rates.courier_name string

信使名称。
最小交付时间
 rates.min_delivery_time integer

最短的传递时间。
最大交付时间
 rates.max_delivery_time integer

最长传递时间。
价值货币排名
 rates.value_for_money_rank integer

货币排名的价值。
传递时间排名
 rates.delivery_time_rank integer

传递时间排名。
发货费用
 rates.shipment_charge float

发货费用。
燃油附加费
 rates.fuel_surcharge float

燃油附加费。
远程区域附加费
 rates.remote_area_surcharge integer

偏远地区附加费。
发货费用总计
 rates.shipment_charge_total float

发货费用总计。
仓库处理费
 rates.warehouse_handling_fee integer

仓库处理费。
保险费
 rates.insurance_fee integer

保险费。
DDP 处理费
 rates.ddp_handling_fee integer

如果 incoterm 为 DDP，则为 DDP 处理费用。
导入税款
 rates.import_tax_charge integer

进口税。
导入关税费用
 rates.import_duty_charge integer

进口关税。
总费用
 rates.total_charge float

总费用。
高于阈值
 rates.is_above_threshold boolean

是否高于阈值。
有效的 Incoterms
 rates.effective_incoterms string

有效的内行。
估计的进口税
 rates.estimated_import_tax integer

估计的进口税。
估计的导入关税
 rates.estimated_import_duty integer

估计的进口关税。
Courier Does Pickup
 rates.courier_does_pickup boolean

快递员是否取件。
Courier Dropoff URL
 rates.courier_dropoff_url string

信使删除 URL 地址。
跟踪分级
 rates.tracking_rating integer

跟踪分级。
付款收件人
 rates.payment_recipient string

付款收件人。
信使备注
 rates.courier_remarks string

快递员的讲话。
货币
 rates.currency string

货币。
Name
 rates.box.name string

名称。
长度
 rates.box.length integer

长度。
宽度
 rates.box.width integer

宽度。
高度
 rates.box.height integer

高度。
最低取件费
 rates.minimum_pickup_fee integer

最低取件费。
Description
 rates.title string

说明。
完整说明
 rates.full_description string

完整说明。

获取跟踪状态

操作 ID:
GetStatus

检索发货的跟踪状态。

参数

名称 密钥 必需 类型 说明
简易发货 ID
 easyship_shipment_id True string

Easyship 发货标识符。
平台订单号
 platform_order_number string

平台订单号。
页
 page integer

页面。
每页
 per_page integer

每页的编号。

返回

名称 路径 类型 说明
总页数
 total_page integer

总页数。
当前页
 current_page integer

当前页。
发货
 shipments array of object
简易发货 ID
 shipments.easyship_shipment_id string

Easyship 发货唯一标识符。
平台订单号
 shipments.platform_order_number string

平台订单号。
Origin
 shipments.origin string

原点。
目的地
 shipments.destination string

目标。
状态
 shipments.status string

状态。
跟踪编号
 shipments.tracking_number string

跟踪编号。
跟踪页面 URL
 shipments.tracking_page_url string

跟踪页 URL 地址。

获取项目类别

操作 ID:
GetItemCategories

检索使用类别的发货类别列表和滑行。

返回

名称 路径 类型 说明
类别
 categories array of object
Name
 categories.name string

名称。
Slug
 categories.slug string

唠叨

请求取件 （V1）

操作 ID:
RequestAPickup

创建取件时，将直接向快递公司发出取件请求，该请求将返回参考号。 联系快递员的客户服务时，可以使用参考号。 必须选择取件槽;可以使用“获取可用取件槽”作找到即将推出的取件槽。

参数

名称 密钥 必需 类型 说明
Courier ID
 courier_id string

快递标识符。
首选日期
 preferred_date string

首选日期。
首选最大时间
 preferred_max_time string

首选的最大时间。
首选最小时间
 preferred_min_time string

首选的最短时间。
简易发货 ID
 easyship_shipment_ids array of string

简易货物标识器。

返回

名称 路径 类型 说明
Courier ID
 courier_id string

快递标识符。
Courier 名称
 courier_name string

信使名称。
简易发货 ID
 easyship_shipment_ids array of string

Easyship 发货标识符。
Easyship Pickup ID
 pickup.easyship_pickup_id string

Easyship 取件标识符。
首选最小时间
 pickup.preferred_min_time string

首选的最短时间。
首选最大时间
 pickup.preferred_max_time string

首选的最大时间。
取件参考编号
 pickup.pickup_reference_number string

取件参考编号。
取件费
 pickup.pickup_fee string

取件费。
提供程序名称
 pickup.provider_name string

提供程序名称。
提供商客户服务电话
 pickup.provider_customer_service_phone string

提供商客户服务电话号码。
发货计数
 pickup.shipments_count string

发货计数。
总实际权重
 pickup.total_actual_weight string

总实际权重。
取件状态
 pickup.pickup_state string

取件状态。
地址
 pickup.address.line_1 string

地址。
地址行 2
 pickup.address.line_2 string

地址行 2。
地址行 3
 pickup.address.line_3 string

地址行 3。
邮政编码
 pickup.address.postal_code string

邮政编码。
City
 pickup.address.city string

城市。
State
 pickup.address.state string

省/市/自治区。
国家
 pickup.address.country string

国家/ 地区。
联系电子邮件地址
 pickup.address.contact_email string

联系人电子邮件地址。
联系人电话
 pickup.address.contact_phone string

联系人电话号码。
公司名称
 pickup.address.company_name string

公司名称。
联系人姓名
 pickup.address.contact_name string

联系人姓名。

购买发货标签 （V1）

操作 ID:
BuyAShipmentLabel

购买和检索有关发货标签的信息。

参数

名称 密钥 必需 类型 说明
简易发货 ID
 easyship_shipment_id string

Easyship 发货唯一标识符。
Courier ID
 courier_id string

信使唯一标识符。

返回

名称 路径 类型 说明
Message
 message string

消息。
Errors
 errors array of

错误。
总成本
 total_cost integer

总成本。
可用余额
 available_balance integer

可用余额。
标签
 labels array of object
简易发货 ID
 labels.easyship_shipment_id string

Easyship 发货唯一标识符。
标签状态
 labels.label_state string

标签的状态。
标签 URL
 labels.label_url string

标签的 URL 地址。
状态
 labels.status string

状态。
跟踪编号
 labels.tracking_number string

跟踪编号。
跟踪页面 URL
 labels.tracking_page_url string

跟踪页 URL 地址。