Référence

Utilisez cette référence pour voir les champs pris en charge et les exemples respectifs pour les points de terminaison POST /{catalog_id}/items_batch et POST /{catalog_id}/batch.

Les noms de paramètres pour /{catalog_id}/batch et /{catalog_id}/items_batch peuvent sembler similaires, mais ils sont distinctement différents.

Nous recommandons d’utiliser l’API /{catalog_id}/items_batch, qui prend en charge davantage de cas d’utilisation et est maintenue de manière active.

Champs pris en charge - Envoyer des mises à jour d’articles - /{catalog_id}/batch

Ces champs sont pris en charge pour les méthodes CREATE et UPDATE.

Désactivation des champs

Lors de la mise à jour des articles, fournissez une chaîne vide comme valeur pour désactiver un champ optionnel. Définir la valeur comme null ne désactivera pas le champ.

Champ Description

additional_image_urls

type :

tableau<string>

Facultatif.

URL pour un maximum de 9 à 10 images différentes.

additional_variant_attributes

type :

list<KeyValue:string,string>

Facultatif.

Attributs supplémentaires pour distinguer le produit dans son groupe de variantes.

Exemple : {"Scent" : "Fruity", "Style" : "Classic"}

availability

type : chaîne

Obligatoire

Identifie le statut de disponibilité :

  • in stock - Article expédié immédiatement.
  • out of stock - Réapprovisionnement non prévu
  • available for order - Expédié en 1 à 2 semaines.
  • discontinued

age_group

type : chaîne

Facultatif.

Groupe de personnes ayant le même âge ou un âge similaire. Valeurs acceptées : newborn, infant, toddler, kids, adult.

applinks

type :

objet<>

Facultatif.

Liens vers les applications mobiles.

category

type : chaîne

Facultatif mais recommandé pour les publicités de catalogue Avantage+ (peut contribuer à l’amélioration de la performance des publicités). Facultatif pour Instagram Shopping et les boutiques de Page, mais obligatoire pour activer le paiement sur site sur ces canaux (États-Unis uniquement). Obligatoire pour Marketplace (États-Unis uniquement).

Catégorie de produit Google (GPC) de l’article. Utilisez le chemin de la taxonomie de la catégorie ou son numéro d’identification, listé sur cette page.

Si vous utilisez le paiement sur Instagram ou Facebook (États-Unis uniquement), la GPC de l’article affecte ses taxes et sa politique de retour. Consultez la page d’aide sur les publicités Comment ajouter une catégorie de produits Google ou Facebook aux articles de votre catalogue pour en savoir plus.

Exemple : Apparel & Accessories > Clothing > Shirts & Tops ou 212

color

type : chaîne

Facultatif.

Taille maximale : 100.

Couleur de l’article.

condition

type : chaîne

Obligatoire.

État de l’article : new, refurbished, used.

currency

type : chaîne

Obligatoire.

Devise pour la valeur spécifiée. L’API Marketing accepte toutes les devises prises en charge par les comptes publicitaires. Utilisez l’ISO 4217 pour les normes monétaires.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

type : chaîne

Facultatif.

Nombre maximal de caractères : 100.

Informations supplémentaires sur l’article. Utilisez une chaîne vide pour le désactiver.

description

type : chaîne

Obligatoire.

Taille maximale : 5 000.

Brève description de l’article.

gender

type : chaîne

Facultatif.

Genre pour la taille. Valeurs incluses : male, female, unisex.

gtin

type : chaîne

Facultatif.

Taille maximale : 70.

Le numéro d’identification commercial international (GTIN) peut inclure : UPC,EAN, JAN, et ISBN.

image_url

type : chaîne

Obligatoire.

Lien vers l’image de l’article utilisé dans la publicité. Fournissez des tailles d’image appropriées.

Pour les publicités de catalogue Advantage+ basées à image unique

  • La résolution d’image minimale requise est de 500 px * 500 px
  • Les proportions minimales sont de 4:5
  • Les proportions maximales sont de 1:91:1.

Si l’image ne respecte pas ces proportions, Facebook la recadre afin qu’elle soit la plus proche possible des proportions minimales ou maximales en fonction de ses proportions d’origine.

Pour une image carrousel, publicités de catalogue Advantage+ - L’exigence de résolution d’image minimale est de 500 px * 500 px, et Facebook la recadre aux proportions 1:1.

Recommandation : évitez les changements fréquents d’image url. Les URL d’images ne devraient pas contenir les paramètres tels que price ou timestamp, car ils ont tendance à changer fréquemment.

inventory

type : nombre

Facultatif.

Nombre entier pouvant être utilisé par les annonceurs pour stocker des informations sur le niveau d’inventaire.

marked_for_product_launch

type : chaîne

N/A pour les publicités de catalogue Advantage+. Facultatif pour le commerce.

Indique si un article sera utilisé dans un lancement de produit. Valeurs acceptées :

  • marked : l’article sera masqué pour les acheteur·euses jusqu’à la création du lancement du produit. Cela permet d’éviter que l’article ne soit disponible à la consultation et à l’achat avant l’heure de lancement souhaitée.
  • not_marked (par défaut) : l’article ne fera pas partie d’un lancement de produit.

name

type : chaîne

Obligatoire.

Taille maximale : 100.

Titre de l’article.

pattern

type : chaîne

Facultatif

Taille maximale : 100.

Motif ou imprimé graphique figurant sur un article.

price

type : nombre entier

Obligatoire.

Le prix multiplié par 100, pour toutes les devises. Exemple : 490 utilisé avec USD signifie $4,90, et 49 000 utilisé avec JPY signifie ¥490.

product_type

type : chaîne

Facultatif.

Taille maximale : 750.

Catégorie définie par le vendeur pour l’article.

Exemple : dans TSV Maison & Jardin > Cuisine & Salle à manger > Appareils > Réfrigérateurs.

Exemple : dans type_produit XML > Maison & Jardin > Cuisine & Salle à manger > Appareils > Réfrigérateurs > type_produit.

retailer_product_group_id

type : chaîne

Facultatif.

Accepte des chaînes. Utilisation possible par les annonceurs pour regrouper les produits.

sale_price

type : nombre entier

Facultatif.

Prix réduit si l’article est en solde. Prix de vente multiplié par 100, pour toutes les devises. Exemple : 490 utilisé avec USD signifie $4,90, et 49 000 utilisé avec JPY signifie ¥490.

sale_price_start_date

type : chaîne

Facultatif.

Date et heure de fin de la vente.

Exemple : 2014-12-01T00:00-0300

sale_price_end_date

type : chaîne

Facultatif.

Date et heure de début de la vente.

2014-11-01T12:00-0300

shipping

type :

tableau<object>

Facultatif.

Informations de livraison.

size

type : chaîne

Facultatif.

Taille de l’article. Exemple : Small ou XL.

url

type : chaîne

Obligatoire.

Lien vers le site du marchand où il est possible d’acheter l’article.

vendor_id

type : chaîne

Facultatif.

L’ID du fournisseur/vendeur qui vend l’article.

Exemple de requête - /{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",
      }
    }
  ]
}

Exemple de réponse - /{catalog_id}/batch

Un ou plusieurs descripteurs seront retournés.

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

Champs pris en charge - Envoyer des mises à jour de produits - /{catalog_id}/items_batch

Pour les catalogues de vente : utilisez cette API si vous devez mettre à jour les informations sur les produits plusieurs fois par heure (sinon, utilisez l’API Feed). Elle permet de mettre à jour plusieurs articles à l’aide d’une requête HTTP unique.

PRODUCT_ITEM

Ces champs de produit sont pris en charge pour les méthodes CREATE et UPDATE, pour les versions 3.3 et 3.2 :

ChampDescription

additional_image_link

type :

tableau<string>

Facultatif.

Lien pour un maximum de 9 à 10 images différentes.

additional_variant_attribute

type :

list<KeyValue:string,string>

Facultatif.

Attributs supplémentaires pour distinguer le produit dans son groupe de variantes.

Exemple : "Scent:Fruity,Flavor:Apple"

age_group

type : chaîne

Facultatif.

Groupe de personnes ayant le même âge ou un âge similaire. Valeurs acceptées : newborn, infant, toddler, kids, adult.

applink

type :

objet<string>

Facultatif.

Liens vers les applications mobiles.

Exemple :

"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

type : chaîne

Obligatoire.

