getShipment

速率（每秒请求数）	突发
2	6

速率（每秒请求数）

突发

返回响应

🟢200成功

application/json

获取货物 200 响应

Headers

x-amzn-RequestId

string

可选

唯一请求参考标识符。

x-amzn-RateLimit-Limit

string

可选

您对此操作的速率限制（每秒请求数量）。

Body

包含与入境计划中的货物运输相关的信息。

amazonReferenceId

string

可选

由亚马逊创建的唯一标识符，用于识别此亚马逊合作的少于卡车负载/全车负载（LTL/FTL）货物。

>= 1 字符<= 1024 字符

contactInformation

object (ContactInformation)

卖方的联系信息。

可选

示例值:

{"email":"email@email.com","name":"name","phoneNumber":"1234567890"}

string

电子邮箱地址。

可选

>= 1 字符<= 1024 字符

name

string

联系人的名字。

必需

>= 1 字符<= 50 字符

phoneNumber

string

电话号码。

必需

>= 1 字符<= 20 字符

dates

object (Dates)

可选

指定卖方预计发货的日期。

示例值:

{"readyToShipWindow":{"end":"2024-01-06T14:48:00.000Z","start":"2024-01-05T14:48:00.000Z"}}

readyToShipWindow

object (Window)

可选

包含一个起始和结束的日期时间，表示一个时间范围。

示例值:

{"editableUntil":"2024-01-05T20:00:00.000Z","end":"2024-01-05T20:00:00.000Z","start":"2024-01-05T14:00:00.000Z"}

destination

object (ShipmentDestination)

必需

亚马逊配送中心地址和仓库ID。

address

object (Address)

可选

识别地点的具体细节。

示例值:

{"addressLine1":"123 example street","addressLine2":"Floor 19","city":"Toronto","companyName":"Acme","countryCode":"CA","email":"email@email.com","name":"name","phoneNumber":"1234567890","postalCode":"M1M1M1","stateOrProvinceCode":"ON"}

destinationType

string

必需

此货物的目的地类型可以是：AMAZON_OPTIMIZED，AMAZON_WAREHOUSE。

>= 1 字符<= 1024 字符

warehouseId

string

可选

应发送到的仓库。如果目的地类型是 AMAZON_OPTIMIZED，则为空。

>= 1 字符<= 1024 字符

freightInformation

object (FreightInformation)

可选

货运信息描述了正在运输的SKU。只有在提供货运信息的情况下，运输承运选项和报价才会返回。

示例值:

{"declaredValue":{"amount":5.5,"code":"CAD"},"freightClass":"FC_50"}

declaredValue

object (Currency)

货币定义。

可选

freightClass

string

可选

货运等级。可以是：NONE、FC_50、FC_55、FC_60、FC_65、FC_70、FC_77_5、FC_85、FC_92_5、FC_100、FC_110、FC_125、FC_150、FC_175、FC_200、FC_250、FC_300、FC_400、FC_500。

>= 1 字符<= 1024 字符

name

string

货物名称。

可选

placementOptionId

string

必需

一个投放选项的标识符。投放选项表示SKU的发货拆分和目的地。

>= 38 字符<= 38 字符

正则匹配:

^[a-zA-Z0-9-]*$

selectedDeliveryWindow

object (SelectedDeliveryWindow)

可选

选择的交付时间窗口属性。

示例值:

{"availabilityType":"AVAILABLE","deliveryWindowOptionId":"dw1234abcd-1234-abcd-5678-1234abcd5678","editableUntil":"2024-01-05T20:00:00.000Z","endDate":"2024-01-05T20:00:00.000Z","startDate":"2024-01-05T14:00:00.000Z"}

availabilityType

string

必需

识别交付时间窗口的可用性类型。值：可用，拥堵

deliveryWindowOptionId

string

必需

交付窗口选项的标识符。交付窗口选项代表预期交付货物的一个选项。

>= 36 字符<= 38 字符

正则匹配:

^[a-zA-Z0-9-]*$

editableUntil

string <date-time>

可选

此窗口无法再编辑的时间戳。

endDate

string <date-time>

窗口的结束时间戳。

必需

startDate

string <date-time>

窗口的开始时间戳。

必需

selectedTransportationOptionId

string

可选

运输选项的标识符。运输选项代表了发送货物的一种选择。

>= 38 字符<= 38 字符

正则匹配:

^[a-zA-Z0-9-]*$

selfShipAppointmentDetails

array[object (SelfShipAppointmentDetails) {3}]

可选

自助发货预约详情列表。

appointmentId

number

预约标识符。

可选

appointmentSlotTime

object (AppointmentSlotTime)

可选

预约时间段，包括开始和结束时间。

appointmentStatus

string

预约状态。

可选

>= 1 字符<= 1024 字符

shipmentConfirmationId

string

可选

确认的货物运输ID，显示在标签上（例如 FBA1234ABCD）。

>= 1 字符<= 1024 字符

shipmentId

string

必需

货物的识别码。货物包含正在入库的箱子和单位。

>= 38 字符<= 38 字符

正则匹配:

^[a-zA-Z0-9-]*$

source

object (ShipmentSource)

指定发货地址。

必需

address

object (Address)

可选

识别地点的具体细节。

示例值:

sourceType

string

必需

该货物的来源类型。可以是：SELLER_FACILITY。

>= 1 字符<= 1024 字符

status

string

可选

货物的状态。货物的状态通常会从 WORKING 开始，并在所需操作完成后过渡到 READY_TO_SHIP，然后再被取走或发货。可以是 ABANDONED（已放弃）、CANCELLED（已取消）、CHECKED_IN（已登记）、CLOSED（已关闭）、DELETED（已删除）、DELIVERED（已交付）、IN_TRANSIT（运输中）、MIXED（混合状态）、READY_TO_SHIP（准备发货）、RECEIVING（接收中）、SHIPPED（已发货）或者 WORKING（正在处理）。

>= 1 字符<= 1024 字符

trackingDetails

object (TrackingDetails)

可选

小于卡车装载量（LTL）和小件包裹配送（SPD）货物的追踪信息。

ltlTrackingDetail

object (LtlTrackingDetail)

可选

包含与少于卡车装载（LTL）货物运输跟踪相关的信息。

spdTrackingDetail

object (SpdTrackingDetail)

可选

包含与小包裹配送（SPD）货件追踪相关的信息。

示例

{
  "destination": {
    "destinationType": "AMAZON_OPTIMIZED"
  },
  "freightInformation": {
    "declaredValue": {
      "amount": 5.5,
      "code": "CAD"
    },
    "freightClass": "FC_50"
  },
  "inboundPlanId": "wf1234abcd-1234-abcd-5678-1234abcd5678",
  "placementOptionId": "pl1234abcd-1234-abcd-5678-1234abcd5678",
  "selectedDeliveryWindow": {
    "availabilityType": "AVAILABLE",
    "deliveryWindowOptionId": "dw1234abcd-1234-abcd-5678-1234abcd5678",
    "editableUntil": "2024-01-05T20:00:00.000Z",
    "endDate": "2024-01-05T20:00:00.000Z",
    "startDate": "2024-01-05T14:00:00.000Z"
  },
  "shipmentConfirmationId": "shipmentConfirmationId",
  "shipmentId": "sh1234abcd-1234-abcd-5678-1234abcd5678",
  "source": {
    "sourceType": "SELLER_FACILITY"
  }
}

🟠400请求有误

🟠403禁止访问

🟠404记录不存在

🟠413413

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障

请求参数

示例代码

返回响应