onBehalfOf
post
/ccagent/v1/onBehalfOf
Generate On-Behalf-Of access token.
Request
Supported Media Types
- application/json
Root Schema : onbehalfof_request
Type:
Show Source
object
-
shopperProfileId(optional):
string
Profile Id of the Shopper.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : onbehalfof_response
Type:
Show Source
object
-
access_token(optional):
string
Refreshable OAuth token.
-
expires_in(optional):
integer
Time in seconds until token expires.
-
token_type(optional):
string
OAuth token type.
Example Response (application/json)
{
"access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MTQxNDk5NTYsInN1YiI6IjExMDU1OCIsImlzcyI6InN0b3JlZnJvbnRVSSIsImlhdCI6MTQxNDE0OTAyNn0=.B9qM0/VKpCNKvjCmOnUPv4RS7mkIDgKcP8RJPaVQGYU=",
"token_type":"bearer",
"expires_in":930
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code