--- title: "Get catalogs items" method: GET path: "/catalogs/items" tags: ["catalogs"] --- # Get catalogs items `GET /catalogs/items` Get the items of the catalog created by the "operating user_account". See detailed documentation here. ## Query parameters - `country` string, required - `item_ids` string[], required - `language` string, required ## 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 - object - `item_id` string — The catalog item id in the merchant namespace - `attributes` ItemAttributes - `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://. - `additional_image_link` string[], nullable — The links to additional images for your product. Up to five additional images can be used to show a product from different angles or to show different stages. Separate each additional image with a comma. We recommend enclosing the whole string with quotes. 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: ‘newborn’, ‘infant’, ‘toddler’, ‘kids’, ‘adult’. - `availability` string, nullable — The availability of the product. Must be one of the following values: ‘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 — Set this attribute to FALSE to indicate items that should be excluded from the Pinterest Checkout program. Note, this product is currently being tested and your account must be enrolled. Please contact your Account Manager or contact us for more information. - `color` string, nullable — The primary color of the product. - `condition` string, nullable — The condition of the product. Must be one of the following values: ‘new’, ‘used’, ‘refurbished’. - `custom_label_0` string, nullable — Custom grouping of products. - `custom_label_1` string, nullable — Custom grouping of products. - `custom_label_2` string, nullable — Custom grouping of products. - `custom_label_3` string, nullable — Custom grouping of products. - `custom_label_4` string, nullable — Custom grouping of products. - `description` string — 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: ‘male’, ‘female’, ‘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 — The user-created unique ID that represents the product. Only Unicode characters are accepted. - `image_link` string[] — 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:// - `item_group_id` string, nullable — 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, nullable — 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 — 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. - `size_type` string, nullable — Additional description for the size. Must be one of the following values: ‘regular’, ‘petite’, ‘plus’, ‘big_and_tall’, ‘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 — 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 - `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 ## Other responses - `401` — Not authorized to access catalogs items - `403` — Not authorized to access catalogs items - `default` — Unexpected error ## Changes - **2022-07-11** (v5) `0d5998752011` — 2 warning, 1 info - removed the optional property `items/items/attributes` from the response with the `200` status - removed the optional property `items/items/item_id` from the response with the `200` status - added `subschema #1, subschema #2` to the `items/items/` response property `anyOf` list for the response status `200` - **2022-04-12** (v5) `723c51158044` — 1 info - endpoint added [Change 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/0d5998752011/schema)