CompetitiveSummaryBatchRequest

{
  "$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-competitive-summary-batch-request-schema.json",
  "title": "CompetitiveSummaryBatchRequest",
  "description": "The `competitiveSummary` batch request data.",
  "x-generated": "2026-09-24",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-seller-central-productpricing-api-openapi.yml#/components/schemas/CompetitiveSummaryBatchRequest",
  "type": "object",
  "required": [
    "requests"
  ],
  "properties": {
    "requests": {
      "description": "A batched list of `competitiveSummary` requests.",
      "$ref": "#/$defs/CompetitiveSummaryRequestList"
    }
  },
  "$defs": {
    "Asin": {
      "description": "The ASIN of the item.",
      "type": "string"
    },
    "CompetitiveSummaryIncludedData": {
      "type": "string",
      "description": "The supported data types in the `getCompetitiveSummary` API.",
      "enum": [
        "featuredBuyingOptions",
        "referencePrices",
        "lowestPricedOffers",
        "similarItems"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "featuredBuyingOptions",
          "description": "Describes the current segmented featured offer information for the item."
        },
        {
          "value": "referencePrices",
          "description": "Provides reference price points for the item, such as the Competitive Price Threshold."
        },
        {
          "value": "lowestPricedOffers",
          "description": "The lowest-priced standard offers that are available for the item in the Amazon store."
        },
        {
          "value": "similarItems",
          "description": "Provides a list of up to 20 ASINs which are similar to the item."
        }
      ]
    },
    "CompetitiveSummaryRequest": {
      "description": "An individual `competitiveSummary` request for an ASIN and `marketplaceId`.",
      "type": "object",
      "required": [
        "asin",
        "marketplaceId",
        "includedData",
        "method",
        "uri"
      ],
      "properties": {
        "asin": {
          "description": "The Amazon Standard Identification Number for the item.",
          "$ref": "#/$defs/Asin"
        },
        "marketplaceId": {
          "$ref": "#/$defs/MarketplaceId",
          "description": "An Amazon store identifier."
        },
        "includedData": {
          "type": "array",
          "description": "The list of requested competitive pricing data for the product.",
          "items": {
            "$ref": "#/$defs/CompetitiveSummaryIncludedData"
          },
          "minItems": 1
        },
        "lowestPricedOffersInputs": {
          "type": "array",
          "description": "The list of `lowestPricedOffersInput` parameters that are used to build `lowestPricedOffers` in the response. This attribute is only valid if `lowestPricedOffers` is requested in `includedData`",
          "items": {
            "$ref": "#/$defs/LowestPricedOffersInput"
          },
          "minItems": 0,
          "maxItems": 5
        },
        "method": {
          "description": "HTTP method type",
          "$ref": "#/$defs/HttpMethod"
        },
        "uri": {
          "description": "The URI associated with the individual APIs that are called as part of the batch request. For `getCompetitiveSummary`, this is `/products/pricing/2022-05-01/items/competitiveSummary`.",
          "$ref": "#/$defs/HttpUri"
        }
      }
    },
    "CompetitiveSummaryRequestList": {
      "description": "A batched list of `competitiveSummary` requests.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/CompetitiveSummaryRequest"
      },
      "minItems": 1,
      "maxItems": 20
    },
    "Condition": {
      "description": "The condition of the item.",
      "type": "string",
      "enum": [
        "New",
        "Used",
        "Collectible",
        "Refurbished",
        "Club"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "New",
          "description": "New"
        },
        {
          "value": "Used",
          "description": "Used"
        },
        {
          "value": "Collectible",
          "description": "Collectible"
        },
        {
          "value": "Refurbished",
          "description": "Refurbished"
        },
        {
          "value": "Club",
          "description": "Club"
        }
      ]
    },
    "HttpMethod": {
      "description": "The HTTP method associated with an individual request within a batch.",
      "type": "string",
      "enum": [
        "GET",
        "PUT",
        "PATCH",
        "DELETE",
        "POST"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "GET",
          "description": "GET"
        },
        {
          "value": "PUT",
          "description": "PUT"
        },
        {
          "value": "PATCH",
          "description": "PATCH"
        },
        {
          "value": "DELETE",
          "description": "DELETE"
        },
        {
          "value": "POST",
          "description": "POST"
        }
      ]
    },
    "HttpUri": {
      "description": "The URI associated with the individual APIs that are called as part of the batch request.",
      "type": "string",
      "minLength": 6,
      "maxLength": 512
    },
    "LowestPricedOffersInput": {
      "description": "The input required for building `LowestPricedOffers` data in the response.",
      "type": "object",
      "required": [
        "itemCondition",
        "offerType"
      ],
      "properties": {
        "itemCondition": {
          "type": "string",
          "description": "The input parameter specifies the `itemCondition` of the offer that is requested for `LowestPricedOffers`. `New` is the default value for `itemCondition`.",
          "$ref": "#/$defs/Condition"
        },
        "offerType": {
          "type": "string",
          "description": "The input parameter specifies the type of offers requested for `LowestPricedOffers`. This applies to `Consumer` and `Business` offers. `Consumer` is the default `offerType`.",
          "enum": [
            "Consumer"
          ],
          "x-docgen-enum-table-extension": [
            {
              "value": "Consumer",
              "description": "An offer that is available to all Amazon customers."
            }
          ]
        }
      }
    },
    "MarketplaceId": {
      "description": "The `MarketplaceID` is the globally unique identifier of an Amazon store. To find the ID for your Amazon store, refer to [Amazon store IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).",
      "type": "string"
    }
  }
}