--- title: "Get catalogs items" method: GET path: "/catalogs/items" tags: ["catalogs"] --- # Get catalogs items `GET /catalogs/items` Get the items of the catalog owned by the "operation user_account". See detailed documentation here. - By default, the "operation user_account" is the token user_account. Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager. ## Query parameters - `ad_account_id` string - `country` string, required - `language` string, required - `catalog_id` string - `item_ids` string[] - `hotel_ids` string[] ## Response `200` Response containing the requested catalogs items - CatalogsItems — Response object of catalogs items - `items` ItemResponse[] — Array with catalogs items - union — Object describing an item record - union - object — Object describing a retail item record - `catalog_type` 'RETAIL' | 'HOTEL', required — Type of the catalog entity. - `item_id` string — The catalog retail item id in the merchant namespace - `pins` Pin[], nullable — The pins mapped to the item - `id` string - `created_at` string, date-time - `link` string, nullable - `title` string, nullable - `description` string, nullable - `dominant_color` string, nullable — Dominant pin color. Hex number, e.g. \"#6E7874\". - `alt_text` string, nullable - `creative_type` 'REGULAR' | 'VIDEO' | 'SHOPPING' | 'CAROUSEL' | 'MAX_VIDEO' | 'SHOP_THE_PIN' | 'COLLECTION' | 'IDEA' | 'SHOWCASE' | 'QUIZ' — Ad creative type enum.

Note: SHOP_THE_PIN has been deprecated. Please use COLLECTION instead. - `board_id` string — The board to which this Pin belongs. - `board_section_id` string, nullable — The board section to which this Pin belongs. - `board_owner` BoardOwner - … - `is_owner` boolean — Whether the "operation user_account" is the Pin owner. - `media` PinMedia — Pin media objects. - … - `media_source` union — Pin media source. - … - `parent_pin_id` string, nullable — The source pin id if this pin was saved from another pin. Learn more. - `is_standard` boolean — Whether the Pin is standard or not. See documentation on Changes to Pin creation for more information. - `has_been_promoted` boolean — Whether the Pin has been promoted or not. - `note` string, nullable — Private note for this Pin. Learn more. - `attributes` ItemAttributes - `additional_image_link` string[], nullable —

<= 2000 characters

The links to additional images for your product. Up to ten additional images can be used to show a product from different angles or to show different stages. Must begin with http:// or https://.

- `image_link` string[] —

<= 2000 characters

The link to the main product images. Images should be at least 75x75 pixels to avoid errors. Use the additional_image_link field to add more images of your product. The URL of your image_link must be accessible by the Pinterest user-agent, and send the accurate images. Please make sure there are no template or placeholder images at the link. Must start with http:// or https://.

- `ad_link` string, nullable — Allows advertisers to specify a separate URL that can be used to track traffic coming from Pinterest shopping ads. Must send full URL including tracking—do not send tracking parameters only. At this time we do not support impression tracking. Must begin with http:// or https://. - `adult` boolean, nullable — Set this attribute to TRUE if you're submitting items that are considered “adult”. These will not be shown on Pinterest. - `age_group` string, nullable — The age group to apply a demographic range to the product. Must be one of the following values (upper or lowercased): ‘newborn’ , ‘infant’, ‘toddler’, ‘kids’, or ‘adult’. - `availability` string — The availability of the product. Must be one of the following values (upper or lowercased): ‘in stock’, ‘out of stock’ , ‘preorder’. - `average_review_rating` number, nullable — Average reviews for the item. Can be a number from 1-5. - `brand` string, nullable — The brand of the product. - `checkout_enabled` boolean, nullable — This attribute is not supported anymore. - `color` string, nullable — The primary color of the product. - `condition` string, nullable — The condition of the product. Must be one of the following values (upper or lowercased): ‘new’, ‘used’, or ‘refurbished’. - `custom_label_0` string, nullable —

<= 1000 characters

Custom grouping of products.

- `custom_label_1` string, nullable —

<= 1000 characters

Custom grouping of products.

- `custom_label_2` string, nullable —

<= 1000 characters

Custom grouping of products.

- `custom_label_3` string, nullable —

<= 1000 characters

Custom grouping of products.

- `custom_label_4` string, nullable —

<= 1000 characters

Custom grouping of products.

- `description` string —

<= 10000 characters

The description of the product.

