Every endpoint in Point of sale: 36 operations across 10 resources. Each one takes the same API key and returns the same error shapes as the rest of the API; see Authentication and Errors and limits.
Every path below is relative to https://app.jaicrm.ai. A key only reaches what it was granted when it was created, an endpoint you cannot use answers 403 rather than hiding.
Orders
GET/api/pos/orders
List orders
curl -X GET https://app.jaicrm.ai/api/pos/orders
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/pos/orders/{id}
Read one order
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/pos/orders/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/pos/orders/{id}/receipt
List receipt
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/pos/orders/RECORD_ID/receipt
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/pos/orders/{id}/refundable
List refundable
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/pos/orders/RECORD_ID/refundable
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/pos/orders/{id}/upi-qr
List upi qr
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/pos/orders/RECORD_ID/upi-qr
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/orders
Create an order
curl -X POST https://app.jaicrm.ai/api/pos/orders
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/orders/{id}/abandon
Create an abandon
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/pos/orders/RECORD_ID/abandon
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/orders/{id}/claim
Create a claim
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/pos/orders/RECORD_ID/claim
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/orders/{id}/customer
Create a customer
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/pos/orders/RECORD_ID/customer
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/orders/{id}/discount
Create a discount
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/pos/orders/RECORD_ID/discount
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/orders/{id}/place
Create a place
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/pos/orders/RECORD_ID/place
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/orders/{id}/refund
Create a refund
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/pos/orders/RECORD_ID/refund
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/orders/{id}/settle
Create a settle
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/pos/orders/RECORD_ID/settle
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/orders/{id}/void
Create a void
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/pos/orders/RECORD_ID/void
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/pos/orders/{id}
Change an order
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/pos/orders/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'PUT/api/pos/orders/{id}/lines
Change a line
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PUT https://app.jaicrm.ai/api/pos/orders/RECORD_ID/lines
-H 'Authorization: Bearer YOUR_API_KEY'Shifts
GET/api/pos/shifts
List shifts, filtered, sorted and paged
curl -X GET https://app.jaicrm.ai/api/pos/shifts
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/pos/shifts/{id}/expected
List the expected for a shift
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/pos/shifts/RECORD_ID/expected
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/shifts
Create a shift
curl -X POST https://app.jaicrm.ai/api/pos/shifts
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/shifts/{id}/cash
Add to the cash of a shift
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/pos/shifts/RECORD_ID/cash
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/shifts/{id}/close
Add to the close of a shift
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/pos/shifts/RECORD_ID/close
-H 'Authorization: Bearer YOUR_API_KEY'Stores
GET/api/pos/stores
List stores
curl -X GET https://app.jaicrm.ai/api/pos/stores
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/stores
Create a store
curl -X POST https://app.jaicrm.ai/api/pos/stores
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/pos/stores/{id}
Change a store
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/pos/stores/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/pos/stores/{id}
Delete a store
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/pos/stores/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Terminals
GET/api/pos/terminals
List terminals, filtered, sorted and paged
curl -X GET https://app.jaicrm.ai/api/pos/terminals
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/terminals
Create a terminal
curl -X POST https://app.jaicrm.ai/api/pos/terminals
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/terminals/{id}/pair
Add to the pair of a terminal
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/pos/terminals/RECORD_ID/pair
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/pos/terminals/{id}/unpair
Add to the unpair of a terminal
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/pos/terminals/RECORD_ID/unpair
-H 'Authorization: Bearer YOUR_API_KEY'Menu
GET/api/pos/menu
List menu, filtered, sorted and paged
curl -X GET https://app.jaicrm.ai/api/pos/menu
-H 'Authorization: Bearer YOUR_API_KEY'PUT/api/pos/menu/{itemId}
Change a menu item
| Parameter | Type | Required | Notes |
|---|---|---|---|
itemId | string | Required | The record’s id. |
curl -X PUT https://app.jaicrm.ai/api/pos/menu/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Pair
POST/api/pos/pair
Create a pair
curl -X POST https://app.jaicrm.ai/api/pos/pair
-H 'Authorization: Bearer YOUR_API_KEY'Me
GET/api/pos/me
Read who the current token belongs to
curl -X GET https://app.jaicrm.ai/api/pos/me
-H 'Authorization: Bearer YOUR_API_KEY'Customers
GET/api/pos/customers
List customers
curl -X GET https://app.jaicrm.ai/api/pos/customers
-H 'Authorization: Bearer YOUR_API_KEY'Waiting
GET/api/pos/waiting
List waiting
curl -X GET https://app.jaicrm.ai/api/pos/waiting
-H 'Authorization: Bearer YOUR_API_KEY'Staff
PUT/api/pos/staff/{id}/pin
Change a pin
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PUT https://app.jaicrm.ai/api/pos/staff/RECORD_ID/pin
-H 'Authorization: Bearer YOUR_API_KEY'Something missing or wrong here? Tell us. A question that needed asking usually means a page that needed writing.