Record that the browser already reported a purchase to a provider
Public, no session.
Warning
Not fully described yet. The API description has no described successful answer for this operation yet. The method, path, sign-in, rate limits and request fields on this page are read from the server's code and are accurate; what a successful call returns is not written down here yet. Until it is, search engines and the agent index leave this page out.
POST/api/v1/public/orgId/checkout/sessionId/reported
- Sign-in
- None at the router: the operation is public, or checks its own proof (a signature, a token in the body, a signed link).
- Rate limit
- Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted); up to 10 requests a minute per IP address.
Public, no session. Marks the purchase as reported so the server does not send the same conversion to that provider again; answers recorded: false for an unknown provider or malformed session id, never an error.
Request
Path parameters
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
orgId | string | Yes | - | - |
sessionId | string | Yes | - | - |
Send the body as application/json. The body is optional.
Body
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
provider | string or null | No | at most 64 characters | - |
Example request
Replace each YOUR_... value with your own.
curl -X POST "https://api.console.buildbase.app/api/v1/public/YOUR_ORG_ID/checkout/YOUR_SESSION_ID/reported" \
-H "Content-Type: application/json" \
-d '{
"provider": "string"
}'const response = await fetch(
'https://api.console.buildbase.app/api/v1/public/YOUR_ORG_ID/checkout/YOUR_SESSION_ID/reported',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
provider: 'string',
}),
}
);
if (!response.ok) {
throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();import requests
response = requests.post(
"https://api.console.buildbase.app/api/v1/public/YOUR_ORG_ID/checkout/YOUR_SESSION_ID/reported",
json={
"provider": "string",
},
timeout=30,
)
response.raise_for_status()
data = response.textResponses
A successful answer is not described yet. The server answers with the status and body its handler sends.
Any other status
The handler's own answer. Not described yet: response bodies come from captured responses (server/openapi/captured) and overlays (server/openapi/overlays).
Errors
Each refusal, what it means, and what to do. The request changed nothing.
400 Bad Request
What it means: The request failed a validate() schema, or an id in the path is not a valid id. path names the field.
What to do: Fix the field the body names in path (or read message) and send the request again. Nothing was changed.
{
"error": true,
"success": false,
"path": "string",
"message": "string"
}404 Not Found
What it means: An id in the path names nothing in this org.
What to do: Check the ids in the path: one of them names nothing in this organization.
{
"success": false,
"message": "string"
}429 Too Many Requests
What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.
What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.
{
"success": false,
"message": "string",
"reason": "rate_limited",
"retryAfter": 1
}Related
- Checkout guide: how this part of BuildBase works
- All Checkout operations
- API reference: every operation, by tag
- Sign-in and credentials for the HTTP API
- How the HTTP API reports errors
- Make your first call
- Error codes: every
codethe API returns - OpenAPI: operation
checkout.reported.createin public-v1.json