Passer au contenu principal
Recherchez des produits sur la boutique Olive Young (oliveyoung.co.kr) et lisez ses pages produit via l’API de tâches asynchrones. Envoyez COMMERCE_SERP avec site oliveyoung pour recevoir les produits qu’affiche une recherche, dans l’ordre de la boutique, ou COMMERCE_PRODUCT avec l’url d’un produit pour lire ce produit. Une recherche ou une page produit terminée coûte 0.5 crédit.

Recherche

Soumettez la tâche, puis interrogez GET /v1/async/task/{id} ou recevez son webhook. Voir Tâches asynchrones.

Paramètres

  • site : obligatoire. oliveyoung.
  • query : obligatoire. Terme de recherche, de 1 à 500 caractères.
  • limit : entier facultatif de 1 à 40, avec 20 par défaut.
  • country : facultatif. Par défaut, KR, le pays de la boutique. Tout autre pays est refusé avec 422 REGION_UNSUPPORTED.
Seuls les champs de payload listés ci-dessus sont acceptés. Omettez include : même include: {} renvoie 422 VALIDATION_ERROR sur payload.include avant toute réservation de crédits.

Exemple de réponse

Champs du résultat

  • site, query et country reprennent la requête. returnedCount est le nombre d’éléments de products.
  • Chaque produit comporte rank, productId, title et url. productId est l’identifiant produit propre à la boutique. rank suit l’ordre par défaut de la boutique, et les annonces que la boutique marque comme sponsorisées sont exclues.
  • price, rating, reviewCount, imageUrl et brand apparaissent quand la page de résultats les affiche. price est un nombre dans la currency du produit (ISO 4217) ; quand les formats ont des prix différents, c’est le plus bas.
  • rating utilise une échelle de cinq points. Les nombres d’avis abrégés, comme 999+, sont omis.
  • Chaque recherche renvoie les produits de la première page de résultats de la boutique.

Page produit

Paramètres

  • url : obligatoire. Une page produit de la boutique Olive Young, de 2 048 caractères au plus : oliveyoung.co.kr/store/goods/getGoodsDetail.do?goodsNo={id}. Les url de produit renvoyées par une recherche s’utilisent telles quelles. Les paramètres sans effet sur le résultat, comme les codes de suivi, sont retirés avant la lecture.
  • country : facultatif. Par défaut, KR, le pays de la page. Tout autre pays est refusé avec 422 REGION_UNSUPPORTED.
Seuls les champs de payload listés ci-dessus sont acceptés. Omettez include : même include: {} renvoie 422 VALIDATION_ERROR sur payload.include avant toute réservation de crédits.

Exemple de réponse

Champs du résultat

  • site, country, url et productId identifient la page. url est la page lue, et productId correspond à celui que renvoie une recherche.
  • title est toujours présent. brand, price, listPrice, currency, inStock, rating, reviewCount, images, description, descriptionImages, options, categories et gtin apparaissent quand la page les affiche.
  • price est ce que paie un acheteur tel que la page l’affiche à l’ouverture, avant coupons et livraison, en currency (ISO 4217). listPrice est le prix habituel que la page barre, présent quand il dépasse price. inStock indique la disponibilité du produit.
  • rating utilise une échelle de cinq points avec deux décimales. reviewCount est le nombre d’avis.
  • images liste jusqu’à 30 photos de la galerie du produit, dans l’ordre de la page.
  • description est du texte brut avec une ligne par paragraphe, jusqu’à 10 000 caractères ; le texte qui n’apparaît que dans des images n’est pas inclus. Cette boutique affiche la plupart des détails produit sous forme d’images, donc peu de ses pages ont une description.
  • descriptionImages liste jusqu’à 300 images de la description du produit, dans l’ordre de la page. Les bannières et avis que les vendeurs placent dans leur description sont inclus, et le texte des images n’est pas lu.
  • options liste jusqu’à 20 choix, comme la taille ou la couleur, chacun avec jusqu’à 100 values ; les autres champs décrivent le choix sur lequel la page s’ouvre. categories va de la catégorie la plus large à la plus précise, sur 10 niveaux au plus. gtin est l’UPC, l’EAN ou le JAN indiqué par la page.

Erreurs et facturation

  • Une recherche qui ne renvoie aucun produit se termine par une tâche en échec.
  • Une page produit à laquelle la boutique répond 404 ou 410, comme un produit retiré, termine la tâche avec PAGE_UNAVAILABLE, et le message reprend la réponse de la boutique. Si la boutique refuse la lecture avec 403, 412, 429 ou 435, la tâche attend et redemande pendant 6 minutes au plus. Les autres lectures échouées, et un refus qui dure plus longtemps, se terminent par ENGINE_NO_RESULT.
  • Seules les tâches terminées sont facturées : 0.5 crédit par recherche ou page produit.

Voir aussi