Sync outlet (upsert) | Cata API

curl -X POST http://localhost:8080/api/v1/outlets/sync \
     -H "X-Tenant-ID: string" \
     -H "X-Provider: cata" \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "externalId": "store-001",
  "name": "Golden Dragon Restaurant",
  "channelLinkId": "ch-link-001",
  "address": {
    "street1": "123 Main St",
    "city": "Singapore",
    "postalCode": "123456",
    "country": "SG"
  },
  "contact": {
    "phone": "+65 1234 5678",
    "email": "info@goldendragon.sg"
  },
  "timezone": "Asia/Singapore"
}'

{
  "action": "updated",
  "outlet": {
    "id": "string",
    "name": "string",
    "status": "OPEN",
    "externalId": "string",
    "internalName": "string",
    "slug": "string",
    "refCode": "string",
    "imageUrl": "http://U.hgoWhdDcGWq1PbsSSHK0l.zahFrRfRQoLLnp.vJ4V7GTyduVtHIOBxJEZJr5SGOgug",
    "address": {
      "street1": "string",
      "street2": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string",
      "latitude": 9386.592621819496,
      "longitude": 6777.48917241567
    },
    "contact": {
      "email": "68u4Vh6vbxA5hY@iLkLDHEylxwlGHrlVMqoUQi.ddkl",
      "phone": "string",
      "website": "string",
      "contactName": "string"
    },
    "isOpen": false,
    "isBusy": true,
    "visible": false,
    "timezone": "Asia/Singapore",
    "openingHours": [
      {
        "dayOfWeek": 5,
        "openTime": "09:00",
        "closeTime": "22:00",
        "isClosed": false
      },
      {
        "dayOfWeek": 5,
        "openTime": "09:00",
        "closeTime": "22:00",
        "isClosed": false
      }
    ],
    "capabilities": {
      "acceptsDelivery": false,
      "acceptsPickup": false,
      "acceptsDineIn": true
    },
    "locationId": "string",
    "channelLinkId": "string",
    "showStartDatetime": "2010-08-02T07:18:13.911Z",
    "createdAt": "1947-07-16T23:11:07.924Z",
    "updatedAt": "1977-05-01T06:05:33.515Z"
  }
}

Upsert an outlet by externalId. If an outlet with the given external ID exists, it is updated; otherwise a new outlet is created. Provider is validated via X-Provider header against tenant settings.

Idempotent: calling with the same payload again produces the same result.

Authentication

X-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

externalIdstringRequired

namestringRequired

channelLinkIdstringRequired

addressobjectRequired

contactobjectRequired

timezonestringRequired

Response

actionstring

outletobject

Errors

400

Bad Request Error

403

Forbidden Error

Authentication

Headers

Request

Response

Errors