Get Machines

Retrieves a set of machines.

Verb	POST
Endpoint	{base-url}/machines
Max Page Size	500

Request Body

{
  "requestFilter": {
    "organizationIds": [],
    "accountIds": [],
    "siteIds": [],
    "machineIdentifiers": [],
    "includeDeleted": false
  }
}

Filters Honored

RequestFilter
- organizationIds
- accountIds
- siteIds
- machineIdentifiers
- includeDeleted

Returns

On Success

The requested list of machines.

Response Body

[
  {
    "id": 1166,
    "assetId": 318,
    "organizationId": 1,
    "siteId": 7,
    "typeId": 4,
    "machineMasterId": 12,
    "forceUpdate": false,
    "prose": "PROSE1234567890",
    "name": "Snack Machine - Lobby",
    "modelNumber": "VCController",
    "taxPercentage": 7.5,
    "commissionPercentage": 10.0,
    "callInCode": "U3EA142DP4",
    "creditProcessingFee": 1.5,
    "externalAccountsTerminalId": null,
    "createdAt": "2014-08-06T09:56:58.55",
    "provisionedAt": "2024-01-15T08:00:00Z",
    "canRollbackFirmware": false,
    "controllerFirmware": {
      "current": "4.2.1",
      "pendingUpdate": null
    },
    "pcFirmware": {
      "current": "2.1.0",
      "pendingUpdate": null
    },
    "hasPlanogramChange": true,
    "enableAccountSales": true,
    "enableCashSales": true,
    "enableCreditSales": true,
    "mode": "metered",
    "isVisible": true,
    "isProvisioned": true,
    "enableSlotCountTracking": true,
    "useInternetPricing": false,
    "hardwareSettingsChanged": true,
    "usePlangramPrice": false,
    "useMachineTaxRate": true,
    "useMachineCommissionRate": false,
    "lastHeartBeat": {
      "server": "2024-03-15T10:28:00Z",
      "local": "2024-03-15T10:27:57Z"
    },
    "lastCashSale": {
      "server": "2024-03-15T09:14:22Z",
      "local": "2024-03-15T09:14:19Z"
    },
    "lastCreditSale": {
      "server": "2024-03-15T10:02:05Z",
      "local": "2024-03-15T10:02:02Z"
    },
    "lastAccountSale": {
      "server": "2024-03-14T15:33:11Z",
      "local": "2024-03-14T15:33:08Z"
    },
    "latestRestockToPicklist": {
      "server": "2015-04-22T10:53:20.883",
      "local": "2015-04-22T10:53:17.617"
    },
    "offerSmsReceipts": 1
  }
]

On Error

HTTP Code	Error Code	Definition
404	MISSING_RECORD	One or more of the provided machine identifiers did not match any known machines.