getCarrierAccounts - Amazon SP API

This API will return Get all carrier accounts for a 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

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 the GetCarrierAccounts operation.

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.

Example

{
    "clientReferenceDetails": [
        {
            "clientReferenceType": "IntegratorShipperId",
            "clientReferenceId": "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 GetCarrierAccountsResponse operation.

activeAccounts

array[object (ActiveAccount) {2}]

required

A list of ActiveAccount

accountId

string

optional

Account Id associated with this account.

carrierId

string

optional

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

Example

{
    "activeAccounts": [
        {
            "accountId": "XX",
            "carrierId": "FedEx"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable