iotoms Docs

Partially update a register

PATCH
/api/v1/catalog/business/registers/{id}

Updates only the register fields included in the request body: name, storeId, fromTime, status or inventoryLocationId. Send inventoryLocationId: null to clear the stockroom; leave the key out to keep it. To change the register type, use Update a register.

How to use it

  1. Get the register ID from List registers.
  2. Send only the fields to change, e.g. a new name or inventoryLocationId from List inventory locations (must be active).
  3. Fields not sent stay as they are.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*integer

ID of the record.

Formatint64

Request Body

application/json
  1. body
[key: string]?

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 PATCH 'https://beta.iotoms.com/api/v1/catalog/business/registers/0' \  -H 'Content-Type: application/json' \  -d '{  "property1": {},  "property2": {}}'
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"}