Identifie le statut de disponibilité :

  • in stock - Article expédié immédiatement
  • out of stock - Réapprovisionnement non prévu
  • available for order - Expédition dans 1 à 2 semaines
  • discontinued

brand

type : chaîne

Facultatif.

Marque de l’article.

color

type : chaîne

Facultatif.

Taille maximale : 100.

Couleur de l’article.

condition

type : chaîne

Obligatoire.

État du produit : new, refurbished, ou used.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

type : chaîne

Facultatif.

Nombre maximal de caractères : 100.

Informations supplémentaires sur l’article.

description

type : chaîne

Obligatoire.

Taille maximale : 5 000.

Brève description du produit.

disabled_capabilities

type :

tableau<string>

Facultatif.

Liste des fonctionnalités à désactiver. Valeurs possibles : 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, test_capability.

gender

type : chaîne

Facultatif.

Genre pour la taille. Valeurs incluses : male, female, unisex.

google_product_category

type : chaîne

Facultatif.

Taille maximale : 250.

Valeurs prédéfinies (chaîne ou ID de catégorie) issues de la taxonomie des produits Google.

Exemple : Vêtements et accessoires > Accessoires d’habillement > Robes ou 2271.

gtin

type : chaîne

Facultatif.

Taille maximale : 70.

Le Numéro d’identification commercial international (Global Trade Identification Number, GTIN) peut inclure UPC, EAN, JAN, et ISBN.

id

type : chaîne

Obligatoire.

ID du vendeur

image

type : tableau <object>

URL et tags pour les images à utiliser dans vos publicités ou vos boutiques. Prend en charge jusqu’à 20 images différentes. Les tags sont optionnels et, en cas d’utilisation, ils devraient décrire le contenu de l’image.


Exemple :

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

image_link

type : chaîne

Non nécessaire si image est fourni.

Nous recommandons d’utiliser image à la place. Lorsque image est fourni, image_link et additional_image_link sont ignorés.

Lien vers l’image de l’article utilisé dans la publicité. Fournissez des tailles d’image appropriées.

Pour les publicités de catalogue Advantage+ à image unique :

  • La résolution d’image minimale requise est de 500 px*500 px.
  • Les proportions minimales sont de 4:5.
  • Les proportions maximales sont de 1:91:1. Si l’image ne respecte pas ces proportions, Facebook la recadre pour qu’elle soit le plus proche possible des proportions minimales ou maximales, en fonction de ses proportions d’origine.

Pour une image carrousel, les publicités de catalogue Advantage+ : l’exigence de résolution d’image minimale est de 500 px * 500 px, et Facebook la recadre aux proportions 1:1.

internal_label

type : chaîne

Ajoutez des étiquettes internes pour faciliter le filtrage des articles lorsque vous créez des ensembles de produits. Par exemple, vous pouvez ajouter une étiquette « Été » à tous les articles qui bénéficient des promotions estivales, puis intégrer ces articles dans un ensemble. Les étiquettes ne sont visibles que par vous.