- `free_shipping_label` boolean, nullable — The item is free to ship. - `free_shipping_limit` string, nullable — The minimum order purchase necessary for the customer to get free shipping. Only relevant if free shipping is offered. - `gender` string, nullable — The gender associated with the product. Must be one of the following values (upper or lowercased): ‘male’, ‘female’ , or ‘unisex’. - `google_product_category` string, nullable — The categorization of the product based on the standardized Google Product Taxonomy. This is a set taxonomy. Both the text values and numeric codes are accepted. - `gtin` integer, nullable — The unique universal product identifier. - `id` string —

<= 127 characters

The user-created unique ID that represents the product. Only Unicode characters are accepted.

- `item_group_id` string, nullable —

<= 127 characters

The parent ID of the product.

- `last_updated_time` integer, nullable — The millisecond timestamp when the item was lastly modified by the merchant. - `link` string —

<= 511 characters

The landing page for the product.

- `material` string, nullable — The material used to make the product. - `min_ad_price` string, nullable — The minimum advertised price of the product. It supports the following formats, "19.99 USD", "19.99USD" and "19.99". If the currency is not included, we default to US dollars. - `mobile_link` string, nullable — The mobile-optimized version of your landing page. Must begin with http:// or https://. - `mpn` string, nullable — Manufacturer Part Number are alpha-numeric codes created by the manufacturer of a product to uniquely identify it among all products from the same manufacturer. - `number_of_ratings` integer, nullable — The number of ratings for the item. - `number_of_reviews` integer, nullable — The number of reviews available for the item. - `pattern` string, nullable — The description of the pattern used for the product. - `price` string — The price of the product. It supports the following formats, "24.99 USD", "24.99USD" and "24.99". If the currency is not included, we default to US dollars. - `product_type` string, nullable —

<= 1000 characters

The categorization of your product based on your custom product taxonomy. Subcategories must be sent separated by “ > “. The > must be wrapped by spaces. We do not recognize any other delimiters such as comma or pipe.

- `sale_price` string, nullable — The discounted price of the product. The sale_price must be lower than the price. It supports the following formats, "14.99 USD", "14.99USD" and "14.99". If the currency is not included, we default to US dollars. - `shipping` string, nullable — Shipping consists of one group of up to four elements, country, region, service (all optional) and price (required). All colons, even for blank values, are required. - `shipping_height` string, nullable — The height of the package needed to ship the product. Ensure there is a space between the numeric string and the metric. - `shipping_weight` string, nullable — The weight of the product. Ensure there is a space between the numeric string and the metric. - `shipping_width` string, nullable — The width of the package needed to ship the product. Ensure there is a space between the numeric string and the metric. - `size` string, nullable — The size of the product. - `size_system` string, nullable — Indicates the country’s sizing system in which you are submitting your product. Must be one of the following values (upper or lowercased): ‘US’, ‘UK’, ‘EU’, ‘DE’ , ‘FR’, ‘JP’, ‘CN’, ‘IT’, ‘ BR’, ‘MEX’, or ‘AU’. - `size_type` string, nullable — Additional description for the size. Must be one of the following values (upper or lowercased): ‘regular’, ‘petite’ , ‘plus’, ‘big_and_tall’, or ‘maternity’. - `tax` string, nullable — Tax consists of one group of up to four elements, country, region, rate (all required) and tax_ship (optional). All colons, even for blank values, are required. - `title` string —

<= 500 characters

The name of the product.

- `variant_names` string[], nullable — Options for this variant. People will see these options next to your Pin and can select the one they want. List them in the order you want them displayed. - `variant_values` string[], nullable — Option values for this variant. People will see these options next to your Pin and can select the one they want. List them in the order you want them displayed. The order of the variant values must be consistent with the order of the variant names. - object — Object describing a hotel record - `catalog_type` 'RETAIL' | 'HOTEL', required — Type of the catalog entity. - `hotel_id` string — The catalog hotel id in the merchant namespace - `pins` Pin[], nullable — The pins mapped to the item - `id` string - `created_at` string, date-time - `link` string, nullable - `title` string, nullable - `description` string, nullable - `dominant_color` string, nullable — Dominant pin color. Hex number, e.g. \"#6E7874\". - `alt_text` string, nullable - `creative_type` 'REGULAR' | 'VIDEO' | 'SHOPPING' | 'CAROUSEL' | 'MAX_VIDEO' | 'SHOP_THE_PIN' | 'COLLECTION' | 'IDEA' | 'SHOWCASE' | 'QUIZ' — Ad creative type enum.

