Vouchers

post/api/v1.0/{appId}/vouchers/{voucherId}/usage

Request

  • Base URL: https://api.flipdish.co
  • URL: https://api.flipdish.co/api/v1.0/{appId}/vouchers/{voucherId}/usage
  • Auth: OAuth 2 (implicit, authorization URL https://api.flipdish.co/identity/connect/authorize, scopes: api)

Path parameters

appIdstring required
voucherIdinteger required

Request body

IsUsedboolean

Flag indicating whether the voucher is used

UsedByCustomerIdinteger nullable

Indicates Customer that used the voucher.

TransactionKeystring

An opaque string, to ensure idempotency. This allows for safely retrying requests without accidentally performing the same stamp operation twice. This will typically contain the the ID of the sale order.

Response

OK

Changes

No recorded changes to this operation across all 13 revisions of this API.