Entourez chaque étiquette de guillemets simples (') et séparez les étiquettes par des virgules (,). N’incluez pas d’espace blanc au début ou à la fin d’une étiquette. Limite de caractères : jusqu’à 5 000 étiquettes par produit et 110 caractères par étiquette.

Exemple (TSV, XLSX, Google Sheets) : ['été','tendances']

Exemple (CSV) : « ['été','tendances'] »

Remarque : si vous utilisez actuellement des étiquettes personnalisées (custom_label_0 à custom_label_4) pour le filtrage des ensembles de produits, nous vous recommandons de vous servir plutôt d’étiquettes internes (internal_label). Contrairement aux étiquettes personnalisées, vous pouvez ajouter ou mettre à jour les étiquettes internes aussi souvent que nécessaire sans avoir à soumettre systématiquement les articles à un examen de la politique qui peut affecter la diffusion des publicités.

Ce champ était auparavant appelé product_tags. Même si l’ancien nom du champ est encore pris en charge, nous vous recommandons d’utiliser le nouveau nom.

inventory

type : objet

Facultatif.

Nombre entier pouvant être utilisé par les annonceurs pour stocker des informations sur le niveau d'inventaire.

item_group_id

type : chaîne

Facultatif.

L'ID d’un groupe de produits fourni par l'annonceur ; pas le FBID. Accepte des chaînes. Peut être utilisé par les annonceurs pour regrouper différents objets (produits, véhicules, hôtels, vols, etc.).

link

type : chaîne

Obligatoire.

Lien vers le site du marchand vendant l'article.

manufacturer_part_number

type : chaîne

Facultatif.

ID de fabricant unique pour le produit.

pattern

type : chaîne

Facultatif.

Taille maximale : 100.

Motif ou imprimé graphique figurant sur un produit.

price

type : chaîne

Obligatoire.

Prix de l’article. Le format du prix doit être le suivant : coût suivi du code de devise ISO à 3 chiffres, avec une espace entre les deux.

Exemple : 9.99 USD.

rating_count

type : nombre

Facultatif.

Nombre d’évaluations que les acheteurs ont fournies pour ce produit. Doit être supérieur à 0. Doit être utilisé en association avec user_rating.

Exemple : 100

sale_price

type : chaîne

Facultatif, mais requis pour utiliser la fonctionnalité de superposition pour les publicités de catalogue Advantage+.

Prix réduit si l’article est en solde. Le format du prix doit être le suivant : coût suivi du code de devise ISO à 3 chiffres, avec une espace entre les deux.

Exemple : 9.99 USD, 25.00 EUR

sale_price_effective_date

type : chaîne

Facultatif.

Jour et heure de début et de fin de la réduction, séparés par une barre oblique. Respectez le format suivant pour les dates de début et de fin : AAAA-MM-JJ. Ajoutez un « T » après chaque date, puis ajoutez l’heure. Respectez le format 24 heures pour les heures (de 00:00 à 23:59).

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

shipping

type : chaîne

Facultatif.

Blob avec des prix différents pour chaque pays et région. Les régions différentes sont séparées par des virgules. Le format doit être le suivant : COUNTRY:STATE:SHIPPING_TYPE:PRICE.

Exemple : US:CA:Ground:9.99 USD, US:NY:Air:15.99 USD

size

type : chaîne

Facultatif.

Taille de l’article. Exemple : Small ou XL.

title

type : chaîne

Obligatoire.

Taille maximale : 100.

Titre de l’article.

user_rating

type : nombre

Facultatif.

Évaluation moyenne que les acheteurs ont fournie pour ce produit. Valeur comprise entre 1.0 et 5.0. Une décimale autorisée. Doit être utilisé en association avec rating_count.

Exemple : 4.5

video

type : tableau <object>

URL et tags pour les vidéos à utiliser dans vos publicités ou vos boutiques. Prend en charge jusqu'à 30 000 vidéos au niveau du catalogue. Les tags sont optionnels et, en cas d’utilisation, ils devraient décrire le contenu de la vidéo.


La taille maximale autorisée pour un fichier vidéo est de 200 Mo. Les formats pris en charge sont les suivants : .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 et .wmv


Exemple :

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

NOTE : pour supprimer la vidéo 1 si le produit comporte la vidéo 1, 2, enlevez la vidéo 1 du tableau :

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

Pour supprimer toutes les vidéos, envoyez un tableau vide :

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

Il est également possible d’avoir recours à la méthode UPDATE pour créer des éléments s’ils n’existent pas déjà.

En savoir plus sur les champs de produits dans la Référence API.

Exemple de requête - 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",
        }
      }
    ]
  }

Exemple de réponse - PRODUCT_ITEM

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

En savoir plus sur la rubrique Ajouter des articles de catalogue avec un flux de données.


HÔTEL

Champs de produits pris en charge pour les méthodes CREATE et UPDATE pour le type HOTEL, pour la version 3.2 :

ChampDescription

address

type :

objet<string>

Obligatoire.

Adresse de l'hôtel.

applink

type :

Facultatif.

Liens vers les applications mobiles.

base_price

type : chaîne

Obligatoire.

Prix de base de la chambre d’hôtel par nuitée. Ajoutez le type de devise au prix. Le format du prix doit être le suivant : coût, suivi du code de devise ISO, avec une espace entre les deux. Exemple : USD pour dollars américains.

brand

type : chaîne

Facultatif.

Marque de la chaîne hôtelière.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

type : chaîne

