Get catalogs items
GET {{baseUrl}}/catalogs/items?ad_account_id=15266090296&country=<string>&language=<string>&item_ids=<string>&item_ids=<string>&filters[catalog_type]=RETAIL&filters[item_ids][0]=<string>&filters[catalog_id]=7
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 adaccountid
(obtained via List ad accounts) to use the owner of that adaccount as the "operation useraccount. In order to do this, the token user_account must have one of the following https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts">Business Access roles on the ad_account: Owner, Admin, Catalogs Manager.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
ad_account_id | number | Unique identifier of an ad account. | |
country | string | (Required) Country for the Catalogs Items | |
language | string | (Required) Language for the Catalogs Items | |
item_ids | string | This parameter is deprecated. Use filters instead. | |
item_ids | string | This parameter is deprecated. Use filters instead. | |
filters[catalog_type] | string | Identifies items to be retrieved. This is a required parameter. | |
filters[item_ids][0] | string | Identifies items to be retrieved. This is a required parameter. | |
filters[catalog_id] | number | Identifies items to be retrieved. This is a required parameter. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"catalog_type":"HOTEL","item_id":"\u003cstring\u003e","pins":[{"id":"07","created_at":"\u003cdateTime\u003e","link":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","dominant_color":"\u003cstring\u003e","alt_text":"\u003cstring\u003e","creative_type":"QUIZ","board_id":"885081161","board_section_id":"5157888","board_owner":{"username":"\u003cstring\u003e"},"is_owner":"\u003cboolean\u003e","media":{"media_type":"\u003cstring\u003e"},"media_source":{"source_type":"image_base64","content_type":"image/png","data":"l","is_standard":true},"parent_pin_id":"63005425518","is_standard":"\u003cboolean\u003e","has_been_promoted":"\u003cboolean\u003e","note":"\u003cstring\u003e","pin_metrics":{}},{"id":"53049361334","created_at":"\u003cdateTime\u003e","link":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","dominant_color":"\u003cstring\u003e","alt_text":"\u003cstring\u003e","creative_type":"COLLECTION","board_id":"32","board_section_id":"863","board_owner":{"username":"\u003cstring\u003e"},"is_owner":"\u003cboolean\u003e","media":{"media_type":"\u003cstring\u003e"},"media_source":{"source_type":"image_base64","content_type":"image/png","data":"I3gHAPI","is_standard":true},"parent_pin_id":"0","is_standard":"\u003cboolean\u003e","has_been_promoted":"\u003cboolean\u003e","note":"\u003cstring\u003e","pin_metrics":{}}],"attributes":{"additional_image_link":["\u003cstring\u003e","\u003cstring\u003e"],"image_link":["\u003cstring\u003e"],"ad_link":"\u003cstring\u003e","adult":"\u003cboolean\u003e","age_group":"\u003cstring\u003e","availability":"\u003cstring\u003e","average_review_rating":"\u003cnumber\u003e","brand":"\u003cstring\u003e","checkout_enabled":"\u003cboolean\u003e","color":"\u003cstring\u003e","condition":"\u003cstring\u003e","custom_label_0":"\u003cstring\u003e","custom_label_1":"\u003cstring\u003e","custom_label_2":"\u003cstring\u003e","custom_label_3":"\u003cstring\u003e","custom_label_4":"\u003cstring\u003e","description":"\u003cstring\u003e","free_shipping_label":"\u003cboolean\u003e","free_shipping_limit":"\u003cstring\u003e","gender":"\u003cstring\u003e","google_product_category":"\u003cstring\u003e","gtin":"\u003cinteger\u003e","id":"\u003cstring\u003e","item_group_id":"\u003cstring\u003e","last_updated_time":"\u003clong\u003e","link":"\u003cstring\u003e","material":"\u003cstring\u003e","min_ad_price":"\u003cstring\u003e","mobile_link":"\u003cstring\u003e","mpn":"\u003cstring\u003e","number_of_ratings":"\u003cinteger\u003e","number_of_reviews":"\u003cinteger\u003e","pattern":"\u003cstring\u003e","price":"\u003cstring\u003e","product_type":"\u003cstring\u003e","sale_price":"\u003cstring\u003e","shipping":"\u003cstring\u003e","shipping_height":"\u003cstring\u003e","shipping_weight":"\u003cstring\u003e","shipping_width":"\u003cstring\u003e","size":"\u003cstring\u003e","size_system":"\u003cstring\u003e","size_type":"\u003cstring\u003e","tax":"\u003cstring\u003e","title":"\u003cstring\u003e","variant_names":["\u003cstring\u003e","\u003cstring\u003e"],"variant_values":["\u003cstring\u003e","\u003cstring\u003e"]}},{"catalog_type":"RETAIL","item_id":"\u003cstring\u003e","pins":[{"id":"10341082676","created_at":"\u003cdateTime\u003e","link":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","dominant_color":"\u003cstring\u003e","alt_text":"\u003cstring\u003e","creative_type":"SHOP_THE_PIN","board_id":"14575691","board_section_id":"3477525042","board_owner":{"username":"\u003cstring\u003e"},"is_owner":"\u003cboolean\u003e","media":{"media_type":"\u003cstring\u003e"},"media_source":{"source_type":"image_base64","content_type":"image/png","data":"vsm7sXj","is_standard":true},"parent_pin_id":"5390","is_standard":"\u003cboolean\u003e","has_been_promoted":"\u003cboolean\u003e","note":"\u003cstring\u003e","pin_metrics":{}},{"id":"2","created_at":"\u003cdateTime\u003e","link":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","dominant_color":"\u003cstring\u003e","alt_text":"\u003cstring\u003e","creative_type":"VIDEO","board_id":"53","board_section_id":"25","board_owner":{"username":"\u003cstring\u003e"},"is_owner":"\u003cboolean\u003e","media":{"media_type":"\u003cstring\u003e"},"media_source":{"source_type":"image_base64","content_type":"image/jpeg","data":"y+m1G","is_standard":true},"parent_pin_id":"3670","is_standard":"\u003cboolean\u003e","has_been_promoted":"\u003cboolean\u003e","note":"\u003cstring\u003e","pin_metrics":{}}],"attributes":{"additional_image_link":["\u003cstring\u003e","\u003cstring\u003e"],"image_link":["\u003cstring\u003e"],"ad_link":"\u003cstring\u003e","adult":"\u003cboolean\u003e","age_group":"\u003cstring\u003e","availability":"\u003cstring\u003e","average_review_rating":"\u003cnumber\u003e","brand":"\u003cstring\u003e","checkout_enabled":"\u003cboolean\u003e","color":"\u003cstring\u003e","condition":"\u003cstring\u003e","custom_label_0":"\u003cstring\u003e","custom_label_1":"\u003cstring\u003e","custom_label_2":"\u003cstring\u003e","custom_label_3":"\u003cstring\u003e","custom_label_4":"\u003cstring\u003e","description":"\u003cstring\u003e","free_shipping_label":"\u003cboolean\u003e","free_shipping_limit":"\u003cstring\u003e","gender":"\u003cstring\u003e","google_product_category":"\u003cstring\u003e","gtin":"\u003cinteger\u003e","id":"\u003cstring\u003e","item_group_id":"\u003cstring\u003e","last_updated_time":"\u003clong\u003e","link":"\u003cstring\u003e","material":"\u003cstring\u003e","min_ad_price":"\u003cstring\u003e","mobile_link":"\u003cstring\u003e","mpn":"\u003cstring\u003e","number_of_ratings":"\u003cinteger\u003e","number_of_reviews":"\u003cinteger\u003e","pattern":"\u003cstring\u003e","price":"\u003cstring\u003e","product_type":"\u003cstring\u003e","sale_price":"\u003cstring\u003e","shipping":"\u003cstring\u003e","shipping_height":"\u003cstring\u003e","shipping_weight":"\u003cstring\u003e","shipping_width":"\u003cstring\u003e","size":"\u003cstring\u003e","size_system":"\u003cstring\u003e","size_type":"\u003cstring\u003e","tax":"\u003cstring\u003e","title":"\u003cstring\u003e","variant_names":["\u003cstring\u003e","\u003cstring\u003e"],"variant_values":["\u003cstring\u003e","\u003cstring\u003e"]}}]}