Referencia

Utiliza esta referencia para ver los campos admitidos y los ejemplos respectivos de los puntos de conexión POST /{catalog_id}/items_batch y POST /{catalog_id}/batch.

Los nombres de parámetros de /{catalog_id}/batch y /{catalog_id}/items_batch pueden parecer similares, pero son claramente diferentes.

Te recomendamos usar la API /{catalog_id}/items_batch, que admite más casos de uso y se mantiene de manera activa.

Campos admitidos - Enviar actualizaciones de artículos - /{catalog_id}/batch

Estos campos se admiten en los métodos CREATE y UPDATE.

Eliminar campos

Al actualizar artículos, proporciona una cadena vacía como valor para eliminar un campo opcional. Si configuras el valor como null, no se eliminará el campo.

Campo Descripción

additional_image_urls

Tipo:

matriz <string>

Opcional.

URL de hasta 9 o 10 imágenes diferentes.

additional_variant_attributes

Tipo:

lista <KeyValue:string,string>

Opcional.

Atributos adicionales para distinguir el producto en su grupo de variantes.

Ejemplo: {"Scent" : "Fruity", "Style" : "Classic"}.

availability

Tipo: cadena

Obligatorio

Identifica el estado de disponibilidad:

  • in stock: los artículos se envían de inmediato.
  • out of stock: no se planea reponerlo.
  • available for order: se envía 1 a 2 semanas.
  • discontinued

age_group

Tipo: cadena

Opcional.

Grupo de personas que tienen la misma edad o una edad similar. Los valores aceptados son newborn, infant, toddler, kids y adult.

applinks

Tipo:

objeto <>

Opcional.

Enlaces a apps para celulares.

category

Tipo: cadena

Opcional, pero recomendado para anuncios de catálogo Advantage+ (puede ayudar mejorar el rendimiento de los anuncios). Opcional para compras en Instagram y tiendas de páginas, pero es necesario activar la finalización de compra en el sitio en estos canales (solo EE. UU.). Obligatorio para Marketplace (solo EE. UU.).

Categoría de producto de Google (GPC) del artículo. Usa la ruta de la taxonomía de la categoría o su número de identificación, que aparece aquí.

Si usas la finalización de compra en Instagram o Facebook (solo EE. UU.), la GPC de un artículo repercute en los impuestos y en la política de devolución. Obtén más información sobre la categoría de producto de Google de los artículos del catálogo, servicio de ayuda para anunciantes.

Ejemplo: Apparel & Accessories > Clothing > Shirts & Tops o 212.

color

Tipo: cadena

Opcional.

Tamaño máximo: 100.

Color del artículo.

condition

Tipo: cadena

Obligatorio.

Estado del artículo: new, refurbished o used.

currency

Tipo: cadena

Obligatorio.

Divisa del valor especificado. La API de marketing admite todas las divisas compatibles con las cuentas publicitarias. Utiliza el código ISO 4217 referido a normas de divisas.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

Tipo: cadena

Opcional.

Límite máximo de caracteres: 100.

Información adicional sobre el artículo. Proporciona una cadena vacía para eliminar.

description

Tipo: cadena

Obligatorio.

Tamaño máximo: 5.000.

Breve descripción del artículo.

gender

Tipo: cadena

Opcional.

Género para el tamaño. Los valores incluyen male, female y unisex.

gtin

Tipo: cadena

Opcional.

Tamaño máximo: 70.

El número mundial de artículo comercial puede incluir UPC,EAN, JAN y ISBN.

image_url

Tipo: cadena

Obligatorio.

Enlace a la imagen del artículo que se utiliza en el anuncio. Proporciona los tamaños de imagen adecuados.

En el caso de anuncios de catálogo Advantage+ de una sola imagen

  • El requisito de resolución mínima de la imagen es 500px * 500px.
  • El requisito de relación de aspecto mínima es 4:5.
  • El requisito de relación de aspecto máxima es 1:91:1.

Si la imagen tiene una relación de aspecto que no cumple con estos requisitos, Facebook la recortará de modo que se acerque a la relación de aspecto mínima o máxima, según la relación de aspecto original.

En el caso de anuncios de catálogo Advantage+ de secuencia de imágenes, el requisito de resolución de imagen mínima es de 500px * 500px y Facebook lo recorta a una relación de aspecto de 1:1.

Recomendación: evita cambiar con frecuencia la image url. Las URL de las imágenes no deben contener parámetros, como price o timestamp, ya que estos suelen cambiar frecuentemente.

inventory

Tipo: número

Opcional.

Número entero que los anunciantes pueden usar para guardar información sobre el nivel de inventario.

marked_for_product_launch

Tipo: cadena

No disponible en el caso de los anuncios de catálogo Advantage+. Opcional para el comercio.

Indica si un artículo se usará en el lanzamiento de un producto. Valores admitidos:

  • marked: el artículo se ocultará a los compradores hasta que se cree el lanzamiento del producto. Esto impide que el artículo esté disponible para ver y comprar antes de la hora de lanzamiento deseada.
  • not_marked (predeterminado): el artículo no formará parte del lanzamiento de un producto.

name

Tipo: cadena

Obligatorio.

Tamaño máximo: 100.

Título del artículo.

pattern

Tipo: cadena

