Sign in

v4

OpenAPI 3.0.02026-07-31811,0021.1 MB
Checkout

Simulates purchase points for the current checkout/cart state.

BonifiQ fetches the checkout from the configured platform integration and uses the platform total. Any Total property sent by legacy clients is ignored by model binding because it is not part of this request contract.

post/v1/pvt/Checkout/simulate

Request body

CustomerIdstring nullable

Optional customer identifier resolved according to the tenant checkout customer lookup setting.

CheckoutIdstring

The checkout/cart ID from the e-commerce platform.

Response

The simulated purchase points and cashback.

ErrorMessagestring nullable

Error message returned when the request fails validation or processing. For warnings and successful responses, consumers should usually inspect Result, Code and Severity first.

ErrorCodeinteger nullable

Legacy numeric error code derived from internal API errors when available. This field is relevant only for error flows that use ApiResponseErrorDescription.

Codestring nullable

Endpoint-specific business code formatted as a two-digit string, such as 03 or 07. This field is available for success, warning and error outcomes.

CodeNamestring nullable

Symbolic enum name associated with Code, such as CheckoutNotFound.

Severity0 | 1 | 2

0 = Success 1 = Warning 2 = Error

HasWarningboolean

Convenience flag that is true when Severity is Warning. Warnings are valid 200 OK business outcomes and should not be handled as transport or validation errors.

HasErrorboolean

Indicates whether the request failed and should be handled as an error response. This flag is reserved for real API errors; warnings must keep this property as false.