Sign in
catalogs

Get catalogs items

Get the items of the catalog owned by the "operation user_account". <a href="/docs/shopping/catalog/#Update%20items%20in%20batch" target="_blank">See detailed documentation here.</a>

  • By default, the "operation user_account" is the token user_account.

Optional: Business Access: Specify an <code>ad_account_id</code> (obtained via <a href='/docs/api/v5/#operation/ad_accounts/list'>List ad accounts</a>) 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 <a href="https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts">Business Access</a> roles on the ad_account: Owner, Admin, Catalogs Manager.

get/catalogs/items

Query parameters

countrystring required

Country for the Catalogs Items

item_idsstring[] required

Catalogs Item ids

languagestring required

Language for the Catalogs Items

ad_account_idstring

Unique identifier of an ad account.

Response

Response containing the requested catalogs items

Example response

{
  "items": [
    {
      "item_id": "DS0294-M",
      "attributes": {
        "additional_image_link": [
          "https://scene.example.com/image/image_v2.jpg",
          "https://scene.example.com/image/image_v3.jpg"
        ],
        "image_link": [
          "https://scene.example.com/image/image.jpg"
        ],
        "ad_link": "https://www.example.com/cat/denim-shirt/item012?utm_source=Pinterest",
        "adult": true,
        "age_group": "newborn",
        "availability": "in stock",
        "average_review_rating": 5,
        "brand": "Josie’s Denim",
        "color": "blue",
        "condition": "new",
        "custom_label_0": "Best sellers",
        "custom_label_1": "Summer promotion",
        "custom_label_2": "Winter sales",
        "custom_label_3": "Woman dress",
        "custom_label_4": "Man hat",
        "description": "Casual fit denim shirt made with the finest quality Japanese denim.",
        "free_shipping_label": true,
        "free_shipping_limit": "35 USD",
        "gender": "unisex",
        "google_product_category": "Apparel & Accessories > Clothing > Shirts & Tops",
        "gtin": 3234567890126,
        "id": "DS0294-L",
        "item_group_id": "DS0294",
        "last_updated_time": 1641483432072,
        "link": "https://www.example.com/cat/womens-clothing/denim-shirt-0294",
        "material": "cotton",
        "min_ad_price": "19.99 USD",
        "mobile_link": "https://m.example.com/cat/womens-clothing/denim-shirt-0294",
        "mpn": "PI12345NTEREST",
        "number_of_ratings": 10,
        "number_of_reviews": 10,
        "pattern": "plaid",
        "price": "24.99 USD",
        "product_type": "Clothing > Women’s > Shirts > Denim",
        "sale_price": "14.99 USD",
        "shipping": "US:CA:Ground:0 USD",
        "shipping_height": "12 in",
        "shipping_weight": "3 kg",
        "shipping_width": "16 in",
        "size": "M",
        "size_system": "US",
        "size_type": "regular",
        "tax": "US:1025433:6.00:y",
        "title": "Women’s denim shirt, large",
        "variant_names": [
          "Color",
          "Size"
        ],
        "variant_values": [
          "Red",
          "Small"
        ]
      }
    }
  ]
}

Changes