Password
How to execute the authorization flow and get your access token
The
password grant type is used by sales channels to exchange a 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.
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.POST https://yourdomain.commercelayer.io/oauth/token
Body parameter | Type | Required | Description |
|---|---|---|---|
grant_type | string | Required | password |
username | string | Required | The customer email address. |
password | string | Required | The customer password. |
client_id | string | Required | Your API client client_id. |
scope | string | Optional | Your access token scope (market, stock location). |
The access token scope is a string composed by
"market:{{market_number}}", where market_number is the number of the market you want to put in scope.Request
Response
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 number "1234":curl -g -X POST \
'https://yourdomain.commercelayer.io/oauth/token' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"grant_type": "password",
"username": "[email protected]",
"password": "secret",
"client_id": "your-client-id",
"scope": "market:1234"
}'
On success, the API responds with a
200 OK status code, returning the requested access token and customer info, along with a refresh token:{
"access_token": "your-access-token",
"token_type": "bearer",
"expires_in": 7200,
"refresh_token": "your-refresh-token",
"scope": "market:1234",
"created_at": 123456789,
"owner_id": "zxcVBnMASd",
"owner_type": "customer"
}
Last modified 4mo ago