Scope Wiser

Scope Wiser API: Catalogue and Team

The remaining endpoints: reading and syncing a WhatsApp catalogue, listing and updating catalogue orders and changing their status, and reading team members and roles.

Last updated Sep 5, 2026

The endpoints that are not about messaging. Read Scope Wiser API: Overview and Authentication first for the base URL and the apiToken parameter.

Catalogue

These read and update the WhatsApp catalogue described in Connecting Your WhatsApp Catalog. Commerce is WhatsApp-only, so none of this applies to other channels.

List cataloguesGET/POST/whatsapp/catalog/list

Returns each catalogue's catalog_id, catalog_name, catalog_url and checkout_settings, which holds the tax percentage and shipping charge as JSON.

Sync a cataloguePOST/whatsapp/catalog/sync with whatsapp_catalog_id

Pulls the current products from Meta. Call it after changing products in Commerce Manager rather than waiting for the next automatic sync.

List ordersGET/POST/whatsapp/catalog/order/list, optionally filtered by whatsapp_catalog_id

Each order carries order_unique_id, chat_id, the buyer's name, cart_total and cart_currency, cart_status_raw, payment_method, a shipping_address JSON blob, transaction_id and the timestamps for ordering, payment and status changes.

This is the endpoint that gets catalogue orders into an accounting or fulfilment system. Poll it on a schedule and key on order_unique_id.

Change an order's statusGET/POST/whatsapp/catalog/order/status-change

Parameter

Notes

order_unique_id

Required — from the order list

cart_status

Required — Approved, Completed, Shipped, Delivered or Refunded

Those five values are the whole set; anything else is rejected. Driving this from your warehouse system keeps the customer's view honest without anyone updating it by hand.

Payments themselves are not in this API. Where money is taken, and how cash on delivery is confirmed, is covered in Cash on Delivery & Online Payments in Chat.

Team

Team membersGET/POST/users/team-member/list

Returns each member's id, name, email, role_id, role and status. The id is what assign-to-team-member wants, so call this first when routing chats from your own system.

Roles and packagesGET/POST/user/package/list

Returns package_name, package_type, price, validity, module_ids, monthly_limit and visible. Team roles come back as package_type: "team".

What is not in the API

Worth knowing before you plan around it:

  • No broadcast endpoint. Campaigns are created in the Broadcast Center. To reach many people from your own system, either trigger a bot flow per contact or assign them to a sequence.

  • No flow editing. You can list flows and trigger them, but they are built in the Flow Builder.

  • No template creation. Templates are created in Scope Wiser and approved by Meta. You can list them and send them.

  • No payment endpoints. Gateways are configured against a catalogue in the interface.

A note on the whole API

Every endpoint takes the key as a parameter and returns status as a string. There is no versioning beyond /v1/ in the path, and no webhook subscription API — inbound events are configured in the interface under Bot Settings → Webhook and Automation → Webhook Workflows. Build a thin wrapper in your own code that adds apiToken, checks status === "1", and logs anything else. It will save you repeating the same three lines everywhere.

Was this helpful?
Edit this page