getOrders - Amazon Selling Partner API (SP-API)-中文

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

使用计划：

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

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

请求参数

Query 参数

shipFromPartyId

string

可选

履行仓库的供应商仓库标识符。如果未指定，结果将包含所有仓库的订单。

status

enum<string>

可选

仅返回与指定状态匹配的采购订单。如果未指定，结果将包含与任何状态匹配的订单。

枚举值:

NEWSHIPPEDACCEPTEDCANCELLED

limit

integer <int64>

可选

退货的采购订单数量限制。

>= 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

示例代码

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

采购订单清单。

pagination

object (Pagination)

可选

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

nextToken

string

可选

生成的字符串用于将信息传递给您的下一个请求。如果返回了 NextToken，请将 NextToken 的值传递给下一个请求。如果没有返回 NextToken，则没有更多的订单项可返回。

orders

array[object (Order) {2}]

可选

代表订单列表中的采购订单。

purchaseOrderNumber

string

必需

该订单的采购订单编号。格式说明：字母数字代码。

orderDetails

object (OrderDetails)

订单详情。

可选

示例

{
    "pagination": {
        "nextToken": "string"
    },
    "orders": [
        {
            "purchaseOrderNumber": "string",
            "orderDetails": {
                "customerOrderNumber": "string",
                "orderDate": "2019-08-24T14:15:22Z",
                "orderStatus": "NEW",
                "shipmentDetails": {
                    "isPriorityShipment": true,
                    "isScheduledDeliveryShipment": true,
                    "isPslipRequired": true,
                    "isGift": true,
                    "shipMethod": "string",
                    "shipmentDates": {
                        "requiredShipDate": "2019-08-24T14:15:22Z",
                        "promisedDeliveryDate": "2019-08-24T14:15:22Z"
                    },
                    "messageToCustomer": "string"
                },
                "taxTotal": {
                    "taxLineItem": [
                        {
                            "taxRate": "string",
                            "taxAmount": {
                                "currencyCode": "string",
                                "amount": "string"
                            },
                            "taxableAmount": {
                                "currencyCode": "string",
                                "amount": "string"
                            },
                            "type": "CONSUMPTION"
                        }
                    ]
                },
                "sellingParty": {
                    "partyId": "string",
                    "address": {
                        "name": "string",
                        "attention": "string",
                        "addressLine1": "string",
                        "addressLine2": "string",
                        "addressLine3": "string",
                        "city": "string",
                        "county": "string",
                        "district": "string",
                        "stateOrRegion": "string",
                        "postalCode": "string",
                        "countryCode": "string",
                        "phone": "string"
                    },
                    "taxInfo": {
                        "taxRegistrationType": "VAT",
                        "taxRegistrationNumber": "string",
                        "taxRegistrationAddress": {
                            "name": "string",
                            "attention": "string",
                            "addressLine1": "string",
                            "addressLine2": "string",
                            "addressLine3": "string",
                            "city": "string",
                            "county": "string",
                            "district": "string",
                            "stateOrRegion": "string",
                            "postalCode": "string",
                            "countryCode": "string",
                            "phone": "string"
                        },
                        "taxRegistrationMessages": "string"
                    }
                },
                "shipFromParty": {
                    "partyId": "string",
                    "address": {
                        "name": "string",
                        "attention": "string",
                        "addressLine1": "string",
                        "addressLine2": "string",
                        "addressLine3": "string",
                        "city": "string",
                        "county": "string",
                        "district": "string",
                        "stateOrRegion": "string",
                        "postalCode": "string",
                        "countryCode": "string",
                        "phone": "string"
                    },
                    "taxInfo": {
                        "taxRegistrationType": "VAT",
                        "taxRegistrationNumber": "string",
                        "taxRegistrationAddress": {
                            "name": "string",
                            "attention": "string",
                            "addressLine1": "string",
                            "addressLine2": "string",
                            "addressLine3": "string",
                            "city": "string",
                            "county": "string",
                            "district": "string",
                            "stateOrRegion": "string",
                            "postalCode": "string",
                            "countryCode": "string",
                            "phone": "string"
                        },
                        "taxRegistrationMessages": "string"
                    }
                },
                "shipToParty": {
                    "name": "string",
                    "attention": "string",
                    "addressLine1": "string",
                    "addressLine2": "string",
                    "addressLine3": "string",
                    "city": "string",
                    "county": "string",
                    "district": "string",
                    "stateOrRegion": "string",
                    "postalCode": "string",
                    "countryCode": "string",
                    "phone": "string"
                },
                "billToParty": {
                    "partyId": "string",
                    "address": {
                        "name": "string",
                        "attention": "string",
                        "addressLine1": "string",
                        "addressLine2": "string",
                        "addressLine3": "string",
                        "city": "string",
                        "county": "string",
                        "district": "string",
                        "stateOrRegion": "string",
                        "postalCode": "string",
                        "countryCode": "string",
                        "phone": "string"
                    },
                    "taxInfo": {
                        "taxRegistrationType": "VAT",
                        "taxRegistrationNumber": "string",
                        "taxRegistrationAddress": {
                            "name": "string",
                            "attention": "string",
                            "addressLine1": "string",
                            "addressLine2": "string",
                            "addressLine3": "string",
                            "city": "string",
                            "county": "string",
                            "district": "string",
                            "stateOrRegion": "string",
                            "postalCode": "string",
                            "countryCode": "string",
                            "phone": "string"
                        },
                        "taxRegistrationMessages": "string"
                    }
                },
                "items": [
                    {
                        "itemSequenceNumber": "string",
                        "buyerProductIdentifier": "string",
                        "vendorProductIdentifier": "string",
                        "title": "string",
                        "orderedQuantity": {
                            "amount": 0,
                            "unitOfMeasure": "Each"
                        },
                        "scheduledDeliveryShipment": {
                            "scheduledDeliveryServiceType": "string",
                            "earliestNominatedDeliveryDate": "2019-08-24T14:15:22Z",
                            "latestNominatedDeliveryDate": "2019-08-24T14:15:22Z"
                        },
                        "giftDetails": {
                            "giftMessage": "string",
                            "giftWrapId": "string"
                        },
                        "netPrice": {
                            "currencyCode": "string",
                            "amount": "string"
                        },
                        "taxDetails": {
                            "taxLineItem": [
                                {
                                    "taxRate": "string",
                                    "taxAmount": {
                                        "currencyCode": "string",
                                        "amount": "string"
                                    },
                                    "taxableAmount": {
                                        "currencyCode": "string",
                                        "amount": "string"
                                    },
                                    "type": "CONSUMPTION"
                                }
                            ]
                        },
                        "totalPrice": {
                            "currencyCode": "string",
                            "amount": "string"
                        },
                        "buyerCustomizedInfo": {
                            "customizedUrl": "string"
                        }
                    }
                ]
            }
        }
    ]
}

🟠400请求有误

🟠403禁止访问

🟠404记录不存在

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障