Pinterest

List product Pins

Changed on

List the product Pins of the connected Pinterest account. Pass a returned pin_id in pinterest.product_tags on POST /posts/create / PATCH /posts/{id} to tag the product on a Pin (max 24 products per Pin).

Pinterest only accepts a product tag when the product Pin is public, belongs to the same Pinterest account, and links to a website that account claimed on Pinterest. Products of other merchants cannot be tagged through the API.

Sources. source=catalog reads the Pinterest catalog (with price, currency, availability, item_id) through a product group; the response carries product_groups so you can pick another group with product_group_id. It needs catalog access on the Pinterest connection: in the OmniSocials composer open the Pinterest options, select Add products, then Connect catalog (one time per workspace). Without catalog access the response is error.code = pinterest_catalog_access_required. source=pins reads the account's own Pins and returns the ones Pinterest marks as product Pins; it works on every connection. One pins call scans up to 250 Pins, so products can be empty while bookmark is set: call again with the bookmark. When source is left out, catalog is used when the connection has catalog access, else pins.

Problems that are not a bad request (no Pinterest account, no catalog access, Pinterest did not answer) come back as HTTP 200 with an error object instead of products.

get/pinterest/products

Request

  • Base URL
    https://api.omnisocials.com/v1
  • URL
    https://api.omnisocials.com/v1/pinterest/products
  • Auth
    HTTP bearer

Query parameters

source'catalog' | 'pins'

Where to read product Pins from. Default: catalog when the connection has catalog access, else pins.

product_group_idstring

Catalog source only. A product group id from product_groups. Default: the group named "All Products", else the first group.

bookmarkstring

Cursor from the previous response, to get the next page.

page_sizeinteger

Catalog source only. Products per page.

Response

Product Pins, or an error object when the list could not be read.

bookmarkstring nullable

Pass as bookmark to get the next page. null on the last page.

source'catalog' | 'pins'

The source that was read.

catalog_accessboolean

true when the Pinterest connection can read the catalog.

no_catalogboolean

true when the connection has catalog access but the Pinterest account has no catalog yet (Pinterest answers HTTP 409 to the product group request). products and product_groups are then empty. Products are added at https://www.pinterest.com/business/catalogs/.

product_group_idstring nullable

Catalog source only. The group these products come from.

Example response

{
  "products": [
    {
      "pin_id": "813744226420795884",
      "title": "Blue ribbed top",
      "link": "https://shop.example.com/products/blue-ribbed-top",
      "price": 24.99,
      "currency": "EUR",
      "item_id": "TOP-BLUE-M"
    }
  ],
  "product_groups": [
    {
      "id": "443727193917",
      "name": "All Products"
    }
  ]
}

Changes