Catálogos disponíveis do usuário do Instagram

Representa a coleção de catálogos de produtos na Loja do Instagram de um usuário. Consulte o guia Marcação de produto para ver as informações completas de uso.

Criação

Esta operação não é compatível.

Leitura

GET /{ig-user-id}/available_catalogs

Obtenha o catálogo de produtos da Loja do Instagram de um usuário.

Limitações

  • Não há compatibilidade com contas de criador de conteúdo do Instagram.
  • Não há compatibilidade com Stories, Instagram TV, Reels, Live nem Mentions.
  • Retorna dados somente sobre um catálogo, já que as Lojas do Instagram estão limitadas a um único catálogo.
  • Não há compatibilidade com catálogos colaborativos (como catálogos de parceiros de compras ou de criadores de conteúdo afiliados).

Requisitos

TipoRequisito

Tokens de acesso

Usuário

Funções na empresa

O usuário do aplicativo precisa ter uma função de administrador no Gerenciador de Negócios da Loja do Instagram.

Loja do Instagram

O usuário do Instagram precisa ter uma Loja do Instagram aprovada com um catálogo que inclui produtos.

Permissões

catalog_management
instagram_basic
instagram_shopping_tag_products
pages_show_list


Caso uma função tenha sido concedida ao usuário do aplicativo por meio do Gerenciador de Negócios na Página conectada ao usuário do Instagram em questão, você precisará obter uma das seguintes permissões:


ads_management
business_management

Sintaxe da solicitação

GET https://graph.facebook.com/{api-version}/{ig-user-id}/available_catalogs
  ?fields={fields}
  &access_token={access-token}

Parâmetros de caminho

Espaço reservadoValor

{api-version}

A versão da API.

{ig-user-id}

Obrigatório. O ID do usuário no escopo do aplicativo.

Parâmetros da string de consulta

ChaveEspaço reservadoValor

access_token

{access-token}

Obrigatório. Token de acesso do usuário do aplicativo.

fields

{fields}

Lista separada por vírgulas dos campos de catálogo que você quer retornar para cada catálogo no conjunto de resultados.

Resposta

Um objeto formatado por JSON contendo os dados solicitados.

{
  "data": [
    {
      "catalog_id": "{catalog-id}",
      "catalog_name": "{catalog-name}",
      "shop_name": "{shop-name}",
      "product_count": {product-count}
    }
  ]
}

Conteúdo da resposta

PropriedadeValor

catalog_id

Identificação do catálogo.

catalog_name

Nome do catálogo.

shop_name

Nome da Loja.

product_count

Número de produtos no catálogo. Inclui todos os produtos, não importa o status da análise.

Exemplo de cURL

Solicitação

curl -i -X GET \
 "https://graph.facebook.com/v19.0/90010177253934/available_catalogs?access_token=EAAOc..."

Resposta

{
  "data": [
    {
      "catalog_id": "960179311066902",
      "catalog_name": "Jay's Favorite Snacks",
      "shop_name": "Jay's Bespoke",
      "product_count": 11
    }
  ]
}

Atualização

Esta operação não é compatível.

Exclusão

Esta operação não é compatível.