Send catalog - Omni Z-API

In development. This endpoint does not exist yet. The page is published so you can get to know the shape and plan the integration — the body below is what will apply when it ships.

Overview

Sends a message that opens the catalog connected to your account in Commerce Manager. The content.type field will be CATALOG.

Request body

{
  "recipient": { "identifier": "5511999999999" },
  "content": {
    "type": "CATALOG",
    "message": "New arrivals in the store. Tap to see the full catalog.",
    "footer": "Prices valid while stock lasts",
    "thumbnailProductRetailerId": "SKU-1042"
  }
}

Rules

Rule	Value
Message	required, up to 1024 characters
Footer	optional, up to 60 characters
Cover product	optional; without it Meta uses the first item in the account
Catalog	must be connected in Commerce Manager