iotoms Docs

Create a register

POST
/api/v1/catalog/business/registers

Creates a new register (a van-sales device or in-store till) for a store. Creating an ACTIVE register counts against the plan's register limit and fails once it is reached. Optionally link the stockroom its sales deduct from.

How to use it

  1. Get the store ID from List stores and, optionally, an active stockroom ID from List inventory locations.
  2. Send a unique name, storeId, fromTime, type (VAN or POS) and status.
  3. An ACTIVE register uses one slot of the plan's register limit; if the limit is reached the call is refused.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Request Body

application/json
  1. body
name*string

Register name, unique across the merchant (max 100 characters). Required.

storeId*integer

ID of the store the register belongs to, from List stores. Required.

Formatint64
fromTime*string

Date and time the register comes into service, ISO 8601 with offset (e.g. 2026-01-05T08:00:00+04:00). Required.

type*string

VAN for a van-sales device or POS for an in-store till. Defaults to VAN.

Value in"VAN""POS"
status*string

ACTIVE, INACTIVE, ARCHIVED or DELETED. Defaults to ACTIVE; creating an ACTIVE register fails if the plan's register limit is reached.

Value in"ACTIVE""INACTIVE""ARCHIVED""DELETED"
inventoryLocationId?|

Stockroom ID from List inventory locations that this register's sales deduct from. Must be active. On a full update, leaving it out clears it.

Formatuuid

Response Body

OK

*/*
  1. response
id?|

Register ID. Set by the server.

Formatint64
name*string

Register name, unique across the merchant (max 100 characters).

store?

The store the register belongs to.

fromTime*string

Date and time the register came into service (ISO 8601 with offset).

Formatdate-time
toTime?|

Date and time the register was taken out of service; set when it is terminated, empty while in service.

Formatdate-time
terminationReason?|

Reason recorded when the register was terminated; empty while in service.

type*string

Kind of register: VAN for a van-sales device, POS for an in-store till.

Value in"VAN""POS"
status*string

Register status: ACTIVE, INACTIVE, ARCHIVED or DELETED. Only ACTIVE registers count toward the plan's register limit.

Value in"ACTIVE""INACTIVE""ARCHIVED""DELETED"
modifiedTime*string

When the register was last changed. Set by the server.

Formatdate-time
inventoryLocationId?|

Stockroom (inventory location) this register's sales deduct stock from. When empty, sales deduct from the default warehouse.

Formatuuid
Example Request
curl -X POST 'https://beta.iotoms.com/api/v1/catalog/business/registers' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "storeId": 0,  "fromTime": "string",  "type": "VAN",  "status": "ACTIVE"}'
Example Response
{  "id": 0,  "name": "string",  "store": {    "id": 0,    "name": "string",    "venue": {      "id": 0,      "name": "string",      "status": "ACTIVE",      "modifiedTime": "2019-08-24T14:15:22Z"    },    "storeType": "string",    "promotionalMessage": "string",    "promotionalImage": "string",    "status": "ACTIVE",    "modifiedTime": "2019-08-24T14:15:22Z",    "createdViaAi": true,    "aiSessionId": "string"  },  "fromTime": "2019-08-24T14:15:22Z",  "toTime": "2019-08-24T14:15:22Z",  "terminationReason": "string",  "type": "VAN",  "status": "ACTIVE",  "modifiedTime": "2019-08-24T14:15:22Z",  "inventoryLocationId": "8f43ca4f-50a9-41c3-817f-63e60279ba33"}