sessionLoginForPOS Mutation

Description

Authenticates a user for point-of-sale (POS) access using a device registration and passcode. The device must be previously registered using sessionRegisterDevice. Validates the passcode against the user's passcode. Extends the device registration expiration. Returns a new POS session.

mutation sessionLoginForPOS(
  $registrationRef: ID!
  $userRef: ID!
  $passcode: String!
) {
  sessionLoginForPOS(
    registrationRef: $registrationRef
    userRef: $userRef
    passcode: $passcode
  ) {
    _id
    configRef
    type
    user {
      _id
      firstName
      lastName
      name
      email
      addedAt
      type
      hasIntercom
      hasPasscode
      passwordToken
      lastLogin
    }
    jwt
    expires
    createdAt
    origin
    adminDomains {
      _id
      siteName
      active
      domainName
    }
    shopName
    admins {
      _id
      email
      name
      avatar
      hasPasscode
    }
    deviceName
    deviceId
    mfa
    ip
  }
}

Variables

{
    "registrationRef": "e22489668471078ac0946b4c",
    "userRef": "4a32e4d4f7a8f47c504119ee",
    "passcode": "passcode"
}

Response

{
    "sessionLoginForPOS": {
        "_id": "2c7f54b0c1fbfbfda1fcba6f",
        "configRef": "f274588d0e5b181c7c702c0f",
        "type": "example",
        "user": {
            "_id": "9421d80135bb64235ca95ca6",
            "firstName": "example",
            "lastName": "example",
            "name": "example",
            "email": "email@example.com",
            "addedAt": 1728986161773,
            "type": "example",
            "hasIntercom": true,
            "hasPasscode": true,
            "passwordToken": "example",
            "lastLogin": 1749000665060
        },
        "jwt": "example",
        "expires": 1753517988874,
        "createdAt": 1710241186509,
        "origin": "example",
        "adminDomains": [
            {
                "_id": "418aa8d3bdc103321273bdf7",
                "siteName": "example",
                "active": true,
                "domainName": "example"
            }
        ],
        "shopName": "example",
        "admins": [
            {
                "_id": "07cb56fc2e04f46fa345d9b6",
                "email": "email@example.com",
                "name": "example",
                "avatar": "example",
                "hasPasscode": true
            }
        ],
        "deviceName": "example",
        "deviceId": "example",
        "mfa": true,
        "ip": "example"
    }
}

Arguments

Name	Type	Description
registrationRef	ID!	Reference ID of the device registration to use for authentication.
userRef	ID!	Reference ID of the user to authenticate.
passcode	String!	Passcode for authentication. Must match the user's configured passcode.

Returns

Session