LinkCarrierAccountRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-seller-central/main/json-schema/amazon-seller-central-link-carrier-account-request-schema.json",
  "title": "LinkCarrierAccountRequest",
  "description": "The request schema for verify and add the merchant's account with a certain carrier.",
  "x-generated": "2026-09-24",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-seller-central-shipping-api-openapi.yml#/components/schemas/LinkCarrierAccountRequest",
  "type": "object",
  "required": [
    "carrierAccountAttributes",
    "carrierAccountType"
  ],
  "properties": {
    "clientReferenceDetails": {
      "$ref": "#/$defs/ClientReferenceDetails"
    },
    "carrierAccountType": {
      "$ref": "#/$defs/CarrierAccountType"
    },
    "carrierAccountAttributes": {
      "$ref": "#/$defs/CarrierAccountAttributes"
    },
    "encryptedCarrierAccountAttributes": {
      "$ref": "#/$defs/CarrierAccountAttributes"
    }
  },
  "$defs": {
    "CarrierAccountAttribute": {
      "type": "object",
      "properties": {
        "attributeName": {
          "type": "string",
          "description": "Attribute Name ."
        },
        "propertyGroup": {
          "type": "string",
          "description": "Property Group."
        },
        "value": {
          "type": "string",
          "description": "Value ."
        }
      },
      "description": "Attribute Properties required by carrier"
    },
    "CarrierAccountAttributes": {
      "type": "array",
      "description": "A list of all attributes required by the carrier in order to successfully link the merchant's account",
      "items": {
        "$ref": "#/$defs/CarrierAccountAttribute"
      }
    },
    "CarrierAccountType": {
      "type": "string",
      "description": "CarrierAccountType  associated with account."
    },
    "ClientReferenceDetail": {
      "type": "object",
      "required": [
        "clientReferenceType",
        "clientReferenceId"
      ],
      "properties": {
        "clientReferenceType": {
          "type": "string",
          "description": "Client Reference type.",
          "enum": [
            "IntegratorShipperId",
            "IntegratorMerchantId"
          ],
          "x-docgen-enum-table-extension": [
            {
              "value": "IntegratorShipperId",
              "description": "The unique identifier assigned to a 3P seller by the shipping integrator."
            },
            {
              "value": "IntegratorMerchantId",
              "description": "The unique identifier assigned to a 3P shipping integrator by Amazon."
            }
          ]
        },
        "clientReferenceId": {
          "type": "string",
          "description": "The Client Reference Id."
        }
      },
      "description": "Client Reference Details"
    },
    "ClientReferenceDetails": {
      "type": "array",
      "description": "Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail",
      "items": {
        "$ref": "#/$defs/ClientReferenceDetail"
      }
    }
  }
}