Create outlet | Cata API

curl -X POST http://localhost:8080/api/v1/outlets \
     -H "X-Tenant-ID: string" \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "externalId": "string",
  "internalName": "string",
  "address": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "stateProvince": "string",
    "postalCode": "string",
    "country": "string"
  },
  "contact": {
    "phone": "string",
    "email": "string"
  },
  "timezone": "string",
  "channelLinkId": "string",
  "locationId": "string",
  "visible": true
}'

{
  "id": "string",
  "name": "string",
  "status": "CLOSED",
  "externalId": "string",
  "internalName": "string",
  "slug": "string",
  "refCode": "string",
  "imageUrl": "https://sbR.ntwpetYeGpnbq41iCmo-FShZS7RRJacIbi46sXV4RIb+W.hFPnt",
  "address": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "latitude": 1202.932592069832,
    "longitude": 8635.968572417305
  },
  "contact": {
    "email": "3xIQIYxC20@nNonGJqhligMuUJ.lr",
    "phone": "string",
    "website": "string",
    "contactName": "string"
  },
  "isOpen": false,
  "isBusy": false,
  "visible": true,
  "timezone": "Asia/Singapore",
  "openingHours": [
    {
      "dayOfWeek": 0,
      "openTime": "09:00",
      "closeTime": "22:00",
      "isClosed": true
    },
    {
      "dayOfWeek": 4,
      "openTime": "09:00",
      "closeTime": "22:00",
      "isClosed": false
    }
  ],
  "capabilities": {
    "acceptsDelivery": true,
    "acceptsPickup": false,
    "acceptsDineIn": true
  },
  "locationId": "string",
  "channelLinkId": "string",
  "showStartDatetime": "1968-12-31T23:20:16.685Z",
  "createdAt": "2013-01-01T15:01:41.368Z",
  "updatedAt": "1989-06-26T01:58:45.828Z"
}

Create a new outlet in Cata. POS adapters normalize their payload into this standard format before calling this endpoint.

Authentication

X-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

namestringRequired

externalIdstringRequired

internalNamestringRequired

addressobjectRequired

contactobjectRequired

timezonestringRequired

channelLinkIdstringRequired

locationIdstringRequired

visiblebooleanRequired

Response

Created

idstring

namestring

statusstring

externalIdstring

internalNamestring

slugstring

refCodestring

imageUrlstringformat: "uri"

addressobject

contactobject

isOpenboolean

isBusyboolean

visibleboolean

timezonestring

openingHourslist of objects

capabilitiesobject

locationIdstring

channelLinkIdstring

showStartDatetimedatetime

createdAtdatetime

updatedAtdatetime

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

Authentication

Headers

Request

Response

Errors