Access Tokens

Use the oauth20/access-tokens to get or delete access tokens.

Methods


					The request headers should be empty.
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					{
  "sessionId": your_session_ID,
  "userId": your_user_ID,
  "externalReferenceId": "external_reference_ID",
  "authenticated": "false",
  "locale": "en_US",
  "currency": "USD",
  "cartId": your_cart_ID,
  "clientIpAddress": null,
  "domain": "api.digitalriver.com",
  "expiresIn": 0,
  "createdOn": "2016-12-02T17:23:44.000Z",
  "lastAccessed": "2016-12-02T17:23:56.985Z",
  "themeId": null,
  "sessionTag": null
}
			
					Host: api.digitalriver.com
User-Agent: Apache-HttpClient/4.5.2 (Java/1.8.0_102)
Accept: application/json
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					{
   "sessionId": your_session_ID,
   "userId": your_user_ID,
   "externalReferenceId": external_reference_ID,
   "authenticated": "true",
   "locale": "en_US",
   "currency": "USD",
   "cartId": your_cart_ID,
   "clientIpAddress": null,
   "domain": "drh-api-ot04.digitalriverws.net",
   "expiresIn": 86397,
   "themeId": null,
   "sessionTag": "session_tag"
}
			

Response Body Parameters

Field
Data Type
Visibility
Description
authenticated
Boolean
default When true, the access token has been authenticated.
cartId
string
default
The cart ID. The ID is assigned automatically when you create a cart.
clientIpAddress
string
default
The client's IP address.
createdOn
date
default
The date the token was created.
currency
string
expand
The shopper's preferred currency.
domain
string default The domain associated with the access token.
expiresIn
int default The time in seconds until this token expires.
externalReferenceId
string
expand
The unique reference ID for a shopper on the remote system. See externalReferenceID for more information.
lastAccessed
date
default
The date the token was last accessed
locale
string
expand
The shopper's preferred locale.
sessionId
string
default
The session ID.
sessionTag
string default A unique session identifier that can be used by multiple tokens. The session tag contains an encrypted list of properties that defines the session; including the locale and currency properties. All access tokens that use the same locale and currency properties also have the same session tag value.
themeId
string
default
The theme's ID.
userId
string
defautl
The shopper's ID.