Opcional

Tamaño máximo: 100.

Estampado o impresión gráfica de un artículo.

price

Tipo: entero

Obligatorio.

El precio multiplicado por 100, para todas las divisas. Ejemplo: 490, cuando se usa con USD, equivale a $4,90. Cuando se usa con JPY, 49.000 equivale a ¥490.

product_type

Tipo: cadena

Opcional.

Tamaño máximo: 750.

Categoría del artículo definida por el vendedor.

Ejemplo: en TSV Hogar y jardín > Cocina y comedor > Electrodomésticos > Refrigeradores.

Ejemplo: en XML product_type > Hogar y jardín > Cocina y comedor > Electrodomésticos > Refrigeradores > product_type.

retailer_product_group_id

Tipo: cadena

Opcional.

Admite cadenas. Los anunciantes lo pueden usar para agrupar productos.

sale_price

Tipo: entero

Opcional.

El precio con descuento si el artículo está en oferta. Este es el precio de oferta multiplicado por 100, para todas las divisas. Ejemplo: 490 cuando se usa con USD equivale a $4,90 y 49000 cuando se usa con JPY equivale a ¥490.

sale_price_start_date

Tipo: cadena

Opcional.

Fecha y hora de finalización de la oferta.

Ejemplo: 2014-12-01T00:00-0300.

sale_price_end_date

Tipo: cadena

Opcional.

Fecha y hora de inicio de la oferta.

Ejemplo: 2014-11-01T12:00-0300.

shipping

Tipo:

Matriz <object>

Opcional.

Información de envío.

size

Tipo: cadena

Opcional.

Tamaño del artículo. Ejemplo: Small o XL.

url

Tipo: cadena

Obligatorio.

El enlace al sitio del comerciante donde se puede comprar el artículo.

vendor_id

Tipo: cadena

Opcional.

Identificador del vendedor que vende el artículo.

Ejemplo de solicitud: /{catalog_id}/batch

{
  "access_token": "<ACCESS_TOKEN>",
  "requests": [
    {
      "method": "DELETE",
      "retailer_id": "retailer-1"
    },
    {
      "method": "CREATE",
      "retailer_id": "retailer-2",
      "data": {
        "availability": "in stock",
        "brand": "Nike",
        "category": "t-shirts",
        "description": "product description",
        "image_url": "http://www.images.example.com/t-shirts/1.png",
        "name": "product name",
        "price": 1000,
        "currency": "USD",
        "shipping": [
           {
              "country": "US",
              "region": "CA",
              "service": "service",
              "price_value": "10",
              "price_currency": "USD"
           }
        ],
        "condition": "new",
        "url":"http://www.images.example.com/t-shirts/1.png",
        "retailer_product_group_id": "product-group-1"
      },
      "applinks": {
          "android": [{
              "app_name": "Electronic Example Android",
              "package": "com.electronic",
              "url": "example-android://electronic"
              }],
          "ios": [{
              "app_name": "Electronic Example iOS",
              "app_store_id": 2222,
              "url": "example-ios://electronic"
              }]
      },
    },
    {
      "method": "UPDATE",
      "retailer_id": "retailer-3",
      "data": {
        "availability": "out of stock",
      }
    }
  ]
}

Ejemplo de respuesta: /{catalog_id}/batch

Se devolverán uno o más identificadores.

"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
https://graph.facebook.com/<API_VERSION>/<CATALOG_ID>/batch

Campos admitidos - Enviar actualizaciones de productos - /{catalog_id}/items_batch

En el caso de los catálogos de comercio, utiliza esta API si necesitas actualizar la información de los productos más de una vez por hora (de lo contrario, usa la API de la lista). Puedes actualizar varios artículos en una única solicitud HTTP.

PRODUCT_ITEM

Estos campos de productos se admiten en los métodos CREATE y UPDATE, en las versiones 3.3 y 3.2:

CampoDescripción

additional_image_link

Tipo:

matriz <string>

Opcional.

Enlace a 9 o 10 imágenes diferentes, como máximo.

additional_variant_attribute

Tipo:

lista <KeyValue:string,string>

Opcional.

Atributos adicionales para distinguir el producto en su grupo de variantes.

Ejemplo: "Scent:Fruity,Flavor:Apple"

age_group

Tipo: cadena

Opcional.

Grupo de personas que tienen la misma edad o una edad similar. Los valores aceptados son newborn, infant, toddler, kids y adult.

applink

Tipo:

Objeto <string>

Opcional.

Enlaces a apps para celulares.

Ejemplo:

"applink" : {
  "ios_url": "example-ios://electronic",
  "ios_app_store_id": "42",
  "ios_app_name": "Electronic Example iOS",
  "iphone_url": "example-iphone://electronic",
  "iphone_app_store_id": "43",
  "iphone_app_name": "Electronic Example iPhone",
  "ipad_url": "example-ipad://electronic",
  "ipad_app_store_id": "44",
  "ipad_app_name": "Electronic Example iPad",
  "android_url": "example-android://electronic",
  "android_package": "com.electronic",
  "android_class": "com.electronic.Example",
  "android_app_name": "Electronic Example Android",
  "windows_phone_url": "example-windows://electronic",
  "windows_phone_app_id": "64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
  "windows_phone_app_name": "Electronic Example Windows",
}

