Catalog Items API v2020-12-01 Use Case Guide

AmazonSPAPI

# API Version: 2020-12-01

# What is the Catalog Items API?

Using the Selling Partner API for Catalog Items (Catalog Items API), you can retrieve information about items in the Amazon catalog. See the Catalog Items API Reference (opens new window) for details about API operations and associated data types and schemas.

Key Features

  • Retrieve Detailed Item Information: The Catalog Items API provides details about items in the Amazon catalog, such as summarized item details, product identifiers, sales rankings, variations, and thumbnail images. Vendors may retrieve additional vendor-specific details and brand owners of items may retrieve additional attributes and image content.
  • Search for Items: The Catalog Items API allows you to search the Amazon catalog for existing items using keywords, including product identifiers.

Terminology

  • ASIN: Amazon Standard Identification Number that identifies an item in the Amazon catalog.
  • Variation: Every color or size for a catalog item represents a variation that is assigned a different ASIN. They are grouped together as variations of one parent ASIN.

# Tutorial: Retrieve details for an item in the Amazon catalog

Use this tutorial to retrieve information about an item in the Amazon catalog for the given ASIN and marketplaces.

Prerequisites

To complete this tutorial, you will need:

  • Authorization from the Selling Partner for whom you are making calls. See the Selling Partner API Developer Guide (opens new window) for more information.
  • Approval for the Product Listing role in your developer profile.
  • The Product Listing role selected in the App registration page for your application.

# Step 1: Get information about a catalog item

Call the getCatalogItem (opens new window) operation, passing the following parameters:

Request Parameters

Path Parameter

Parameter Example Description Required
asin XXXXXXXXXX Amazon Standard Identification Number for the item of interest.

Type: string

Yes

Query Parameters

Parameter Example Description Required
marketplaceIds ATVPDKIKX0DER A comma-delimited list of Amazon marketplace identifiers.

See the Selling Partner API Developer Guide for the list of Amazon marketplace identifiers.

Type: < string > array(csv)

Yes
includedData summaries A comma-delimited list of item details to request. If none are specified, will default to returning summaries data.

  • attributes - Listable item attributes. Available to the brand owner of the item. Contains all listable item attributes present on the item for its particular product type.
  • identifiers - External item identifiers such as EAN, UPC, ISBN, etc.
  • images - Product images. Each product image will contain the name of the image variant, resolution, and a link to download the image. All requests for images will include the MAIN product image at small resolution. Requests from brand owners will additionally include other image variants at full resolution.
  • productTypes - Item product type data. The category this product sells under in the Amazon marketplace.
  • salesRanks - Item sales ranking data. Each sales ranking will contain the name of the category, the item's ranking, and a link to the sales ranking page on the retail website.
  • summaries - Summary of item data. Basic attributes such as the item name, manufacturer, and brand.
  • variations - Item variation data. Contains the list of the ASINs of the items related to this item and whether this item is a child or parent item.
  • vendorDetails - Item vendor data. Available to vendors. Contains item replenishment, brand, and manufacturer information.

Type: < enum (IncludedData) > array(csv)

No
locale en_US Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.

Type: string

No

Example Request

GET https://sellingpartnerapi-na.amazon.com/catalog/2020-12-01/items/XXXXXXXXXX
   ?marketplaceIds=ATVPDKIKX0DER
   &includedData=attributes,identifiers,images,productTypes,salesRanks,summaries,variations,vendorDetails
1
2
3

Response

A successful response includes the following:

Name Example Description
asin XXXXXXXXXX The requested ASIN.

Type: ItemAsin

attributes See example response A JSON object containing detailed catalog item data. Values from multiple marketplaces are rolled up into a list under each attribute name.

Type: ItemAttributes

identifiers See example response External identifiers such as UPC, EAN, etc., if applicable.

Type: ItemIdentifiers

images See example response Image data for the item.

Type: ItemImages

productTypes See example response The product type category of the item within the Amazon catalog.

Type: ItemProductTypes

ranks See example response The sales ranking data for the item in every category it is tracked in.

Type: ItemSalesRanks

summaries See example response Summary of item data.

Type: ItemSummaries

variations See example response Other ASINs related to this one and whether this one is a parent ASIN or a child ASIN.

Type: ItemVariations

vendorDetails See example response Detailed vendor information for this product.

Type: ItemVendorDetails

Example Response

