FireFlo OMNI

Cancels an order. Nothing is sent to the customer, and a cancelled order can’t be fulfilled. Webhooks get order.canceled. Asking again for the status it already has changes nothing and sends nothing.

Needs the catalogue.orders:write scope.

Path parameters

Field	Type	Required	Notes
`order_id`	string	Yes	The order’s id.

Request

curl -X POST "https://api.fireflo.au/v1/catalogue/orders/9d4e2b7a-1c3f-4a8e-b6d5-0f2e7c9a1b34/cancel" \
  -H "Authorization: Bearer $OMNI_API_KEY"

import os

import requests

response = requests.post(
    "https://api.fireflo.au/v1/catalogue/orders/9d4e2b7a-1c3f-4a8e-b6d5-0f2e7c9a1b34/cancel",
    headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
)
print(response.status_code, response.json())

const response = await fetch("https://api.fireflo.au/v1/catalogue/orders/9d4e2b7a-1c3f-4a8e-b6d5-0f2e7c9a1b34/cancel", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.OMNI_API_KEY}` },
});
console.log(response.status, await response.json());

Response

200 OK — the order, now cancelled. status is new, confirmed, declined, fulfilled or cancelled. source is where it came from: cart (a WhatsApp cart), agent (an AI agent’s draft, approved by a person), person (made by hand in the panel) or api. channel is the channel it came in on, where replies about it go. Each line keeps its own copy of the name and price, so a later change to the product doesn’t rewrite it; product is the product’s id, or null for a SKU the catalogue doesn’t have. Money is in minor units.

{
  "id": "9d4e2b7a-1c3f-4a8e-b6d5-0f2e7c9a1b34",
  "number": 1043,
  "status": "cancelled",
  "source": "api",
  "channel": "whatsapp",
  "contact": {
    "id": "5b2f9e1c-8a3d-4c7e-9f61-2d4b7a0e3c85",
    "name": "Asha Menon",
    "phone": "+919876500102"
  },
  "items": [
    {
      "product": "3f8a2c1e-7b4d-4e6a-9c2f-1a5b8d7e6f40",
      "sku": "KUR-COT-IND-M",
      "name": "Cotton kurta — indigo, M",
      "quantity": 2,
      "unit_price_minor": 199900
    },
    {
      "product": "a71c5e93-2d8b-4f16-8e0a-6b9d3c2f1e57",
      "sku": "DUP-PHUL-RED",
      "name": "Phulkari dupatta — red",
      "quantity": 1,
      "unit_price_minor": 179900
    }
  ],
  "total_minor": 579700,
  "currency": "INR",
  "note": "Gift wrap, please.",
  "created_at": "2026-10-06T11:08:37+05:30",
  "updated_at": "2026-10-06T11:15:02+05:30"
}

Errors

Every refusal is {"error": {"code", "message", "field"}}; field is there when one input is at fault.

Status	Error code	When
404	`not_found`	No order of this account’s has that id.
404	`module_off`	The account doesn’t have Catalogue on.
403	`scope_missing`	The key doesn’t have the `catalogue.orders:write` scope.

Any request can also be refused for its key, its account or its rate (key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.

Overview

Account

Messages

Broadcasts

Routes

Templates

Contacts

Conversations

Senders

Calls

Usage

Reports

Webhooks

WhatsApp

SMS

Pipelines

Tickets

Calendar

Catalogue

Customer data

AI agents

Try it

POST /v1/catalogue/orders/{order_id}/cancel

Path parameters

Request

Response

Errors

​Path parameters

​Request

​Response

​Errors

Path parameters

Request

Response

Errors