availability

Tipo: cadena

Obligatorio.

Identifica el estado de disponibilidad:

  • in stock: el artículo se envía de inmediato
  • out of stock: no se planea reponerlo.
  • available for order: se envía en 1 a 2 semanas.
  • discontinued

brand

Tipo: cadena

Opcional.

Marca del artículo.

color

Tipo: cadena

Opcional.

Tamaño máximo: 100.

Color del artículo.

condition

Tipo: cadena

Obligatorio.

Estado del producto: new, refurbished o used.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

Tipo: cadena

Opcional.

Límite máximo de caracteres: 100.

Información adicional sobre el artículo.

description

Tipo: cadena

Obligatorio.

Tamaño máximo: 5.000.

Texto corto con el que se describe el producto.

disabled_capabilities

Tipo:

matriz <string>

Opcional.

Lista de capacidades que se van a desactivar. Los valores posibles son: marketplace, b2c_marketplace, buy_on_facebook, cpas_parent_catalog, marketplace_shops, shops, daily_deals, ig_onsite_shopping, ig_product_tagging, c2c_marketplace, groups, profile, da, whatsapp, ldp, mini_shops, business_inbox_in_messenger, neighborhoods y test_capability.

gender

Tipo: cadena

Opcional.

Género para el tamaño. Los valores incluyen male, female y unisex.

google_product_category

Tipo: cadena

Opcional.

Tamaño máximo: 250.

Valores predefinidos (identificador de categoría o cadena) de la taxonomía de productos de Google.

Ejemplo: Ropa y accesorios > Ropa > Vestidos o 2271.

gtin

Tipo: cadena

Opcional.

Tamaño máximo: 70.

El número mundial de artículo comercial (GTIN) puede incluir UPC, EAN, JAN y ISBN.

id

Tipo: cadena

Obligatorio.

Identificador del vendedor.

image

Tipo: matriz <object>

URL y etiquetas de las imágenes que se usarán en tus anuncios o en tiendas. Admite hasta 20 imágenes diferentes. Las etiquetas son opcionales y, si se usan, deben describir lo que hay en la imagen.


Ejemplo:

"image": [
      {
        "url":"http://example.com/image_1.jpg",
        "tag": ['Swimming pool','Gym'],
      }
]

image_link

Tipo: cadena

No es obligatorio si se proporciona image.

Recomendamos usar image en su lugar. Cuando se proporciona image, image_link y additional_image_link se ignoran.

Enlace a la imagen del artículo que se utiliza en el anuncio. Proporciona los tamaños de imagen adecuados.

En el caso de anuncios de catálogo Advantage+ de una sola imagen:

  • El requisito de resolución mínima de imagen es 500px*500px.
  • El requisito de relación de aspecto mínima es 4:5.
  • El requisito de relación de aspecto máxima es 1:91:1. Si la imagen no cumple con estos requisitos, Facebook la recortará para que se acerque a la relación de aspecto mínima o máxima, según la relación de aspecto original.

En el caso de los anuncios de catálogo Advantage+ de secuencia de imágenes, el requisito de resolución mínima de imagen es 500px*500px, y Facebook la recortará a una relación de aspecto de 1:1.

internal_label

Tipo: cadena

Agrega etiquetas internas para ayudar a filtrar elementos cuando crees conjuntos de productos. Por ejemplo, puedes agregar una etiqueta de "verano" a todos los artículos incluidos en las promociones de verano y, luego, filtrarlos en un conjunto. Solo tú puedes ver las etiquetas.

