pair-pos-device

Method: POST
Path: /pos/auth/pair-device

Tags: POS

Summary

Pair POS device

Description

This endpoint allows a POS device to be activated by submitting a valid pairing code received via phone or email. The endpoint requires authentication with an API key that has the scope set to 'storefront' for a particular store, ensuring secure access for device activation operation.

Pos SDK Usage

SDK Method: pos.pairDevice()

Example:

const { data, error } = await pos.pairDevice({
  pairing_code: "ABC123"
});

if (error) {
  console.error("Device pairing failed:", error.message);
} else {
  console.log("Device paired:", data.device.id);
  console.log("Device name:", data.device.name);
  // Store device_id for future use
}

TypeScript Definition

"pair-pos-device": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    pairing_code: string;
                };
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message: string;
                        success: boolean;
                        content: {
                            device: components["schemas"]["PosDevice"];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
        };
    };

Component References

Reference	Resolves To
components["schemas"]["PosDevice"]	PosDevice
components["responses"]["BadRequest"]	BadRequest
components["responses"]["Unauthorized"]	Unauthorized

Request Body

Content Types: application/json

Responses

200

OK

400

Bad request

401

Not authorized for given operation on the Resource

OpenAPI Definition

{
  "tags": [
    "POS"
  ],
  "operationId": "pair-pos-device",
  "summary": "Pair POS device",
  "description": "This endpoint allows a POS device to be activated by submitting a valid pairing code received via phone or email. The endpoint requires authentication with an API key that has the scope set to 'storefront' for a particular store, ensuring secure access for device activation operation.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/pair-pos-device",
    "description": "API reference for the pair-pos-device operation"
  },
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "pairing_code"
          ],
          "properties": {
            "pairing_code": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success",
              "content"
            ],
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "device": {
                    "$ref": "#/components/schemas/PosDevice"
                  }
                },
                "required": [
                  "device"
                ],
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    }
  },
  "security": [
    {
      "X-Api-Key": []
    }
  ],
  "x-speakeasy-group": "pos",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "pairDevice"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions