unclaim-pos-device

Method: POST
Path: /pos/devices/{id}/unclaim

Tags: POS

Summary

Unclaim device

Description

Unclaim device

Pos SDK Usage

SDK Method: pos.unclaimDevice()

Example:

const { data, error } = await pos.unclaimDevice({
  id: "01H9DEVICE12345ABCDE"
});

if (error) {
  console.error("Failed to unclaim device:", error.message);
} else {
  console.log("Device unclaimed:", data.message);
}

TypeScript Definition

"unclaim-pos-device": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description device id */
                id: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message: string;
                        success: boolean;
                        content: {
                            user: components["schemas"]["PosUser"];
                        };
                    };
                };
            };
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["schemas"]["PosUser"]	PosUser
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Parameters

• id (path): device id

Responses

200

OK

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "POS"
  ],
  "operationId": "unclaim-pos-device",
  "summary": "Unclaim device",
  "description": "Unclaim device",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/unclaim-pos-device",
    "description": "API reference for the unclaim-pos-device operation"
  },
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "device id",
      "required": true,
      "schema": {
        "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": {
                  "user": {
                    "$ref": "#/components/schemas/PosUser"
                  }
                },
                "required": [
                  "user"
                ],
                "type": "object"
              }
            }
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "pos",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "unclaimDevice"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions