Easy Ship API v2022-03-23

亚马逊SPAPI

# 概述

Easy Ship的销售伙伴API可以帮助您建立应用程序,帮助卖家管理和运送亚马逊Easy Ship订单.

您的Easy Ship应用程序可以

  • 获取包裹的可用时间段,以便安排发货.

  • 安排、重新安排和取消Easy Ship订单.

  • 打印标签、发票和保证书.

参见市场支持表了解不同市场的Easy Ship操作的差异.

# Version information

版本 : 2022-03-23

# Operations

listHandoverSlots
getScheduledPackage
createScheduledPackage
updateScheduledPackages

# 路径

# listHandoverSlots

POST /easyShip/2022-03-23/timeSlot

# Description

根据卖家指定的包裹重量和尺寸,返回可供Easy Ship订单安排的时间段.

此操作可用于基于市场支持的预定和未预定的订单.参见市场支持表中的获取时间段.

该操作可以返回具有取件或落件交接方法的时间段-见市场支持表.中的**支持的交接方法

使用计划:

速率(每秒的请求) 突发
1 5

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制(如果有的话).上表显示了该操作的默认速率和突发值.业务需求需要更高的吞吐量的销售伙伴可能会看到比这里显示的更高的速率和突发值.更多信息,见使用计划和速率限制在销售伙伴API (opens new window).

# Parameters

Type Name Description Schema
Body ListHandoverSlotsRequest
optional
The request schema for the listHandoverSlots operation. ListHandoverSlotsRequest

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
ListHandoverSlotsResponse

错误状态代码、描述和模式,见错误响应和模式.

# getScheduledPackage

GET /easyShip/2022-03-23/package

# Description

返回关于包裹的信息,包括尺寸、重量、交接的时间段信息、发票和物品信息以及状态.

使用计划:

Rate (requests per second) Burst
1 5

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制(如果有的话).上表显示了该操作的默认速率和突发值.业务需求需要更高的吞吐量的销售伙伴可能会看到比这里显示的更高的速率和突发值.更多信息,见使用计划和速率限制在销售伙伴API (opens new window).

# Parameters

Type Name Description Schema
Query amazonOrderId
required
An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
minLength : 1
最大长度 : 255
string
Query marketplaceId
required
卖家所销售的市场的标识符.
minLength : 1
最大长度 : 255
string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) : 唯一的请求参考标识符.
Package

错误状态代码、描述和模式,见错误响应和模式.

# createScheduledPackage

POST /easyShip/2022-03-23/package

# Description

安排一个Easy Ship订单,并返回预定的包裹信息.

这个操作做了以下事情

  • 指定订单的时间段和交接方式,以便安排发货.

  • 更新Easy Ship订单的状态.

  • 生成运输标签和发票. 如果你指定了一个序列号'的值,调用createScheduledPackage'也会生成一个保修文件. 要获得这些文件,请看如何获得发票、运输标签和保修文件.

  • 当你调用订单销售伙伴API的getOrders'操作并检查响应体中的EasyShipShipmentStatus'属性时,显示Easy Ship订单的状态.

参见市场支持表中的发货标签发票保修列,以了解每个市场支持哪些文件.

使用计划:

速率(每秒的请求) 爆发
1 5

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制(如果有的话).上表显示了该操作的默认速率和突发值.业务需求需要更高的吞吐量的销售伙伴可能会看到比这里显示的更高的速率和突发值.更多信息,见使用计划和速率限制在销售伙伴API (opens new window).

# Parameters

Type Name Description Schema
Body CreateScheduledPackageRequest
required
The request schema for the createScheduledPackage operation. CreateScheduledPackageRequest

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) : 唯一的请求参考标识符.
Package

错误状态代码、描述和模式,见错误响应和模式.

# updateScheduledPackages

PATCH /easyShip/2022-03-23/package

# Description

更新由指定的 "scheduledPackageId "指示的移交包裹的时间段. 你可以在进行另一个 "patch "调用之前,通过调用 "listHandoverSlots "操作来获得该时间段的新 "slotId "值.

请看市场支持表中的更新包列,看看这个操作在哪些市场被支持.

使用计划:

速率(每秒的请求) 突发
1 5

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制(如果有的话).上表显示了该操作的默认速率和突发值.业务需求需要更高的吞吐量的销售伙伴可能会看到比这里显示的更高的速率和突发值.更多信息,见使用计划和速率限制在销售伙伴API (opens new window).

