Dispatch order to external POS | Cata API

curl -X POST http://localhost:8080/api/v1/orders/dispatch \
     -H "X-Tenant-ID: string" \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "outletId": "store-uuid-123",
  "event": "order.paid",
  "order": {
    "uuid": "ord-550e8400-e29b-41d4-a716-446655440000",
    "orderRefNo": "ORD-2024-001",
    "dailyQueueNo": "A12",
    "storeUuid": "store-uuid-123",
    "storeName": "Downtown Branch",
    "deliveryMethod": "DELIVERY",
    "status": "PAID",
    "currency": "AED",
    "isPreorder": false,
    "items": [
      {
        "plu": "SKU-BURGER-01",
        "name": "Classic Burger",
        "quantity": 2,
        "itemOnlyPrice": 35,
        "modifierOnlyPrice": 5,
        "itemPrice": 40,
        "itemSubTotal": 80,
        "modifiers": [
          {
            "modifierHeaderId": "mh-cheese",
            "modifierOptionId": "mo-extra-cheese",
            "modifierHeaderName": "Cheese",
            "modifierOptionName": "Extra Cheese",
            "price": 5,
            "quantity": 1
          }
        ]
      }
    ],
    "subtotal": 80,
    "discountTotal": 0,
    "serviceCharge": 0,
    "deliveryFee": 5,
    "totalPay": 85,
    "payment": {
      "amount": 85,
      "tip": 5,
      "method": "CARD"
    },
    "createdAt": "2024-12-01T14:30:00Z"
  }
}'

{
  "code": 200,
  "isSuccess": true,
  "message": "string",
  "orderId": "string",
  "dispatched": false,
  "reason": "string"
}

Dispatches an order event to an external POS system through the connector layer. Called by kds-management-service (internal service-to-service).

The order payload is validated for required fields, then dispatched as-is (original bytes preserved for HMAC signature integrity).

The connector is resolved based on the store’s registered webhook/provider. If no active webhook exists, the order is persisted but not dispatched.

Dispatches an order event to an external POS system through the connector layer. Called by kds-management-service (internal service-to-service). The order payload is validated for required fields, then dispatched as-is (original bytes preserved for HMAC signature integrity). The connector is resolved based on the store's registered webhook/provider. If no active webhook exists, the order is persisted but not dispatched.

Authentication

X-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

outletIdstringRequired

eventstringRequired

orderobjectRequired

Response

codeinteger

reasonstring

messagestring

orderIdstring

isSuccessboolean

dispatchedboolean

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

Authentication

Headers

Request

Response

Errors