getCarrierAccountFormInputs

This API will return a list of input schema required to register a shipper account with the carrier.

Usage Plan:

Rate (requests per second)	Burst
80	100

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Request

Header Params

x-amzn-shipping-business-id

enum<string>

optional

Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

Allowed values:

AmazonShipping_USAmazonShipping_INAmazonShipping_UKAmazonShipping_UAEAmazonShipping_SAAmazonShipping_EGAmazonShipping_ITAmazonShipping_ESAmazonShipping_FRAmazonShipping_JP

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The Response for the GetCarrierAccountFormInputsResponse operation.

linkableCarriersList

array[object (LinkableCarrier) {2}]

optional

A list of LinkableCarrier

carrierId

string

optional

The carrier identifier for the offering, provided by the carrier.

linkableAccountTypes

array[object (LinkableAccountType) {2}]

optional

A list of LinkableAccountType

Example

{
    "linkableCarriers": [
        {
            "carrierId": "FedEx",
            "linkableAccountTypes": [
                {
                    "accountTypeId": "",
                    "carrierAccountInputs": [
                        {
                            "descriptionLocalizationKey": "accountNumberDescriptionString",
                            "inputType": "TEXTBOX",
                            "isConfidential": true,
                            "isHidden": false,
                            "isMandatory": true,
                            "name": "ACCOUNT_NUMBER",
                            "validationMetadata": [
                                {
                                    "errorMessage": "stringId4",
                                    "validationStrategy": "MIN_LENGTH",
                                    "value": "5"
                                },
                                {
                                    "errorMessage": "stringId5",
                                    "validationStrategy": "MAX_LENGTH",
                                    "value": "35"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable