# 概述
用于零售采购装运的销售伙伴API为供应商提供零售装运数据的程序化访问.
# Version information
版本 : v1
# Operations
# 路径
# SubmitShipmentConfirmations
POST /vendor/shipping/v1/shipmentConfirmations
# Description
为供应商订单提交一份或多份发货确认书.
使用计划:
计划类型 | 速率(每秒的请求) | 突发 |
---|---|---|
Default | 10 | 10 |
销售伙伴具体 | 变量 | 变量 |
x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.某些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂量.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | body required | The request schema for the SubmitShipmentConfirmations operation. | SubmitShipmentConfirmationsRequest |
# Responses
HTTP Code | Description | Schema |
---|---|---|
202 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
错误状态代码、描述和模式,见错误响应和模式.
# 错误响应和模式
该表包含HTTP状态代码和错误响应的相关信息.
HTTP Code | Description | Schema |
---|---|---|
400 | Request有缺失或无效的参数,无法解析. Headers x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头 x-amzn-RequestId (string):Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
404 | 指定的资源不存在. 头 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
413 | 请求的大小超过了最大接受的大小. 头 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作._注意:_对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string): Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
415 | 请求的有效载荷是不支持的格式. ****头 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作._注意:_对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string) Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
429 | 请求的频率超过了允许的范围. 头 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作._注意:_对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string) Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
500 | 发生了一个意外情况,使服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作._注意:_对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string): Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
503 | 服务器临时超载或维护. 头 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作._注意:_对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string): Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
# Definitions
# SubmitShipmentConfirmationsRequest
SubmitShipmentConfirmations操作的请求模式.
Name | Schema |
---|---|
shipmentConfirmations optional | < ShipmentConfirmation > array |
# ShipmentConfirmation
名称 | 描述 | 架构 |
---|---|---|
shipmentIdentifier 必填 | 唯一的货件 ID(过去 365 天内未使用)。 | string |
shipmentConfirmationType 必填 | 表示此货件确认是初始确认,还是用于替换已经过帐的货件确认。如果替换现有的发货确认,请务必提供与之前确认中相同的 shippingIdentifier 和 saleParty 信息。 | enum (ShipmentConfirmationType) |
shipmentType 可选 | 货件类型。 | 枚举 (ShipmentType) |
shipmentStructure 可选 | 货件层次结构。 | 枚举 (ShipmentStructure) |
transportationDetails 可选 | 此货件的运输详细信息。 | TransportationDetails |
amazonReferenceNumber 可选 | 亚马逊参考号是亚马逊在您提交路由请求时为所有 Collect/WePay 货件生成的唯一标识符。对于 Collect/WePay 货件,此字段是必需的。 | string |
shipmentConfirmationDate 必填 | 提交装运确认的日期。 | 字符串(日期-时间) |
shippedDate 可选 | 货件从供应商位置出发的日期和时间。要求供应商在离开其仓库/配送中心的 30 分钟内或在亚马逊目的地仓库的预约时间前至少 6 小时内发送 ASN,以较早者为准。发货确认中提到的发货日期不应是将来的日期。 | string (date-time) |
estimatedDeliveryDate 可选 | 货物预计到达买方仓库的日期和时间。它需要根据船舶从地点到目的地之间的平均运输时间进行估算。确切的预约时间将由买方提供,在创建发货确认时可能不知道。 | 字符串(日期-时间) |
salesParty 必填 | 卖方的姓名/地址和税务详情。 | PartyIdentification |
shipFromParty 必填 | 发货方的名称/地址和税务详情。 | PartyIdentification |
shipToParty 必填 | 货物要运往的目的地仓库的名称/地址。 | PartyIdentification |
shipmentMeasurements 可选 | 货件测量详细信息。 | ShipmentMeasurements |
importDetails 可选 | 仅当此货件是直接进口时才提供这些字段。 | ImportDetails |
shippedItems 必填 | 此货件中的物品清单及其相关详细信息。如果任何项目详细信息字段在纸箱或托盘级别是通用的,请在相应的纸箱或托盘级别提供它们。 | < Item > 数组 |
cartons 可选 | 这批货物中的纸箱列表。 | < Carton > 数组 |
pallets 可选 | 此货件中的托盘列表。 | < Pallet > 数组 |
# ShipmentMeasurements
货件测量细节.
Name | Description | Schema |
---|---|---|
货物总重量 可选 | 货物总重量. | 重量 |
shipmentVolume optional | Volume of the shipment. | Volume |
cartonCount optional | 货物中存在的纸箱数量.仅对无托盘的货物提供纸箱数量. | integer |
palletCount optional | 货物中存在的托盘数量.只为托盘化的货物提供托盘数量. | integer |
# TransportationDetails
Name | Description | Schema |
---|---|---|
carrierScac optional | 识别货物承运人的代码.标准承运人阿尔法代码(SCAC)是一个独特的2到4个字母的代码,用于识别承运人.承运人SCAC代码由NMFTA分配和维护(国家汽车货运协会).该字段对于美国、加州、MX的货物确认是强制性的. | string |
carrierShipmentReferenceNumber optional | 该字段也被称为PRO号码,是承运人分配的唯一号码.它用于识别和跟踪出去交货的货物.该字段在UA, CA, MX的货物确认中是强制性的. | string |
运输方式 可选 | 此货件的运输方式. | enum (运输方式) |
billOfLadingNumber optional | Bill Of Lading (BOL)号码是供应商分配的唯一号码.货件确认信息中出现的BOL最好与随货提供的纸质BOL一致,但这不是必须的.代替BOL,也可以在这个字段中发送货件的替代参考号码(如送货单号) |
# ImportDetails
Name | Description | Schema |
---|---|---|
methodOfPayment optional | 这仅用于进口采购订单.如果收件人要求,这个字段将包含发货的付款方式. | enum (MethodOfPayment) |
密封号码 可选 | 集装箱的密封号码. | 字符串 |
路线 可选 | 这批货物的路线和停靠站详情. | 路线 |
importContainers optional | 进口订单的集装箱类型和数量(s)如果货物有多个集装箱,可以是一个逗号-分隔的列表. maxLength : 64 | string |
billableWeight optional | 直接进口货物的计费重量. | Weight |
estimatedShipByDate optional | 预计发货的日期.这个值不应该是过去的,也不能超过未来60天. | string (date-time) |
# Item
正在运送的物品的详细信息.
Name | Description | Schema |
---|---|---|
itemSequenceNumber required | 物品的序列号.第一个物品是001,第二个是002,以此类推.这个数字被用作参考,以便从纸箱或托盘层面参考这个物品. | string |
amazonProductIdentifier optional | Amazon Standard Identification Number (ASIN)一个物品的标准识别号码. | string |
vendorProductIdentifier optional | 供应商选择的商品标识.应与采购订单中发送的相同. | string |
shippedQuantity required | 本次发货的物品总量. | ItemQuantity |
itemDetails optional | 这批货物中的每件物品都要提供物品或纸箱或托盘的详细信息,以合适的为准. | ItemDetails |
# Carton
装运的纸箱/包装的详细信息.
Name | Description | Schema |
---|---|---|
cartonIdentifiers optional | A list of carton identifiers. | < ContainerIdentification> array |
cartonSequenceNumber required | 纸箱的序列号.第一个纸箱是001,第二个是002,以此类推.这个数字被用来作为参考,以便从托盘层面引用这个纸箱. | string |
尺寸 可选 | 容器的物理尺寸测量. | 尺寸 |
weight optional | The weight. | Weight |
追踪号码 可选择 | 这是在小包裹运输中每个纸箱都需要提供的. | 字符串 |
items required | A list of container item details. | < ContainerItem> array |
# Pallet
被运送的托盘/皮重的详情.
Name | Description | Schema |
---|---|---|
palletIdentifiers required | A list of pallet identifiers. | < ContainerIdentification> array |
层 可选 | 每个托盘的层数. | integer |
块 可选择 | 托盘上每层的纸箱数量. | 整数 |
尺寸 选项 | 集装箱的物理尺寸测量. | 尺寸 |
weight optional | The weight. | Weight |
cartonReferenceDetails optional | Carton reference details. | CartonReferenceDetails |
items optional | A 容器物品详细信息列表. | < ContainerItem>数组 |
# ItemDetails
为装运中的每件物品提供物品细节,可以是物品或纸箱或托盘级别,以适当的为准.
Name | Description | Schema |
---|---|---|
采购订单号 可选 | 正在确认的货物的亚马逊采购订单号.如果此货物中的物品属于多个采购订单号,并在货物的特定纸箱或托盘中,那么请提供相应纸箱或托盘级别的采购订单号.格式说明8-character alpha-numeric code. | string |
lotNumber optional | 批号或lot号将物品与制造商认为与元素字符串所适用的贸易物品的可追溯性有关的信息联系起来.该数据可以指贸易物品本身或包含的物品.该字段对所有易腐物品是强制性的. | string |
expiry optional | 无论是expiryDate还是mfgDate和expiryAfterDuration对于易腐物品都是必须的. | Expiry |
maximumRetailPrice optional | 被运送物品的最高零售价格. | Money |
handlingCode optional | 标识指定的物品/纸箱/托盘应该如何处理的说明. | enum (HandlingCode |
# ContainerIdentification
Name | Description | Schema |
---|---|---|
containerIdentificationType required | The container identification type. | enum (ContainerIdentificationType) |
集装箱标识号 必填 | 符合集装箱标识类型定义的集装箱标识号. | 字符串 |
# ContainerItem
该物品的纸箱/托盘级别的详细信息.
Name | Description | Schema |
---|---|---|
itemReference required | 物品的参考编号.请提供'items'段的itemSequenceNumber,以便在这里参考该物品的细节. | string |
shippedQuantity required | 在这个纸箱/托盘中运送的物品总量. | ItemQuantity |
itemDetails optional | 在物品或纸箱或货盘的层面上,为每一个装运的物品提供物品细节,以合适的为准. | ItemDetails |
# CartonReferenceDetails
Name | Description | Schema |
---|---|---|
cartonCount optional | 托盘级别的纸箱数量对于单品托盘是必须的,对于混合物品托盘是可选的. | integer |
cartonReferenceNumbers required | 属于这个货盘/货物的纸箱的参考号码阵列.请提供'cartons'部分的cartonSequenceNumber,以便在这里参考该纸箱的细节. | < string > array |
# PartyIdentification
Name | Description | Schema |
---|---|---|
地址 可选 | 按地址确定当事人身份. | 地址 |
partyId required | 为当事人分配的标识. | string |
税务登记细节 可选的 | 实体的税务登记细节. | < TaxRegistrationDetails>数组 |
# TaxRegistrationDetails
该实体的税务登记细节.
Name | Description | Schema |
---|---|---|
*税务登记类型 必须的 | 实体的税务登记类型. | enum (税务登记类型) |
税务登记号码 必须的 | 实体的税务登记号码.例如,增值税ID. | 字符串 |
# Address
当事人的地址.
Name | Description | Schema |
---|---|---|
name required | 该地址的个人、企业或机构的名称. | string |
addressLine1 required | 地址的第一行. | string |
addressLine2 optional | 额外的街道地址信息,如果需要的话. | string |
addressLine3 optional | Additional street address information, if required. | string |
城市 可选择 | 个人、企业或机构所在的城市. | string |
县 可选择 | 个人、企业或机构所在的县. | string |
区 可选择 | 个人、企业或机构所在的区. | string |
州或地区 可选择 | 个人、企业或机构所在的州或地区. | string |
postalCode optional | 该地址的邮政编码.它包含一系列的字母或数字或两者,有时包括空格或标点符号. | string |
countryCode required | ISO 3166-1 alpha-2格式的两位数的国家代码. | string |
电话 可选 | 位于该地址的个人、企业或机构的电话号码. | string |
# Route
这仅用于直接进口货物的确认.
Name | Schema |
---|
# Stop
与货物运输有关的合同或作业港口或地点.
Name | Description | Schema |
---|---|---|
functionCode required | Provide the function code. | enum (FunctionCode) |
locationIdentification optional | Location identifier. | Location |
arrivalTime optional | 货物到达的日期和时间. | string (date-time) |
departureTime optional | 货物离开的日期和时间. | string (date-time) |
# Location
位置标识符.
Name | Description | Schema |
---|---|---|
type optional | Type of location identification. | string |
locationCode optional | Location code. | string |
countryCode optional | 两位数的国家代码.以ISO 3166-1 alpha-2格式. | string |
# Dimensions
容器的物理尺寸测量.
Name | Description | Schema |
---|---|---|
length required | 容器的长度. | Decimal |
width required | 容器的宽度. | 十进制 |
height required | 容器的高度. | 十进制 |
unitOfMeasure required | 尺寸的测量单位. | enum (UnitOfMeasure |
# Volume
容器的体积.
Name | Description | Schema |
---|---|---|
unitOfMeasure required | The unit of measurement. | enum (UnitOfMeasure) |
value required | The measurement value. | Decimal |
# Weight
重量.
Name | Description | Schema |
---|---|---|
unitOfMeasure required | The unit of measurement. | enum (UnitOfMeasure) |
value required | The measurement value. | Decimal |
# Money
一笔钱,包括货币形式的单位.
Name | Description | Schema |
---|---|---|
currencyCode required | 三位数的ISO 4217格式的货币代码. | string |
amount required | 一个没有精度损失的十进制数字.当精度损失是不可接受的时候很有用,比如货币.遵循RFC7159的数字表示法. Pattern : ^-?(0\|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$ . | Decimal |
# Decimal
一个没有精度损失的十进制数.当精度损失不可接受时很有用,比如货币.遵循RFC7159的数字表示法.
模式^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$
.
类型:字符串
# ItemQuantity
项目数量的详细信息.
Name | Description | Schema |
---|---|---|
amount required | 特定物品在装运水平上的装运单位数量.如果该物品仅存在于装运中的某些纸箱或托盘中,请提供相应的纸箱或托盘水平. | integer |
单位计量 必须的 | 装运数量的计量单位. | enum (单位计量 |
单位大小 可选 | 箱子大小,如果我们用箱子订购.否则,1. | 整数 |
# Expiry
Name | Description | Schema |
---|---|---|
manufacturerDate optional | 由制造商确定的生产、包装或装配日期.其含义根据贸易项目的背景确定. | string (date-time) |
expiryDate optional | 决定产品的消费或使用限制的日期.其含义根据贸易项目的上下文确定. | string (date-time) |
expiryAfterDuration optional | 制造日期之后的期限,在此期限内产品可以消费. | Duration |
# Duration
Name | Description | Schema |
---|---|---|
durationUnit required | Unit for duration. | enum (DurationUnit) |
durationValue required | 以durationUnit. | integer |
# SubmitShipmentConfirmationsResponse
提交货件确认操作的响应模式.
Name | Description | Schema |
---|---|---|
payload optional | SubmitShipmentConfirmations操作的响应有效载荷. | TransactionReference |
errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
# TransactionReference
Name | Description | Schema |
---|---|---|
transactionId optional | GUID由亚马逊分配来识别此交易.此值可用于交易状态API,以返回此交易的状态. | string |
# ErrorList
当请求不成功时返回的错误响应列表.
类型 < Error > 数组
# Error
当请求不成功时返回的错误响应.
Name | Description | Schema |
---|---|---|
code required | 一个错误代码,用于识别所发生的错误类型. | string |
message required | 一个描述错误情况的信息. | string |
details optional | 可以帮助呼叫者理解或解决这个问题的额外细节. | string |
# MethodOfPayment
这仅用于进口采购订单.如果收件人要求,这个字段将包含发货的付款方式.
类型 : 枚举
Value | Description |
---|---|
由买方支付 | 买方支付运费. |
CollectOnDelivery | 买方支付交货时的运费. |
由买方和卖方定义 | 按照买方和卖方之间的协议支付运费. |
FOBPortOfCall | 卖方支付运输费用,包括.装载、运输. |
PrepaidBySeller | Seller prepays for shipping. |
PaidBySeller | Seller pay for shipping. |
# ShipmentType
货件的类型.
类型 : 枚举
Value | Description |
---|---|
TruckLoad | Truckload运输是指大量同质货物的运输,一般是指装满整个半挂车或联运集装箱所需的数量. |
LessThanTruckLoad | 运输并不能填满整个卡车. |
小包裹 | 小包裹运输每件重量在70磅以下,用你自己的包装或承运人提供的箱子装运. |
# TransportationMode
这批货物的运输方式.
类型 : 枚举
Value | Description |
---|---|
陆路 | 运输方式是通过陆路(卡车). |
空中 | 运输方式为空中(飞机上). |
海洋 | 运输方式是海洋(乘船). |
# HandlingCode
识别指定的物品/纸箱/货盘应该如何处理的指示.
类型 : 枚举
Value | Description |
---|---|
超大 | 一个重量在150磅或以下,长度和周长超过130英寸的包件被归类为超大包件. |
易碎的 | 含有易碎物品的包件. |
食品 | 含有可食用物品的包装. |
谨慎处理 | 含有易碎或危险物品的包装. |
# TaxRegistrationType
该实体的税务登记类型.
类型 : 枚举
Value | Description |
---|---|
VAT | Value-added tax. |
GST | 商品和服务税. |
# DurationUnit
持续时间的单位.
类型 : 枚举
Value | Description |
---|---|
Days | Days |
Months | Months |
# FunctionCode
提供函数代码.
类型 : 枚举
Value | Description |
---|---|
卸货港 | 卸货港是指船舶卸下或卸下部分或全部货物的地方. |
运费支付地点 | 支付运费的地方. |
装货港 | 货物装船的港口. |
# ContainerIdentificationType
容器的识别类型.
类型 : 枚举
Value | Description |
---|---|
SSCC | 2位应用标识符(00)之后是唯一的18-位串行装运集装箱代码(SSCC),用于定义托盘/纸箱并识别其内容. |
AMZNCC | 亚马逊集装箱代码-替代SSCC,由亚马逊为小型供应商生成,并与托盘/纸箱标签相关联. |
GTIN | 全球贸易识别码(标准GS1条码和产品识别系统的一部分). |
BPS | 条形码包装单. |
CID | 进口货物的集装箱标识. |
# ShipmentConfirmationType
表示这个货件确认是最初的确认,还是要取代已经发布的货件确认.如果取代现有的货件确认,请确保提供与之前的确认相同的货件标识符和销售方信息.
类型 : 枚举
Value | Description |
---|---|
原件 | 初始发货确认信息. |
替换 | 替换原始货件确认信息. |
# ShipmentStructure
货件分层结构.
类型 : 枚举
Value | Description |
---|---|
alletizedAssortmentCase | Shipment ->; Order ->; Pallet/Tare ->; Carton/Package ->; Item |
松散分类箱 | 发货 ->; 订单 ->; 纸箱/包装 ->; Item |
PalletOfItems | Shipment ->; Order ->; Pallet/Tare ->; Item |
托盘标准箱 | 发货 ->; 订单 ->; 托盘/皮重 ->; 项目 ->; 纸箱/包装 |
LoseStandardCase | Shipment ->; Order ->; Item ->; Carton/Package |
MasterPallet | Shipment ->; Pallet/Tare ->; Order ->; Item |
MasterCase | Shipment ->; Carton/Package ->; Order ->; Item |
# UnitOfMeasure
类型 : 枚举
用于定义(s)Weight 计量单位.
Value | Description |
---|---|
G | Grams |
Kg | Kilograms |
Oz | Ounces |
Lb | Pounds |
用于定义(s)Dimensions 尺寸的测量单位.
Value | Description |
---|---|
In | Inches |
Ft | Feet |
Meter | Meters |
Yard | Yards |
用于定义(s)Volume 计量单位.
Value | Description |
---|---|
CuFt | Cubic feet. |
CuIn | Cubic inches. |
CuM | Cubic meter. |
CuY | Cubic yard. |
用于定义(s)ItemQuantity 发货数量的计量单位.
Value | Description |
---|---|
箱 | 将单个物品包装成一个箱子. |
Eaches | Individual items. |