Activity Messenger Help Center

Products

See API introduction for authentication, request conventions, pagination, rate limits, and errors.

These endpoints return JSON arrays; they do not support page or per_page.

Send the X-Activity-Messenger-Api-Key header on every request. Products are managed under E-Commerce → Products. Archived (deleted) products are never returned; hidden and disabled ones are. Product variants are not included in the response.

A product object contains these fields:

• id: numeric product ID; the stable key.
• tags: array of tag names (strings) assigned to the product; empty when the product has no tag.
• name: in the current release this field returns the numeric product ID rather than the product name.
• image_url, image_url2, image_ur3: image URLs, or null. The third key is spelled image_ur3.
• short_description, description: product texts, or null. description can contain HTML.
• order: integer display order.
• visible: boolean; false when the product is hidden from the public store.
• disabled: boolean; true when the product cannot be purchased.
• price: decimal string with two decimals, for example "25.00".
• tax_info: null when the price is zero. Otherwise an object with display, after_tax, before_tax, inclusive_tax, exclusive_tax, tax (numbers), taxes (one amount per tax), names, inclusive_names, and exclusive_names (tax names).
• microsite_url: public store URL, anchored on the product card.
• iframe_url: URL of the same page in the embeddable iframe layout.

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

Retrieve all products sold by the organization, including hidden ones to the public. You may filter by passing a list of tags[] in the query string (optional). Any product matching the passed tags will be returned.

• tags[]: optional tag names, exact match and case sensitive. Several values use an OR operator: a product is returned when it has at least one of the tags. A single tags= value is also accepted. Empty values are ignored; without any tag, every product is returned.

[
  {
    "id": 8765,
    "tags": ["Merchandise", "Summer"],
    "name": 8765,
    "image_url": "https://activitymessenger.com/storage/example/shirt.jpg",
    "image_url2": null,
    "image_ur3": null,
    "short_description": "Club T-shirt",
    "description": "<p>Cotton T-shirt with the club logo.</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": ["GST 5%", "QST 9.975%"],
      "inclusive_names": [],
      "exclusive_names": ["GST 5%", "QST 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

Retrieve all tags defined and used on products. The response is an array of tag names (strings) ordered alphabetically by slug, for example ["Merchandise", "Summer"]. Tags that are not assigned to any product are not returned.