Escribe el nombre de cada etiqueta entre comillas simples (') y separa las etiquetas con comas (,). Asegúrate de que no haya espacios en blanco al principio o al final de una etiqueta. Límite de caracteres: hasta 5.000 etiquetas por producto y 110 caracteres por etiqueta.

Ejemplo (TSV, XLSX, Hojas de cálculo de Google): ['verano','tendencia']

Ejemplo (CSV): "['verano','tendencia']"

Nota: Si usas etiquetas personalizadas (custom_label_0 a custom_label_4) para filtrar conjuntos de productos, te recomendamos usar etiquetas internas (internal_label). A diferencia de las etiquetas personalizadas, puedes agregar etiquetas internas o actualizarlas cuando quieras sin necesidad de enviar los artículos a un proceso de revisión de políticas cada vez que lo hagas, ya que esto puede afectar la entrega de anuncios.

Anteriormente, este campo se llamaba product_tags. Si bien seguimos admitiendo el nombre de campo anterior, te recomendamos que uses el nuevo.

inventory

Tipo: objeto

Opcional.

Número entero que los anunciantes pueden usar para guardar información sobre el nivel de inventario.

item_group_id

Tipo: cadena

Opcional.

El identificador suministrado por el anunciante de un grupo de productos; no el FBID. Admite cadenas. Los anunciantes pueden utilizarlo para agrupar una variedad de objetos diferentes (artículos de productos, vehículos, hoteles, vuelos, etc.).

link

Tipo: cadena

Obligatorio.

El enlace al sitio del comerciante donde se puede comprar el artículo.

manufacturer_part_number

Tipo: cadena

Opcional.

Identificador único del fabricante correspondiente al producto.

pattern

Tipo: cadena

Opcional.

Tamaño máximo: 100.

Estampado o impresión gráfica de un producto.

price

Tipo: cadena

Obligatorio.

Precio del artículo. El formato del precio debe ser el costo seguido del código de divisa ISO de 3 dígitos, con un espacio entre el costo y la divisa.

Ejemplo: 9.99 USD.

rating_count

Tipo: número

Opcional.

El número de calificaciones de este producto que proporcionaron los compradores. Debe ser mayor que 0. Se debe usar junto con user_rating.

Ejemplo: 100

sale_price

Tipo: cadena

Opcional, pero obligatorio para usar la función de superposición en anuncios de catálogo Advantage+.

El precio con descuento si el artículo está en oferta. El formato del precio debe ser el costo seguido del código de divisa ISO de 3 dígitos, con un espacio entre el costo y la divisa.

Ejemplo: 9.99 USD, 25.00 EUR.

sale_price_effective_date

Tipo: cadena

Opcional.

Las fechas de inicio y finalización de la venta separadas por una barra diagonal. Las fechas de inicio y finalización deben estar en formato YYYY-MM-DD. Agrega una "T" después de cada fecha e incluye la hora a continuación Escribe la hora siguiendo el formato de 24 horas (de 0:00 a 23:59).

Ejemplo: 2014-11-01T12:00-0300/2014-12-01T00:00-0300.

shipping

Tipo: cadena

Opcional.

Blob con diferentes precios según cada país y región. Las diferentes regiones están separadas por comas. El formato debería ser COUNTRY:STATE:SHIPPING_TYPE:PRICE.

Ejemplo: US:CA:Ground:9.99 USD, US:NY:Air:15.99 USD.

size

Tipo: cadena

Opcional.

Tamaño del artículo. Ejemplo: Small o XL.

title

Tipo: cadena

Obligatorio.

Tamaño máximo: 100.

Título del artículo.

user_rating

Tipo: número

Opcional.

El número de calificaciones promedio de este producto que proporcionaron los compradores. Intervalo entre 1.0 y 5.0. Solo se permite un decimal. Se debe usar junto con rating_count.

Ejemplo: 4.5

video

Tipo: matriz <object>

URL y etiquetas de videos que se utilizarán en tus anuncios o en tiendas. Admite hasta 30.000 videos a nivel de catálogo. Las etiquetas son opcionales y, si se usan, deben describir lo que aparece en el video.


El tamaño máximo del archivo de video es de 200 MB. Los formatos admitidos incluyen .3g2, .3gp, .3gpp, .asf, .avi, .dat, .divx, .dv, .f4v, .flv, .gif, .m2ts, .m4v, .mkv, .mod, .mov, .mp4, .mpe, .mpeg, .mpeg4, .mpg, .mts, .nsv, .ogm, .ogv, .qt, .tod, .ts, .vob y .wmv.


Ejemplo:

"video": [
      {
        "url":"http://example.com/video_1.mp4",
        "tag": ['Swimming pool','Gym'],
      }
]

NOTA: Para eliminar el video 1 si el producto tiene video 1, 2, elimina el video 1 de la matriz:

[
  {
    "method": "UPDATE",
    "data": {
      "video": [
        {
          "url": "https://google.com/video_2.mp4",
          "tag": ["video_2"]
        }
      ]
    }
  }
]

Para eliminar todos los videos, envía una matriz vacía:

[
  {
    "method": "UPDATE",
    "data": {
      "video": []
    }
  }
]

El método UPDATE también se puede usar para crear artículos, si todavía no existen.

Obtén más información sobre los campos de productos en Referencia de la API.

Ejemplo de solicitud: PRODUCT_ITEM

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "PRODUCT_ITEM",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "id": "retailer-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "id": "retailer-2",
            "applink" : {
            "ios_url":"example-ios://electronic",
            "ios_app_store_id":"42",
            "ios_app_name":"Electronic Example iOS",
            "iphone_url":"example-iphone://electronic",
            "iphone_app_store_id":"43",
            "iphone_app_name":"Electronic Example iPhone",
            "ipad_url":"example-ipad://electronic",
            "ipad_app_store_id":"44",
            "ipad_app_name":"Electronic Example iPad",
            "android_url":"example-android://electronic",
            "android_package":"com.electronic",
            "android_class":"com.electronic.Example",
            "android_app_name":"Electronic Example Android",
            "windows_phone_url":"example-windows://electronic",
            "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
            "windows_phone_app_name":"Electronic Example Windows",
          },
          "availability": "in stock",
          "brand": "Nike",
          "google_product_category": "t-shirts",
          "description": "product description",
          "image_link": "http://www.images.example.com/t-shirts/1.png",
          "title": "product name",
          "price": "10.00 USD",
          "shipping": [
               {
                  "shipping_country": "US",
                  "shipping_region": "CA",
                  "shipping_service": "service",
                  "shipping_price_value": "10",
                  "shipping_price_currency": "USD"
               }
          ],
          "condition": "new",
          "link":"http://www.images.example.com/t-shirts/1.png",
          "item_group_id": "product-group-1"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "availability": "out of stock",
          "id": "retailer-3",
        }
      }
    ]
  }

Ejemplo de respuesta: PRODUCT_ITEM

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

