v4
OpenAPI 3.0.02026-07-31811,0021.1 MBThis 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