Get catalogs items
GET {{baseUrl}}/catalogs/items?country=<string>&item_ids=<string>&item_ids=<string>&language=<string>&ad_account_id=47
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 |
---|---|---|---|
country | string | (Required) Country for the Catalogs Items | |
item_ids | string | (Required) Catalogs Item ids | |
item_ids | string | (Required) Catalogs Item ids | |
language | string | (Required) Language for the Catalogs Items | |
ad_account_id | number | Unique identifier of an ad account. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"item_id":"\u003cstring\u003e","pins":[{"id":"6955","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":"468840275","board_section_id":"46090857015","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":"tUqyV+/WjWO","is_standard":true},"parent_pin_id":"47","is_standard":"\u003cboolean\u003e","has_been_promoted":"\u003cboolean\u003e","note":"\u003cstring\u003e"},{"id":"969746","created_at":"\u003cdateTime\u003e","link":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","dominant_color":"\u003cstring\u003e","alt_text":"\u003cstring\u003e","creative_type":"CAROUSEL","board_id":"8","board_section_id":"5","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":"3nd2r","is_standard":true},"parent_pin_id":"42801622316","is_standard":"\u003cboolean\u003e","has_been_promoted":"\u003cboolean\u003e","note":"\u003cstring\u003e"}],"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"]}},{"item_id":"\u003cstring\u003e","pins":[{"id":"586","created_at":"\u003cdateTime\u003e","link":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","dominant_color":"\u003cstring\u003e","alt_text":"\u003cstring\u003e","creative_type":"REGULAR","board_id":"080061","board_section_id":"9506080","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":"tx6X/","is_standard":true},"parent_pin_id":"5498","is_standard":"\u003cboolean\u003e","has_been_promoted":"\u003cboolean\u003e","note":"\u003cstring\u003e"},{"id":"17592146266","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":"17718","board_section_id":"466","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":"l","is_standard":true},"parent_pin_id":"0048727520","is_standard":"\u003cboolean\u003e","has_been_promoted":"\u003cboolean\u003e","note":"\u003cstring\u003e"}],"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"]}}]}