[Not Implemented] Receive order status update | Cata API

curl -X PATCH http://localhost:8080/api/v1/orders/string \
     -H "X-Tenant-ID: string" \
     -H "X-Store-ID: string" \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "posType": "LIGHTSPEED",
  "status": "PENDING",
  "reason": "string"
}'

{
  "success": true,
  "orderId": "string",
  "externalOrderId": "string",
  "status": "CANCELLED",
  "order": {
    "id": "string",
    "storeId": "string",
    "items": [
      {
        "id": "string",
        "name": "string",
        "quantity": 4865,
        "unitPrice": {
          "amount": 1299,
          "currency": "USD"
        },
        "externalId": "string",
        "description": "string",
        "totalPrice": {
          "amount": 1299,
          "currency": "USD"
        },
        "modifiers": [
          {
            "id": "string",
            "name": "string",
            "price": {
              "amount": 1299,
              "currency": "USD"
            },
            "quantity": 1,
            "externalId": "string",
            "metadata": {
              "key_0": 7881,
              "key_1": "string"
            }
          },
          {
            "id": "string",
            "name": "string",
            "price": {
              "amount": 1299,
              "currency": "USD"
            },
            "quantity": 1,
            "externalId": "string",
            "metadata": {
              "key_0": 1,
              "key_1": "true"
            }
          }
        ],
        "specialInstructions": "string",
        "metadata": {
          "key_0": 2916,
          "key_1": "string"
        }
      },
      {
        "id": "string",
        "name": "string",
        "quantity": 9735,
        "unitPrice": {
          "amount": 1299,
          "currency": "USD"
        },
        "externalId": "string",
        "description": "string",
        "totalPrice": {
          "amount": 1299,
          "currency": "USD"
        },
        "modifiers": [
          {
            "id": "string",
            "name": "string",
            "price": {
              "amount": 1299,
              "currency": "USD"
            },
            "quantity": 1,
            "externalId": "string",
            "metadata": {
              "key_0": 1,
              "key_1": "string"
            }
          },
          {
            "id": "string",
            "name": "string",
            "price": {
              "amount": 1299,
              "currency": "USD"
            },
            "quantity": 1,
            "externalId": "string",
            "metadata": {
              "key_0": 1,
              "key_1": "8706",
              "key_2": 5224
            }
          }
        ],
        "specialInstructions": "string",
        "metadata": {
          "key_0": 1,
          "key_1": "false"
        }
      }
    ],
    "totalAmount": {
      "amount": 1299,
      "currency": "USD"
    },
    "status": "CANCELLED",
    "externalId": "string",
    "channelOrderId": "string",
    "channelName": "string",
    "customer": {
      "id": "string",
      "name": "string",
      "email": "sPjzvm@RZGkpbDCN.py",
      "phone": "string",
      "address": {
        "street": "123 Main St",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001",
        "country": "US",
        "latitude": 1802.77392886677,
        "longitude": 6337.39476826978
      }
    },
    "subtotal": {
      "amount": 1299,
      "currency": "USD"
    },
    "tax": {
      "amount": 1299,
      "currency": "USD"
    },
    "tip": {
      "amount": 1299,
      "currency": "USD"
    },
    "deliveryFee": {
      "amount": 1299,
      "currency": "USD"
    },
    "orderType": "PREORDER",
    "scheduledFor": "1983-07-18T08:06:48.387Z",
    "estimatedDeliveryTime": "2001-12-13T09:01:35.800Z",
    "pickupTime": "1986-12-28T02:39:45.808Z",
    "deliveryAddress": {
      "street": "123 Main St",
      "city": "New York",
      "state": "NY",
      "postalCode": "10001",
      "country": "US",
      "latitude": 5397.451648579874,
      "longitude": 3976.600440793725
    },
    "notes": "string",
    "metadata": {
      "key_0": 175.40467930517335,
      "key_1": 1445
    },
    "createdAt": "1968-09-13T08:10:41.369Z",
    "updatedAt": "1974-11-06T11:04:18.505Z"
  },
  "message": "string"
}

Status: Not Implemented

Receives an order status update from the third-party POS system. Cata does not push status changes to the POS — status changes originate from the POS and are forwarded to Cata.

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

orderIdstringRequired

Order identifier

Request

This endpoint expects an object.

posTypestringRequired

statusstringRequired

reasonstringRequired

Response

successboolean

orderIdstring

externalOrderIdstring

statusstring

orderobject

messagestring

Errors

400

Bad Request Error

404

Not Found Error

Authentication

Path parameters

Headers

Request

Response

Errors