Quick start

1. Get your credentials

You do not need a business account to start developing: apply for a test account; once approved you receive ck_test_ keys for one restaurant and one Çarşı business.

Live credentials are created by the business: the Integration details card on the Integration page of the partner console lists the Seller ID (the merchantId in the API), the Integration reference code, a ck_live_ API Key, the API Secret and a Token. The business enters these into your point-of-sale software. The API Secret and the Token are shown only when created; if lost they are rotated, never recovered.

2. Base URL

https://api.supergelsin.com/api/partner/v1

https://sandbox.supergelsin.com/api/partner/v1

Both environments serve the same surface; only the data, the key prefix and the external services differ. A key sent to the wrong environment receives 401 environment_mismatch. There are no path prefixes: restaurants and Çarşı businesses use the same endpoints, and the key determines the business and the vertical.

3. Your first request

Every request requires Basic authentication and the X-Integrator header; X-Operator is optional (see Authorization). The first call, and the regular monitoring call, is GET /merchant.

curl "https://api.supergelsin.com/api/partner/v1/merchant" \
  -H "Authorization: Basic $(printf '%s:%s' "$API_KEY" "$API_SECRET" | base64)" \
  -H "X-Integrator: Ornek POS" \
  -H "X-Operator: kasiyer_01"

{
  "merchantId": "cm_ornek_isletme",
  "vertical": "restaurant",
  "name": "Örnek Restoran",
  "status": "open",
  "acceptingOrders": true,
  "busy": null,
  "autoPaused": null,
  "workingHours": null,
  "integrator": "Ornek POS",
  "serverTime": "2026-01-31T10:00:00.000Z"
}

The vertical in the response is restaurant or store (a Çarşı business). Every response carries an X-Request-Id; include it in support requests. See the Business page for details.

4. Create a test order

To complete an integration you need to exercise three things: receiving a webhook, reading an order and writing a status. You can create a test order with your own credentials without waiting for a real customer. The endpoint does not read a body.

curl -X POST "https://api.supergelsin.com/api/partner/v1/orders/test" \
  -H "Authorization: Basic $(printf '%s:%s' "$API_KEY" "$API_SECRET" | base64)" \
  -H "X-Integrator: Ornek POS" \
  -H "X-Operator: kasiyer_01"

The response is 201 with the same body as GET /orders/{id}, with isTest set to true. The order picks lines from the business's own menu (restaurant) or from its products on sale (Çarşı). If your webhook address is registered, the order.created event is delivered with a real signature and the order appears in GET /orders.