Sign in

v29

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-06-042661,1122.5 MB
catalog_items

Get catalogs items (POST)

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 ad_account_id (obtained via List ad accounts) 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 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.

post/catalogs/items

Query parameters

ad_account_idstring

Unique identifier of an ad account.

Request body

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.

Example request

{
  "language": "EN"
}

Response

The request has succeeded.

Example response

{
  "items": [
    {
      "attributes": {
        "ad_image_0_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_0_tag": "black friday",
        "ad_image_10_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_10_tag": "black friday",
        "ad_image_11_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_11_tag": "black friday",
        "ad_image_12_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_12_tag": "black friday",
        "ad_image_13_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_13_tag": "black friday",
        "ad_image_14_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_14_tag": "black friday",
        "ad_image_15_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_15_tag": "black friday",
        "ad_image_16_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_16_tag": "black friday",
        "ad_image_17_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_17_tag": "black friday",
        "ad_image_18_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_18_tag": "black friday",
        "ad_image_19_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_19_tag": "black friday",
        "ad_image_1_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_1_tag": "black friday",
        "ad_image_2_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_2_tag": "black friday",
        "ad_image_3_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_3_tag": "black friday",
        "ad_image_4_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_4_tag": "black friday",
        "ad_image_5_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_5_tag": "black friday",
        "ad_image_6_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_6_tag": "black friday",
        "ad_image_7_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_7_tag": "black friday",
        "ad_image_8_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_8_tag": "black friday",
        "ad_image_9_link": "https://www.example.com/image/image_v2.jpg",
        "ad_image_9_tag": "black friday",
        "ad_link": "https://www.example.com/cat/denim-shirt/item012?utm_source=Pinterest",
        "ad_video_0_link": "https://www.example.com/video/video_v2.mov",
        "ad_video_0_tag": "black friday",
        "ad_video_1_link": "https://www.example.com/video/video_v2.mov",
        "ad_video_1_tag": "black friday",
        "ad_video_2_link": "https://www.example.com/video/video_v2.mov",
        "ad_video_2_tag": "black friday",
        "adult": true,
        "age_group": "newborn",
        "android_deep_link": "pinterest://item/1234567890",
        "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",
        "custom_number_0": 10,
        "custom_number_2": 1520000000,
        "custom_number_3": 4294967295,
        "custom_number_4": 50,
        "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",
        "id": "DS0294-L",
        "installment_price": "10:10.00 USD",
        "ios_deep_link": "pinterest://item/1234567890",
        "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",
        "promotion_id": "promotion_1",
        "sale_price": "14.99 USD",
        "sale_price_effective_date": "2025-01-01T00:00:00.000000Z/2025-01-07T00:00:00.000000Z",
        "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",
        "unit_pricing_base_measure": "10 ML",
        "unit_pricing_measure": "10 ML",
        "variant_names": [
          "Color",
          "Size"
        ],
        "variant_values": [
          "Red",
          "Small"
        ]
      },
      "item_id": "DS0294-M",
      "pins": [
        {
          "media": {
            "images": {
              "150x150": {
                "width": 150,
                "height": 150,
                "url": "https://i.pinimg.com/150x150/0d/f6/f1/0df6f1f0bfe7aaca849c1bbc3607a34b.jpg"
              },
              "400x300": {
                "width": 400,
                "height": 300,
                "url": "https://i.pinimg.com/400x300/0d/f6/f1/0df6f1f0bfe7aaca849c1bbc3607a34b.jpg"
              },
              "600x": {
                "width": 600,
                "height": 600,
                "url": "https://i.pinimg.com/600x/0d/f6/f1/0df6f1f0bfe7aaca849c1bbc3607a34b.jpg"
              },
              "1200x": {
                "width": 1200,
                "height": 1200,
                "url": "https://i.pinimg.com/1200x/0d/f6/f1/0df6f1f0bfe7aaca849c1bbc3607a34b.jpg"
              }
            }
          },
          "pin_metrics": {
            "90d": {
              "pin_click": 7,
              "impression": 2,
              "clickthrough": 3
            },
            "lifetime_metrics": {
              "pin_click": 7,
              "impression": 2,
              "clickthrough": 3,
              "reaction": 10,
              "comment": 2
            }
          }
        }
      ]
    }
  ]
}