# Parameters

Type Name Description Schema
Body UpdateScheduledPackagesRequest
optional
The request schema for the updateScheduledPackages operation. UpdateScheduledPackagesRequest

# Responses

HTTP Code Description Schema
200 Success
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) : 唯一的请求参考标识符.
Packages

关于错误状态代码、描述和模式,见错误响应和模式.

# 错误响应和模式

该表包含HTTP状态代码和错误响应的相关信息.

HTTP Code Description Schema
400 Request有缺失或无效的参数,无法解析.
Headers
x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
401 请求的授权头格式不正确或不包含有效的令牌.

x-amzn-RateLimit-Limit (string):您对该操作的速率限制(每秒的请求).
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
**头信息
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
404 指定的资源不存在.

x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
415 请求的有效载荷是不支持的格式.
头信息
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
429 请求的频率超过了允许的范围.
标题
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
503 服务器的临时超载或维护.
头信息
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList

:唯一的请求参考标识符

# Definitions

# PackageIdentifier

可选的卖家-创建的标识符,印在运输标签上,帮助卖家识别包装.

类型:字符串

# PackageStatus

包裹的状态.

类型 : 枚举

Value Description
ReadyForPickup 该包裹已准备好提货.
PickedUp 该包裹已被取走.
AtOriginFC 该包裹在其原产地执行中心.
AtDestinationFC 该包裹在其目的地执行中心.
交付 包裹已经交付.
拒绝 包裹已被拒绝.
无法投递 该包裹无法投递.
退回给卖家 该包裹已被退回给卖家.
LostInTransit 包裹在运输途中丢失.
LabelCanceled 该包裹的标签已被取消.
在运输途中损坏 包裹在运输途中被损坏.
OutForDelivery 该包裹已被送出.

# PackageId

一个亚马逊-定义的计划包的标识符.

类型:字符串

# TrackingDetails

追踪元数据的代表.

Name Description Schema
trackingId
optional
计划包的跟踪标识符. String

# HandoverMethod

识别卖家将包裹移交给亚马逊物流的方法.

类型 : 枚举

Value Description
取货 亚马逊物流公司将从卖家的取货地址取货(s)
Dropoff 卖家需要把包裹(s)送到指定地点.

# AmazonOrderId

一个亚马逊-定义的订单标识符.标识了卖家希望使用亚马逊易发货的订单.

类型:字符串

# Dimension

指定尺寸的数值.

类型 : 数字 (float)

最小值 : 0.01

# Dimensions

预定包的尺寸.

Name Description Schema
length
optional
The length dimension. Dimension
width
optional
The width dimension. Dimension
height
optional
The height dimension. Dimension
单位
可选
用于测量长度的计量单位. UnitOfLength
identifier
optional
用于自定义包装尺寸的标识符. String

# ListHandoverSlotsRequest

用于 "listHandoverSlots "操作的请求模式.

Name Description Schema
marketplaceId
required
A string of up to 255 characters. String
amazonOrderId
required
An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. AmazonOrderId
packageDimensions
required
计划包装的尺寸. Dimensions
包装重量
required
预定包装的重量 Weight

# ListHandoverSlotsResponse

ListHandoverSlots "操作的响应模式.

Name Description Schema
amazonOrderId
required
An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. AmazonOrderId
timeSlots
required
A list of time slots. TimeSlots

# InvoiceData

发票号码和日期.

Name Description Schema
invoiceNumber
required
The invoice number. String
invoiceDate
optional
发票产生的日期. DateTime

# Item

项目标识符和序列号信息.

Name Description Schema
orderItemId
optional
The Amazon-defined order item identifier. OrderItemId
orderItemSerialNumbers
optional
A list of serial numbers for the items associated with the OrderItemId value. OrderItemSerialNumbers

# Items

包裹中包含的物品列表.

类型 < Item > 数组

最大项目 : 500

# OrderItemId

亚马逊-定义的订单项目标识符.

类型:字符串

最大长度 255

# OrderItemSerialNumber

与 "OrderItemId "值相关的物品序列号.

类型 :字符串

最大长度 : 255

# OrderItemSerialNumbers

与 "OrderItemId "相关的物品序列号的列表,值.

