Vendor Direct Fulfillment Orders API v1 reference

亚马逊SPAPI

# 概述

直接履行订单的销售伙伴API提供了对直接履行供应商的订单数据的程序化访问.

# Version information

版本 : v1

# Operations

getOrders
getOrder
submitAcknowledgement
<a name="paths">

# 路径

<a name="getorders">

# getOrders

GET /vendor/directFulfillment/orders/v1/purchaseOrders

# Description

返回在您指定的时间范围内创建的采购订单列表.您使用createdAfter和createdBefore参数定义时间范围.您必须使用这两个参数.您可以选择通过将includeDetails参数设置为false来只获得采购订单号码.在这种情况下,该操作返回采购订单号码列表.然后您可以调用getOrder操作来返回特定订单的细节.

使用计划:

计划类型 速率(每秒的请求) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.某些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂量.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema Default
*Query *shipFromPartyId
optional
履约仓库的供应商仓库标识.如果没有指定,结果将包含所有仓库的订单. string -
*Query *status
optional
只返回符合指定状态的采购订单.如果没有指定,结果将包含符合任何状态的订单. enum (Status) -
Query limit
optional
返回的采购订单的数量限制.
Minimum : 1
最大 : 100
integer (int64) -
*Query *createdAfter
required
在此日期和时间之后可用的采购订单将包括在结果中.必须是ISO-8601日期/时间格式. string (date-time)
Query createdBefore
required
在此日期和时间之前成为可用的采购订单将被包括在结果中.必须是ISO-8601日期/时间格式. string (date-time)
*Query *sortOrder
optional
按订单创建日期以升序或降序排序列表. enum (SortOrder -
*Query *nextToken
optional
当有更多的订单超过指定的结果大小限制时,用于分页.token值在前一个API调用中返回. string -
Query includeDetails
optional
为真时,返回完整的采购订单细节.否则,只返回采购订单号码. string (boolean) "true"

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
GetOrdersResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrdersResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetOrdersResponse
404 指定的资源不存在.
Headers :
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetOrdersResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetOrdersResponse
429 请求的频率超过允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetOrdersResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetOrdersResponse
503 服务器的临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetOrdersResponse

更多的错误状态代码、描述和模式,见错误响应和模式. <a name="getorder">

# getOrder

GET /vendor/directFulfillment/orders/v1/purchaseOrders/{purchaseOrderNumber}

# Description

返回您指定的purchaseOrderNumber的采购订单信息.

使用计划:

计划类型 速率(每秒请求数) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.某些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂量.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path purchaseOrderNumber
required
您想要的采购订单的订单标识符.格式说明:alpha-数字代码. string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
GetOrderResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetOrderResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetOrderResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetOrderResponse
429 请求的频率超过允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetOrderResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetOrderResponse
503 服务器的临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetOrderResponse

更多的错误状态代码、描述和模式,见错误响应和模式. <a name="submitacknowledgement">

# submitAcknowledgement

POST /vendor/directFulfillment/orders/v1/acknowledgements

# Description

提交一个或多个采购订单的确认书.

使用计划:

计划类型 速率(每秒的请求) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.某些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂量.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Body body
required
submitAcknowledgement操作的请求模式. SubmitAcknowledgementRequest

# Responses

HTTP Code Description Schema
202 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
SubmitAcknowledgementResponse
400 Request有缺失或无效的参数,无法解析.
Headers:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
SubmitAcknowledgementResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : Unique request reference identifier.
SubmitAcknowledgementResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
SubmitAcknowledgementResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
SubmitAcknowledgementResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
SubmitAcknowledgementResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
SubmitAcknowledgementResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
SubmitAcknowledgementResponse

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

<a name="error-responses-and-schemas">

# 错误响应和模式

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

HTTP Code Description Schema
401 请求的授权头格式不正确或不包含有效的标记.

x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
GetOrderResponse
413 请求的大小超过了最大接受的大小.

x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
SubmitAcknowledgementResponse

<a name="definitions">

# Definitions

<a name="getordersresponse">

# GetOrdersResponse

getOrders操作的响应模式.

Name Description Schema
********
可选
A采购订单列表. OrderList
errors
optional
A list of error responses return when a request is unsuccessful. ErrorList

<a name="getorderresponse">

# GetOrderResponse

getOrder操作的响应模式.

Name Description Schema
payload
optional
getOrder操作的有效载荷. Order
errors
optional
请求不成功时返回的错误响应列表. ErrorList

<a name="orderlist">

# OrderList

Name Schema
pagination
optional
Pagination
orders
optional
< Order > array

<a name="分页">

# Pagination

Name Description Schema
nextToken
optional
A生成的字符串,用来传递信息给你的下一个请求.如果NextToken被返回,就把NextToken的值传递给下一个请求.如果NextToken没有返回,就没有更多的订单项目可以返回. string

<a name="order">

# Order

Name Description Schema
采购订单号
必须的
此订单的采购订单号.格式说明:alpha-数字代码. string
orderDetails
optional
Purchase order details. OrderDetails

<a name="orderdetails">

# OrderDetails

一个订单的细节.

Name Description Schema
customerOrderNumber
required
The customer order number. string
*orderDate
required
下订单的日期.此字段应采用ISO-8601日期/时间格式,例如:2018-07-16T23:00 00Z/ 2018-07-16T23:00:00-05:00 /2018-07-16T23:00:00-08:00.如果没有指定时区,应假定为UTC. string (date-time)
orderStatus
optional
订单的当前状态. enum (OrderStatus
装运细节
required
装运所需的装运细节. ShipmentDetails
taxTotal
optional
- taxTotal
sellingParty
required
PartyID of vendor code. PartyIdentification
shipFromParty
required
PartyID of vendor's warehouse. PartyIdentification
shipToParty
required
name/Address and tax details of the ship to party. Address
billToParty
required
name/Address and tax details of the bill to party. PartyIdentification
items
required
A 这个采购订单的项目列表. < OrderItem > 数组

<a name="orderdetails-taxtotal"> 税金总额

Name Description Schema
taxLineItem
optional
Tax details. TaxLineItem

<a name="partyidentification">

# PartyIdentification

Name Description Schema
partyId
required
为当事人分配的标识.例如,仓库代码或供应商代码.更多细节请参考具体当事人. string
address
optional
当事人的详细地址. Address
taxInfo
optional
实体的税务登记详情. TaxRegistrationDetails

<a name="taxregistrationdetails">

# TaxRegistrationDetails

实体的税务登记详情.

Name Description Schema
*税务登记类型
可选
实体的税务登记类型. enum (税务登记类型)
taxRegistrationNumber
required
当事人的税务登记号码.例如,VAT ID. string
税务登记地址
可选的
与税务登记号码相关的地址. 地址
xRegistrationMessages
optional
税务登记信息,可用于额外的税务相关细节. string

<a name="地址">

# Address

当事人的地址.

Name Description Schema
name
required
该地址的个人、企业或机构的名称. string
attention
optional
该地址的人的注意名称. string
addressLine1
required
地址的第一行. string
addressLine2
optional
额外的地址信息,如果需要的话. string
addressLine3
optional
Additional address information, if required. string
city
optional
个人、企业或机构所在的城市. string

可选择
个人、企业或机构所在的县. string

可选择
个人、企业或机构所在的区. string
stateOrRegion
required
个人、企业或机构所在的州或地区. string
postalCode
可选的
该地址的邮政编码.它由一系列字母或数字或两者组成,有时包括空格或标点符号. string
countryCode
required
两位数的国家代码.以ISO 3166-1 alpha-2格式. string
phone
optional
位于该地址的个人、企业或机构的电话号码. string

<a name="orderitem">

# OrderItem

Name Description Schema
itemSequenceNumber
required
Numbering of the item on the purchase order. 第一个项目将是1,第二个是2,以此类推. string
buyerProductIdentifier
optional
买方的标准识别号码(ASIN)的一个项目. string
vendorProductIdentifier
optional
供应商选定的物品的产品标识. string
title
optional
项目的标题. string
orderedQuantity
required
Item quantity ordered. ItemQuantity
scheduledDeliveryShipment
optional
Details for the scheduled delivery shipment. ScheduledDeliveryShipment
giftDetails
optional
Gift message and wrapId details. GiftDetails
netPrice
required
Net price (before tax) to vendor with currency details. Money
taxDetails
optional
细列项目的总税收细节. taxDetails
totalPrice
optional
对亚马逊的价格,每个(cost). money

<a name="orderitem-taxdetails"> 税项细节

Name Description Schema
taxLineItem
optional
Tax details. TaxLineItem

<a name="money">

# Money

一笔钱,包括货币形式的单位.

Name Description Schema
currencyCode
optional
ISO 4217格式的三位数货币代码.长度为3的字符串. string
amount
optional
一个没有精度损失的十进制数字.当精度损失不可接受时,很有用,如货币.遵循RFC7159的数字表示法. Decimal

<a name="十进制">

# Decimal

一个没有精度损失的十进制数.当精度损失不可接受时很有用,比如货币.遵循RFC7159的数字表示法.

类型:字符串

<a name="submitacknowledgementresponse">

# SubmitAcknowledgementResponse

submitAcknowledgement操作的响应模式.

Name Description Schema
payload
optional
submitAcknowledgement操作的有效载荷. TransactionId
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

<a name="transactionid">

# TransactionId

Name Description Schema
transactionId
optional
GUID由亚马逊分配来识别此交易.此值可用于交易状态API,以返回此交易的状态. string

<a name="errorlist">

# ErrorList

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

类型 < Error > 数组

<a name="submitacknowledgementrequest">

# SubmitAcknowledgementRequest

submitAcknowledgement操作的请求模式.

Name Description Schema
orderAcknowledgements
optional
A list of one or more purchase orders. < OrderAcknowledgementItem> array

<a name="orderacknowledgementitem">

# OrderAcknowledgementItem

被确认的单个订单的详细信息.

Name Description Schema
采购订单号
必须的
此订单的采购订单号.格式说明:alpha-数字代码. string
vendorOrderNumber
required
此订单的供应商的订单号. string
确认日期
必须的
订单被确认的日期和时间,以ISO-8601日期/时间格式.为例2018-07-16T23:00:00Z / 2018-07-16T23:00:00-05:00 / 2018-07-16T23:00:00-08:00. string (date-time)
acknowledgementStatus
required
Status of acknowledgement. AcknowledgementStatus
sellingParty
required
PartyID as vendor code. PartyIdentification
shipFromParty
required
PartyID as the vendor's warehouseId. PartyIdentification
itemAcknowledgements
required
Item details including acknowledged quantity. < OrderItemAcknowledgement> array

<a name="orderitemAcknowledgement">

# OrderItemAcknowledgement

Name Description Schema
itemSequenceNumber
required
Line item sequence number for the item. string
买方产品标识符
可选的
买方的标准标识号(ASIN)的一个项目. string
vendorProductIdentifier
optional
供应商选定的物品的产品标识.应与采购订单中提供的相同. string
确认的数量
必须的
用上述确认代码确认的数量细节. ItemQuantity

<a name="itemquantity">

# ItemQuantity

订购数量的详细信息.

Name Description Schema
amount
optional
Acknowledged quantity.这个值不应该是零. integer
unitOfMeasure
optional
确认数量的计量单位. enum (UnitOfMeasure)

<a name="taxlineitem">

# TaxLineItem

税项列表.

类型 < TaxDetails > 数组

<a name="taxdetails">

# TaxDetails

Name Description Schema
taxRate
optional
A十进制数字,没有精度损失.当精度损失不可接受时很有用,如货币.遵循RFC7159的数字表示. Decimal
taxAmount
required
一个金额,包括货币形式的单位. Money
应纳税额
可选择
一个金额,包括货币形式的单位. Money
type
optional
Tax type. enum (Type)

<a name=" acknowledgementstatus">

# AcknowledgementStatus

确认的状态.

Name Description Schema
code
optional
Acknowledgement code是一个独特的两位数的值,表示确认的状态.关于亚马逊支持的确认代码的列表,见Vendor Direct Fulfillment APIs Use Case Guide. string
description
optional
确认代码的原因. string

<a name="error">

# Error

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

Name Description Schema
code
required
一个错误代码,用于识别所发生的错误类型. string
message
required
一个描述错误情况的信息. string
details
optional
可以帮助呼叫者了解或解决这个问题的额外细节. string

<a name="shipmentdetails">

# ShipmentDetails

货件所需的货件详情.

Name Description Schema
isPriorityShipment
required
当为真时,这是个优先货物. boolean
isScheduledDeliveryShipment
optional
当为真时,这个订单是一个预定交货计划的一部分. boolean
isPslipRequired
required
当为真时,需要向客户发送一份装箱单. boolean
isGift
optional
当为真时,该订单包含一个礼物.包括礼物信息和礼物包装信息. boolean
*shipMethod
required
运送订单所使用的运送方式.亚马逊定义的运送方式代码表明了运送载体和运送服务水平.要查看使用中的运送方式的完整列表,包括代码和友好名称,请在供应商中心的'帮助'部分搜索'运送方式'. string
shipmentDates
required
Shipment dates. ShipmentDates
messageToCustomer
required
Message to customer for order status. string

<a name="shipmentdates">

# ShipmentDates

装运日期.

Name Description Schema
requiredShipDate
required
供应商需要在什么时间之前发货. string (date-time)
promisedDeliveryDate
optional
承诺给亚马逊客户的交付日期. string (date-time)

<a name="scheduleddeliveryshipment">

# ScheduledDeliveryShipment

预定交货装运的日期.

Name Description Schema
预定交货服务类型
可选
预定交货服务类型. string
earliestNominatedDeliveryDate
optional
EarliestNominated delivery date for the scheduled delivery. string (date-time)
latestNominatedDeliveryDate
optional
Latest nominated delivery date for the scheduled delivery. string (date-time)

<a name="giftdetails">

# GiftDetails

项目的礼物详情.

Name Description Schema
giftMessage
optional
Gift message to be printed in shipment. string
giftWrapId
optional
用于礼品包装的标识符,如果有的话. string

<a name="status">

# Status

只返回符合指定状态的采购订单.如果没有指定,结果将包含符合任何状态的订单.

类型 : 枚举

Value Description
****** 新创建的采购订单的状态.
SHIPPED 已经发货的采购订单的状态.
ACCEPTED 被供应商接受的采购订单的状态.
CANCELLED 取消的采购订单的状态.

<a name="orderstatus">

# OrderStatus

订单的当前状态.

类型 : 枚举

Value Description
****** 新创建订单的状态.
SHIPPED 已经发货的订单的状态.
ACCEPTED 被供应商接受的订单的状态.
CANCELLED 取消的订单的状态.

<a name="type">

# Type

税收类型.

类型 : 枚举

Value Description
**CONSUMPTION 对商品和服务的消费支出征收的税款.
GST 对为国内消费而销售的大多数商品和服务征收的税款.
MwSt. Mehrwertsteuer,MwSt,是德语中的价值税-增值税.
PST A省销售税(PST)是在加拿大许多省份对商品和特殊服务的消费者征收的.
TOTAL 所有适用税种的综合总额.
TVA Taxe sur la Valeur Ajout&#233;e (TVA)是法语中的增值税.
VAT Value-added tax.

<a name="unitofmeasure">

# UnitOfMeasure

确认数量的计量单位.

类型 : 枚举

Value Description
Each 代表单件的计量单位.

<a name="税务登记类型">

# TaxRegistrationType

该实体的税务登记类型.

类型 : 枚举

Value Description
VAT Value-added tax.
GST 商品和服务税.

<a name="sortorder">

# SortOrder

以升序或降序排序,按订单创建日期排序.

类型 : 枚举

Value Description
ASC 按订单创建日期升序排序.
DESC 按订单创建日期降序排序.
Last Updated: 2022/10/17 下午9:17:02