Note: SHOP_THE_PIN has been deprecated. Please use COLLECTION instead. - `board_id` string — The board to which this Pin belongs. - `board_section_id` string, nullable — The board section to which this Pin belongs. - `board_owner` BoardOwner - … - `is_owner` boolean — Whether the "operation user_account" is the Pin owner. - `media` PinMedia — Pin media objects. - … - `media_source` union — Pin media source. - … - `parent_pin_id` string, nullable — The source pin id if this pin was saved from another pin. Learn more. - `is_standard` boolean — Whether the Pin is standard or not. See documentation on Changes to Pin creation for more information. - `has_been_promoted` boolean — Whether the Pin has been promoted or not. - `note` string, nullable — Private note for this Pin. Learn more. - `attributes` CatalogsHotelAttributes - `name` string, nullable — The hotel's name. - `link` string, nullable — Link to the product page - `description` string, nullable — Brief description of the hotel. - `brand` string, nullable — The brand to which this hotel belongs to. - `latitude` number — Latitude of the hotel. - `longitude` number, nullable — Longitude of the hotel. - `neighborhood` string[], nullable — A list of neighborhoods where the hotel is located - `address` CatalogsHotelAddress - … - `custom_label` string[], nullable — A list of custom labels - `category` string, nullable — The type of property. The category can be any type of internal description desired. - `base_price` string, nullable — Base price of the hotel room per night followed by the ISO currency code - `sale_price` string, nullable — Sale price of a hotel room per night. Used to advertise discounts off the regular price of the hotel. - `guest_ratings` CatalogsHotelGuestRatings — If specified, you must provide all properties - … - union - object — Object describing a retail item error - `catalog_type` 'RETAIL' | 'HOTEL', required — Type of the catalog entity. - `item_id` string — The catalog item id in the merchant namespace - `errors` ItemValidationEvent[] — Array with the errors for the item id requested - `attribute` string — The attribute that the item validation event references - `code` integer — The event code that the item validation event references - `message` string — Title message describing the item validation event - object — Object describing a hotel item error - `catalog_type` 'RETAIL' | 'HOTEL', required — Type of the catalog entity. - `hotel_id` string — The catalog hotel id in the merchant namespace - `errors` ItemValidationEvent[] — Array with the errors for the item id requested - `attribute` string — The attribute that the item validation event references - `code` integer — The event code that the item validation event references - `message` string — Title message describing the item validation event ## Other responses - `400` — Invalid request parameters. - `401` — Not authorized to access catalogs items - `403` — Not authorized to access catalogs items - `default` — Unexpected error ## Changes - **2023-08-17** (v5) `0ff12596bafd` — 5 info - added the new optional `query` request parameter `catalog_id` - added the new optional `query` request parameter `hotel_ids` - the `query` request parameter `item_ids` became optional - added `subschema #1, subschema #2` to the `items/items/` response property `anyOf` list for the response status `200` - …1 more - **2023-07-14** (v5) `52586a274771` — 1 info - added the optional property `items/items/anyOf[subschema #1]/pins` to the response with the `200` status - **2022-11-14** (v5) `e041d7b0cef0` — 2 info - added the new optional `query` request parameter `ad_account_id` - added the non-success response with the status `400` - **2022-09-07** (v5) `bd20b6eb152f` — 47 warning, 1 info - removed the optional property `items/items/anyOf[subschema #1]/attributes/ad_link` from the response with the `200` status - removed the optional property `items/items/anyOf[subschema #1]/attributes/additional_image_link` from the response with the `200` status - removed the optional property `items/items/anyOf[subschema #1]/attributes/adult` from the response with the `200` status - removed the optional property `items/items/anyOf[subschema #1]/attributes/age_group` from the response with the `200` status - …44 more - …earlier changes not shown [Full history](https://skmtc.dev/pinterest/apis/pinterest-rest-api/changes/catalogs/items/get.md) --- [API](https://skmtc.dev/pinterest/apis/pinterest-rest-api.md) · [All operations](https://skmtc.dev/pinterest/apis/pinterest-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pinterest/pinterest-rest-api/revisions/0ff12596bafd/schema)