API reference
Base URL https://api.example.com (yours is given with your credentials). Authenticate with X-Api-Key or a bearer token; operator writes are also signed. Read Authentication first, and Errors and limits for conventions.
OpenAPI 3.1 (JSON) Postman collection
Admin
GET/v1/admin/domains
Parameters
| Name | In | Type | |
|---|---|---|---|
status | query | integer |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/admin/domains" \
-H "X-Api-Key: $API_KEY"Auth
POST/v1/auth/forgot-password
Request body
| Field | Type | Notes |
|---|---|---|
email required | string |
json
{
"email": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/auth/forgot-password" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"email":"string"}'POST/v1/auth/reset-password
Request body
| Field | Type | Notes |
|---|---|---|
token required | string | |
password required | string |
json
{
"token": "string",
"password": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/auth/reset-password" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"token":"string","password":"string"}'POST/v1/auth/login
Request body
| Field | Type | Notes |
|---|---|---|
email required | string | |
password required | string |
json
{
"email": "string",
"password": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/auth/login" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"email":"string","password":"string"}'POST/v1/auth/refresh
Request body
| Field | Type | Notes |
|---|---|---|
refreshToken required | string |
json
{
"refreshToken": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/auth/refresh" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"refreshToken":"string"}'EmailAdmin
GET/v1/admin/email
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/admin/email" \
-H "X-Api-Key: $API_KEY"POST/v1/admin/email/test
Request body
| Field | Type | Notes |
|---|---|---|
to required | string |
json
{
"to": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/admin/email/test" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"to":"string"}'Images
GET/v1/images/{imageId}
Parameters
| Name | In | Type | |
|---|---|---|---|
imageId | path | string (uuid) | required |
w | query | integer | string (int32) | |
h | query | integer | string (int32) | |
fit | query | string | |
fmt | query | string |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/images/$imageId" \
-H "X-Api-Key: $API_KEY"Imports
POST/v1/imports
Parameters
| Name | In | Type | |
|---|---|---|---|
kind | query | integer | |
fileName | query | string |
Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/imports" \
-H "X-Api-Key: $API_KEY"GET/v1/imports
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/imports" \
-H "X-Api-Key: $API_KEY"GET/v1/imports/{id}
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/imports/$id" \
-H "X-Api-Key: $API_KEY"Me
GET/v1/me
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/me" \
-H "X-Api-Key: $API_KEY"MerchantCatalog
GET/v1/merchants/{merchantId}/categories
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/categories" \
-H "X-Api-Key: $API_KEY"POST/v1/merchants/{merchantId}/categories
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
name required | string |
json
{
"name": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/categories" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string"}'PUT/v1/merchants/{merchantId}/categories/order
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
ids required | array |
json
{
"ids": [
"00000000-0000-0000-0000-000000000000"
]
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/categories/order" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"ids":["00000000-0000-0000-0000-000000000000"]}'PUT/v1/merchants/{merchantId}/categories/{id}
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
id | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
name required | string | |
isActive required | boolean | |
color required | string |
json
{
"name": "string",
"isActive": false,
"color": "string"
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/categories/$id" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string","isActive":false,"color":"string"}'POST/v1/merchants/{merchantId}/products/{id}/image
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
id | path | string (uuid) | required |
Request body
Multipart form data. See the guide for the fields.
Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/products/$id/image" \
-H "X-Api-Key: $API_KEY"DELETE/v1/merchants/{merchantId}/products/{id}/image
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
id | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X DELETE "$BASE/v1/merchants/$merchantId/products/$id/image" \
-H "X-Api-Key: $API_KEY"POST/v1/merchants/{merchantId}/branches
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
name required | string | |
code required | string |
json
{
"name": "string",
"code": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/branches" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string","code":"string"}'GET/v1/merchants/{merchantId}/branches
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/branches" \
-H "X-Api-Key: $API_KEY"PUT/v1/merchants/{merchantId}/branches/{branchId}
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
branchId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
name required | string | |
code required | string | |
isActive required | boolean |
json
{
"name": "string",
"code": "string",
"isActive": false
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/branches/$branchId" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string","code":"string","isActive":false}'GET/v1/merchants/{merchantId}/products
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
q | query | string | |
categoryId | query | string (uuid) | |
includeInactive | query | boolean | |
page | query | integer | string (int32) | |
pageSize | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/products" \
-H "X-Api-Key: $API_KEY"POST/v1/merchants/{merchantId}/products
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
name required | string | |
description required | string | |
categoryId required | string (uuid) | |
unit required | string | |
taxClass required | any | |
trackStock required | boolean | |
variants required | array |
json
{
"name": "string",
"description": "string",
"categoryId": "00000000-0000-0000-0000-000000000000",
"unit": "string",
"taxClass": 0,
"trackStock": false,
"variants": [
{
"sku": "string",
"name": "string",
"barcode": "string",
"priceKobo": 0,
"costKobo": 0
}
]
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/products" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string","description":"string","categoryId":"00000000-0000-0000-0000-000000000000","unit":"string","taxClass":0,"trackStock":false,"variants":[{"sku":"string","name":"string","barcode":"string","priceKobo":0,"costKobo":0}]}'GET/v1/merchants/{merchantId}/products/{id}
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
id | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/products/$id" \
-H "X-Api-Key: $API_KEY"PUT/v1/merchants/{merchantId}/products/{id}
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
id | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
name required | string | |
description required | string | |
categoryId required | string (uuid) | |
unit required | string | |
taxClass required | any | |
trackStock required | boolean | |
isActive required | boolean | |
isFavourite required | boolean |
json
{
"name": "string",
"description": "string",
"categoryId": "00000000-0000-0000-0000-000000000000",
"unit": "string",
"taxClass": 0,
"trackStock": false,
"isActive": false,
"isFavourite": false
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/products/$id" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string","description":"string","categoryId":"00000000-0000-0000-0000-000000000000","unit":"string","taxClass":0,"trackStock":false,"isActive":false,"isFavourite":false}'POST/v1/merchants/{merchantId}/products/import
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
csv required | string | |
dryRun required | boolean |
json
{
"csv": "string",
"dryRun": false
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/products/import" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"csv":"string","dryRun":false}'PUT/v1/merchants/{merchantId}/products/order
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
ids required | array |
json
{
"ids": [
"00000000-0000-0000-0000-000000000000"
]
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/products/order" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"ids":["00000000-0000-0000-0000-000000000000"]}'POST/v1/merchants/{merchantId}/products/{id}/variants
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
id | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
sku required | string | |
name required | string | |
barcode required | string | |
priceKobo required | integer | string (int64) | |
costKobo | integer | string (int64) |
json
{
"sku": "string",
"name": "string",
"barcode": "string",
"priceKobo": 0,
"costKobo": 0
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/products/$id/variants" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"sku":"string","name":"string","barcode":"string","priceKobo":0,"costKobo":0}'PUT/v1/merchants/{merchantId}/variants/{variantId}
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
variantId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
name required | string | |
barcode required | string | |
priceKobo required | integer | string (int64) | |
costKobo required | integer | string (int64) | |
isActive required | boolean |
json
{
"name": "string",
"barcode": "string",
"priceKobo": 0,
"costKobo": 0,
"isActive": false
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/variants/$variantId" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string","barcode":"string","priceKobo":0,"costKobo":0,"isActive":false}'PUT/v1/merchants/{merchantId}/variants/{variantId}/prices/{branchId}
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
variantId | path | string (uuid) | required |
branchId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
priceKobo required | integer | string (int64) |
json
{
"priceKobo": 0
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/variants/$variantId/prices/$branchId" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"priceKobo":0}'DELETE/v1/merchants/{merchantId}/variants/{variantId}/prices/{branchId}
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
variantId | path | string (uuid) | required |
branchId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X DELETE "$BASE/v1/merchants/$merchantId/variants/$variantId/prices/$branchId" \
-H "X-Api-Key: $API_KEY"GET/v1/merchants/{merchantId}/catalog
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
branchId | query | string (uuid) | |
cursor | query | string | |
updatedSince | query | string (date-time) | |
limit | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/catalog" \
-H "X-Api-Key: $API_KEY"GET/v1/merchants/{merchantId}/lookup
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
barcode | query | string | |
branchId | query | string (uuid) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/lookup" \
-H "X-Api-Key: $API_KEY"MerchantInventory
POST/v1/merchants/{merchantId}/inventory/adjustments
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
branchId required | string (uuid) | |
variantId required | string (uuid) | |
quantityDelta required | number | string (double) | |
note required | string | |
unitCostKobo required | integer | string (int64) |
json
{
"branchId": "00000000-0000-0000-0000-000000000000",
"variantId": "00000000-0000-0000-0000-000000000000",
"quantityDelta": 0,
"note": "string",
"unitCostKobo": 0
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/adjustments" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"branchId":"00000000-0000-0000-0000-000000000000","variantId":"00000000-0000-0000-0000-000000000000","quantityDelta":0,"note":"string","unitCostKobo":0}'POST/v1/merchants/{merchantId}/inventory/receipts
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
branchId required | string (uuid) | |
reference required | string | |
supplierName required | string | |
note required | string | |
lines required | array |
json
{
"branchId": "00000000-0000-0000-0000-000000000000",
"reference": "string",
"supplierName": "string",
"note": "string",
"lines": [
{
"variantId": "00000000-0000-0000-0000-000000000000",
"quantity": 0,
"unitCostKobo": 0
}
]
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/receipts" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"branchId":"00000000-0000-0000-0000-000000000000","reference":"string","supplierName":"string","note":"string","lines":[{"variantId":"00000000-0000-0000-0000-000000000000","quantity":0,"unitCostKobo":0}]}'PUT/v1/merchants/{merchantId}/inventory/reorder-levels
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
branchId required | string (uuid) | |
variantId required | string (uuid) | |
reorderLevel required | number | string (double) |
json
{
"branchId": "00000000-0000-0000-0000-000000000000",
"variantId": "00000000-0000-0000-0000-000000000000",
"reorderLevel": 0
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/inventory/reorder-levels" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"branchId":"00000000-0000-0000-0000-000000000000","variantId":"00000000-0000-0000-0000-000000000000","reorderLevel":0}'GET/v1/merchants/{merchantId}/inventory/levels
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
branchId | query | string (uuid) | |
variantId | query | string (uuid) | |
lowOnly | query | boolean | |
q | query | string | |
page | query | integer | string (int32) | |
pageSize | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/inventory/levels" \
-H "X-Api-Key: $API_KEY"GET/v1/merchants/{merchantId}/inventory/movements
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
branchId | query | string (uuid) | |
variantId | query | string (uuid) | |
reason | query | integer | |
from | query | string (date-time) | |
to | query | string (date-time) | |
page | query | integer | string (int32) | |
pageSize | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/inventory/movements" \
-H "X-Api-Key: $API_KEY"GET/v1/merchants/{merchantId}/inventory/valuation
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
branchId | query | string (uuid) | |
detail | query | boolean |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/inventory/valuation" \
-H "X-Api-Key: $API_KEY"POST/v1/merchants/{merchantId}/inventory/transfers
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
fromBranchId required | string (uuid) | |
toBranchId required | string (uuid) | |
reference required | string | |
note required | string | |
lines required | array |
json
{
"fromBranchId": "00000000-0000-0000-0000-000000000000",
"toBranchId": "00000000-0000-0000-0000-000000000000",
"reference": "string",
"note": "string",
"lines": [
{
"variantId": "00000000-0000-0000-0000-000000000000",
"quantity": 0
}
]
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/transfers" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"fromBranchId":"00000000-0000-0000-0000-000000000000","toBranchId":"00000000-0000-0000-0000-000000000000","reference":"string","note":"string","lines":[{"variantId":"00000000-0000-0000-0000-000000000000","quantity":0}]}'GET/v1/merchants/{merchantId}/inventory/transfers
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
status | query | integer | |
page | query | integer | string (int32) | |
pageSize | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/inventory/transfers" \
-H "X-Api-Key: $API_KEY"GET/v1/merchants/{merchantId}/inventory/transfers/{id}
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
id | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/inventory/transfers/$id" \
-H "X-Api-Key: $API_KEY"POST/v1/merchants/{merchantId}/inventory/transfers/{id}/receive
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
id | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|
json
{
"lines": [
{
"variantId": null,
"quantityReceived": null
}
]
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/transfers/$id/receive" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"lines":[{"variantId":null,"quantityReceived":null}]}'POST/v1/merchants/{merchantId}/inventory/transfers/{id}/cancel
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
id | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/transfers/$id/cancel" \
-H "X-Api-Key: $API_KEY"POST/v1/merchants/{merchantId}/inventory/counts
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
branchId required | string (uuid) | |
name required | string | |
variantIds required | array |
json
{
"branchId": "00000000-0000-0000-0000-000000000000",
"name": "string",
"variantIds": [
"00000000-0000-0000-0000-000000000000"
]
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/counts" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"branchId":"00000000-0000-0000-0000-000000000000","name":"string","variantIds":["00000000-0000-0000-0000-000000000000"]}'GET/v1/merchants/{merchantId}/inventory/counts
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
status | query | integer | |
page | query | integer | string (int32) | |
pageSize | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/inventory/counts" \
-H "X-Api-Key: $API_KEY"GET/v1/merchants/{merchantId}/inventory/counts/{id}
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
id | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/inventory/counts/$id" \
-H "X-Api-Key: $API_KEY"PUT/v1/merchants/{merchantId}/inventory/counts/{id}/lines
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
id | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
lines required | array |
json
{
"lines": [
{
"variantId": "00000000-0000-0000-0000-000000000000",
"countedQty": 0
}
]
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/inventory/counts/$id/lines" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"lines":[{"variantId":"00000000-0000-0000-0000-000000000000","countedQty":0}]}'POST/v1/merchants/{merchantId}/inventory/counts/{id}/post
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
id | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/counts/$id/post" \
-H "X-Api-Key: $API_KEY"POST/v1/merchants/{merchantId}/inventory/counts/{id}/cancel
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
id | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/counts/$id/cancel" \
-H "X-Api-Key: $API_KEY"MerchantReconciliation
GET/v1/merchants/{merchantId}/transactions
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
branchId | query | string (uuid) | |
terminalId | query | string (uuid) | |
status | query | integer | |
type | query | integer | |
from | query | string (date-time) | |
to | query | string (date-time) | |
rrn | query | string | |
page | query | integer | string (int32) | |
pageSize | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/transactions" \
-H "X-Api-Key: $API_KEY"GET/v1/merchants/{merchantId}/reconciliation/summary
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
branchId | query | string (uuid) | |
terminalId | query | string (uuid) | |
date | query | string (date) | |
from | query | string (date-time) | |
to | query | string (date-time) | |
graceMinutes | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/reconciliation/summary" \
-H "X-Api-Key: $API_KEY"GET/v1/merchants/{merchantId}/reconciliation/exceptions
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
kind | query | string | |
branchId | query | string (uuid) | |
terminalId | query | string (uuid) | |
date | query | string (date) | |
from | query | string (date-time) | |
to | query | string (date-time) | |
graceMinutes | query | integer | string (int32) | |
page | query | integer | string (int32) | |
pageSize | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/reconciliation/exceptions" \
-H "X-Api-Key: $API_KEY"POST/v1/merchants/{merchantId}/reconciliation/run
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/reconciliation/run" \
-H "X-Api-Key: $API_KEY"POST/v1/merchants/{merchantId}/transactions/{transactionId}/match
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
transactionId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
saleTenderId required | string (uuid) | |
note required | string |
json
{
"saleTenderId": "00000000-0000-0000-0000-000000000000",
"note": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/transactions/$transactionId/match" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"saleTenderId":"00000000-0000-0000-0000-000000000000","note":"string"}'POST/v1/merchants/{merchantId}/transactions/{transactionId}/ignore
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
transactionId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|
json
{
"note": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/transactions/$transactionId/ignore" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"note":"string"}'GET/v1/merchants/{merchantId}/reports/sales
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
groupBy | query | integer | |
branchId | query | string (uuid) | |
terminalId | query | string (uuid) | |
date | query | string (date) | |
from | query | string (date-time) | |
to | query | string (date-time) | |
format | query | string |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/reports/sales" \
-H "X-Api-Key: $API_KEY"MerchantSales
POST/v1/merchants/{merchantId}/sales
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Idempotency-Key | header | string |
Request body
| Field | Type | Notes |
|---|---|---|
saleId required | string (uuid) | |
branchId required | string (uuid) | |
tid required | string | |
shiftId required | string (uuid) | |
receiptNo required | string | |
cashierRef required | string | |
occurredAt required | string (date-time) | |
lines required | array | |
tenders required | array | |
expectedTotalKobo required | integer | string (int64) | |
note required | string |
json
{
"saleId": "00000000-0000-0000-0000-000000000000",
"branchId": "00000000-0000-0000-0000-000000000000",
"tid": "string",
"shiftId": "00000000-0000-0000-0000-000000000000",
"receiptNo": "string",
"cashierRef": "string",
"occurredAt": "2026-11-16T10:00:00+01:00",
"lines": [
{
"variantId": "00000000-0000-0000-0000-000000000000",
"quantity": 0,
"unitPriceKobo": 0,
"discountKobo": 0
}
],
"tenders": [
{
"type": 0,
"amountKobo": 0,
"rrn": "string",
"stan": "string",
"tid": "string",
"maskedPan": "string",
"authCode": "string",
"reference": "string"
}
],
"expectedTotalKobo": 0,
"note": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/sales" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"saleId":"00000000-0000-0000-0000-000000000000","branchId":"00000000-0000-0000-0000-000000000000","tid":"string","shiftId":"00000000-0000-0000-0000-000000000000","receiptNo":"string","cashierRef":"string","occurredAt":"2026-11-16T10:00:00+01:00","lines":[{"variantId":"00000000-0000-0000-0000-000000000000","quantity":0,"unitPriceKobo":0,"discountKobo":0}],"tenders":[{"type":0,"amountKobo":0,"rrn":"string","stan":"string","tid":"string","maskedPan":"string","authCode":"string","reference":"string"}],"expectedTotalKobo":0,"note":"string"}'GET/v1/merchants/{merchantId}/sales
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
branchId | query | string (uuid) | |
terminalId | query | string (uuid) | |
shiftId | query | string (uuid) | |
status | query | integer | |
from | query | string (date-time) | |
to | query | string (date-time) | |
receipt | query | string | |
page | query | integer | string (int32) | |
pageSize | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/sales" \
-H "X-Api-Key: $API_KEY"GET/v1/merchants/{merchantId}/sales/{saleId}
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
saleId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/sales/$saleId" \
-H "X-Api-Key: $API_KEY"POST/v1/merchants/{merchantId}/sales/{saleId}/returns
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
saleId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
returnId required | string (uuid) | |
occurredAt required | string (date-time) | |
reason required | string | |
cashierRef required | string | |
lines required | array | |
refunds required | array |
json
{
"returnId": "00000000-0000-0000-0000-000000000000",
"occurredAt": "2026-11-16T10:00:00+01:00",
"reason": "string",
"cashierRef": "string",
"lines": [
{
"saleLineId": "00000000-0000-0000-0000-000000000000",
"quantity": 0,
"restock": false
}
],
"refunds": [
{
"type": 0,
"amountKobo": 0,
"rrn": "string",
"reference": "string"
}
]
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/sales/$saleId/returns" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"returnId":"00000000-0000-0000-0000-000000000000","occurredAt":"2026-11-16T10:00:00+01:00","reason":"string","cashierRef":"string","lines":[{"saleLineId":"00000000-0000-0000-0000-000000000000","quantity":0,"restock":false}],"refunds":[{"type":0,"amountKobo":0,"rrn":"string","reference":"string"}]}'POST/v1/merchants/{merchantId}/shifts
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
shiftId required | string (uuid) | |
branchId required | string (uuid) | |
tid required | string | |
openedAt required | string (date-time) | |
openingFloatKobo required | integer | string (int64) | |
cashierRef required | string |
json
{
"shiftId": "00000000-0000-0000-0000-000000000000",
"branchId": "00000000-0000-0000-0000-000000000000",
"tid": "string",
"openedAt": "2026-11-16T10:00:00+01:00",
"openingFloatKobo": 0,
"cashierRef": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/shifts" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"shiftId":"00000000-0000-0000-0000-000000000000","branchId":"00000000-0000-0000-0000-000000000000","tid":"string","openedAt":"2026-11-16T10:00:00+01:00","openingFloatKobo":0,"cashierRef":"string"}'GET/v1/merchants/{merchantId}/shifts
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
branchId | query | string (uuid) | |
terminalId | query | string (uuid) | |
status | query | integer | |
page | query | integer | string (int32) | |
pageSize | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/shifts" \
-H "X-Api-Key: $API_KEY"GET/v1/merchants/{merchantId}/shifts/{shiftId}
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
shiftId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/shifts/$shiftId" \
-H "X-Api-Key: $API_KEY"POST/v1/merchants/{merchantId}/shifts/{shiftId}/close
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
shiftId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
countedCashKobo required | integer | string (int64) | |
closedAt required | string (date-time) | |
cashierRef required | string |
json
{
"countedCashKobo": 0,
"closedAt": "2026-11-16T10:00:00+01:00",
"cashierRef": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/shifts/$shiftId/close" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"countedCashKobo":0,"closedAt":"2026-11-16T10:00:00+01:00","cashierRef":"string"}'GET/v1/merchants/{merchantId}/reports/z
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
branchId | query | string (uuid) | |
terminalId | query | string (uuid) | |
shiftId | query | string (uuid) | |
date | query | string (date) | |
from | query | string (date-time) | |
to | query | string (date-time) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/reports/z" \
-H "X-Api-Key: $API_KEY"GET/v1/merchants/{merchantId}/oversells
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
branchId | query | string (uuid) | |
status | query | integer | |
page | query | integer | string (int32) | |
pageSize | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/oversells" \
-H "X-Api-Key: $API_KEY"POST/v1/merchants/{merchantId}/oversells/{alertId}/acknowledge
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
alertId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|
json
{
"note": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/oversells/$alertId/acknowledge" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"note":"string"}'GET/v1/merchants/{merchantId}/rejections
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
resolved | query | boolean | |
page | query | integer | string (int32) | |
pageSize | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/rejections" \
-H "X-Api-Key: $API_KEY"POST/v1/merchants/{merchantId}/rejections/{rejectionId}/resolve
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | path | string (uuid) | required |
rejectionId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|
json
{
"note": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/rejections/$rejectionId/resolve" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"note":"string"}'NetworkReports
GET/v1/reports/network
Parameters
| Name | In | Type | |
|---|---|---|---|
groupBy | query | integer | |
from | query | string (date) | |
to | query | string (date) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/reports/network" \
-H "X-Api-Key: $API_KEY"GET/v1/reports/platform
Parameters
| Name | In | Type | |
|---|---|---|---|
days | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/reports/platform" \
-H "X-Api-Key: $API_KEY"OrganizationBranding
GET/v1/organizations/{id}/branding
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/organizations/$id/branding" \
-H "X-Api-Key: $API_KEY"PUT/v1/organizations/{id}/branding
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
brandName required | string | |
logoUrl required | string | |
primaryColor required | string | |
showPoweredBy | boolean | |
canOverrideBranding | boolean |
json
{
"brandName": "string",
"logoUrl": "string",
"primaryColor": "string",
"showPoweredBy": false,
"canOverrideBranding": false
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/organizations/$id/branding" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"brandName":"string","logoUrl":"string","primaryColor":"string","showPoweredBy":false,"canOverrideBranding":false}'GET/v1/organizations/{id}/domains
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/organizations/$id/domains" \
-H "X-Api-Key: $API_KEY"POST/v1/organizations/{id}/domains
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
host required | string |
json
{
"host": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/organizations/$id/domains" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"host":"string"}'POST/v1/organizations/{id}/domains/{domainId}/refresh
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
domainId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/organizations/$id/domains/$domainId/refresh" \
-H "X-Api-Key: $API_KEY"DELETE/v1/organizations/{id}/domains/{domainId}
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
domainId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X DELETE "$BASE/v1/organizations/$id/domains/$domainId" \
-H "X-Api-Key: $API_KEY"Organizations
GET/v1/organizations
Parameters
| Name | In | Type | |
|---|---|---|---|
type | query | integer |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/organizations" \
-H "X-Api-Key: $API_KEY"POST/v1/organizations
Request body
| Field | Type | Notes |
|---|---|---|
type required | integer | |
parentId required | string (uuid) | |
name required | string | |
slug required | string | |
sandbox | boolean | |
mid | string |
json
{
"type": 0,
"parentId": "00000000-0000-0000-0000-000000000000",
"name": "string",
"slug": "string",
"sandbox": false,
"mid": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/organizations" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"type":0,"parentId":"00000000-0000-0000-0000-000000000000","name":"string","slug":"string","sandbox":false,"mid":"string"}'PUT/v1/organizations/{id}
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
name required | string | |
status required | any | |
mid required | string |
json
{
"name": "string",
"status": 0,
"mid": "string"
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/organizations/$id" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string","status":0,"mid":"string"}'GET/v1/organizations/{id}/users
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/organizations/$id/users" \
-H "X-Api-Key: $API_KEY"POST/v1/organizations/{id}/users
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
email required | string | |
fullName required | string | |
password required | string | |
role required | integer | |
invite | boolean |
json
{
"email": "string",
"fullName": "string",
"password": "string",
"role": 0,
"invite": false
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/organizations/$id/users" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"email":"string","fullName":"string","password":"string","role":0,"invite":false}'GET/v1/organizations/{id}/profile
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/organizations/$id/profile" \
-H "X-Api-Key: $API_KEY"PUT/v1/organizations/{id}/profile
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
name required | string | |
address required | string | |
phone required | string | |
contactEmail required | string | |
taxId required | string | |
receiptFooter required | string | |
dailySummary required | boolean |
json
{
"name": "string",
"address": "string",
"phone": "string",
"contactEmail": "string",
"taxId": "string",
"receiptFooter": "string",
"dailySummary": false
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/organizations/$id/profile" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string","address":"string","phone":"string","contactEmail":"string","taxId":"string","receiptFooter":"string","dailySummary":false}'PUT/v1/organizations/{id}/users/{userId}
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
userId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
fullName required | string | |
role required | any | |
isActive required | boolean |
json
{
"fullName": "string",
"role": 0,
"isActive": false
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/organizations/$id/users/$userId" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"fullName":"string","role":0,"isActive":false}'POST/v1/organizations/{id}/users/{userId}/password
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
userId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
password required | string |
json
{
"password": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/organizations/$id/users/$userId/password" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"password":"string"}'POST/v1/organizations/{id}/api-keys
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
name required | string | |
scopes required | array |
json
{
"name": "string",
"scopes": [
"string"
]
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/organizations/$id/api-keys" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string","scopes":["string"]}'Public
GET/v1/public/branding
Parameters
| Name | In | Type | |
|---|---|---|---|
host | query | string |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/public/branding" \
-H "X-Api-Key: $API_KEY"Sync
PUT/v1/sync/merchants
Request body
| Field | Type | Notes |
|---|---|---|
items required | array |
json
{
"items": [
{
"externalId": "string",
"name": "string",
"mid": "string",
"slug": "string",
"resellerId": "00000000-0000-0000-0000-000000000000",
"status": null
}
]
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/sync/merchants" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"items":[{"externalId":"string","name":"string","mid":"string","slug":"string","resellerId":"00000000-0000-0000-0000-000000000000","status":null}]}'PUT/v1/sync/branches
Request body
| Field | Type | Notes |
|---|---|---|
items required | array |
json
{
"items": [
{
"externalId": "string",
"merchantExternalId": "string",
"name": "string",
"code": "string"
}
]
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/sync/branches" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"items":[{"externalId":"string","merchantExternalId":"string","name":"string","code":"string"}]}'PUT/v1/sync/terminals
Request body
| Field | Type | Notes |
|---|---|---|
items required | array |
json
{
"items": [
{
"externalId": "string",
"tid": "string",
"serialNumber": "string",
"model": "string",
"status": null,
"merchantExternalId": "string",
"branchExternalId": "string"
}
]
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/sync/terminals" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"items":[{"externalId":"string","tid":"string","serialNumber":"string","model":"string","status":null,"merchantExternalId":"string","branchExternalId":"string"}]}'POST/v1/sync/webhooks
Request body
| Field | Type | Notes |
|---|---|---|
eventId required | string | |
type required | string | |
occurredAt required | string (date-time) | |
data required | any |
json
{
"eventId": "string",
"type": "string",
"occurredAt": "2026-11-16T10:00:00+01:00",
"data": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/sync/webhooks" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"eventId":"string","type":"string","occurredAt":"2026-11-16T10:00:00+01:00","data":"string"}'Terminal
GET/v1/terminal/catalog
Parameters
| Name | In | Type | |
|---|---|---|---|
cursor | query | string | |
updatedSince | query | string (date-time) | |
limit | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/terminal/catalog" \
-H "X-Api-Key: $API_KEY"GET/v1/terminal/categories
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/terminal/categories" \
-H "X-Api-Key: $API_KEY"GET/v1/terminal/lookup
Parameters
| Name | In | Type | |
|---|---|---|---|
barcode | query | string |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/terminal/lookup" \
-H "X-Api-Key: $API_KEY"GET/v1/terminal/stock/{variantId}
Parameters
| Name | In | Type | |
|---|---|---|---|
variantId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/terminal/stock/$variantId" \
-H "X-Api-Key: $API_KEY"POST/v1/terminal/sales
Parameters
| Name | In | Type | |
|---|---|---|---|
Idempotency-Key | header | string |
Request body
| Field | Type | Notes |
|---|---|---|
saleId required | string (uuid) | |
receiptNo required | string | |
cashierRef required | string | |
occurredAt required | string (date-time) | |
shiftId required | string (uuid) | |
lines required | array | |
tenders required | array | |
expectedTotalKobo required | integer | string (int64) | |
note required | string |
json
{
"saleId": "00000000-0000-0000-0000-000000000000",
"receiptNo": "string",
"cashierRef": "string",
"occurredAt": "2026-11-16T10:00:00+01:00",
"shiftId": "00000000-0000-0000-0000-000000000000",
"lines": [
{
"variantId": "00000000-0000-0000-0000-000000000000",
"quantity": 0,
"unitPriceKobo": 0,
"discountKobo": 0
}
],
"tenders": [
{
"type": 0,
"amountKobo": 0,
"rrn": "string",
"stan": "string",
"tid": "string",
"maskedPan": "string",
"authCode": "string",
"reference": "string"
}
],
"expectedTotalKobo": 0,
"note": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/terminal/sales" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"saleId":"00000000-0000-0000-0000-000000000000","receiptNo":"string","cashierRef":"string","occurredAt":"2026-11-16T10:00:00+01:00","shiftId":"00000000-0000-0000-0000-000000000000","lines":[{"variantId":"00000000-0000-0000-0000-000000000000","quantity":0,"unitPriceKobo":0,"discountKobo":0}],"tenders":[{"type":0,"amountKobo":0,"rrn":"string","stan":"string","tid":"string","maskedPan":"string","authCode":"string","reference":"string"}],"expectedTotalKobo":0,"note":"string"}'GET/v1/terminal/sales/{saleId}
Parameters
| Name | In | Type | |
|---|---|---|---|
saleId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/terminal/sales/$saleId" \
-H "X-Api-Key: $API_KEY"POST/v1/terminal/sales/{saleId}/returns
Parameters
| Name | In | Type | |
|---|---|---|---|
saleId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
returnId required | string (uuid) | |
occurredAt required | string (date-time) | |
reason required | string | |
cashierRef required | string | |
lines required | array | |
refunds required | array |
json
{
"returnId": "00000000-0000-0000-0000-000000000000",
"occurredAt": "2026-11-16T10:00:00+01:00",
"reason": "string",
"cashierRef": "string",
"lines": [
{
"saleLineId": "00000000-0000-0000-0000-000000000000",
"quantity": 0,
"restock": false
}
],
"refunds": [
{
"type": 0,
"amountKobo": 0,
"rrn": "string",
"reference": "string"
}
]
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/terminal/sales/$saleId/returns" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"returnId":"00000000-0000-0000-0000-000000000000","occurredAt":"2026-11-16T10:00:00+01:00","reason":"string","cashierRef":"string","lines":[{"saleLineId":"00000000-0000-0000-0000-000000000000","quantity":0,"restock":false}],"refunds":[{"type":0,"amountKobo":0,"rrn":"string","reference":"string"}]}'POST/v1/terminal/shifts
Request body
| Field | Type | Notes |
|---|---|---|
shiftId required | string (uuid) | |
branchId required | string (uuid) | |
tid required | string | |
openedAt required | string (date-time) | |
openingFloatKobo required | integer | string (int64) | |
cashierRef required | string |
json
{
"shiftId": "00000000-0000-0000-0000-000000000000",
"branchId": "00000000-0000-0000-0000-000000000000",
"tid": "string",
"openedAt": "2026-11-16T10:00:00+01:00",
"openingFloatKobo": 0,
"cashierRef": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/terminal/shifts" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"shiftId":"00000000-0000-0000-0000-000000000000","branchId":"00000000-0000-0000-0000-000000000000","tid":"string","openedAt":"2026-11-16T10:00:00+01:00","openingFloatKobo":0,"cashierRef":"string"}'POST/v1/terminal/shifts/{shiftId}/close
Parameters
| Name | In | Type | |
|---|---|---|---|
shiftId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
countedCashKobo required | integer | string (int64) | |
closedAt required | string (date-time) | |
cashierRef required | string |
json
{
"countedCashKobo": 0,
"closedAt": "2026-11-16T10:00:00+01:00",
"cashierRef": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/terminal/shifts/$shiftId/close" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"countedCashKobo":0,"closedAt":"2026-11-16T10:00:00+01:00","cashierRef":"string"}'GET/v1/terminal/shifts/{shiftId}
Parameters
| Name | In | Type | |
|---|---|---|---|
shiftId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/terminal/shifts/$shiftId" \
-H "X-Api-Key: $API_KEY"GET/v1/terminal/shifts/{shiftId}/report
Parameters
| Name | In | Type | |
|---|---|---|---|
shiftId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/terminal/shifts/$shiftId/report" \
-H "X-Api-Key: $API_KEY"Terminals
GET/v1/terminals
Parameters
| Name | In | Type | |
|---|---|---|---|
merchantId | query | string (uuid) | |
unassigned | query | boolean | |
status | query | integer | |
q | query | string | |
page | query | integer | string (int32) | |
pageSize | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/terminals" \
-H "X-Api-Key: $API_KEY"POST/v1/terminals
Request body
| Field | Type | Notes |
|---|---|---|
tid required | string | |
serialNumber required | string | |
model required | string | |
merchantId required | string (uuid) | |
branchId required | string (uuid) | |
operatorId required | string (uuid) |
json
{
"tid": "string",
"serialNumber": "string",
"model": "string",
"merchantId": "00000000-0000-0000-0000-000000000000",
"branchId": "00000000-0000-0000-0000-000000000000",
"operatorId": "00000000-0000-0000-0000-000000000000"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/terminals" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"tid":"string","serialNumber":"string","model":"string","merchantId":"00000000-0000-0000-0000-000000000000","branchId":"00000000-0000-0000-0000-000000000000","operatorId":"00000000-0000-0000-0000-000000000000"}'PUT/v1/terminals/{id}
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
serialNumber required | string | |
model required | string | |
status required | any | |
assignment required | string | |
merchantId required | string (uuid) | |
branchId required | string (uuid) |
json
{
"serialNumber": "string",
"model": "string",
"status": 0,
"assignment": "string",
"merchantId": "00000000-0000-0000-0000-000000000000",
"branchId": "00000000-0000-0000-0000-000000000000"
}Responses
200 | OK |
Example
bash
curl -X PUT "$BASE/v1/terminals/$id" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"serialNumber":"string","model":"string","status":0,"assignment":"string","merchantId":"00000000-0000-0000-0000-000000000000","branchId":"00000000-0000-0000-0000-000000000000"}'POST/v1/terminals/{tid}/sessions
Parameters
| Name | In | Type | |
|---|---|---|---|
tid | path | string | required |
Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/terminals/$tid/sessions" \
-H "X-Api-Key: $API_KEY"Transactions
POST/v1/transactions
Request body
| Field | Type | Notes |
|---|---|---|
items required | array |
json
{
"items": [
{
"externalId": "string",
"tid": "string",
"mid": "string",
"type": null,
"rrn": "string",
"stan": "string",
"amountKobo": 0,
"responseCode": "string",
"occurredAt": "2026-11-16T10:00:00+01:00",
"maskedPan": "string",
"authCode": "string",
"scheme": "string"
}
]
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/transactions" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"items":[{"externalId":"string","tid":"string","mid":"string","type":null,"rrn":"string","stan":"string","amountKobo":0,"responseCode":"string","occurredAt":"2026-11-16T10:00:00+01:00","maskedPan":"string","authCode":"string","scheme":"string"}]}'Webhooks
GET/v1/organizations/{id}/webhooks/events
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/organizations/$id/webhooks/events" \
-H "X-Api-Key: $API_KEY"GET/v1/organizations/{id}/webhooks
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/organizations/$id/webhooks" \
-H "X-Api-Key: $API_KEY"POST/v1/organizations/{id}/webhooks
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
url required | string | |
events required | array | |
description required | string |
json
{
"url": "string",
"events": [
"string"
],
"description": "string"
}Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/organizations/$id/webhooks" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"string","events":["string"],"description":"string"}'PATCH/v1/organizations/{id}/webhooks/{endpointId}
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
endpointId | path | string (uuid) | required |
Request body
| Field | Type | Notes |
|---|---|---|
url required | string | |
events required | array | |
isActive required | boolean |
json
{
"url": "string",
"events": [
"string"
],
"isActive": false
}Responses
200 | OK |
Example
bash
curl -X PATCH "$BASE/v1/organizations/$id/webhooks/$endpointId" \
-H "X-Api-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"string","events":["string"],"isActive":false}'DELETE/v1/organizations/{id}/webhooks/{endpointId}
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
endpointId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X DELETE "$BASE/v1/organizations/$id/webhooks/$endpointId" \
-H "X-Api-Key: $API_KEY"POST/v1/organizations/{id}/webhooks/{endpointId}/rotate-secret
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
endpointId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/organizations/$id/webhooks/$endpointId/rotate-secret" \
-H "X-Api-Key: $API_KEY"POST/v1/organizations/{id}/webhooks/{endpointId}/test
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
endpointId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/organizations/$id/webhooks/$endpointId/test" \
-H "X-Api-Key: $API_KEY"GET/v1/organizations/{id}/webhooks/{endpointId}/deliveries
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
endpointId | path | string (uuid) | required |
status | query | integer | |
page | query | integer | string (int32) | |
pageSize | query | integer | string (int32) |
Responses
200 | OK |
Example
bash
curl -X GET "$BASE/v1/organizations/$id/webhooks/$endpointId/deliveries" \
-H "X-Api-Key: $API_KEY"POST/v1/organizations/{id}/webhooks/{endpointId}/deliveries/{deliveryId}/retry
Parameters
| Name | In | Type | |
|---|---|---|---|
id | path | string (uuid) | required |
endpointId | path | string (uuid) | required |
deliveryId | path | string (uuid) | required |
Responses
200 | OK |
Example
bash
curl -X POST "$BASE/v1/organizations/$id/webhooks/$endpointId/deliveries/$deliveryId/retry" \
-H "X-Api-Key: $API_KEY"