Nombre maximal de caractères : 100.

Jusqu’à cinq champs personnalisés pour toute information supplémentaire que vous souhaitez utiliser pour filtrer des articles quand vous créez des ensembles. Par exemple, vous pouvez utiliser un champ personnalisé pour indiquer toutes les chambres qui bénéficient des promotions estivales, puis intégrer ces chambres dans un ensemble. Ce champ peut contenir n’importe quelle valeur de texte, y compris des chiffres.


Exemple : Summer Sale

Ce champ est pris en charge par des flux de produits supplémentaires.

custom_number_0
custom_number_1
custom_number_2
custom_number_3
custom_number_4

type : nombre entier

Jusqu’à cinq champs personnalisés pour toute information numérique supplémentaire que vous souhaitez utiliser pour filtrer des articles quand vous créez des ensembles. Ce champ permet de filtrer par plages de nombres (supérieur à et inférieur à) lorsque vous créez un ensemble. Par exemple, vous pouvez indiquer l’année d’ouverture d’un hôtel, puis filtrer sur un intervalle d’années dans un ensemble.


Ce champ peut contenir des nombres entiers compris entre 0 et 4 294 967 295. Les nombres négatifs, les nombres décimaux ou les virgules, comme -2, 5,5 ou 10,000, ne sont pas acceptés.


Exemple : 2022

description

type : chaîne

Obligatoire.

Maximum de caractères autorisé : 5 000.

Brève description de l’hôtel.

guest_rating

type :

tableau<object>

Facultatif.

Les évaluations de la clientèle de l'hôtel.

hotel_id

type : chaîne

Obligatoire.

ID unique pour l'hôtel.

image

type :

tableau<object>

Obligatoire.

URL et tags pour les images à utiliser dans les publicités. Prend en charge jusqu’à 20 images différentes. Le tag est facultatif, en cas d’utilisation. Devrait décrire le contenu de l’image. Exemple : "reception".

latitude

type : chaîne

Obligatoire.

Latitude de l'hôtel.

longitude

type : chaîne

Obligatoire.

Longitude de l’hôtel.

loyalty_program

type : chaîne

Facultatif.

Programme de fidélité utilisé pour l'hôtel.

margin_level

type : chaîne

Facultatif.

Indicateur de rentabilité de l'hôtel ; valeur de 1 à 10.

name

type : chaîne

Obligatoire.

Nom de l'hôtel.

neighborhood

type :

tableau<string>

Facultatif.

Un ou plusieurs quartiers dans lesquels se trouve l’hôtel. Exemple : Soho ou Las Vegas Strip. Le nombre maximum de quartiers autorisés est de 20.

phone

type : chaîne

Facultatif.

Numéro de téléphone avec indicatif pays.

sale_price

type : chaîne

Facultatif.

Prix de vente par nuitée dans l’hôtel. Utilisez ceci pour publier des réductions sur le prix régulier de l'hôtel. Obligatoire : ajoutez le type de devise au prix. Le format du prix doit être le suivant : coût, suivi du code de devise ISO, avec une espace entre les deux. Exemple : USD pour dollars américains.

star_rating

type : chaîne

Facultatif.

Évaluation de l’hôtel en nombre d’étoiles. Le nombre doit être compris entre 1 et 5.

url

type : chaîne

Obligatoire.

Lien vers le site externe de réservation de la chambre d’hôtel.

Il est également possible d’avoir recours à la méthode UPDATE pour créer des éléments s’ils n’existent pas déjà.

Exemple de requête - 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",
        }
      }
    ]
  }

Exemple de réponse - HOTEL

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

HOTEL_ROOM

Ces champs de produit sont pris en charge pour les méthodes CREATE et UPDATE pour le type HOTEL_ROOM, pour la version 3.2.

ChampDescription

base_price

type : chaîne

Obligatoire.

Prix de base pour une nuitée. La devise doit respecter les codes de devise de la norme ISO 4217.

Exemple : 9.99 USD.

description

type : chaîne

Obligatoire.

Taille maximale : 5 000.

Brève description de la chambre.

hotel_retailer_id

type : chaîne

Obligatoire.

Identifiant unique pour l’hôtelier.

hotel_room_id

type : chaîne

Obligatoire.

ID unique pour l'hôtel.

