Skip to content

Cash registers

This is the physical cash register device associated with the receipt.

Operations

Upload list of cash registers

Request

POST https://api.zoined.com/cashRegisters?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=false
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
register_idstringrequired

Register ID

Example:"123-1"
register_namestringrequired

Register name

Example:"Kiosk 1"
organisation_idstring

Organisation / store this register belongs to

Example:"540"
register_typestring

Register type

Example:"Kiosk"
register_groupstring

Register group

Example:"Self service"
custom_dimension1string

Custom Field 1

Example:"Class 3"
custom_dimension2string

Custom Field 2

Example:"Class 3"
custom_dimension3string

Custom Field 3

Example:"Class 3"
custom_dimension4string

Custom Field 4

Example:"Class 3"
custom_dimension5string

Custom Field 5

Example:"Class 3"
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/cashRegisters?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "register_id": "123-1",
    "register_name": "Kiosk 1",
    "organisation_id": "540",
    "register_type": "Kiosk",
    "register_group": "Self service",
    "custom_dimension1": "Class 3",
    "custom_dimension2": "Class 3",
    "custom_dimension3": "Class 3",
    "custom_dimension4": "Class 3",
    "custom_dimension5": "Class 3",
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
statusstringrequired

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}