Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ready2order Coupon API

Coupons are gift cards and vouchers that merchants sell and later accept as payment at the point of sale. The `coupon_value` field always holds the current remaining balance.**Balance and Lifecycle**You create a coupon with an initial value. From there you can [charge it](#operation/couponChargeById) (add value) or [redeem it](#operation/couponRedeemById) (deduct value). Partial redemptions work fine; the coupon stays active until the balance reaches zero.**Coupon Purpose**`coupon_purpose` determines when VAT is due. We distinguish between two voucher types:| Purpose | When VAT is due | `coupon_containsVat` ||---------|-----------------|----------------------|| `single` | At issuance (place of supply and tax rate are known at creation) | The applicable rate, e.g. `20` || `multi` | At redemption (the POS applies the right rate per item) | Must be `0` |Single-purpose suits vouchers for specific goods at a fixed rate, such as a drink voucher tied to a particular product.Multi-purpose fits general gift cards redeemable for anything or across multiple locations.Check with your tax advisor which type applies to your situation.**Identifier**`coupon_identifier` is the numeric code printed on physical voucher cards. If you leave it out, an EAN-13 code is generated automatically. Pass it as the `identifier` query parameter on [GET /coupons](#operation/couponGetAll) to look up a coupon by barcode scan.

Ready2order Coupon API is one of 36 APIs that Ready2order publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Coupon. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 4 paths. It is described by OpenAPI 3.0.0, at version R2-2026.30.2.

Requests are made against a single base URL, https://api.ready2order.com/v1.

7 operations 4 paths 0 schemas 1 DELETE2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
R2-2026.30.2
Base URL
https://api.ready2order.com/v1
Authentication
API Key
Contact
support@ready2order.com
License
proprietary
Resource Areas
1

Authentication & Security 1

Ready2order Coupon API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer).

  • Bearer — Account Token obtained after completing the authorization flow. See First Steps for details.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Coupon 7

Coupons are gift cards and vouchers that merchants sell and later accept as payment at the point of sale. The couponvalue field always holds the current remaining balance. Balance…

GET
/coupons
List coupons
couponGetAll 4 params → 200401403
POST
/coupons
Create a coupon
couponCreate body → 200400401403
GET
/coupons/{id}
Get a coupon
couponFindById 1 param → 200401403404
PUT
/coupons/{id}
Update a coupon
couponUpdateById 1 param body → 200400401403404
DELETE
/coupons/{id}
Delete a coupon
couponDeleteById 1 param → 200400401403404
POST
/coupons/{id}/charge
Charge a coupon
couponChargeById 1 param body → 200400401403404
POST
/coupons/{id}/redeem
Redeem a coupon
couponRedeemById 1 param body → 200400401403404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ready2order-coupon-api-openapi.yml Raw ↑

Other APIs Ready2order publishes across the network.

Ready2order Account Token API
Ready2order Accounting Financial Year API
Ready2order Bill API
Ready2order Bill Type API
Ready2order Country API
Ready2order Coupon Category API
Ready2order Currency API
Ready2order Customer API
Ready2order Customer Group API
Ready2order Daily Report API
Ready2order Device API
Ready2order Discount API