Skip to content
On this page

login

Definition

Login user to shopware instance.

Signature

ts
export async function login(
  parameters: { username?: string; password?: string } = {},
  contextInstance: ShopwareApiInstance = defaultInstance,
): Promise<ContextTokenResponse> 

Parameters

NameTypeDescription
parameters
{ username?: string; password?: string }
username and password
contextInstance
ShopwareApiInstance
ShopwareApiInstance

Return type

ts
Promise<ContextTokenResponse>

Properties

NameTypeDescription

Usage example

WARNING

Example is generated automatically. Sometimes it's required to be adjusted to your needs.

Open in StackBlitz

login has loaded