Obtén más información sobre cómo agregar artículos de catálogo con una lista de datos.


HOTEL

Campos de productos admitidos para los métodos CREATE y UPDATE, para el tipo HOTEL, de la versión 3.2:

CampoDescripción

address

Tipo:

objeto<string>

Obligatorio.

Dirección del hotel.

applink

Tipo:

Opcional.

Enlaces a apps para celulares.

base_price

Tipo: cadena

Obligatorio.

Precio base de la habitación del hotel por noche. Agrega el tipo de divisa al precio. El formato del precio debe ser el costo seguido por el código de divisa ISO, con un espacio entre el costo y la divisa. Ejemplo: USD en el caso de dólares estadounidenses.

brand

Tipo: cadena

Opcional.

Marca de la cadena de hoteles.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

Tipo: cadena

Límite máximo de caracteres: 100.

Hasta cinco campos personalizados con cualquier información adicional en función de la cual quieras filtrar los artículos al crear conjuntos. Por ejemplo, puedes usar un campo personalizado para indicar todas las habitaciones que forman parte de las rebajas de verano y, luego, filtrar esas habitaciones en un conjunto. Este campo admite cualquier valor de texto, incluso números.


Ejemplo: Summer Sale

Este campo es compatible con las listas complementarias.

custom_number_0
custom_number_1
custom_number_2
custom_number_3
custom_number_4

Tipo: entero

Hasta cinco campos personalizados con cualquier información adicional relacionada con números que quieras usar para filtrar los artículos al crear conjuntos. Este campo te permite filtrar por intervalos de números (es mayor que y es menor que) cuando crees un conjunto. Por ejemplo, puedes usar este campo para indicar el año en que se inauguró un hotel y, luego, filtrar un rango de años en un conjunto.


Este campo admite números enteros entre 0 y 4294967295. No admite números negativos, números decimales ni puntos, como -2, 5,5 o 10.000.


Ejemplo: 2022

description

Tipo: cadena

Obligatorio.

Límite máximo de caracteres: 5.000.

Descripción breve del hotel.

guest_rating

Tipo:

Matriz <object>

Opcional.

Calificaciones de los huéspedes del hotel.

hotel_id

Tipo: cadena

Obligatorio.

Identificador único del hotel.

image

Tipo:

Matriz <object>

Obligatorio.

URL y etiquetas de imágenes que se usan en los anuncios. Admite hasta 20 imágenes múltiples. Si se usa, la etiqueta es opcional. Debería describir lo que hay en la imagen. Ejemplo: "reception".

latitude

Tipo: cadena

Obligatorio.

Ubicación de la latitud del hotel.

longitude

Tipo: cadena

Obligatorio.

Ubicación de la longitud del hotel.

loyalty_program

Tipo: cadena

Opcional.

Programa de fidelización usado en el hotel.

margin_level

Tipo: cadena

Opcional.

Indicador de la rentabilidad del hotel; valores de 1 a 10.

name

Tipo: cadena

Obligatorio.

Nombre del hotel.

neighborhood

Tipo:

matriz <string>

Opcional.

Una o más comunidades locales del hotel. Ejemplo: Soho o Las Vegas Strip. Número máximo de comunidades permitidas: 20.

phone

Tipo: cadena

Opcional.

Número de teléfono con código de país.

sale_price

Tipo: cadena

Opcional.

Precio de venta por noche en el hotel. Úsalo para anunciar descuentos con respecto al precio normal del hotel. Obligatorio: agrega el tipo de divisa al precio. El formato del precio debe ser el costo seguido por el código de divisa ISO, con un espacio entre el costo y la divisa. Ejemplo: USD en el caso de dólares estadounidenses.

star_rating

Tipo: cadena

Opcional.

Calificación con estrellas del hotel. El número debe ser de 1 a 5.

url

Tipo: cadena

Obligatorio.

Enlace al sitio externo en el que puedes reservar una habitación.

El método UPDATE también se puede usar para crear artículos, si todavía no existen.

Ejemplo de solicitud: HOTEL

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "HOTEL",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "hotel_id": "hotel-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "hotel_id": "1234",
          "brand": "Premium_brand",
          "description": "A very nice hotel",
          "name": "The best hotel",
          "base_price": "100.00 USD",
          "longitude":"42.10",
          "latitude":"42.10",
          "address": {
              "addr1":"100 Main Street",
              "city":"North Pole",
              "region":"ABC",
              "country":"US",
              "postal_code":"11111"
          },
          "guest_rating" : [
            {
                "rating_system":"tripAdvisor",
                "score":"7.8",
                "number_of_reviewers":"300",
                "max_score":"10",
            },
            {
                "rating_system":"Yelp",
                "score":"5.1",
                "number_of_reviewers":"123",
                "max_score":"10",
            },
          ],
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['Swimming pool','Gym'],
            }
          ],
          "applink" : {
            "ios_url":"example-ios://electronic",
            "ios_app_store_id":"42",
            "ios_app_name":"Electronic Example iOS",
            "iphone_url":"example-iphone://electronic",
            "iphone_app_store_id":"43",
            "iphone_app_name":"Electronic Example iPhone",
            "ipad_url":"example-ipad://electronic",
            "ipad_app_store_id":"44",
            "ipad_app_name":"Electronic Example iPad",
            "android_url":"example-android://electronic",
            "android_package":"com.electronic",
            "android_class":"com.electronic.Example",
            "android_app_name":"Electronic Example Android",
            "windows_phone_url":"example-windows://electronic",
            "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
            "windows_phone_app_name":"Electronic Example Windows",
          },
          "loyalty_program":"Premium_program",
          "margin_level": "8",
          "phone":"+61 2-96027455",
          "star_rating":"4",
          "url":"http://www.images.example.com/t-shirts/1.png"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "base_price": "90.00 USD",
          "hotel_id": "hotel-3",
        }
      }
    ]
  }

