Error
A valid request URL is required to generate request examples{
"error": {
"message": "Invalid authentication credentials",
"code": "invalid_credentials"
}
}{
"error": {
"message": "The Bearer token does not match the x-supertab-client-id header | Missing or invalid x-supertab-client-id | Invalid subject type {request_subject_type} found, {expected_token_type} expected",
"code": "client_id_mismatch | missing_or_invalid_x_supertab_client_id | invalid_subject_type"
}
}{
"error": {
"message": "Currency not found | No offering price found | Website not found.",
"code": "currency_not_found | offering_price_not_found | site_not_found"
}
}{
"error": [
{
"code": "validation_error",
"message": "Validation Error",
"errors": [
{
"attribute": "query -> subject",
"code": "missing",
"message": "field required"
}
]
}
]
}Endpoints
Retrieve website
Retrieves information about the current website, identified by the Client ID. The response contains information about all the available offerings, configuration for the experiences (e.g. paygates and buttons), and some other metadata.
GET
/
site
Error
A valid request URL is required to generate request examples{
"error": {
"message": "Invalid authentication credentials",
"code": "invalid_credentials"
}
}{
"error": {
"message": "The Bearer token does not match the x-supertab-client-id header | Missing or invalid x-supertab-client-id | Invalid subject type {request_subject_type} found, {expected_token_type} expected",
"code": "client_id_mismatch | missing_or_invalid_x_supertab_client_id | invalid_subject_type"
}
}{
"error": {
"message": "Currency not found | No offering price found | Website not found.",
"code": "currency_not_found | offering_price_not_found | site_not_found"
}
}{
"error": [
{
"code": "validation_error",
"message": "Validation Error",
"errors": [
{
"attribute": "query -> subject",
"code": "missing",
"message": "field required"
}
]
}
]
}Required Scopes
capi:read - Read access to Customer API resourcesAuthorizations
Supertab OAuth2 flow for CAPI. See Authentication.
Headers
The version of the Customer API you are using.
Your Client ID with Supertab. Used to identify the website on which Customer is making a Purchase.
Examples:
"live_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9"
"test_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9"
Response
Successful Response
Was this page helpful?