PosDevice

Type: schema

TypeScript Definition

PosDevice: {{
            readonly id: string;
            name: string;
            /** @enum {string} */
            device_type: "pos-terminal";
            /** @description A Device ID shared by POS device provider. */
            readonly external_device_id: string;
            vendor: string;
            model_number: string;
            mac_address: string | null;
            location_id: string;
            readonly location_name: string;
            /** @description Returns a user object if the device is claimed, otherwise returns null. */
            claimed_by: components["schemas"]["PosDeviceClaimedUser"] | null;
            /** @enum {string} */
            readonly status: "available" | "claimed" | "offline";
            readonly is_busy: boolean;
        };
        /** PosDeviceClaimedUser */
}

Component References

Reference	Resolves To
components["schemas"]["PosDeviceClaimedUser"]	PosDeviceClaimedUser

OpenAPI Schema

{
  "title": "PosDevice",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/PosDevice",
    "description": "API reference for the PosDevice schema"
  },
  "required": [
    "id",
    "name",
    "device_type",
    "external_device_id",
    "vendor",
    "model_number",
    "mac_address",
    "location_id",
    "location_name",
    "claimed_by",
    "status",
    "is_busy"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "device_type": {
      "type": "string",
      "enum": [
        "pos-terminal"
      ]
    },
    "external_device_id": {
      "description": "A Device ID shared by POS device provider.",
      "type": "string",
      "readOnly": true
    },
    "vendor": {
      "type": "string"
    },
    "model_number": {
      "type": "string"
    },
    "mac_address": {
      "type": [
        "string",
        "null"
      ]
    },
    "location_id": {
      "type": "string"
    },
    "location_name": {
      "type": "string",
      "readOnly": true
    },
    "claimed_by": {
      "description": "Returns a user object if the device is claimed, otherwise returns null.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/PosDeviceClaimedUser"
        },
        {
          "type": "null"
        }
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "available",
        "claimed",
        "offline"
      ],
      "readOnly": true
    },
    "is_busy": {
      "type": "boolean",
      "readOnly": true
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions