List outlets from the POS system

View as MarkdownOpen in Claude
Fetches the list of locations/outlets available in the external POS system. Requires an active adapter script for the `list_remote_outlets` topic. Use this to populate a dropdown when mapping Cata outlets to POS locations. Each item contains the POS location ID (use as `externalId` when mapping) and a human-readable name. **Requires:** A working provider connection with valid credentials.

Authentication

X-Api-Keystring
API Key authentication via header

Path parameters

slugstringRequired

Provider slug (e.g. “revel”)

Response

OK
codeinteger
totalinteger
messagestring
isSuccessboolean
remoteOutletslist of objects

Errors

400
Bad Request Error
404
Not Found Error