SPI Tax Free
Add Transaction
post /transactionsCreate a new tax free transaction.
Note that the transaction ID might not be returned if the ui_type property in the request body is set to
web-page. Then it will be provided later in a callback from the web page.
ID of the store (Sitoo clients will send the externalid property of the store object in Sitoo)
ID of the staff (Sitoo clients will send the externalid property of the user object in Sitoo)
ID of the register
ID of the request
Tax Free transaction.
| HTTP Status Code Summary | |
|---|---|
| 201 | Successful. Returns a tax free transaction. |
| 400 | Invalid request. Data sent from client is invalid. |
| 401 | Missing or bad authentication. |
| 403 | User is not authorized to perform operation. |
| 500 | Internal Server Error. |
| 502 | Bad Gateway. |
Get Transaction
get /transactions/{transaction_id}Get a transaction.
Transaction ID.
ID of the store (Sitoo clients will send the externalid property of the store object in Sitoo)
ID of the staff (Sitoo clients will send the externalid property of the user object in Sitoo)
ID of the register
ID of the request
| HTTP Status Code Summary | |
|---|---|
| 200 | Successful. Returns a tax free transaction. |
| 400 | Invalid request. Data sent from client is invalid. |
| 401 | Missing or bad authentication. |
| 403 | User is not authorized to perform operation. |
| 404 | The specified resource was not found. |
| 500 | Internal Server Error. |
| 502 | Bad Gateway. |
Void Transaction
delete /transactions/{transaction_id}Void a transaction. Typically used when returning items for a previous sales.
Transaction ID.
ID of the store (Sitoo clients will send the externalid property of the store object in Sitoo)
ID of the staff (Sitoo clients will send the externalid property of the user object in Sitoo)
ID of the register
ID of the request
| HTTP Status Code Summary | |
|---|---|
| 200 | Successful. |
| 400 | Invalid request. Data sent from client is invalid. |
| 401 | Missing or bad authentication. |
| 403 | User is not authorized to perform operation. |
| 404 | The specified resource was not found. |
| 500 | Internal Server Error. |
| 502 | Bad Gateway. |
Get Printouts
get /transactions/{transaction_id}/printoutsGet printouts for a transaction.
Transaction ID.
ID of the store (Sitoo clients will send the externalid property of the store object in Sitoo)
ID of the staff (Sitoo clients will send the externalid property of the user object in Sitoo)
ID of the register
ID of the request
| HTTP Status Code Summary | |
|---|---|
| 200 | Successful. Returns a list of printouts. |
| 400 | Invalid request. Data sent from client is invalid. |
| 401 | Missing or bad authentication. |
| 403 | User is not authorized to perform operation. |
| 404 | The specified resource was not found. |
| 500 | Internal Server Error. |
| 502 | Bad Gateway. |
Objects
ErrorCodestring
Error code describing the data and depending on value, the error_data property will contain the following
additional information:
Error code Additional info field-missing fieldfield-unknown fieldfield-readonly fieldfield-type fieldfield-validation fieldversion-invalid none condition-failed none other none
ErrorMessageobject
Error object returned when a request is not successful.
ID of request
The error code returned.
A string map with fields depending on the error_code. The field message is always available.
Addressobject
Address.
The address line 1.
The address line 2.
Zip for the address.
City for the address.
State/Region for the address.
Country ID for the address (ISO 3166-1 Alpha2 uppercase).
Customerobject
Customer data.
First name.
Last name.
Mobile phone number.
Email.
Company.
OrderItemobject
The Stock Keeping Unit (SKU)
Title row 1.
Title row 2.
The quantity of this item.
Unit quantity (How much that is included in each unit).
Label for unit of transaction item. (e.g. kg)
Total amount including VAT for the order item.
Total VAT for the order item.
VAT percentage for the order item.
Orderobject
The order data.
Timestamp for when the order was created.
Unique receipt ID.
Order ID.
Order External ID. If the order was placed externally.
Store ID for the order.
Store Name for the order.
Currency used for transaction (3-letter ISO 4217).
Roundoff for the order.
Order items.
The total amount including VAT.
The total VAT amount.
Transactionobject
Tax Free transaction.
The ID of the transaction. Usually returned later in the web page callback.
The name of the service.
Type of UI for the tax free session. Note that the value must be web-page.
| VALUES |
|---|
| web-page |
URL to load if type is web-page.
Type of printout to make.
| VALUES |
|---|
| none |
| print-data |
Printoutarray
List of printouts for a tax free transaction. Each array represents a separate printout and every element in the inner array represents a row in the printout. See the overview for a more detailed example of a printout.