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

此API调用用于获取先前生成的收集表单的历史记录。

使用计划：

速率（每秒请求次数）	突发
80	100

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

请求参数

Header 参数

x-amzn-shipping-business-id

enum<string>

可选

亚马逊运输业务将承担此请求。默认值为 AmazonShipping_UK。

枚举值:

AmazonShipping_USAmazonShipping_INAmazonShipping_UKAmazonShipping_UAEAmazonShipping_SAAmazonShipping_EGAmazonShipping_ITAmazonShipping_ESAmazonShipping_FRAmazonShipping_JP

Body 参数application/json

获取历史 API 查询集合的请求架构。

clientReferenceDetails

array[object (ClientReferenceDetail) {2}]

可选

对象以传递关于MCI集成器发货人类型的附加信息：ClientReferenceDetail列表

clientReferenceType

enum<string>

客户参考类型。

必需

枚举值:

IntegratorShipperIdIntegratorMerchantId

clientReferenceId

string

客户参考 ID。

必需

maxResults

integer

可选

查询的最大结果数量。

carrierId

string

可选

运营商提供的产品的运营商标识符。

shipFromAddress

object (Address)

地址。

可选

name

string

必需

地址上的个人、企业或机构名称。

>= 1 字符<= 50 字符

addressLine1

string

地址的第一行。

必需

>= 1 字符<= 60 字符

addressLine2

string

可选

如有需要，附加地址信息。

>= 1 字符<= 60 字符

addressLine3

string

可选

如有需要，附加地址信息。

>= 1 字符<= 60 字符

companyName

string

可选

与该地址相关联的企业或机构名称。

stateOrRegion

string

必需

该人、企业或机构所在的州、县或地区。

city

string

必需

该人、企业或机构所在的城市或城镇。

countryCode

string

必需

两位数字的国家代码。遵循ISO 3166-1 alpha-2格式。

postalCode

string

必需

该地址的邮政编码。它包含一系列字母或数字或两者，有时包括空格或标点符号。

string

可选

与该地址相关的联系人的电子邮件地址。

<= 64 字符

phoneNumber

string

可选

位于该地址的个人、企业或机构的电话号码，包括国家拨号代码。

>= 1 字符<= 20 字符

geocode

object (Geocode)

可选

定义接入点的纬度和经度。

dateRange

object (DateRange)

可选

查询结果的日期范围。

startDate

string <dateTime>

查询开始日期。

可选

endDate

string <dateTime>

查询的结束日期。

可选

示例

{
    "clientReferenceDetails": [
        {
            "clientReferenceType": "IntegratorShipperId",
            "clientReferenceId": "string"
        }
    ],
    "maxResults": 0,
    "carrierId": "string",
    "shipFromAddress": {
        "name": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "companyName": "string",
        "stateOrRegion": "string",
        "city": "string",
        "countryCode": "string",
        "postalCode": "string",
        "email": "string",
        "phoneNumber": "string",
        "geocode": {
            "latitude": "string",
            "longitude": "string"
        }
    },
    "dateRange": {
        "startDate": "string",
        "endDate": "string"
    }
}

示例代码

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

GetCollectionFormHistoryResponse操作的响应。

collectionFormsHistoryRecordList

array[object (CollectionFormsHistoryRecord) {5}]

可选

CollectionFormsHistoryRecord 列表

carrierName

string

可选

此项服务的运营商名称。

creationDate

string <dateTime>

此账户的创建时间。

可选

generationStatus

enum<string>

生成状态。

可选

枚举值:

CompletedInProgress

collectionFormId

string

可选

重印的收集表单ID。

shipFromAddress

object (Address)

地址。

可选

lastRefreshedDate

string

最后刷新日期的收集

可选

示例

{
    "collectionFormsHistoryRecordList": [
        {
            "carrierName": "USPS",
            "creationDate": 1650163712052,
            "generationStatus": "COMPLETED",
            "collectionFormId": "2c631e32-2538-3431-889e-008b6f5a6f11",
            "shipFromAddress": "<**-redacted-**>"
        }
    ],
    "lastRefreshedDate": "April 17 2022 06:20 PM PDT"
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠413413

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障