Búsqueda de productos en el catálogo de un usuario de Instagram

Representa productos y variantes de productos que coincidan con una cadena de búsqueda determinada en el catálogo de productos de la tienda de Instagram de un usuario de Instagram. Consulta todos los detalles sobre el uso en la guía de etiquetado de productos.

Creación

Esta operación no es compatible.

Lectura

GET /{ig-user-id}/catalog_product_search

Obtén una colección de productos que coincidan con una cadena de búsqueda determinada en el catálogo de la tienda de Instagram del usuario de Instagram de destino.

Limitaciones

No se admiten las cuentas de creador de Instagram.
No se admiten Stories, Instagram TV, Reels, Live ni Mentions.
Se devolverán los productos con un valor rejected de la propiedad review_status; sin embargo, no se puede etiquetar contenido multimedia con productos rechazados.
Aunque la API no devolverá ningún error al realizar una publicación etiquetada con un producto no aprobado, la etiqueta no aparecerá en la publicación hasta que el producto se haya aprobado. Por lo tanto, te recomendamos que solo permitas a los usuarios de la aplicación realizar publicaciones con etiquetas cuyos productos tengan el valor approved en la propiedad review_status. Este campo se devuelve para cada producto de forma predeterminada al obtener los productos de un usuario de la aplicación que cumplen los requisitos.

Requisitos

Tipo	Requisito
Identificadores de acceso	Usuario
Roles de la empresa	El usuario de la aplicación debe tener un rol de administrador en la cuenta de Business Manager a la que pertenece la tienda de Instagram del usuario de Instagram.
Tienda de Instagram	El usuario de Instagram debe tener una tienda de Instagram aprobada con un catálogo de productos que contenga productos.
Permisos	`catalog_management` `instagram_basic` `instagram_shopping_tag_products` `pages_show_list` Si se ha concedido un rol al usuario de la aplicación mediante Business Manager en la página conectada al usuario de Instagram de destino, también necesitarás uno de los elementos siguientes: `ads_management` `business_management`

Sintaxis de la solicitud

GET https://graph.facebook.com/{api-version}/{ig-user-id}/catalog_product_search
  ?catalog_id={catalog-id}
  &q={q}
  &access_token={access-token}

Parámetros de ruta

Marcador de posición	Valor
`{api-version}`	Versión de la API.
`{ig-user-id}`	Obligatorio. Identificador de usuario específico de la aplicación del usuario de la aplicación.

Parámetros de la cadena de consulta

Clave	Marcador de posición	Valor
`access_token`	`{access-token}`	Obligatorio. Identificador de acceso del usuario de la aplicación.
`catalog_id`	`{catalog-id}`	Obligatorio. Identificador del catálogo en el que se va a realizar la búsqueda.
`q`	`{q}`	Cadena que se va a buscar en el nombre o el número de SKU de cada producto (los números de SKU se pueden añadir en la columna Identificador de contenido de la interfaz de administración de catálogos). Si no se especifica ninguna cadena, se devolverán todos los productos que cumplan los requisitos de las etiquetas.

Respuesta

Un objeto con formato JSON que contiene una matriz de los productos que cumplen los requisitos de las etiquetas y los metadatos correspondientes. Admite la paginación basada en cursores.

{
  "data": [
    {
      "product_id": {product-id},
      "merchant_id": {merchant-id},
      "product_name": "{product-name}",
      "image_url": "{image-url}",
      "retailer_id": "{retailer-id}",
      "review_status": "{review-status}",
      "is_checkout_flow": {is-checkout-flow}
    }
  ]
}

Contenido de la respuesta

Propiedad	Valor
`product_id`	Identificador del producto.
`merchant_id`	Identificador del comerciante.
`product_name`	Nombre del producto.
`image_url`	URL de la imagen del producto.
`retailer_id`	Identificador del minorista.
`review_status`	Estado de la revisión. Los valores pueden ser `approved`, `outdated`, `pending` y `rejected`. Un producto aprobado puede aparecer en la tienda de Instagram de un usuario de la aplicación, pero un estado aprobado no indica su disponibilidad (es decir, el producto podría estar agotado). En las publicaciones, solo pueden aparecer etiquetas asociadas a productos que tengan el valor `approved` en la propiedad `review_status`.
`is_checkout_flow`	Si el valor es `true`, el producto se puede comprar directamente en la aplicación de Instagram. Si el valor es `false`, el producto se debe comprar en la aplicación o el sitio web del usuario de la aplicación.
`product_variants`	Identificadores de productos (`product_id`) y nombres (`variant_name`) de variantes de productos.

Ejemplo de cURL

Solicitud

curl -i -X GET \
 "https://graph.facebook.com/v19.0/90010177253934/catalog_product_search?catalog_id=960179311066902&q=gummy&access_token=EAAOc"

Respuesta

{
  "data": [
    {
      "product_id": 3231775643511089,
      "merchant_id": 90010177253934,
      "product_name": "Gummy Wombats",
      "image_url": "https://scont...",
      "retailer_id": "oh59p9vzei",
      "review_status": "approved",
      "is_checkout_flow": true,
      "product_variants": [
            {
              "product_id": 5209223099160494
            },
            {
              "product_id": 7478222675582505,
              "variant_name": "Green Gummy Wombats"
            }
          ]
    }
  ]
}

Actualizar

Esta operación no es compatible.

Eliminación

Esta operación no es compatible.