{
  "asin": "B07N4M94X4",
  "attributes": {
    "total_hdmi_ports": [
      {
        "value": 4,
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "resolution": [
      {
        "language_tag": "en_US",
        "value": "4K",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "item_weight": [
      {
        "unit": "pounds",
        "value": 107.6,
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "product_subcategory": [
      {
        "value": "50400150",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "item_dimensions": [
      {
        "width": {
          "unit": "inches",
          "value": 72.4
        },
        "length": {
          "unit": "inches",
          "value": 2.4
        },
        "height": {
          "unit": "inches",
          "value": 41.4
        },
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "brand": [
      {
        "language_tag": "en_US",
        "value": "Samsung Electronics",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "generic_keyword": [
      {
        "language_tag": "en_US",
        "value": "smart tv; 4k tv; roku tv ;lg tv; oled tv; 65 inch smart tv; 4k tv 65 inch; lg smart tv; nvidia shield tv 2018; tv 4k; oled tv 65; sony 4k tv; 4k smart tv; 4k hdr tv; nvidia shield tv; gaming tv; lg 65 inch 4k tv; tv 65 inch smart tv 4k; 65 inch 4k tv; sony 65 inch 4k tv; vizio 4k tv; uhd tv; uhd tv 4k",
        "marketplace_id": "ATVPDKIKX0DER"
      },
      {
        "language_tag": "en_US",
        "value": "lg oled; 65 inch smart tv; samsung qled 75 inch tv; 85 inch 4k tv; lg smart tv; 4k tv 65 inch; samsung qled 82 inch tv; 8k tv; lg oled 65; lg smart tv; qled samsung 65 inch; 80 inch tv 4k; sony 4k tv; nvidia shield tv 2018",
        "marketplace_id": "ATVPDKIKX0DER"
      },
      {
        "language_tag": "en_US",
        "value": "samsung q9fn qled 2018; vizio; lg oled; lg 4k; sony 4k; sony oled; toshiba; antenna; dvd player; outdoor tv; kitchen tv; fire tv; firetv; hdtv; hd tv; android; shield tv; gaming; deals; tv ears; roku; dvr; speakers; digital tv antenna; apple tv; android tv; frame; mount",
        "marketplace_id": "ATVPDKIKX0DER"
      },
      {
        "language_tag": "en_US",
        "value": "4k hdr tv; 70" tv; nvidia shield tv; 90 inch tv; gaming tv; 75" tv; lg 65 inch 4k tv; tv 65 inch smart tv 4k; 65 inch 4k tv; sony 65 inch 4k tv; vizio 4k tv; uhd tv; uhd tv 4k;",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "control_method": [
      {
        "value": "voice",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "item_package_dimensions": [
      {
        "length": {
          "unit": "centimeters",
          "value": 26.67
        },
        "width": {
          "unit": "centimeters",
          "value": 121.92
        },
        "height": {
          "unit": "centimeters",
          "value": 203.2
        },
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "image_aspect_ratio": [
      {
        "language_tag": "en_US",
        "value": "16:9",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "part_number": [
      {
        "value": "QN82Q60RAFXZA",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "includes_remote": [
      {
        "value": true,
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "item_type_name": [
      {
        "language_tag": "en_US",
        "value": "TV",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "battery": [
      {
        "cell_composition": [
          {
            "value": "alkaline"
          }
        ],
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "manufacturer": [
      {
        "language_tag": "en_US",
        "value": "Samsung",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "number_of_boxes": [
      {
        "value": 1,
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "total_usb_ports": [
      {
        "value": 2,
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "model_number": [
      {
        "value": "QN82Q60RAFXZA",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "supplier_declared_dg_hz_regulation": [
      {
        "value": "not_applicable",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "num_batteries": [
      {
        "quantity": 2,
        "type": "aaa",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "california_proposition_65": [
      {
        "compliance_type": "on_product_combined_cancer_reproductive",
        "marketplace_id": "ATVPDKIKX0DER"
      },
      {
        "compliance_type": "chemical",
        "chemical_names": [
          "di_2_ethylhexyl_phthalate_dehp"
        ],
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "display": [
      {
        "resolution_maximum": [
          {
            "unit": "pixels",
            "language_tag": "en_US",
            "value": "3840 x 2160"
          }
        ],
        "size": [
          {
            "unit": "inches",
            "value": 82
          }
        ],
        "type": [
          {
            "language_tag": "en_US",
            "value": "QLED"
          }
        ],
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "item_name": [
      {
        "language_tag": "en_US",
        "value": "Samsung QN82Q60RAFXZA Flat 82-Inch QLED 4K Q60 Series (2019) Ultra HD Smart TV with HDR and Alexa Compatibility",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "list_price": [
      {
        "currency": "USD",
        "value": 3799.99,
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "batteries_required": [
      {
        "value": false,
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "includes_rechargable_battery": [
      {
        "value": false,
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "product_site_launch_date": [
      {
        "value": "2019-03-11T08:00:01.000Z",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "product_category": [
      {
        "value": "50400100",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "batteries_included": [
      {
        "value": false,
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "connectivity_technology": [
      {
        "language_tag": "en_US",
        "value": "Bluetooth",
        "marketplace_id": "ATVPDKIKX0DER"
      },
      {
        "language_tag": "en_US",
        "value": "USB",
        "marketplace_id": "ATVPDKIKX0DER"
      },
      {
        "language_tag": "en_US",
        "value": "Wireless",
        "marketplace_id": "ATVPDKIKX0DER"
      },
      {
        "language_tag": "en_US",
        "value": "HDMI",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "included_components": [
      {
        "language_tag": "en_US",
        "value": "QLED Standard Smart Remote",
        "marketplace_id": "ATVPDKIKX0DER"
      },
      {
        "language_tag": "en_US",
        "value": "Power Cable",
        "marketplace_id": "ATVPDKIKX0DER"
      },
      {
        "language_tag": "en_US",
        "value": "Stand",
        "marketplace_id": "ATVPDKIKX0DER"
      },
      {
        "language_tag": "en_US",
        "value": "Samsung Smart Control",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "specification_met": [
      {
        "language_tag": "en_US",
        "value": "",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "cpsia_cautionary_statement": [
      {
        "value": "no_warning_applicable",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "item_type_keyword": [
      {
        "value": "qled-televisions",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "number_of_items": [
      {
        "value": 1,
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "warranty_description": [
      {
        "language_tag": "en_US",
        "value": "1 year manufacturer",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "max_resolution": [
      {
        "unit": "pixels",
        "value": 8.3,
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "item_package_weight": [
      {
        "unit": "kilograms",
        "value": 62.142,
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "supported_internet_services": [
      {
        "language_tag": "en_US",
        "value": "Amazon Instant Video",
        "marketplace_id": "ATVPDKIKX0DER"
      },
      {
        "language_tag": "en_US",
        "value": "YouTube",
        "marketplace_id": "ATVPDKIKX0DER"
      },
      {
        "language_tag": "en_US",
        "value": "Netflix",
        "marketplace_id": "ATVPDKIKX0DER"
      },
      {
        "language_tag": "en_US",
        "value": "Hulu",
        "marketplace_id": "ATVPDKIKX0DER"
      },
      {
        "language_tag": "en_US",
        "value": "Browser",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "tuner_technology": [
      {
        "language_tag": "en_US",
        "value": "Analog Tuner",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "wireless_communication_technology": [
      {
        "language_tag": "en_US",
        "value": "Wi-Fi::Wi-Fi Direct::Bluetooth",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "model_year": [
      {
        "value": 2019,
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "power_source_type": [
      {
        "language_tag": "en_US",
        "value": "Corded Electric",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "street_date": [
      {
        "value": "2019-03-21T00:00:01Z",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ],
    "refresh_rate": [
      {
        "unit": "hertz",
        "language_tag": "en_US",
        "value": "120",
        "marketplace_id": "ATVPDKIKX0DER"
      }
    ]
  },
  "identifiers": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "identifiers": [
        {
          "identifier": "0887276302195",
          "identifierType": "EAN"
        },
        {
          "identifier": "00887276302195",
          "identifierType": "GTIN"
        },
        {
          "identifier": "887276302195",
          "identifierType": "UPC"
        }
      ]
    }
  ],
  "images": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "images": [
        {
          "variant": "MAIN",
          "link": "https://m.media-amazon.com/images/I/51DZzp3w3vL.jpg",
          "height": 333,
          "width": 500
        }
      ]
    }
  ],
  "productTypes": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "productType": "TELEVISION"
    }
  ],
  "ranks": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "ranks": [
        {
          "title": "Electronics",
          "link": "http://www.amazon.com/gp/bestsellers/electronics",
          "value": 61667
        },
        {
          "title": "QLED TVs",
          "link": "http://www.amazon.com/gp/bestsellers/electronics/21489946011",
          "value": 84
        }
      ]
    }
  ],
  "summaries": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "brandName": "Samsung Electronics",
      "colorName": "Black",
      "itemName": "Samsung QN82Q60RAFXZA Flat 82-Inch QLED 4K Q60 Series (2019) Ultra HD Smart TV with HDR and Alexa Compatibility",
      "manufacturer": "Samsung",
      "modelNumber": "QN82Q60RAFXZA",
      "sizeName": "82-Inch",
      "styleName": "TV only"
    }
  ],
  "variations": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "asins": [
        "B08J7TQ9FL"
      ],
      "variationType": "CHILD"
    }
  ],
  "vendorDetails": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "brandCode": "SAMF9",
      "categoryCode": "50400100",
      "manufacturerCode": "SAMF9",
      "manufacturerCodeParent": "SAMF9",
      "productGroup": "Home Entertainment",
      "replenishmentCategory": "OBSOLETE",
      "subcategoryCode": "50400150"
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501

# Tutorial: Search for items in the Amazon catalog

Use this tutorial to search for items in the Amazon catalog.

Prerequisites

To complete this tutorial, you will need:

  • Authorization from the Selling Partner for whom you are making calls. See the Selling Partner API Developer Guide (opens new window) for more information.
  • Approval for the Product Listing role in your developer profile.
  • The Product Listing role selected in the App registration page for your application.

# Step 1: Get a list of catalog items and associated information

To search for and return a list of catalog items with the optional associated information you specify, call the searchCatalogItems operation.

Call the searchCatalogItems (opens new window) operation, passing the following parameters:

Request Parameters

Query Parameters

Parameter Example Description Required
keywords shoes A comma-delimited list of words or item identifiers to search the Amazon catalog for.

Type: < string > array(csv)

Yes
marketplaceIds ATVPDKIKX0DER A comma-delimited list of Amazon marketplace identifiers.

See the Selling Partner API Developer Guide for the list of Amazon marketplace identifiers.

Type: < string > array(csv)

Yes
includedData summaries A comma-delimited list of item details to request. If none are specified, will default to returning summaries data.

  • identifiers - External item identifiers such as EAN, UPC, ISBN, etc.
  • images - Product images. Each product image will contain the name of the image variant, resolution, and a link to download the image. All requests for images will include the MAIN product image at small resolution. Requests from brand owners will additionally include other image variants at full resolution.
  • productTypes - Item product type data. The category this product sells under in the Amazon marketplace.
  • salesRanks - Item sales ranking data. Each sales ranking will contain the name of the category, the item's ranking, and a link to the sales ranking page on the retail website.
  • summaries - Summary of item data. Basic attributes such as the item name, manufacturer, and brand.
  • variations - Item variation data. Contains the list of the ASINs of the items related to this item and whether this item is a child or parent item.
  • vendorDetails - Item vendor data. Available to vendors. Contains item replenishment, brand, and manufacturer information.

Type: < enum (IncludedData) > array(csv)

No
brandNames Beautiful Boats A comma-delimited list of brand names to limit the search to.

Type: < string > array(csv)

No
classificationIds 12345678 A comma-delimited list of classification identifiers to limit the search to.

Type: < string > array(csv)

No
pageSize 9 Number of results to be returned per page.

Default: 10

Type: integer

No
pageToken See example response. A token to fetch a certain page when there are multiple pages worth of results.

Type: string

No
keywordsLocale en-US The language the keywords are provided in. Keywords will be translated to the response locale for searching if the two differ.

Type: string

No
locale es-US Return results in this language, if available. If this parameter is not specified, the results will be returned in the marketplace's default language.

Type: string

No

Example Request

GET https://sellingpartnerapi-na.amazon.com/catalog/2020-12-01/items
   ?keywords=red,polo,shirt
   &marketplaceIds=ATVPDKIKX0DER
   &includedData=summaries
   &pageSize=5
1
2
3
4
5

Response

A successful response includes the following:

Name Example Description
numberOfResults 3097 The total number of products matched by the search query (only results up to the page count limit will be returned per request regardless of the number found).

Type: integer

pagination See example response A JSON object containing one or more page tokens that can be used to fetch the next or previous page of results.

Type: Pagination

refinements See example response A JSON object containing keys that can be used to refine the search results down to certain brands or categories.

Type: Refinements

items See example response A list of items from the Amazon catalog.

Type: < Item > array

Example Response

{
    "numberOfResults": 12247,
    "pagination": {
        "nextToken": "9HkIVcuuPmX_bm51o3-igBfN45pxW4Ru7ElIM6GCECYCuXJKzT26f-AlJJZYjIPp8wkOEmQdma1wt_JvE7qiRmNsKy7hH"
    },
    "refinements": {
        "brands": [
            {
                "numberOfResults": 91,
                "brandName": "Polo Ralph Lauren"
            },
            {
                "numberOfResults": 79,
                "brandName": "Eddie Bauer"
            },
            {
                "numberOfResults": 46,
                "brandName": "Cutter & Buck"
            },
            {
                "numberOfResults": 39,
                "brandName": "FILA"
            },
            {
                "numberOfResults": 37,
                "brandName": "Orvis"
            }
        ],
        "classifications": [
            {
                "numberOfResults": 1243,
                "displayName": "Clothing, Shoes & Jewelry",
                "classificationId": "7141124011"
            },
            {
                "numberOfResults": 126,
                "displayName": "Sports & Outdoors",
                "classificationId": "3375301"
            }
        ]
    },
    "items": [
        {
            "asin": "B002N36Q3M",
            "summaries": [
                {
                    "marketplaceId": "ATVPDKIKX0DER",
                    "brandName": "Fred Perry",
                    "colorName": "Wht/Brt Red/Nvy",
                    "itemName": "Fred Perry Men's Twin Tipped Polo Shirt-M1200, WHT/BRT RED/NVY, X-Large",
                    "manufacturer": "Fred Perry Men's Apparel",
                    "modelNumber": "M1200",
                    "sizeName": "X-Large",
                    "styleName": "Twin Tipped Polo Shirt-m1200"
                }
            ]
        },
        {
            "asin": "B002N3ABSI",
            "summaries": [
                {
                    "marketplaceId": "ATVPDKIKX0DER",
                    "brandName": "Fred Perry",
                    "colorName": "White/Bright Red/Navy",
                    "itemName": "Fred Perry Men's Twin Tipped Polo, White/Bright Red/Navy, SM",
                    "manufacturer": "Fred Perry Apparel Mens",
                    "modelNumber": "M1200-748",
                    "sizeName": "SM",
                    "styleName": "Twin Tipped Fred Perry Polo"
                }
            ]
        },
        {
            "asin": "B01N5B3598",
            "summaries": [
                {
                    "marketplaceId": "ATVPDKIKX0DER",
                    "brandName": "NHL",
                    "colorName": "Red",
                    "itemName": "NHL New Jersey Devils Men's Polo, Small, Red",
                    "manufacturer": "Knight's Apparel",
                    "modelNumber": "H0MEE3ZAMZ",
                    "sizeName": "Small"
                }
            ]
        },
        {
            "asin": "B00HIVDUXI",
            "summaries": [
                {
                    "marketplaceId": "ATVPDKIKX0DER",
                    "brandName": "adidas",
                    "colorName": "Bold Red/White",
                    "itemName": "Adidas Golf Men's Puremotion Textured Stripe Polo, Bold Red/White, Large",
                    "manufacturer": "TaylorMade - Adidas Golf Apparel",
                    "modelNumber": "TM3010S4",
                    "sizeName": "Large"
                }
            ]
        },
        {
            "asin": "B005ZZ12YS",
            "summaries": [
                {
                    "marketplaceId": "ATVPDKIKX0DER",
                    "brandName": "RALPH LAUREN",
                    "colorName": "Black / Red Pony",
                    "itemName": "Polo Ralph Lauren Men's Long-sleeved T-shirt / Sleepwear / Thermal in Black, Red Pony (Large / L)",
                    "sizeName": "Large"
                }
            ]
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

# Paging in the response to a search for items in the Amazon catalog

When a call to the searchCatalogItems (opens new window) operation produces a response that exceeds the pageSize, pagination occurs. This means the response is divided into individual pages, where each page is returned in successive calls. To retrieve the next page or the previous page, you must pass the nextToken value or the previousToken value as the pageToken parameter in the next request.

You get the first page of results when you call the searchCatalogItems operation and provide no page token. You then iterate through the rest of the pages using the nextToken page token provided in successive responses.

Page tokens are special values that are decoded to determine which page is requested and how many pages are before or after.

If the next or previous page is not available, the corresponding page token attribute (nextToken or previousToken respectively) will not be present in the pagination object.

Examples:

When the response does not exceed the pageSize, there is no pagination, so there is no nextToken or previousToken:

"pagination": {
},
1
2

When the response exceeds the pageSize and pagination occurs:

For the first page, there is no previous page, so there is no previousToken:

"pagination": {
  "nextToken": "XXXXXX"
},
1
2
3

For the last page, there is no next page, so there is no nextToken:

"pagination": {
  "previousToken": "XXXXXX"
},
1
2
3

For all other pages:

"pagination": {
  "nextToken": "XXXXXX",
  "previousToken": "XXXXXX"
},
1
2
3
4

Note: Even though there can be more than 1000 ASINs that match the search criteria, the maximum number of results that can be returned and paged through is limited to 1000. For example, if the caller sets the pageSize to 10, the maximum number of possible pages is 100.

Last Updated: 10/11/2022, 9:45:34 PM