image

type :

tableau<object>

Obligatoire.

Images de la chambre.

name

type : chaîne

Obligatoire.

Taille maximale : 100.

Nom de la chambre.

url

type : chaîne

Obligatoire.

Lien vers le site de réservation du séjour de l'annonceur.

Il est également possible d’avoir recours à la méthode UPDATE pour créer des éléments s’ils n’existent pas déjà.

Exemple de requête - 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",
        }
      }
    ]
  }

Exemple de réponse - HOTEL_ROOM

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

VOL

Ces champs de produits sont pris en charge pour les méthodes CREATE et UPDATE pour le type FLIGHT, pour la version 3.2.

ChampDescription

description

type : chaîne

Facultatif.

Nombre maximal de caractères : 5 000.

Description du vol.

destination_airport

type : chaîne

Obligatoire.

Aéroport de destination pour le vol. Doit être au format du code IATA.

Exemple : SFO.

destination_city

type : chaîne

Facultatif.

Nom de la ville de destination pour le vol.

image

type :

tableau<object>

Obligatoire.

URL et tags pour les images à utiliser dans les publicités. Prend en charge jusqu’à 20 images différentes. Le tag étant facultatif, en cas d’utilisation, il doit décrire le contenu de l'image.

Exemple : seat

origin_airport

type : chaîne

Obligatoire.

Aéroport de départ pour le vol. Doit être au format du code IATA.

Exemple : SFO

origin_city

type : chaîne

Facultatif.

Nom de la ville d'origine pour le vol.

price

type : chaîne

Facultatif.

Prix et devise du vol. Le prix est un nombre suivi du code de la devise. Utilisez les normes ISO 4217. Utilisez « . » comme décimale pour le prix.

url

type : chaîne

Facultatif.

Lien vers le site Web de réservation du vol.

Il est également possible d’avoir recours à la méthode UPDATE pour créer des éléments s’ils n’existent pas déjà.

Exemple de requête - 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": {

Exemple de réponse - FLIGHT

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

DESTINATION

Ces champs de produit sont pris en charge pour les méthodes CREATE et UPDATE pour le type DESTINATION, pour la version 3.2.

ChampDescription

applink

type :

objet<string>

Facultatif.

Liens vers les applications mobiles.

address

type :

objet<string>

Obligatoire.

Adresse de l'hôtel.

description

type : chaîne

Facultatif.

Nombre maximal de caractères : 5 000.

Court paragraphe décrivant la destination.

destination_id

type : chaîne

Obligatoire.

Nombre maximal de caractères : 100.

Identifiant unique pour la destination.

image

type :

tableau<object>

Obligatoire.

URL et tags pour les images à utiliser dans les publicités. Prend en charge jusqu’à 20 images différentes. Le tag étant facultatif, en cas d’utilisation, il doit décrire le contenu de l'image.

Exemple :seat.

latitude

type : chaîne

Obligatoire.

Latitude de la destination.

longitude

type : chaîne

Obligatoire.

Longitude de la destination.

name

type : chaîne

Obligatoire.

Nom de la destination.

neighborhood

type :

tableau<string>

Facultatif.

Le nombre maximum de quartiers autorisés est de 20. Un ou plusieurs quartiers dans lesquels se trouve la destination.

Exemple : Soho ou Las Vegas Strip.

price

type : chaîne

Facultatif.

Prix moyen le plus bas et devise pour la destination. Le prix doit être composé d’un nombre suivi du code de la devise. Utilisez les normes ISO 4217. Utilisez « . » comme décimale pour le prix.

price_change

type : chaîne

Facultatif.

Changement de prix. Peut être utilisé pour construire des ensembles de produits et dans le contenu publicitaire :

  • 0 - Pas de changement de prix
  • -10 - Baisse de prix de 10 %
  • 20 - Augmentation de prix de 20 %.

Exemple : « le prix moyen à NYC a diminué de X » ou « le prix moyen à NYC a chuté »

type

type :

tableau<string>

Obligatoire.

Le nombre maximum de types de destinations est de 20. Type(s) de destination. Une destination peut comprendre plusieurs types.

Exemple : park ou beach

url

type : chaîne

Obligatoire.

Lien vers le site Web de réservation de la destination.

