Map outlet to a provider | Cata API

Maps an outlet to a POS provider (upsert). The provider must already have a connection configured via the Provider Connections endpoints. One provider per outlet — re-mapping replaces the existing mapping.

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

outletIdstringRequired

Outlet UUID

Request

This endpoint expects an object.

providerSlugstringRequired

externalIdstringRequired

settingsstringRequired

Response

codeinteger

isSuccessboolean

messagestring

outletProviderobject

Errors

400

Bad Request Error

404

Not Found Error

1	curl -X PUT http://localhost:8080/api/v1/outlet-providers/cacb674d-8a81-fcbd-05eb-9209400d35dd \
2	-H "X-Api-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"providerSlug": "revel",
6	"externalId": "string",
7	"settings": "string"
8	}'

1	{
2	"code": 169,
3	"isSuccess": true,
4	"message": "string",
5	"outletProvider": {
6	"outletId": "2487c692-7b35-f3d5-c4e1-9cbfc8c7af3a",
7	"outletName": "string",
8	"providerSlug": "revel",
9	"externalId": "string",
10	"settings": "string",
11	"createdAt": "2014-04-21T07:42:24.759Z",
12	"updatedAt": "1991-08-22T04:20:54.797Z"
13	}
14	}