Centre d’aide Activity Messenger

Forfaits de réservation

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 forfaits sont les offres réservables gérées sous E-Commerce → Forfaits de réservations; les catégories de forfaits les regroupent sur le microsite. Les forfaits et catégories archivés (supprimés) ne sont jamais renvoyés; ceux qui sont masqués ou désactivés le sont.

Un objet catégorie de forfaits contient les champs suivants :

• id : identifiant numérique de la catégorie; la clé stable.
• name : nom de la catégorie.
• image_url : URL de l’image de la catégorie, ou null.
• short_description, description : textes de la catégorie, ou null. description peut contenir du HTML.
• order : ordre d’affichage (entier).
• visible : booléen; false lorsque la catégorie est masquée du microsite public.
• microsite_url : URL publique de la catégorie sur le microsite.
• iframe_url : URL de la même page dans la présentation intégrable en iframe.

Un objet forfait contient les champs suivants :

• id : identifiant numérique du forfait; la clé stable.
• package_category_id : identifiant de la catégorie, ou null lorsque le forfait n’est dans aucune catégorie.
• name : dans la version actuelle, ce champ renvoie l’identifiant numérique du forfait 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 forfait, ou null. description peut contenir du HTML.
• order : ordre d’affichage (entier).
• visible : booléen; false lorsque le forfait est masqué du microsite public.
• disabled : booléen; true lorsque le forfait ne peut pas être réservé.
• price : chaîne décimale à deux décimales, par exemple "100.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 du forfait sur le microsite.
• iframe_url : URL de la même page dans la présentation intégrable en iframe.

GET /api/v1/organization/{organization}/package_categories

Récupère les catégories définies pour regrouper les forfaits. Seules les catégories contenant au moins un forfait sont renvoyées, triées par order puis de la plus récente à la plus ancienne. Le tableau est vide lorsqu’aucun forfait n’est dans une catégorie.

GET /api/v1/organization/{organization}/packages

Récupère tous les forfaits de l’organisation, dans toutes les catégories et hors catégorie. Aucun paramètre de filtre ni de tri n’est pris en charge.

[
  {
    "id": 5678,
    "package_category_id": 91,
    "name": 5678,
    "image_url": "https://activitymessenger.com/storage/example/package.jpg",
    "image_url2": null,
    "image_ur3": null,
    "short_description": "Terrain privé, une heure",
    "description": "<p>Réservez un terrain privé pour une heure.</p>",
    "order": 1,
    "visible": true,
    "disabled": false,
    "price": "40.00",
    "tax_info": {
      "display": 40,
      "after_tax": 45.99,
      "before_tax": 40,
      "inclusive_tax": 0,
      "exclusive_tax": 5.99,
      "tax": 5.99,
      "taxes": [2, 3.99],
      "names": ["TPS 5%", "TVQ 9.975%"],
      "inclusive_names": [],
      "exclusive_names": ["TPS 5%", "TVQ 9.975%"]
    },
    "microsite_url": "https://activitymessenger.com/org/1234/package/5678",
    "iframe_url": "https://activitymessenger.com/iframe//org/1234/package/5678"
  }
]

GET /api/v1/organization/{organization}/package_categories/{package_category}/packages

Récupère tous les forfaits de la catégorie, triés par order puis de la plus récente à la plus ancienne. Remplacez {package_category} par un id de catégorie renvoyé par GET package_categories. Chaque élément est un objet forfait tel que décrit ci-dessus.