Il est également possible d’avoir recours à la méthode UPDATE pour créer des éléments s’ils n’existent pas déjà.

Exemple de requête - 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",
        }
      }
    ]
  }

Exemple de réponse - DESTINATION

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

HOME_LISTING

Ces champs de produits sont pris en charge pour les méthodes CREATE et UPDATE pour le type HOME_LISTING, pour les versions 3.3 et 3.2.

ChampDescription

applink

type :

objet<string>

Facultatif.

Liens vers les applications mobiles.

address

type :

objet<string>

Obligatoire.

Adresse postale pour l’annonce immobilière.

availability

type : chaîne

Obligatoire.

Disponibilité actuelle de l’annonce immobilière. Valeurs prises en charge : for_sale, for_rent, sale_pending, recently_sold, off_market, available_soon.

available_dates_price_config

type :

tableau<object>

Facultatif.

Configurations de prix.

description

type : chaîne

Facultatif.

Nombre maximal de caractères : 5 000.

Court paragraphe décrivant l’annonce immobilière.

image

type :

tableau<object>

Obligatoire.

URL et tags pour les images à utiliser dans les publicités. Prend en charge jusqu’à 20 images différentes. Le tag étant facultatif, en cas d’utilisation, il doit décrire le contenu de l'image.

Exemple : pool.

latitude

type : chaîne

Facultatif.

Latitude de l’annonce immobilière.

longitude

type : chaîne

Facultatif.

Longitude de l'annonce immobilière.

listing_type

type : chaîne

Facultatif.

Annonce immobilière. Valeurs prises en charge : for_rent_by_agent, for_rent_by_owner, for_sale_by_agent, for_sale_by_owner, foreclosed, new_construction, new_listing.

name

type : chaîne

Obligatoire.

Nom de l’annonce immobilière.

neighborhood

type :

tableau<object>

Facultatif.

Quartier pour l’annonce immobilière. Nombre de quartiers max. autorisés : 20.

num_baths

type : chaîne

Facultatif.

Nombre de salles de bain.

num_beds

type : chaîne

Facultatif.

Nombre de chambres.

num_units

type : chaîne

Facultatif.

Nombre d'unités disponibles. Uniquement applicable aux appartements ou aux copropriétés disponibles à la vente/location.

price

type : chaîne

Obligatoire.

Prix et devise pour l’annonce immobilière. Le prix est un nombre suivi du code de la devise. Utilisez les normes ISO 4217. Utilisez « . » comme décimale pour le prix.

price_change

type : chaîne

Facultatif.

Changement de prix. Peut être utilisé pour construire des ensembles de produits et dans le contenu publicitaire :

  • 0 - Pas de changement de prix
  • -10 - Baisse de prix de 10 %
  • 20 - Augmentation de prix de 20 %.

Exemple : « le prix moyen à NYC a diminué de X » ou « le prix moyen à NYC a chuté »

property_type

type : chaîne

Facultatif.

Type de propriété. Valeurs prises en charge : apartment, condo, house, land, manufactured, other, townhouse.

url

type : chaîne

Obligatoire.

Lien vers le site Web de consultation de l’annonce.

year_built

type : chaîne

Facultatif.

Année de construction de la maison.

Il est également possible d’avoir recours à la méthode UPDATE pour créer des éléments s’ils n’existent pas déjà.

Exemple de requête - 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",
      }
    }
  ]
}

Exemple de réponse - HOME_LISTING

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

VÉHICULE

Pour les champs pris en charge pour les méthodes CREATE et UPDATE pour le type VEHICLE, consultez Champs de catalogue d'inventaire automobile - Véhicule.

Les champs pris en charge sont disponibles pour Véhicule et Concessionnaire.

Il est également possible d’avoir recours à la méthode UPDATE pour créer des éléments s’ils n’existent pas déjà.

Exemple de requête - 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",
        }
      }
    ]
  }

Exemple de réponse - VEHICLE

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

Champs pris en charge - Envoyer un lot d’articles localisés - /{catalog_id}/localized_items_batch

Consultez la liste des champs pris en charge et leurs descriptions respectives pour chaque champ, pour le point de terminaison /{catalog_id}/localized_items_batch :

Consultez la liste complète des champs pris en charge par le catalogue.

En savoir plus