类型: < OrderItemSerialNumber >数组

最大项目 : 100

# Package

一个包裹. 这个对象包含了计划中的Easy Ship包裹的所有细节,包括包裹的标识符,物理属性,如尺寸和重量,选择的时间段将包裹移交给承运人,包裹的状态,以及跟踪/发票细节.

Name Description Schema
scheduledPackageId
required
确定要更新的计划包. ScheduledPackageId
packageDimensions
required
计划包的尺寸. Dimensions
包装重量
required
计划包装的重量 Weight
packageItems
optional
A list of items contained in the package. Items
packageTimeSlot
required
A time window to hand over an Easy Ship package to Amazon Logistics. TimeSlot
packageIdentifier
optional
Optional seller-created identifier that is printed on the shipping label to help the seller identify the package. PackageIdentifier
invoice
optional
Invoice number and date. InvoiceData
包装状态
可选
包装的状态. 包装状态
trackingDetails
optional
Representation of tracking metadata. TrackingDetails

# Packages

一个包的列表.

Name Schema
packages
required
< Package > array

# PackageDetails

包的细节.包括包的项目'、包的时间段'和`包的标识符'.

Name Description Schema
包装物品
可选的
包装中包含的物品清单. 物品
packageTimeSlot
required
A time window to hand over an Easy Ship package to Amazon Logistics. TimeSlot
packageIdentifier
optional
Optional seller-created identifier,印在运输标签上,帮助卖家识别包裹. PackageIdentifier

# TimeSlot

将Easy Ship包裹移交给亚马逊物流的时间窗口.

Name Description Schema
slotId
required
An Amazon-defined identifier for a time slot. String
startTime
optional
时隙的起始日期和时间. DateTime
endTime
optional
时隙的结束日期和时间. DateTime
handoverMethod
optional
卖家将包裹移交给亚马逊物流的方法. HandoverMethod

# TimeSlots

一个时间段的列表.

类型 < TimeSlot >阵列

最小项目 : 1 最大项目 : 500

# ScheduledPackageId

识别要更新的预定软件包.

Name Description Schema
amazonOrderId
required
An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. AmazonOrderId
packageId
optional
An Amazon-defined identifier for the scheduled package. PackageId

# CreateScheduledPackageRequest

用于 "创建预定包 "操作的请求模式.

Name Description Schema
amazonOrderId
required
An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. AmazonOrderId
marketplaceId
required
A string of up to 255 characters. String
packageDetails
required
package details.包括packageItemspackageTimeSlot,和packageIdentifier. PackageDetails

# UpdateScheduledPackagesRequest

updateScheduledPackages操作的请求模式.

Name Description Schema
marketplaceId
required
A string of up to 255 characters. String
updatePackageDetailsList
required
A list of package update details. UpdatePackageDetailsList

# UpdatePackageDetails

请求更新一个包的时间段.

Name Description Schema
scheduledPackageId
required
确定要更新的计划包. ScheduledPackageId
packageTimeSlot
required
A time window to hand over an Easy Ship package to Amazon Logistics. TimeSlot

# UpdatePackageDetailsList

一个软件包更新细节的列表.

类型 : < UpdatePackageDetails>数组

最小项目 : 1 最大项目 : 500

# String

一个最多255个字符的字符串.

类型 : 字符串

最小长度 1 最大长度 : 255

# DateTime

一个ISO 8601格式的日期时间值.

类型 : string (date-time)

# UnitOfLength

用来测量长度的计量单位.

类型 : 枚举

Value Description
Cm Centimeters

# UnitOfWeight

用来测量重量的计量单位.

类型 : 枚举

Value Description
Grams Grams
G Grams

# Weight

预定包裹的重量

Name Description Schema

可选
包装的重量. WeightValue
单位
可选
用于测量重量的计量单位. 重量单位

# WeightValue

包装的重量.

类型 : 数字 (float)

最小值 : 11.0

# ErrorList

当请求不成功时返回的错误响应列表.

Name Schema
errors
required
< Error > array

# Error

当请求不成功时返回的错误响应.

Name Description Schema
code
required
一个错误代码,用于识别所发生的错误类型. string
message
required
一个描述错误情况的信息. string
details
optional
可以帮助呼叫者理解或解决这个问题的额外细节. string
Last Updated: 2022/10/16 下午10:27:34