Centre d’aide Activity Messenger

Produits

Consultez l’introduction à l’API pour l’authentification, les conventions, la pagination, les limites de requêtes et les erreurs.

Ces points de terminaison renvoient des tableaux JSON; ils ne prennent pas en charge page ni per_page.

Transmettez l’en-tête X-Activity-Messenger-Api-Key à chaque requête. Les produits sont gérés sous E-Commerce → Produits. Les produits archivés (supprimés) ne sont jamais renvoyés; ceux qui sont masqués ou désactivés le sont. Les variantes de produit ne sont pas incluses dans la réponse.

Un objet produit contient les champs suivants :

• id : identifiant numérique du produit; la clé stable.
• tags : tableau des noms d’étiquettes (chaînes) attribuées au produit; vide lorsque le produit n’a aucune étiquette.
• name : dans la version actuelle, ce champ renvoie l’identifiant numérique du produit plutôt que son nom.
• image_url, image_url2, image_ur3 : URL des images, ou null. La troisième clé s’écrit image_ur3.
• short_description, description : textes du produit, ou null. description peut contenir du HTML.
• order : ordre d’affichage (entier).
• visible : booléen; false lorsque le produit est masqué de la boutique publique.
• disabled : booléen; true lorsque le produit ne peut pas être acheté.
• price : chaîne décimale à deux décimales, par exemple "25.00".
• tax_info : null lorsque le prix est nul. Sinon, un objet avec display, after_tax, before_tax, inclusive_tax, exclusive_tax, tax (nombres), taxes (un montant par taxe), names, inclusive_names et exclusive_names (noms des taxes).
• microsite_url : URL publique de la boutique, ancrée sur la fiche du produit.
• iframe_url : URL de la même page dans la présentation intégrable en iframe.

GET /api/v1/organization/{organization}/products?tags[]={tag}&tags[]={tag}

Récupère tous les produits vendus par l’organisation, y compris ceux qui sont masqués au public. Vous pouvez transmettre une liste facultative tags[] dans la chaîne de requête. Tout produit correspondant aux étiquettes est renvoyé.

• tags[] : noms d’étiquettes facultatifs, correspondance exacte et sensible à la casse. Plusieurs valeurs utilisent un opérateur OU : un produit est renvoyé dès qu’il porte au moins une des étiquettes. Une valeur unique tags= est aussi acceptée. Les valeurs vides sont ignorées; sans étiquette, tous les produits sont renvoyés.

[
  {
    "id": 8765,
    "tags": ["Articles", "Été"],
    "name": 8765,
    "image_url": "https://activitymessenger.com/storage/example/shirt.jpg",
    "image_url2": null,
    "image_ur3": null,
    "short_description": "T-shirt du club",
    "description": "<p>T-shirt en coton avec le logo du club.</p>",
    "order": 1,
    "visible": true,
    "disabled": false,
    "price": "25.00",
    "tax_info": {
      "display": 25,
      "after_tax": 28.74,
      "before_tax": 25,
      "inclusive_tax": 0,
      "exclusive_tax": 3.74,
      "tax": 3.74,
      "taxes": [1.25, 2.49],
      "names": ["TPS 5%", "TVQ 9.975%"],
      "inclusive_names": [],
      "exclusive_names": ["TPS 5%", "TVQ 9.975%"]
    },
    "microsite_url": "https://activitymessenger.com/org/1234/products#product-card-8765",
    "iframe_url": "https://activitymessenger.com/iframe//org/1234/products#product-card-8765"
  }
]

GET /api/v1/organization/{organization}/product_tags

Récupère toutes les étiquettes définies et utilisées sur les produits. La réponse est un tableau de noms d’étiquettes (chaînes) triés alphabétiquement par slug, par exemple ["Articles", "Été"]. Les étiquettes attribuées à aucun produit ne sont pas renvoyées.

Pour poursuivre : Connecter un formulaire Activity Messenger à Zapier