API Shopify : les nouveautés de la version d'octobre 2021

Dans cet article, nous allons passer en revue les nouvelles fonctionnalités d’API que nous venons de lancer en ce mois d’octobre 2021. Vous découvrirez ainsi comment ces nouveautés vous aideront à améliorer la qualité de vos applications et votre expérience de développement.

Cette version inclut des améliorations significatives de l'API Storefront, y compris une toute nouvelle API de panier et la possibilité d'extraire des ressources spécifiques par identifiant. Elle intègre également des webhooks pour les opérations en bloc, la mise en attente manuelle du traitement pour faciliter les pré-commandes, et des points de terminaison pour le consentement des clients à la réception de communications marketing par SMS.

Le lancement de cette nouvelle version coïncide avec la suppression de la version 2020-10. Assurez-vous donc de consulter votre rapport de santé (ou health report) des API pour vérifier que vos boutiques sont compatibles et n'oubliez pas de consulter les changements à venir. Pour connaître la liste complète des changements d’API associés à cette version, consultez les notes de la version 2021-10.

1. API de panier

Par le passé, la gestion des paniers avec l'API Storefront présentait des inconvénients importants. La seule façon d’obtenir en temps réel des informations sur la disponibilité des produits, les tarifs et les réductions était de créer ou de mettre à jour un paiement. Shopify limite soigneusement les paiements pour assurer une expérience de haute qualité pour les acheteurs, et les requêtes de gestion de ce « pseudo-panier » étaient décomptées de votre limite de paiements.

La version 2021-10 permet d'interagir directement avec les paniers via l'API Storefront. Cette API de panier est un énorme progrès en matière de facilité d'utilisation, car elle vous permet d'obtenir toutes les informations contextuelles sur une commande à venir, sans avoir besoin de créer un paiement avant que le client ne soit prêt à payer. De plus, ces paniers ne sont plus liés à la limite du nombre de paiements, ils respectent la même limite de débit que toutes les autres requêtes de la boutique. Les ventes flash bénéficient également de cette mise à jour : la file d'attente des paiements est désormais disponible pour les paniers créés via l'API Storefront.

Voici un exemple de mutation pour créer un panier via l'API Storefront :

Variables :

L'API répondra avec un panier :

Consultez notre documentation pour en savoir plus sur la gestion d'un panier avec l'API Storefront.

2. Améliorations de l'API Storefront

De nouveaux champs ont été ajoutés à l'objet QueryRoot pour faciliter l'extraction de ressources spécifiques. Par exemple, vous pouvez interroger directement des blogs, des collections, des pages et des produits avec un identifiant ou une ancre. Ces champs vous permettent de récupérer rapidement et efficacement la ressource dont vous avez besoin, plutôt que de la trouver dans une liste de toutes les ressources renvoyées à partir de l'index ou en utilisant le point de terminaison de recherche et en parcourant les périphéries et les nœuds pour chaque ressource renvoyée dans la réponse GraphQL.

Voici un exemple de requête GraphQL pour extraire un produit spécifique en fonction de son ancre :

Réponse

3. Webhooks pour les opérations en bloc

Dans les versions précédentes, vous deviez interroger l'état d'une opération en bloc pour savoir quand Shopify avait terminé de la traiter. Dans la version 2021-10, nous avons inclus des webhooks pour vous avertir si une tâche en bloc est terminée, a échouée ou a été annulée. Les webhooks réduisent encore davantage l'impact des opérations en bloc sur la limite d'appels de l'API et vous permettent d'attendre tranquillement la réponse webhook qui inclut l’état de votre opération en bloc.

Voici un exemple de mutation permettant de créer un abonnement à un webhook d'opération en bloc :

Voici un exemple de charge utile envoyée à l'URL spécifiée lorsqu'une opération en bloc se termine :

Pour en savoir plus sur les opérations en bloc, consultez notre documentation sur l'exécution d'opérations en bloc avec l'API administrateur GraphQL.

4. Mise en attente de traitement manuelle

La version 2021-10 offre des flux de traitement plus puissants pour les clients utilisant l’API Fulfillment Orders. Cette API prend désormais en charge l'action « hold » (suspendre) : cela permet aux applications de mettre en attente des articles, pour des commandes en souffrance ou des pré-commandes, jusqu’à ce que l'article soit disponible et que la commande puisse être traitée.

Voici un exemple de mutation pour placer une suspension sur une commande Fulfillment :

Variables :

Réponse :

Ces nouvelles actions sont disponibles uniquement via l’API Fulfillment Orders, et non via l’ancienne plateforme de traitement. Comme toujours, nous recommandons vivement à tous les clients qui interagissent avec les opérations de traitement d'utiliser l’API Fulfillment Orders plutôt que les anciens points de terminaison de traitement des commandes.

5. Consentement aux SMS

Les clients API peuvent désormais récupérer, ajouter et mettre à jour le consentement des clients à recevoir des informations marketing par SMS. Les mises à jour de cette préférence déclenchent un webhook CUSTOMER_MARKETING_CONSENT_UPDATE, ce qui vous permet de rester informé des préférences marketing du client.

Ces préférences sont mises à jour à l'aide de la mutation customerSmsMarketingConsentUpdate. Voici un exemple :

Variables :

Réponse :

Pour rappel, toutes les applications qui effectuent des activités marketing doivent mettre à jour le dossier client dans Shopify avec les préférences marketing recueillies auprès du client. Disposer d'informations à jour sur les préférences marketing des clients dans Shopify permet à toutes les applications d'une boutique de respecter ces préférences.

Pour plus d'informations sur les préférences marketing et les niveaux d'abonnement disponibles, consultez notre documentation sur la mutation customerSmsMarketingConsentUpdate.

Restez au courant de toutes les nouveautés

Pour connaître toutes les nouveautés de la plateforme Shopify, abonnez-vous au journal des changements pour les développeurs Shopify, la principale source d’information pour tous les nouveaux lancements de produits. Utilisez régulièrement ce journal et restez à la pointe en utilisant toutes les nouvelles fonctionnalités dès leur sortie dans la prochaine version d’API candidate, 2022-01.

---

Publié par Maud Leuenberger. Maud est la rédactrice en chef du blog français de Shopify.

Texte original par Shayne Parmelee. Traduction par Solenn Marchand. Image : Burst.