Skip to content

PosUser

Type: schema

TypeScript Definition

typescript
PosUser: {{
            id: string;
            first_name: string;
            last_name: string | null;
            phone: string;
            /** Format: email */
            email: string;
            channel: {
                id: string;
                name: string;
            };
            device: {
                id: string;
                name: string;
            } | null;
            location: {
                id: string;
                name: string;
            };
            roles: {
                location_id: string;
                location_name: string;
                role_id?: string;
                role_name?: string;
            }[];
        };
        /** Product */
}

OpenAPI Schema

json
{
  "title": "PosUser",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/PosUser",
    "description": "API reference for the PosUser schema"
  },
  "required": [
    "id",
    "first_name",
    "last_name",
    "phone",
    "email",
    "channel",
    "device",
    "location",
    "roles"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "phone": {
      "type": "string"
    },
    "email": {
      "type": "string",
      "format": "email"
    },
    "channel": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "device": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "location": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "roles": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "location_id",
          "location_name"
        ],
        "properties": {
          "location_id": {
            "type": "string"
          },
          "location_name": {
            "type": "string"
          },
          "role_id": {
            "type": "string"
          },
          "role_name": {
            "type": "string"
          }
        }
      }
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: