Receipts
Receipt services for a site/kiosk. There is only one receipt service, the POST service from the tablet application to the service to register product sales.
Endpoints¶
POST sema/site/receipts
Headers¶
| Header | Required | Example | Description |
|---|---|---|---|
| Authorization | YES | Authorization: Bearer xxxx.yyyy.zzzz |
Contains token as received from login |
| content-Type | YES | Content-Type: application/json |
Path Parameters¶
None
Query Parameters¶
None
POST Body (JSON formatted)¶
| Field Name | Required | Type | Description |
|---|---|---|---|
| id | YES | String | Unique Id for the receipt |
| createdDate | YES | String ISO 8601 format. | |
| customerId | YES | String | Customer identifier |
| paymentType | YES | String | Use "", reserved for future use |
| currencyCode | YES | String | Standard currency code. i.e.: USD, NZD etc |
| siteId | YES | Number | site/kiosk identifier |
| customerTypeId | YES | Number | Customer type identifier |
| total | YES | Number | total amount |
| cogs | YES | Number Cost of goods sold | |
| salesChannelId | YES | Number | Sales channel identifier for the sale |
| receiptId | YES | String | Additional, (client side), receipt id |
| products | NO | Array | Array of products purchased |
Each product has the following information:
| Field Name | Required | Type | Description |
|---|---|---|---|
| productId | YES | Number | Product identifier |
| quantity | YES | Number | Number sold |
| priceTotal | YES | Number | Sales/item * quantity |
| cogsTotal | YES | Number | Cost of goods sold |
| sku | YES | String | Product sku |