Ejemplo de respuesta: HOTEL

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

HOTEL_ROOM

Estos campos de productos se admiten en los métodos CREATE y UPDATE del tipo HOTEL_ROOM, en la versión 3.2.

CampoDescripción

base_price

Tipo: cadena

Obligatorio.

Precio base por 1 noche. La divisa debe expresarse según los códigos de divisa de la norma ISO 4217.

Ejemplo: 9.99 USD.

description

Tipo: cadena

Obligatorio.

Tamaño máximo: 5.000.

Texto breve en el que se describe la habitación.

hotel_retailer_id

Tipo: cadena

Obligatorio.

Identificador único del minorista de hotel.

hotel_room_id

Tipo: cadena

Obligatorio.

Identificador único del hotel.

image

Tipo:

Matriz <object>

Obligatorio.

Imágenes de la habitación.

name

Tipo: cadena

Obligatorio.

Tamaño máximo: 100.

Nombre de la habitación.

url

Tipo: cadena

Obligatorio.

Enlace al sitio web del anunciante donde alguien puede reservar la estadía.

El método UPDATE también se puede usar para crear artículos, si todavía no existen.

Ejemplo de solicitud: HOTEL_ROOM

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "HOTEL_ROOM",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "hotel_retailer_id": "1234",
          "hotel_room_id": "room-1",
        }
      },
      {
        "method": "CREATE",
        "data": {
          "hotel_retailer_id": "1234",
          "hotel_room_id": "room-2",
          "description": "product description",
          "name": "product name",
          "base_price": "100 USD",
          "url": "http://www.example.com/t-shirts/1.html",
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['Swimming pool','Gym'],
            }
          ]
      },
      {
        "method": "UPDATE",
        "data": {
          "hotel_retailer_id": "1234",
          "hotel_room_id": "room-3",
          "base_price": "120 USD",
        }
      }
    ]
  }

Ejemplo de respuesta: HOTEL_ROOM

{
    // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
  }

FLIGHT

Estos campos de productos se admiten en los métodos CREATE y UPDATE del tipo FLIGHT, en la versión 3.2.

CampoDescripción

description

Tipo: cadena

Opcional.

Límite máximo de caracteres: 5.000.

Descripción del vuelo.

destination_airport

Tipo: cadena

Obligatorio.

Aeropuerto de destino del vuelo. Deberá escribirse con el formato del código IATA.

Ejemplo: SFO.

destination_city

Tipo: cadena

Opcional.

Nombre de la ciudad de destino del vuelo.

image

Tipo:

Matriz <object>

Obligatorio.

URL y etiquetas de las imágenes que se usan en los anuncios. Admite hasta 20 imágenes múltiples. La etiqueta es opcional. Si se la usa, debes describir lo que hay en la imagen.

Ejemplo: seat.

origin_airport

Tipo: cadena

Obligatorio.

Aeropuerto de origen del vuelo. Deberá escribirse con el formato del código IATA.

Ejemplo: SFO

origin_city

Tipo: cadena

Opcional.

Nombre de la ciudad de origen del vuelo.

price

Tipo: cadena

Opcional.

Costo y divisa del vuelo. El precio es un número seguido del código de la divisa; usa la norma ISO 4217. Usa ""."" como punto decimal para indicar el precio.

url

Tipo: cadena

Opcional.

Enlace al sitio web donde puedes reservar el vuelo.

El método UPDATE también se puede usar para crear artículos, si todavía no existen.

