--- title: "Get catalogs items (POST)" method: POST path: "/catalogs/items" tags: ["catalog_items"] --- # Get catalogs items (POST) `POST /catalogs/items` Get the items of the catalog owned by the "operation user_account". [See detailed documentation here.](/docs/api-features/shopping-overview/#Update%20items%20in%20batch) - By default, the "operation user_account" is the token user_account. Optional: Business Access: Specify an `ad_account_id` (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) 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](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager. Note: Access to the Creative Assets catalog type is restricted to a specific group of users. If you require access, please reach out to your partner manager. ## Query parameters - `ad_account_id` string ## Request body - CatalogsItemsRequest — Request object of catalogs items - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required — Country ID from ISO 3166-1 alpha-2. - `filters` union, required - object - `catalog_id` string — Catalog id pertaining to the retail item. If not provided, default to oldest retail catalog - `catalog_type` 'RETAIL', required - `item_ids` string[], required - object - `catalog_id` string — Catalog id pertaining to the hotel item. If not provided, default to oldest hotel catalog - `catalog_type` 'HOTEL', required - `hotel_ids` string[], required - object - `catalog_id` string — Catalog id pertaining to the creative assets item. If not provided, default to oldest creative assets catalog - `catalog_type` 'CREATIVE_ASSETS', required - `creative_assets_ids` string[], required - `language` union, required — We recommend using the CatalogsLocale values. - 'af-ZA' | 'ar-SA' | 'bg-BG' | 'bn-IN' | 'cs-CZ' | 'da-DK' | 'de' | 'el-GR' | 'en-AU' | 'en-CA' | 'en-GB' | 'en-IN' | 'en-US' | 'es-419' | 'es-AR' | 'es-ES' | 'es-MX' | 'fi-FI' | 'fr' | 'fr-CA' | 'he-IL' | 'hi-IN' | 'hr-HR' | 'hu-HU' | 'id-ID' | 'it' | 'ja' | 'ko-KR' | 'ms-MY' | 'nb-NO' | 'nl' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'ro-RO' | 'ru-RU' | 'sk-SK' | 'sv-SE' | 'te-IN' | 'th-TH' | 'tl-PH' | 'tr' | 'uk-UA' | 'vi-VN' | 'zh-CN' | 'zh-TW' - 'AM' | 'AR' | 'AZ' | 'BG' | 'BN' | 'BS' | 'CA' | 'CS' | 'DA' | 'DV' | 'DZ' | 'DE' | 'EL' | 'EN' | 'ES' | 'ET' | 'FA' | 'FI' | 'FR' | 'HE' | 'HI' | 'HR' | 'HU' | 'HY' | 'ID' | 'IN' | 'IS' | 'IT' | 'IW' | 'JA' | 'KA' | 'KM' | 'KO' | 'LO' | 'LT' | 'LV' | 'MK' | 'MN' | 'MS' | 'MY' | 'NB' | 'NE' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO' | 'RU' | 'SK' | 'SL' | 'SQ' | 'SR' | 'SV' | 'TL' | 'UK' | 'VI' | 'TE' | 'TH' | 'TR' | 'XX' | 'ZH' — Language code, which is among the official ISO 639-1 language list. ## Response `200` The request has succeeded. - object - `items` ItemResponse[], required - union — Object describing an item record or error. Discriminated by `item_response_kind` (one unique value per leaf). - object — Object describing a retail item record - `attributes` ItemAttributes - `ad_image_0_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_0_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_10_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_10_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_11_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_11_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_12_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_12_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_13_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_13_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_14_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_14_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_15_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_15_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_16_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_16_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_17_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_17_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_18_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_18_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_19_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_19_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_1_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_1_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_2_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_2_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_3_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_3_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_4_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_4_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_5_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_5_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_6_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_6_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_7_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_7_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_8_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_8_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `ad_image_9_link` string, nullable — Ad image link that supplements main image for shopping campaigns. Image format:- Pixel size at least 75 x 75 Link guidelines:- Include extension in file name - Do not include template or placeholder images in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_image_9_tag` string, nullable — Ad image tag. If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute. - `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. Must begin with http:// or https://. - `ad_video_0_link` string, nullable — Restricted. Ad video link that supplements main video for shopping campaigns. Video format:- Pixel size between 75 x 75 and 9450 x 9450 - File size smaller than 2 GB - Time span between 4 seconds and 15 minutes - Accepted formats: .MP4, .MOV, .M4V Link guidelines:- Include extension in file name - Do not include template or placeholder videos in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_video_0_tag` string, nullable — Restricted. Ad video tag. If you provide an ad_video_x_link, include the video tag with the corresponding ad_video_x_tag attribute. - `ad_video_1_link` string, nullable — Restricted. Ad video link that supplements main video for shopping campaigns. Video format:- Pixel size between 75 x 75 and 9450 x 9450 - File size smaller than 2 GB - Time span between 4 seconds and 15 minutes - Accepted formats: .MP4, .MOV, .M4V Link guidelines:- Include extension in file name - Do not include template or placeholder videos in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_video_1_tag` string, nullable — Restricted. Ad video tag. If you provide an ad_video_x_link, include the video tag with the corresponding ad_video_x_tag attribute. - `ad_video_2_link` string, nullable — Restricted. Ad video link that supplements main video for shopping campaigns. Video format:- Pixel size between 75 x 75 and 9450 x 9450 - File size smaller than 2 GB - Time span between 4 seconds and 15 minutes - Accepted formats: .MP4, .MOV, .M4V Link guidelines:- Include extension in file name - Do not include template or placeholder videos in link - Make URL accessible to Pinterest user-agent - Must start with http:// or https:// - `ad_video_2_tag` string, nullable — Restricted. Ad video tag. If you provide an ad_video_x_link, include the video tag with the corresponding ad_video_x_tag attribute. - `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'. - `android_deep_link` string — The deep link to the product on the Android app. - `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 — <= 511 characters for retail and creative asset catalogs, <= 127 characters for hotel catalogs. Custom grouping of products. - `custom_label_1` string, nullable — <= 511 characters for retail and creative asset catalogs, <= 127 characters for hotel catalogs. Custom grouping of products. - `custom_label_2` string, nullable — <= 511 characters for retail and creative asset catalogs, <= 127 characters for hotel catalogs. Custom grouping of products. - `custom_label_3` string, nullable — <= 511 characters for retail and creative asset catalogs, <= 127 characters for hotel catalogs. Custom grouping of products. - `custom_label_4` string, nullable — <= 511 characters for retail and creative asset catalogs, <= 127 characters for hotel catalogs. Custom grouping of products. - `custom_number_0` integer, nullable — An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. - `custom_number_1` integer, nullable — An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. - `custom_number_2` integer, nullable — An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. - `custom_number_3` integer, nullable — An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. - `custom_number_4` integer, nullable — An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. - `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` union — The unique universal product identifier. - string, nullable - integer, nullable — DEPRECATED: Integer format will be removed in future versions. Please use string format to preserve leading zeros and maintain GTIN integrity. - `id` string — <= 127 characters. The user-created unique ID that represents the product. Only Unicode characters are accepted. - `installment_price` string, nullable — Installment price of the product. Expected format: : - `ios_deep_link` string — The deep link to the product on the iOS app. - `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 " > ". - `promotion_id` string, nullable — A unique identifier referencing the promotion associated with this catalog item. - `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". - `sale_price_effective_date` string, nullable — Sale price effective date. Expected format: / (ISO 8601 format) - `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. - `unit_pricing_base_measure` string, nullable — Unit pricing base measure of the product. Expected format: - `unit_pricing_measure` string, nullable — Unit pricing total measure of the product. Expected format: - `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. - `catalog_type` 'RETAIL', required - `item_id` string — The catalog retail item id in the merchant namespace - `item_response_kind` 'retail_item', required — Discriminator literal identifying this leaf inside an `ItemResponse` payload. - `pins` Pin[], nullable — The pins mapped to the item - `ai_disclosures` AiDisclosures — AI disclosure declarations the creator has made about the Pin. - `values` AiDisclosureItem[], required — List of AI disclosure declarations the creator has made about this Pin. - `board_id` string — The board to which this Pin belongs. - `board_owner` BoardOwner - `username` string - `board_section_id` string, nullable — The board section to which this Pin belongs. - `created_at` string, date-time - `creative_type` 'REGULAR' | 'VIDEO' | 'SHOPPING' | 'CAROUSEL' | 'MAX_VIDEO' | 'SHOP_THE_PIN' | 'COLLECTION' | 'IDEA' | 'SHOWCASE' | 'QUIZ' | 'COLLAGE' | 'MAX_WIDTH_REGULAR_COLLECTION' | 'MAX_WIDTH_VIDEO_COLLECTION' | 'APP' — Ad creative type enum. **Note:** SHOP_THE_PIN has been deprecated. Please use COLLECTION instead. - `dominant_color` string, nullable — Dominant pin color. Hex number, e.g. `#6E7874`. - `has_been_promoted` boolean — Whether the Pin has been promoted or not. - `id` string, required - `is_owner` boolean — Whether the "operation user_account" is the Pin owner. - `is_product` boolean — Whether the Pin is a product Pin. - `is_standard` boolean — Whether the Pin is standard or not. See documentation on [Changes to Pin creation](/docs/api-features/content-overview/) for more information. - `media` union — Pin media that can be an image, video, or a mix of both. - object — Pin with image. - … - object — Pin with video. - … - object — Pin with multiple images. - … - object — Pin with multiple videos. - … - object — Pin with a mix of images and videos. - … - `parent_pin_id` string, nullable — The source pin id if this pin was saved from another pin. [Learn more](https://help.pinterest.com/article/save-pins-on-pinterest). - `pin_metrics` object, nullable — Pin metrics with associated time intervals if any. - object — Object describing a hotel record - `attributes` CatalogsHotelAttributes - `address` CatalogsHotelAddress - `addr1` string — Primary street address of hotel. - `city` string — City where the hotel is located. - `country` string — Country where the hotel is located. - `postal_code` string — Required for countries with a postal code system. Postal or zip code of the hotel. - `region` string — State, county, province, where the hotel is located. - `base_price` string, nullable — Base price of the hotel room per night followed by the ISO currency code - `brand` string, nullable — The brand to which this hotel belongs to. - `category` string, nullable — The type of property. The category can be any type of internal description desired. - `custom_label_0` string, nullable — Custom grouping of hotels - `custom_label_1` string, nullable — Custom grouping of hotels - `custom_label_2` string, nullable — Custom grouping of hotels - `custom_label_3` string, nullable — Custom grouping of hotels - `custom_label_4` string, nullable — Custom grouping of hotels - `description` string, nullable — Brief description of the hotel. - `guest_ratings` CatalogsHotelGuestRatings - `max_score` number, nullable — Max value for the hotel rating score. - `number_of_reviewers` integer, nullable — Total number of people who have rated this hotel. - `rating_system` string, nullable — System you use for guest reviews. - `score` number, nullable — Your hotel's rating. - `latitude` number — Latitude of the hotel. - `link` string, nullable — Link to the product page - `longitude` number, nullable — Longitude of the hotel. - `name` string, nullable — The hotel's name. - `neighborhood` string[], nullable — A list of neighborhoods where the hotel is located - `sale_price` string, nullable — Sale price of a hotel room per night. Used to advertise discounts off the regular price of the hotel. - `catalog_type` 'HOTEL', required - `hotel_id` string — The catalog hotel id in the merchant namespace - `item_response_kind` 'hotel_item', required — Discriminator literal identifying this leaf inside an `ItemResponse` payload. - `pins` Pin[], nullable — The pins mapped to the item - `ai_disclosures` AiDisclosures — AI disclosure declarations the creator has made about the Pin. - `values` AiDisclosureItem[], required — List of AI disclosure declarations the creator has made about this Pin. - `board_id` string — The board to which this Pin belongs. - `board_owner` BoardOwner - `username` string - `board_section_id` string, nullable — The board section to which this Pin belongs. - `created_at` string, date-time - `creative_type` 'REGULAR' | 'VIDEO' | 'SHOPPING' | 'CAROUSEL' | 'MAX_VIDEO' | 'SHOP_THE_PIN' | 'COLLECTION' | 'IDEA' | 'SHOWCASE' | 'QUIZ' | 'COLLAGE' | 'MAX_WIDTH_REGULAR_COLLECTION' | 'MAX_WIDTH_VIDEO_COLLECTION' | 'APP' — Ad creative type enum. **Note:** SHOP_THE_PIN has been deprecated. Please use COLLECTION instead. - `dominant_color` string, nullable — Dominant pin color. Hex number, e.g. `#6E7874`. - `has_been_promoted` boolean — Whether the Pin has been promoted or not. - `id` string, required - `is_owner` boolean — Whether the "operation user_account" is the Pin owner. - `is_product` boolean — Whether the Pin is a product Pin. - `is_standard` boolean — Whether the Pin is standard or not. See documentation on [Changes to Pin creation](/docs/api-features/content-overview/) for more information. - `media` union — Pin media that can be an image, video, or a mix of both. - object — Pin with image. - … - object — Pin with video. - … - object — Pin with multiple images. - … - object — Pin with multiple videos. - … - object — Pin with a mix of images and videos. - … - `parent_pin_id` string, nullable — The source pin id if this pin was saved from another pin. [Learn more](https://help.pinterest.com/article/save-pins-on-pinterest). - `pin_metrics` object, nullable — Pin metrics with associated time intervals if any. - object — Object describing a creative assets item record - `attributes` CatalogsCreativeAssetsAttributes - `android_deep_link` string, nullable — Link to the creative assets page. - `custom_label_0` string, nullable — Custom grouping of creative assets. - `custom_label_1` string, nullable — Custom grouping of creative assets. - `custom_label_2` string, nullable — Custom grouping of creative assets. - `custom_label_3` string, nullable — Custom grouping of creative assets. - `custom_label_4` string, nullable — Custom grouping of creative assets. - `description` string — Brief description of the creative assets. - `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. - `ios_deep_link` string, nullable — IOS deep link to the creative assets page. - `link` string — Link to the creative assets page. - `title` string — The name of the creative assets. - `visibility` string, nullable — Visibility of the creative assets. Must be one of the following values (upper or lowercase): 'visible', 'hidden'. - `catalog_type` 'CREATIVE_ASSETS', required - `creative_assets_id` string — The catalog creative assets id in the merchant namespace - `item_response_kind` 'creative_assets_item', required — Discriminator literal identifying this leaf inside an `ItemResponse` payload. - `pins` Pin[], nullable — The pins mapped to the item - `ai_disclosures` AiDisclosures — AI disclosure declarations the creator has made about the Pin. - `values` AiDisclosureItem[], required — List of AI disclosure declarations the creator has made about this Pin. - `board_id` string — The board to which this Pin belongs. - `board_owner` BoardOwner - `username` string - `board_section_id` string, nullable — The board section to which this Pin belongs. - `created_at` string, date-time - `creative_type` 'REGULAR' | 'VIDEO' | 'SHOPPING' | 'CAROUSEL' | 'MAX_VIDEO' | 'SHOP_THE_PIN' | 'COLLECTION' | 'IDEA' | 'SHOWCASE' | 'QUIZ' | 'COLLAGE' | 'MAX_WIDTH_REGULAR_COLLECTION' | 'MAX_WIDTH_VIDEO_COLLECTION' | 'APP' — Ad creative type enum. **Note:** SHOP_THE_PIN has been deprecated. Please use COLLECTION instead. - `dominant_color` string, nullable — Dominant pin color. Hex number, e.g. `#6E7874`. - `has_been_promoted` boolean — Whether the Pin has been promoted or not. - `id` string, required - `is_owner` boolean — Whether the "operation user_account" is the Pin owner. - `is_product` boolean — Whether the Pin is a product Pin. - `is_standard` boolean — Whether the Pin is standard or not. See documentation on [Changes to Pin creation](/docs/api-features/content-overview/) for more information. - `media` union — Pin media that can be an image, video, or a mix of both. - object — Pin with image. - … - object — Pin with video. - … - object — Pin with multiple images. - … - object — Pin with multiple videos. - … - object — Pin with a mix of images and videos. - … - `parent_pin_id` string, nullable — The source pin id if this pin was saved from another pin. [Learn more](https://help.pinterest.com/article/save-pins-on-pinterest). - `pin_metrics` object, nullable — Pin metrics with associated time intervals if any. - object — Object describing a retail item error - `catalog_type` 'RETAIL', required - `errors` ItemValidationEvent[], required — 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 - `item_id` string — The catalog item id in the merchant namespace - `item_response_kind` 'retail_item_error', required — Discriminator literal identifying this leaf inside an `ItemResponse` payload. - object — Object describing a hotel item error - `catalog_type` 'HOTEL', required - `errors` ItemValidationEvent[], required — 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 - `hotel_id` string — The catalog hotel id in the merchant namespace - `item_response_kind` 'hotel_item_error', required — Discriminator literal identifying this leaf inside an `ItemResponse` payload. - object — Object describing a creative assets item error - `catalog_type` 'CREATIVE_ASSETS', required - `creative_assets_id` string — The catalog creative assets id in the merchant namespace - `errors` ItemValidationEvent[], required — 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 - `item_response_kind` 'creative_assets_item_error', required — Discriminator literal identifying this leaf inside an `ItemResponse` payload. ## Other responses - `400` — The request could not be understood by the server due to unexpected data. - `401` — Authentication is required and has either failed or not been provided. - `403` — The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource. - `404` — The requested resource could not be found on this server. - `429` — The user has sent too many requests in a given amount of time and is being rate limited. - `default` — An unexpected error response. --- [API](https://skmtc.net/pinterest/apis/pinterest-rest-api.md) · [All operations](https://skmtc.net/pinterest/apis/pinterest-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pinterest/pinterest-rest-api/revisions/b698c180678a/schema)