Password

How to execute the authorization flow and get your access token

The password grant type is used by sales channels to exchange customer credentials for an access token (i.e. to get a "logged" access token).

By including a scope in the access token request, all the resources that you fetch are automatically filtered.

Getting an access token

To get an access token using the password grant type, send a POST request to the /oauth/token endpoint, passing the API client credentials in the request body.

Request

POST https://auth.commercelayer.io/oauth/token

Arguments

Body parameterTypeRequiredDescription

grant_type

String

Required

password

username

String

Required

The customer's email address.

password

String

Required

The customer's password.

client_id

String

Required

Your application's client ID.

scope

String

Optional

Your access token scope (market, stock location).

Example

Sales channel

The following request tries to get an access token for a sales channel API client, using the password grant type for a specific user, putting in scope the market identified by the ID "xYZkjABcde":

curl -g -X POST \
  'https://auth.commercelayer.io/oauth/token' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "grant_type": "password",
  "username": "john@example.com",
  "password": "s3creT",
  "client_id": "{{your_client_id}}",
  "scope": "market:id:xYZkjABcde"
}'

Last updated