v4

OpenAPI 3.0.02026-07-31811,0021.1 MB
POS

This is shortcut for the original /orders endpoint to add orders into BonifiQ

An important part of the program points is awarding point for purchases that customers made. In order for points to be given we need to receive purchases that the customers made.

Order State

In BonifiQ an order can be in one of these 3 states:

  • Completed: An order in a completed state will receive points according to the configuration in BonifiQ panel
  • Canceled: An order that is incomplete, not paide or returned. If any points was awarded they will be removed
  • Pending: An order that is neither Completed nor Canceled.

You dont need to send pending orders to BonifiQ. You can send them when they are completed (or canceled). The pending state exists for integrations that requires this flow.

To set the State of the order use the IsCompleted and IsCancelledOrReturned fields. Whenever one of them is true the respective OrderCompletedDate or OrderCancelledDate must be set.

Order Status

The OrderStatus field is the status in the platform. This is merely informative

Order Total

This is a very important field as it determines how many points the user will be awarded. This value must not consider shipping costs, taxes, discounts, promotions, giftcard, etc In other words, the value must be what the customer really paid discounted shipping

Coupon

The Coupon field is important as is the way BonifiQ is aware of an used coupon or reward. Use this field as follow:

  • If this order used a reward from the Redeem endpoint, them pass here the ExternalCode return from the redeem api call
  • If this order didt not used an reward from BonifiQ pass here the coupon used by the customer, if available
post/v1/pvt/POS/orders

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

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.