getOrders

北美(North America）

https://sellingpartnerapi-na.amazon.com

GET

/orders/v0/orders

Orders

返回在指定参数指示的时间范围内创建或更新的订单。您还可以应用一系列过滤标准以缩小返回的订单列表。如果存在 NextToken，将使用它来检索订单，而不是其他标准。

使用计划：

速率（每秒请求）	峰值
0.0167	20

x-amzn-RateLimit-Limit 响应头返回已应用于请求操作的使用计划速率限制（如适用）。上表显示了此操作的默认速率和峰值值。业务需求需要更高吞吐量的销售合作伙伴可能会看到比此处显示的更高的速率和峰值值。有关更多信息，请参阅销售合作伙伴 API 中的使用计划和速率限制。

请求参数

Query 参数

CreatedAfter

string

可选

用于选择在指定时间后（或在该时间）创建的订单的日期。仅返回在指定时间后下的订单。日期必须采用ISO 8601格式。

注意：需要提供CreatedAfter参数或LastUpdatedAfter参数。您可以指定CreatedBefore，但是在指定CreatedAfter时不提供LastUpdatedAfter或LastUpdatedBefore。

CreatedBefore

string

可选

用于选择在指定时间之前（或在指定时间时）创建的订单的日期。仅返回在指定时间之前下的订单。日期必须采用ISO 8601格式。

注意：当指定了CreatedAfter时，CreatedBefore是可选的。但如果指定了，CreatedBefore应等于或晚于CreatedAfter日期，并且必须在当前时间之前至少2分钟。

LastUpdatedAfter

string

可选

用于选择在指定时间之前（或在该时间）最后更新的订单的日期。更新被定义为订单状态的任何更改，包括新订单的创建。包括亚马逊和卖家所做的更新。日期必须采用 ISO 8601 格式。

注意：当指定了 LastUpdatedAfter 时，LastUpdatedBefore 为可选。但是如果指定，LastUpdatedBefore 应该等于或晚于 LastUpdatedAfter 日期，并且至少在当前时间之前 2 分钟。

LastUpdatedBefore

string

可选

用于选择在指定时间之前（或在指定时间时）最后更新的订单的日期。更新被定义为订单状态的任何更改，包括新订单的创建。包括亚马逊和卖方所做的更新。日期必须采用ISO 8601格式。

注意：当设置了LastUpdatedAfter时，LastUpdatedBefore是可选的。但如果指定，LastUpdatedBefore应等于或晚于LastUpdatedAfter日期，并且至少应在当前时间之前2分钟。

OrderStatuses

array[string]

可选

用于过滤结果的 OrderStatus 值列表。

可能的值：

PendingAvailability（该状态仅适用于预订。订单已下达，付款尚未授权，商品的发布日期在未来。）

Pending（订单已下达，但付款尚未授权。）

Unshipped（付款已被授权，订单已准备好发货，但订单中的商品尚未发货。）

PartiallyShipped（订单中的一个或多个商品已发货，但并非所有商品。）

Shipped（订单中的所有商品均已发货。）

InvoiceUnconfirmed（订单中的所有商品均已发货。卖家尚未向亚马逊确认发票已发给买家。）

Canceled（订单已被取消。）

Unfulfillable（订单无法满足。该状态仅适用于多渠道履行订单。）

MarketplaceIds

array[string]

必需

一份 MarketplaceId 值的列表。用于选择在指定市场中下的订单。

请参考市场 ID 以获取完整的 MarketplaceId 值列表。

<= 50 items

FulfillmentChannels

array[string]

可选

一个指示订单如何履行的列表。按履行渠道过滤结果。

可能的值：AFN（由亚马逊履行）；MFN（由卖方履行）。

PaymentMethods

array[string]

可选

支付方式值的列表。用于选择使用指定支付方式支付的订单。

可能的值：COD（货到付款）；CVS（便利店支付）；Other（除COD或CVS以外的任何支付方式）。

BuyerEmail

string

可选

买家的电子邮件地址。用于选择包含指定电子邮件地址的订单。

SellerOrderId

string

可选

由卖方指定的订单标识符。用于选择仅匹配该订单标识符的订单。如果指定了 SellerOrderId，则不能指定 FulfillmentChannels、OrderStatuses、PaymentMethod、LastUpdatedAfter、LastUpdatedBefore 和 BuyerEmail。

MaxResultsPerPage

integer

可选

一个指示每页可以返回的最大订单数的数字。值必须在1到100之间。默认值为100。

EasyShipShipmentStatuses

array[string]

可选

EasyShipShipmentStatus 值的列表。用于选择与指定状态匹配的 Easy Ship 订单。如果指定了 EasyShipShipmentStatus，则仅返回亚马逊 Easy Ship 订单。

可能的值：

PendingSchedule（包裹正在等待取件的安排。）

PendingPickUp（亚马逊尚未从卖家处提取包裹。）

PendingDropOff（卖家将把包裹交给承运人。）

LabelCanceled（卖家取消了提货。）

PickedUp（亚马逊已从卖家处提取包裹。）

DroppedOff（包裹已由卖家交给承运人。）

AtOriginFC（包裹在出发地履行中心。）

AtDestinationFC（包裹在目的地履行中心。）

Delivered（包裹已送达。）

RejectedByBuyer（买家已拒收包裹。）

Undeliverable（包裹无法送达。）

ReturningToSeller（包裹未送达，正在返回给卖家。）

ReturnedToSeller（包裹未送达，已返回给卖家。）

Lost（包裹丢失。）

OutForDelivery（包裹正在派送中。）

Damaged（包裹在运输过程中受损。）

ElectronicInvoiceStatuses

array[string]

可选

ElectronicInvoiceStatus 值的列表。用于选择与指定值匹配的电子发票状态的订单。

可能的值：

NotRequired（此订单不需要提交电子发票。）

NotFound（此订单未提交电子发票。）

Processing（此订单的电子发票正在处理中。）

Errored（最后提交的电子发票因该订单被拒绝。）

Accepted（最后提交的电子发票已提交并被接受。）

NextToken

string

可选

在您之前请求的响应中返回的字符串令牌。

AmazonOrderIds

array[string]

可选

一组 AmazonOrderId 值。AmazonOrderId 是 Amazon 定义的订单标识符，格式为 3-7-7。

<= 50 items

ActualFulfillmentSupplySourceId

string

可选

表示建议的 sourceId，订单应从该来源完成。

IsISPU

boolean

可选

当为真时，该订单标记为从店内取货，而不是送货。

StoreChainStoreId

string

可选

连锁店标识符。与连锁店中的特定商店相关联。

EarliestDeliveryDateBefore

string

可选

用于选择最早交付日期在指定时间之前（或等于该时间）的订单的日期。日期必须符合ISO 8601格式。

EarliestDeliveryDateAfter

string

可选

用于选择在指定时间之后（或与此同时）具有最早交货日期的订单的日期。该日期必须采用ISO 8601格式。

LatestDeliveryDateBefore

string

可选

用于选择交付日期在指定时间之前（或在指定时间）的订单的日期。该日期必须采用ISO 8601格式。

LatestDeliveryDateAfter

string

可选

用于选择最新交货日期在指定时间之后（或等于指定时间）的订单的日期。日期必须采用ISO 8601格式。

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

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

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

`getOrders` 操作的响应模式。

payload

object (OrdersList)

可选

一份订单清单以及附加信息，以便进行后续的API调用。

Orders

array[object (Order) {47}]

订单列表。

必需

NextToken

string

可选

在存在且不为空时，请在下一个请求中传递此字符串标记，以返回下一个响应页面。

LastUpdatedBefore

string

可选

用于选择最后更新时间在指定时间之前（或等于该时间）的订单的日期。更新被定义为订单状态的任何更改，包括新订单的创建。包括亚马逊和卖家所做的更新。所有日期必须采用ISO 8601格式。

CreatedBefore

string

可选

用于选择在指定时间之前（或在该时间）创建的订单的日期。仅返回在指定时间之前下的订单。日期必须采用 ISO 8601 格式。

errors

array[object (Error) {3}]

可选

请求失败时返回的错误响应列表。

code

string

必需

一个标识发生错误类型的错误代码。

message

string

必需

描述错误状态的消息。

details

string

可选

可以帮助拨打者理解或解决问题的附加细节。

示例

{
  "payload": {
    "NextToken": "2YgYW55IGNhcm5hbCBwbGVhc3VyZS4",
    "Orders": [
      {
        "AmazonOrderId": "902-3159896-1390916",
        "PurchaseDate": "2017-01-20T19:49:35Z",
        "LastUpdateDate": "2017-01-20T19:49:35Z",
        "OrderStatus": "Pending",
        "FulfillmentChannel": "SellerFulfilled",
        "NumberOfItemsShipped": 0,
        "NumberOfItemsUnshipped": 0,
        "PaymentMethod": "Other",
        "PaymentMethodDetails": [
          "CreditCard",
          "GiftCerificate"
        ],
        "MarketplaceId": "ATVPDKIKX0DER",
        "ShipmentServiceLevelCategory": "Standard",
        "OrderType": "StandardOrder",
        "EarliestShipDate": "2017-01-20T19:51:16Z",
        "LatestShipDate": "2017-01-25T19:49:35Z",
        "IsBusinessOrder": false,
        "IsPrime": false,
        "IsAccessPointOrder": false,
        "IsGlobalExpressEnabled": false,
        "IsPremiumOrder": false,
        "IsSoldByAB": false,
        "IsIBA": false,
        "ShippingAddress": {
          "Name": "Michigan address",
          "AddressLine1": "1 Cross St.",
          "City": "Canton",
          "StateOrRegion": "MI",
          "PostalCode": "48817",
          "CountryCode": "US"
        },
        "BuyerInfo": {
          "BuyerEmail": "user@example.com",
          "BuyerName": "John Doe",
          "BuyerTaxInfo": {
            "CompanyLegalName": "A Company Name"
          },
          "PurchaseOrderNumber": "1234567890123"
        }
      }
    ]
  }
}

🟠400请求有误

🟠403禁止访问

🟠404记录不存在

🟠429429

🔴500服务器错误

🔴503服务器故障

getOrder