Gestione los detalles de los productos en su catálogo mediante API
Los minoristas pueden gestionar los detalles de los productos en su catálogo mediante varios endpoints de API. Estas API le permiten:
- Actualizar inventarios de productos
- Eliminar productos del catálogo
- Recuperar información detallada sobre los productos
Actualizar el inventario de productos
Para actualizar el inventario de un producto, vuelva a sincronizarlo con CitrusAd y ponga su inventario a cero. Los minoristas suelen realizar estas actualizaciones a diario para reflejar cambios como:
- Actualizaciones del nombre del producto
- Estado del inventario. Si el inventario de un producto se pone a cero, indica que el producto está agotado. Sin embargo, el nuevo inventario puede llegar al día siguiente.
Solicitar parámetros
A continuación se muestran los parámetros de consulta y cuerpo:
Parámetro de consulta
| objeto | tipo | Descripción |
|---|---|---|
| ID de equipo | cadena, opcional | ID de su equipo. Si no se indica un teamId , se utilizará de forma predeterminada teamId el especificado en la autenticación. |
Parámetro de cuerpo
| objeto | tipo | Descripción |
|---|---|---|
| ID del catálogo | cadena, obligatorio | Identificador del catálogo al que pertenece el producto. Puede obtener el catalogID en la interfaz de usuario de Epsilon Retail Media o en el minorista. |
| gtin | cadena, obligatorio | Número de artículo comercial mundial (GTIN) del producto. |
| inventario | número, opcional | Recuento de inventario para el producto. |
| precio | número, opcional | Precio del producto. |
| jerarquía de categorías | matriz de cadenas, opcional | Jerarquía de las categorías a las que pertenece el producto. |
| Etiquetas: | matriz de cadenas, opcional | Etiquetas asociadas al producto. |
| filtros | matriz de cadenas, opcional | Filtros aplicados al producto. |
POST $BASE_URL/v1/catalog-products?teamId=<YOUR_TEAM_ID> HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
"catalogProducts": [
{
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965543",
"inventory": 0,
"price": "19.99",
"tags": [
"imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL"
],
"filters": [
"category:Health&Beauty","category:Grocery","Brand:Covergirl","Special_Flag:0"
]
}
]
}
Eliminar productos del catálogo
Una vez que tenga un producto en el catálogo, puede que necesite eliminarlo más adelante. Para eliminar un producto, siga los pasos que se indican a continuación.
Solicitar parámetros
El endpoint acepta un código de producto por solicitud, que suele ser el ID de GTIN. Para eliminar un producto, realice una solicitud DELETE HTTP de la siguiente manera:
DELETE $BASE_URL/v1/catalog-products/<CATALOG_ID>/<PRODUCT_CODE> HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
Tiempo de procesamiento
El proceso de eliminación del producto puede tardar entre 30 minutos y una hora.
Importante
Si un producto está agotado, ponga su inventario a 0 en lugar de eliminarlo. Si borra un producto, se eliminará la posibilidad de los anunciantes de seleccionarlo en la plataforma CitrusAd para publicitarlo automáticamente, incluso cuando vuelva a estar disponible.
Gestión de errores
Si no se encuentra el producto, es probable que sea porque el producto no se ha incorporado al sistema de CitrusAd.
Recuperar detalles del producto
Es posible que necesite recuperar la información actual de un producto en su catálogo más adelante. Para ello, puede enviar una solicitud GET HTTP de la siguiente manera:
GET $BASE_URL/v1/catalog-products/<CATALOG_ID>/<PRODUCT_CODE> HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
| objeto | tipo | Descripción |
|---|---|---|
| ID del catálogo | cadena, obligatorio | Identificador del catálogo al que pertenece el producto. Puede obtener el catalogID en la interfaz de usuario de Epsilon Retail Media o en el minorista. |
| Código de producto | cadena, obligatorio | Por lo general, se trata del número de artículo comercial mundial (GTIN) del producto. |
Debería recibir la información actual incorporada en el sistema de CitrusAd para el código de producto especificado.
Nota
Las actualizaciones de productos no se procesan al instante en el sistema de CitrusAd. Puede que CitrusAd tarde algún tiempo en incorporar y reflejar por completo la actualización. No se preocupe si la información del producto no se actualiza de inmediato cuando se recupera.
Actualizado Hace 10 meses