Partial cancellation
Cancels specific items from a confirmed transaction. Returns the redemption (cashback) that should be refunded to the customer and reverts the reward (cashback) generated for those items.
Items are matched by id (SKU) and, when needed, by price — never by the position of the
item inside the request. When the same id appears in more than one line of the order:
- All lines share the same unit price —
priceis optional. Lines are consumed in the order they were sent inrewardByOrder, so cancelling one unit takes the first line that still has an uncancelled quantity. The lines are interchangeable, so the refund is the same whichever one is picked. - The lines have different unit prices —
pricebecomes required. Without it the request fails with409instead of guessing a line, since cancelling the wrong line would refund the wrong amount.
Re-sending every item of the original purchase remains the safest approach.
Try-it values populated from environment ACME (Demo)
Authentication
Token
Send your user token in the x-guper-authorization header. Endpoints that
support a Public mode (e.g. acúmulo and resgate previews) accept the same
request without the header — Private mode adds customer data and a
confirmation token to the response.
Headers
Path parameters
Request body
Content-Type:
application/json