POS

Estimates the points, cashback and availability dates for a sale without saving an order.

Changed on

Send the same body as POST /v1/pvt/POS/orders. The estimate in Result uses the submitted sale, even if an order with the same OriginalId exists. The estimate applies the store's customer enrollment rules.

Required permission: Pos (Admin: PDV / POS - Acesso)

post/v1/pvt/POS/orders/estimate

Request

  • Base URL
    https://api.bonifiq.com.br
  • Auth
    HTTP basic

Request body

OriginalIdstring

This is the Id in the client store.

OrderPlacementDatestring date-time

Date of the customer's purchase.

OrderCompletedDatestring date-time nullable

Date the order reached the completed state (usually it's invoiced or delivered).

OrderCancelledDatestring date-time nullable

if the order is cancelled, contains the date.

OrderStatusstring

Status at the client's order system.

IsCancelledOrReturnedboolean

if true the order was cancelled or returned.

IsCompletedboolean

If true it means the order has reached its final status and points can be awarded to the consumer.

OrderTotalnumber

Can be used at Loyalty Programs. Important: these values should not include Shipping costs.

UpdatedDatestring date-time

the date from the last update on this order.

Couponstring nullable

Coupon code used on this order.

ExternalCouponstring nullable

Example request

{
  "TradePolicy": {
    "OriginalId": "OUTLET",
    "Name": "Loja Outlet"
  }
}

Response

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.

Changes