getPurchaseOrders

返回一个在您指定的时间范围内创建或更改的采购订单列表。您可以使用 createdAfter、createdBefore、changedAfter 和 changedBefore 参数定义时间范围。搜索的日期范围不得超过7天。您可以通过将 includeDetails 设置为 false，仅获取采购订单号。然后可以使用 getPurchaseOrder 操作接收特定采购订单的详细信息。

使用计划：

速率（每秒请求数）	突发
10	10

x-amzn-RateLimit-Limit 响应头返回适用于请求操作的使用计划速率限制（如果有的话）。上表指示了此操作的默认速率和突发值。业务需求更高的销售合作伙伴可能会看到比这里显示的更高的速率和突发值。有关更多信息，请参见 Selling Partner API 中的使用计划和速率限制。

请求参数

Query 参数

limit

integer <int64>

可选

返回记录的数量限制。默认值为100条记录。

>= 1<= 100

createdAfter

string <date-time>

可选

在此时间后生成的采购订单将会包含在结果中。必须采用ISO 8601日期/时间格式。

createdBefore

string <date-time>

可选

在此时间之前可用的采购订单将包含在结果中。必须使用ISO 8601日期/时间格式。

sortOrder

enum<string>

可选

按采购订单创建日期升序或降序排序。

枚举值:

ASCDESC

nextToken

string

可选

用于分页，当购买订单数量超过指定的结果大小限制时。令牌值在之前的API调用中返回。

includeDetails

string <boolean>

可选

当为true时，返回包含完整细节的采购订单。否则，仅返回采购订单编号。默认值为true。

changedAfter

string <date-time>

可选

在此时间戳之后更改的采购订单将包含在结果中。必须采用ISO 8601日期/时间格式。

changedBefore

string <date-time>

可选

在此时间戳之前更改的采购订单将包含在结果中。必须采用ISO 8601日期/时间格式。

poItemState

enum<string>

可选

采购订单项的当前状态。如果此值为已取消，此API将返回一个或多个被亚马逊取消的采购订单，且更新后的商品数量为零。

枚举值:

Cancelled

isPOChanged

string <boolean>

可选

当设置为true时，返回在下单后被修改的采购订单。供应商需要提取更改后的采购订单，并履行更新后的采购订单，而不是原始订单。默认值为false。

purchaseOrderState

enum<string>

可选

根据采购订单状态过滤采购订单。

枚举值:

NewAcknowledgedClosed

orderingVendorCode

string

可选

根据指定的订购供应商代码过滤采购订单。该值应与采购订单中的 'sellingParty.partyId' 相同。如果未包含在过滤器中，将返回用于授权 API 客户端应用程序的供应商组中所有供应商代码的所有采购订单。

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

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

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

`getPurchaseOrders` 操作的响应模式。

payload

object (OrderList)

返回的订单列表。

可选

pagination

object (Pagination)

可选

检索剩余数据所需的分页元素。

orders

array[object (Order) {3}]

可选

表示OrderList中的一个单独订单。

errors

array[object (Error) {3}]

可选

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

code

string

必需

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

message

string

必需

描述错误状态的消息。

details

string

可选

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

示例

{
    "payload": {
        "pagination": {
            "nextToken": "string"
        },
        "orders": [
            {
                "purchaseOrderNumber": "string",
                "purchaseOrderState": "New",
                "orderDetails": {
                    "purchaseOrderDate": "2019-08-24T14:15:22Z",
                    "purchaseOrderChangedDate": "2019-08-24T14:15:22Z",
                    "purchaseOrderStateChangedDate": "2019-08-24T14:15:22Z",
                    "purchaseOrderType": "RegularOrder",
                    "importDetails": {
                        "methodOfPayment": "PaidByBuyer",
                        "internationalCommercialTerms": "ExWorks",
                        "portOfDelivery": "string",
                        "importContainers": "string",
                        "shippingInstructions": "string"
                    },
                    "dealCode": "string",
                    "paymentMethod": "Invoice",
                    "buyingParty": {
                        "partyId": "string",
                        "address": {
                            "name": "string",
                            "addressLine1": "string",
                            "addressLine2": "string",
                            "addressLine3": "string",
                            "city": "string",
                            "county": "string",
                            "district": "string",
                            "stateOrRegion": "string",
                            "postalCode": "string",
                            "countryCode": "st",
                            "phone": "string"
                        },
                        "taxInfo": {
                            "taxRegistrationType": "VAT",
                            "taxRegistrationNumber": "string"
                        }
                    },
                    "sellingParty": {
                        "partyId": "string",
                        "address": {
                            "name": "string",
                            "addressLine1": "string",
                            "addressLine2": "string",
                            "addressLine3": "string",
                            "city": "string",
                            "county": "string",
                            "district": "string",
                            "stateOrRegion": "string",
                            "postalCode": "string",
                            "countryCode": "st",
                            "phone": "string"
                        },
                        "taxInfo": {
                            "taxRegistrationType": "VAT",
                            "taxRegistrationNumber": "string"
                        }
                    },
                    "shipToParty": {
                        "partyId": "string",
                        "address": {
                            "name": "string",
                            "addressLine1": "string",
                            "addressLine2": "string",
                            "addressLine3": "string",
                            "city": "string",
                            "county": "string",
                            "district": "string",
                            "stateOrRegion": "string",
                            "postalCode": "string",
                            "countryCode": "st",
                            "phone": "string"
                        },
                        "taxInfo": {
                            "taxRegistrationType": "VAT",
                            "taxRegistrationNumber": "string"
                        }
                    },
                    "billToParty": {
                        "partyId": "string",
                        "address": {
                            "name": "string",
                            "addressLine1": "string",
                            "addressLine2": "string",
                            "addressLine3": "string",
                            "city": "string",
                            "county": "string",
                            "district": "string",
                            "stateOrRegion": "string",
                            "postalCode": "string",
                            "countryCode": "st",
                            "phone": "string"
                        },
                        "taxInfo": {
                            "taxRegistrationType": "VAT",
                            "taxRegistrationNumber": "string"
                        }
                    },
                    "shipWindow": "string",
                    "deliveryWindow": "string",
                    "items": [
                        {
                            "itemSequenceNumber": "string",
                            "amazonProductIdentifier": "string",
                            "vendorProductIdentifier": "string",
                            "orderedQuantity": {
                                "amount": 0,
                                "unitOfMeasure": "Cases",
                                "unitSize": 0
                            },
                            "isBackOrderAllowed": true,
                            "netCost": {
                                "currencyCode": "str",
                                "amount": "string"
                            },
                            "listPrice": {
                                "currencyCode": "str",
                                "amount": "string"
                            }
                        }
                    ]
                }
            }
        ]
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400请求有误

🟠403禁止访问

🟠404记录不存在

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障

请求参数

示例代码

返回响应