Ejemplo de solicitud: FLIGHT

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "FLIGHT",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "origin_airport": "BOS",
          "destination_airport": "JFK",
        }
      },
      {
        "method": "CREATE",
        "data": {
          "origin_airport": "BOS",
          "destination_airport": "SFO",
          "description": "Best Flight to SFO",
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['City'],
            },
            {
                "url":"http://example.com/some.image_2.jpg",
                "tag": ['Food'],
            }
          ],
          "price":"100.00 USD",
        }
      },
      {
        "method": "UPDATE",
        "data": {

Ejemplo de respuesta: FLIGHT

{
    // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
  }

DESTINATION

Estos campos de productos se admiten en los métodos CREATE y UPDATE del tipo DESTINATION, en la versión 3.2.

CampoDescripción

applink

Tipo:

Objeto <string>

Opcional.

Enlaces a apps para celulares.

address

Tipo:

objeto<string>

Obligatorio.

Dirección del hotel.

description

Tipo: cadena

Opcional.

Límite máximo de caracteres: 5.000.

Breve párrafo en el que se describe el destino.

destination_id

Tipo: cadena

Obligatorio.

Límite máximo de caracteres: 100.

Identificador único del destino.

image

Tipo:

Matriz <object>

Obligatorio.

URL y etiquetas de las imágenes que se usan en los anuncios. Admite hasta 20 imágenes múltiples. La etiqueta es opcional. Si se la usa, debes describir lo que hay en la imagen.

Ejemplo: seat.

latitude

Tipo: cadena

Obligatorio.

Ubicación de la latitud del destino.

longitude

Tipo: cadena

Obligatorio.

Ubicación de la longitud del destino.

name

Tipo: cadena

Obligatorio.

Nombre del destino.

neighborhood

Tipo:

matriz <string>

Opcional.

Número máximo de comunidades permitidas: 20. Una o más comunidades del destino.

Ejemplo: Soho o Las Vegas Strip.

price

Tipo: cadena

Opcional.

Costo promedio más bajo y divisa del destino. El formato del precio debe ser un número seguido del código de la divisa; usa la norma ISO 4217. Usa ""."" como punto decimal para indicar el precio.

price_change

Tipo: cadena

Opcional.

Cambio de precio. Se puede usar para crear conjuntos de productos y en el contenido del anuncio:

  • 0: sin cambio de precio
  • -10: reducción del 10% del precio
  • 20: reducción del 20% del precio

Ejemplo: ""el precio promedio en NYC se redujo un X"" o ""bajó el precio promedio en NYC""

type

Tipo:

matriz <string>

Obligatorio.

Número máximo de tipos de destino: 20. Tipos de destino. Un destino puede tener varios tipos.

Ejemplo: park o beach.

url

Tipo: cadena

Obligatorio.

Enlace al sitio web donde se puede reservar el destino.

El método UPDATE también se puede usar para crear artículos, si todavía no existen.

Ejemplo de solicitud: DESTINATION

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "DESTINATION",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "destination_id": "destination-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "destination_id": "123456789",
          "description": "My destination is the best.",
          "name": "The best destination",
          "price": "199.00 USD",
          "price_change": "-20",
          "longitude":"-122.4424",
          "latitude":"37.7712",
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['City','Package'],
            },
            {
                "url":"http://example.com/some.image_2.jpg",
                "tag": ['Tour','Landmark'],
            }
          ],
          "address": {
              "addr1":"1 Market Street",
              "city":"San Francisco",
              "region":"California",
              "country":"United States",
              "postal_code":"94117"
          },
          "applink" : {
            "ios_url":"example-ios://travelapp",
            "ios_app_store_id":"42",
            "ios_app_name":"Travel App iOS",
            "iphone_url":"example-iphone://travelapp",
            "iphone_app_store_id":"43",
            "iphone_app_name":"Travel App iPhone",
            "ipad_url":"example-ipad://travelapp",
            "ipad_app_store_id":"44",
            "ipad_app_name":"Travel App iPad",
            "android_url":"example-android://travelapp",
            "android_package":"com.travelapp",
            "android_class":"com.travelapp.Example",
            "android_app_name":"Travel App Android",
            "windows_phone_url":"example-windows://travelapp",
            "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
            "windows_phone_app_name":"Travel App Windows",
          },
          "type":["city","culture"],
          "neighborhood":["Mission","SoMa"],
          "url":"http://www.thebestdestination.com"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "price": "159.99",
          "destination_id": "destination-3",
        }
      }
    ]
  }

Ejemplo de respuesta: DESTINATION

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

HOME_LISTING

Estos campos de productos se admiten en los métodos CREATE y UPDATE del tipo HOME_LISTING, en la versión 3.3 y 3.2.

CampoDescripción

applink

Tipo:

Objeto <string>

Opcional.

Enlaces a apps para celulares.

address

Tipo:

objeto<string>

Obligatorio.

Dirección postal de la vivienda.

availability

Tipo: cadena

Obligatorio.

Disponibilidad actual de la vivienda. Valores admitidos: for_sale, for_rent, sale_pending, recently_sold, off_market y available_soon.

available_dates_price_config

Tipo:

Matriz <object>

Opcional.

Configuraciones de precios.

description

Tipo: cadena

Opcional.

Límite máximo de caracteres: 5.000.

Párrafo corto en el que se describe la vivienda.

image

Tipo:

Matriz <object>

Obligatorio.

URL y etiquetas de las imágenes que se usan en los anuncios. Admite hasta 20 imágenes múltiples. La etiqueta es opcional. Si se la usa, debes describir lo que hay en la imagen.

Ejemplo: pool.

latitude

Tipo: cadena

Opcional.

Ubicación de la latitud de la vivienda.

longitude

Tipo: cadena

Opcional.

Ubicación de la longitud de la vivienda.

listing_type

Tipo: cadena

Opcional.

Tipo de anuncio. Valores admitidos: for_rent_by_agent, for_rent_by_owner, for_sale_by_agent, for_sale_by_owner, foreclosed, new_construction y new_listing.

name

Tipo: cadena

Obligatorio.

Nombre de la vivienda.

neighborhood

Tipo:

Matriz <object>

Opcional.

Comunidad local de la vivienda. Número máx. de comunidades permitidas: 20.

num_baths

Tipo: cadena

Opcional.

Número de baños.

num_beds

Tipo: cadena

Opcional.

Número de habitaciones.

num_units

Tipo: cadena

Opcional.

