Skip to content

refresh-pos-access-token

Method: POST
Path: /pos/auth/refresh-token

Tags: POS

Summary

Refresh POS access token

Description

Refresh POS access token

Pos SDK Usage

SDK Method: pos.refreshAccessToken()

Example:

typescript
const { data, error } = await pos.refreshAccessToken({
  refresh_token: "refresh-token-here"
});

if (error) {
  console.error("Token refresh failed:", error.message);
} else {
  console.log("New access token:", data.access_token);
  console.log("New refresh token:", data.refresh_token);
  // New tokens are automatically stored by the SDK
}

TypeScript Definition

typescript
"refresh-pos-access-token": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    refresh_token: string;
                };
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message: string;
                        success: boolean;
                        content: {
                            access_token: string;
                            refresh_token: string;
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
        };
    };

Component References

ReferenceResolves To
components["responses"]["BadRequest"]BadRequest

Request Body

Content Types: application/json

Responses

200

OK

400

Bad request

OpenAPI Definition

json
{
  "tags": [
    "POS"
  ],
  "operationId": "refresh-pos-access-token",
  "summary": "Refresh POS access token",
  "description": "Refresh POS access token",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/refresh-pos-access-token",
    "description": "API reference for the refresh-pos-access-token operation"
  },
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "refresh_token"
          ],
          "properties": {
            "refresh_token": {
              "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": {
                  "access_token": {
                    "type": "string"
                  },
                  "refresh_token": {
                    "type": "string"
                  }
                },
                "required": [
                  "access_token",
                  "refresh_token"
                ],
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "pos",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "refreshAccessToken"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: