Supports multiple custom parameters to invoke hooks in B2C Commerce API. Multiple custom parameters can be added. Use the c_
prefix to distinguish custom query parameters from standard query parameters, for example: c_captcha=true
If there is a validation error, a 400 Bad_Request with the details of the error is thrown.
This type supports additional properties passed along with the defined properties of this API. To indicate that the properties were defined and expected to be handled as additional properties, they are expected to be prefixed with a c_
. The type will reject any property that does not fit this pattern, only allowing additional properties beginning with the known prefix.
c_faxNumber
Value to be sent by the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
client-state
The channel that the request is for. For a B2C Commerce request, this is angalous to the site ID.
RefArch
Must be code
. Indicates that the client wants an authorization code (when the grant type is authorization_code
).
- code
The unique shopper ID.
18cda486-fe32-4e27-888b-6e4f89938e67
Scopes to limit an application's access to a user's account.
openid|offline_access|email
SLAS client ID. Required when the grant type is authorization_code_pkce
.
z99ec276-cg53-4g94-cf72-76f300c6778zc
PKCE code verifier. Created by the client calling the login
endpoint.
The code_challenge
is created by SHA256 hashing the code_verifier
and Base64 encoding the resulting hash.
The code_verifier
should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
The code_challenge
is optional when using a private client id for the token request.
krc5G3_5lRUcXDUzFZQ88oJA_-ZmlHWkyGsgOrSLEWg
The URI to which the server redirects the browser after the user grants the authorization. The URI must be registered with the SLAS client. A variety of URI formats and wildcards for host are supported, but app links like airbnb:// or fb:// are not. Examples of supported URIs:
Examples of supported URIs:
http://localhost:3000/callback
https://example.com/callback
com.example.app:redirect_uri_path
*.subdomain.topleveldomain.com
http://localhost:3000/callback