SearchResultTerminal resource

Methods

  • get - Get all active terminals

Resource

{
    "limit": "int32",
    "skip": "int32",
    "total": "int64",
    "values": [
        {
            "active": "boolean",
            "appVersion": "string",
            "assignedInventoryId": "string",
            "checkoutType": "string",
            "companyId": "string",
            "created": "int64",
            "creditCardReader": {
                "encryptionType": "string",
                "secretKey": "string"
            },
            "currentEmployeeId": "string",
            "cvAccountId": "string",
            "deleted": "boolean",
            "deviceDetails": [
                {
                    "active": "boolean",
                    "appType": "string",
                    "deviceId": "string",
                    "deviceModel": "string",
                    "deviceName": "string",
                    "deviceToken": "string",
                    "deviceType": "string",
                    "deviceVersion": "string",
                    "sdkVersion": "string",
                    "version": "string"
                }
            ],
            "deviceId": "string",
            "deviceModel": "string",
            "deviceName": "string",
            "deviceToken": "string",
            "deviceType": "string",
            "deviceVersion": "string",
            "dirty": "boolean",
            "id": "string",
            "modified": "int64",
            "name": "string",
            "onPremEnabled": "boolean",
            "posTerminal": "string",
            "regionId": "string",
            "shopId": "string",
            "terminalLocations": [
                {
                    "companyId": "string",
                    "created": "int64",
                    "deleted": "boolean",
                    "deviceId": "string",
                    "dirty": "boolean",
                    "employeeId": "string",
                    "id": "string",
                    "loc": [
                        "double"
                    ],
                    "modified": "int64",
                    "name": "string",
                    "shopId": "string",
                    "terminalId": "string",
                    "timeCardId": "string",
                    "updated": "boolean"
                }
            ],
            "terminalType": "string",
            "updated": "boolean"
        }
    ]
}

Properties

Name Type Description Additional
limit int32 Optional
skip int32 Optional
total int64 Optional
values[] array Optional
values[].active boolean Optional
values[].appVersion string Optional
values[].assignedInventoryId string Optional
values[].checkoutType string

Possible values are:

  • Direct
  • Fulfillment
  • FulfillmentThreeStep
 Optional
values[].companyId string Optional
values[].created int64 Optional
values[].creditCardReader object CreditCardReader Optional
values[].creditCardReader.encryptionType string

Possible values are:

  • BlazeSymmetricEncryption
  • DUKPT
 Optional
values[].creditCardReader.secretKey string Optional
values[].currentEmployeeId string Optional
values[].cvAccountId string Optional
values[].deleted boolean Optional
values[].deviceDetails[] array Optional
values[].deviceDetails[].active boolean Optional
values[].deviceDetails[].appType string

Possible values are:

  • Connect
  • Blaze
  • Developer
  • StoreWidget
  • Distribution
  • Grow
  • DeliveryApp
 Optional
values[].deviceDetails[].deviceId string Optional
values[].deviceDetails[].deviceModel string Optional
values[].deviceDetails[].deviceName string Optional
values[].deviceDetails[].deviceToken string Optional
values[].deviceDetails[].deviceType string

Possible values are:

  • Android
  • iOS
 Optional
values[].deviceDetails[].deviceVersion string Optional
values[].deviceDetails[].sdkVersion string Optional
values[].deviceDetails[].version string Optional
values[].deviceId string Optional
values[].deviceModel string Optional
values[].deviceName string Optional
values[].deviceToken string Optional
values[].deviceType string Optional
values[].deviceVersion string Optional
values[].dirty boolean Optional
values[].id string Optional
values[].modified int64 Optional
values[].name string Optional
values[].onPremEnabled boolean Optional
values[].posTerminal string Optional
values[].regionId string Optional
values[].shopId string Optional
values[].terminalLocations[] array Optional
values[].terminalLocations[].companyId string Optional
values[].terminalLocations[].created int64 Optional
values[].terminalLocations[].deleted boolean Optional
values[].terminalLocations[].deviceId string Optional
values[].terminalLocations[].dirty boolean Optional
values[].terminalLocations[].employeeId string Optional
values[].terminalLocations[].id string Optional
values[].terminalLocations[].loc[] array of double Optional
values[].terminalLocations[].modified int64 Optional
values[].terminalLocations[].name string Optional
values[].terminalLocations[].shopId string Optional
values[].terminalLocations[].terminalId string Optional
values[].terminalLocations[].timeCardId string Optional
values[].terminalLocations[].updated boolean Optional
values[].terminalType string

Possible values are:

  • NotAssigned
  • WalkIn
  • Delivery
  • SelfCheckout
 Optional
values[].updated boolean Optional