Número de unidades disponibles. Usar solo para apartamentos o condominios disponibles para alquilar.

price

Tipo: cadena

Obligatorio.

Costo y divisa de la vivienda. El precio es un número seguido de un código de divisa; usa la norma ISO 4217. Usa ""."" como punto decimal para indicar el precio.

price_change

Tipo: cadena

Opcional.

Cambio de precio. Se puede usar para crear conjuntos de productos y en el contenido del anuncio:

  • 0: sin cambio de precio
  • -10: reducción del 10% del precio
  • 20: reducción del 20% del precio

Ejemplo: ""el precio promedio en NYC se redujo un X"" o ""bajó el precio promedio en NYC""

property_type

Tipo: cadena

Opcional.

Tipo de propiedad. Valores admitidos: apartment, condo, house, land, manufactured, other y townhouse.

url

Tipo: cadena

Obligatorio.

Enlace al sitio web donde se puede ver la vivienda.

year_built

Tipo: cadena

Opcional.

Año en que se construyó la casa.

El método UPDATE también se puede usar para crear artículos, si todavía no existen.

Ejemplo de solicitud: HOME_LISTING

{
  "access_token": "<ACCESS_TOKEN>",
  "item_type": "HOME_LISTING",
  "requests": [
    {
      "method": "DELETE",
      "data": {
        "home_listing_id": "home-listing-1"
      }
    },
    {
      "method": "CREATE",
      "data": {
        "home_listing_id": "12345678",
        "availability": "for_sale",
        "description": "An amazing listing",
        "name": "1 Hacker Way, Menlo Park, CA 94025",
        "price": "110000 USD",
        "longitude":"1.11414",
        "latitude":"-1.835003",
        "address": {
            "addr1":"1 Hacker Way",
            "city":"Menlo Park",
            "region":"California",
            "country":"United States",
            "postal_code":"94025"
        },
        "neighborhood":["Menlo Oaks"],
        "image": [
          {
              "url":"http://img10.naventcdn.com/avisos/18/00/52/30/31/52/1200x1200/63590918.jpg",
          },
        ],
        "listing_type": "for_sale_by_agent",
        "num_baths":"6",
        "num_beds":"5",
        "num_units":"1",
        "property_type":"house",
        "year_built":"2007",
        "available_dates_price_config" : [
          {
              "start_date":"2020-11-15",
              "end_date":"2020-12-15",
              "rate":"10000",
              "currency":"USD",
              "interval":"nightly",
          },
          {
              "start_date":"2020-11-15",
              "end_date":"2020-12-15",
              "rate":"50000",
              "currency":"USD",
              "interval":"weekly",
          },
        ],
        "applink" : {
          "ios_url":"example-ios://travelapp",
          "ios_app_store_id":"42",
          "ios_app_name":"Travel App iOS",
          "android_url":"example-android://travelapp",
          "android_package":"com.travelapp",
          "android_class":"com.travelapp.Example",
          "android_app_name":"Travel App Android",
        },
        "url":"http://www.example.com/link_to_listing"
      }
    },
    {
      "method": "UPDATE",
      "data": {
        "price": "100000 USD",
        "home_listing_id": "home-listing-3",
      }
    }
  ]
}

Ejemplo de respuesta: HOME_LISTING

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

VEHICLE

Para conocer los campos admitidos para los métodos CREATE y UPDATE del tipo VEHICLE, consulta Campos del catálogo de inventario de automóviles - Vehículo.

Los campos admitidos están disponibles para Vehículo y Concesionario.

El método UPDATE también se puede usar para crear artículos, si todavía no existen.

Ejemplo de solicitud: VEHICLE

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "VEHICLE",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "vehicle_id": "vehicle-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "vehicle_id": "i2 2017 Ford Fusion",
          "availability": "AVAILABLE",
          "make": "Ford",
          "model": "Fusion",
          "year": "2017",
          "mileage": {
            "value": "1500",
            "unit": "KM",
          },
          "image": [
            {
                "url":"http://www.facebook.com/teapic.jpg",
                "tag":["Car"],
            },
          ],
          "fuel_type":"gasoline",
          "body_style":"sedan",
          "drivetrain":"FWD",
          "vin":"1FADP5AU6DL536022",
          "condition":"EXCELLENT",
          "description": "Turbocharged! Gasoline!",
          "title": "SE Ford Certified and 6-Speed Automatic.",
          "price": "18000 USD",
          "exterior_color":"white",
          "sale_price":"16000 USD",
          "state_of_vehicle":"new",
          "longitude":"52.35",
          "latitude":"42.1",
          "address": {
              "addr1":"550 Auto Center Dr",
              "city":"Watsonville",
              "region":"CA",
              "country":"US",
              "postal_code":"96075"
          },
          "url":"http://www.example.com/test"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "price": "16000 USD",
          "vehicle_id": "vehicle-3",
        }
      }
    ]
  }

Ejemplo de respuesta: VEHICLE

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

Campos admitidos - Enviar lote de artículos localizados - /{catalog_id}/localized_items_batch

Consulta la lista de campos admitidos y las respectivas descripciones de cada campo para hallar el punto de conexión /{catalog_id}/localized_items_batch:

Consulta la lista completa de los campos admitidos para catálogos.

Más información