iotoms Docs

Terminate a register

POST
/api/v1/catalog/business/registers/{id}/terminate

Retires a register: records the required terminationReason, sets an end time (defaults to now) and makes it inactive. A terminated register can no longer be used to sign in. Fails if the register is already inactive.

How to use it

  1. Get the register ID from List registers; it must not already be INACTIVE.
  2. Send a terminationReason and, optionally, the toTime it leaves service (defaults to now).
  3. The register becomes INACTIVE with its end time and reason recorded, and can no longer be used to sign in.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*integer

ID of the record.

Formatint64

Request Body

application/json
  1. body
terminationReason*string

Why the register is being retired, e.g. device lost or replaced. Required and must not be blank.

toTime*string

Date and time the register leaves service (ISO 8601 with offset). Defaults to now.

Formatdate-time
status*string

Status to set on the register. Defaults to INACTIVE.

Value in"ACTIVE""INACTIVE""ARCHIVED""DELETED"

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/0/terminate' \  -H 'Content-Type: application/json' \  -d '{  "terminationReason": "string",  "toTime": "2019-08-24T14:15:22Z",  "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"}