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

此API调用用于生成收集表单。

使用计划：

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

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

请求参数

Header 参数

x-amzn-IdempotencyKey

string

可选

服务器用来识别后续重试相同请求的唯一值。

x-amzn-shipping-business-id

enum<string>

可选

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

枚举值:

AmazonShipping_USAmazonShipping_INAmazonShipping_UKAmazonShipping_UAEAmazonShipping_SAAmazonShipping_EGAmazonShipping_ITAmazonShipping_ESAmazonShipping_FRAmazonShipping_JP

Body 参数application/json

请求架构调用以生成集合表单。

clientReferenceDetails

array[object (ClientReferenceDetail) {2}]

可选

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

clientReferenceType

enum<string>

客户参考类型。

必需

枚举值:

IntegratorShipperIdIntegratorMerchantId

clientReferenceId

string

客户参考 ID。

必需

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)

可选

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

示例

{
    "clientReferenceDetails": [
        {
            "clientReferenceType": "IntegratorShipperId",
            "clientReferenceId": "string"
        }
    ],
    "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"
        }
    }
}

示例代码

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

GenerateCollectionFormResponse 操作的响应。

collectionsFormDocument

object (CollectionsFormDocument)

收集表格文档详情

可选

base64EncodedContent

string

可选

Base64文档集合值。

documentFormat

string <application/pdf>

可选

收集文件格式为PDF。

示例

{
    "collectionsFormDocument": {
        "base64EncodedContent": "VGhpcyBpcyBzb21lIHRleHQgdG8gY29udmVydCB2aWEgQ3J5cHQu",
        "documentFormat": "application/pdf"
    }
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠413413

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障