linkCarrierAccount - Amazon SP API

This API associates/links the specified carrier account with the merchant.

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

Path Params

carrierId

string

required

The unique identifier associated with the carrier account.

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

Body Params application/json

The request schema for verify and add the merchant's account with a certain carrier.

clientReferenceDetails

array[object (ClientReferenceDetail) {2}]

optional

Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail

clientReferenceType

enum<string>

required

Client Reference type.

Allowed values:

IntegratorShipperIdIntegratorMerchantId

clientReferenceId

string

required

The Client Reference Id.

carrierAccountType

string

required

CarrierAccountType associated with account.

carrierAccountAttributes

array[object (CarrierAccountAttribute) {3}]

required

A list of all attributes required by the carrier in order to successfully link the merchant's account

attributeName

string

optional

Attribute Name .

propertyGroup

string

optional

Property Group.

value

string

optional

Value .

encryptedCarrierAccountAttributes

array[object (CarrierAccountAttribute) {3}]

optional

A list of all attributes required by the carrier in order to successfully link the merchant's account

Example

{
    "clientReferenceDetails": [
        {
            "clientReferenceType": "IntegratorShipperId",
            "clientReferenceId": "string"
        }
    ],
    "carrierAccountType": "string",
    "carrierAccountAttributes": [
        {
            "attributeName": "string",
            "propertyGroup": "string",
            "value": "string"
        }
    ],
    "encryptedCarrierAccountAttributes": [
        {
            "attributeName": "string",
            "propertyGroup": "string",
            "value": "string"
        }
    ]
}

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 LinkCarrierAccount operation.

registrationStatus

enum<string>

optional

Account Status.

Allowed values:

ACTIVEINACTIVEPENDINGSUSPENDED

Example

{
    "registrationStatus": "ACTIVE"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable