Skip to content

Easyflow (1.0)

Easyflow API Document

This is the API documentation and must be used by everyone who wants to integrate with the Easyflow platform.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Languages
Servers
Mock server
https://docs.easyflow.digital/_mock/openapi
Production environment URL
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com

Businesses

Operations

Refunds

Operations

Sales

Operations

Subscriptions

Operations

Financials

Operations

Products

Operations

Orders

Operations

Customers

Operations

Webhooks

Operations

Pixel

Operations

Vouchers

Operations

Get voucher by code

Request

Retrieves a voucher using its unique voucher code. This endpoint is typically used by customers or integrations to validate or display voucher information.

Path
codestringrequired

Unique voucher code used to retrieve the voucher.

curl -i -X GET \
  'https://docs.easyflow.digital/_mock/openapi/vouchers/voucher-code/{code}'

Responses

Voucher successfully retrieved.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "id": "9b6f1a2d-7d92-4c0a-bc1d-6a4aafc0e1c2",
    "name": "Premium Sushi Dinner",
    "stockName": "Special Offer",
    "description": "Exclusive dinner experience for two people.",
    "baseValueInCents": 25000,
    "paidValueInCents": 9900,
    "expirationAt": "2026-12-31T03:00:00.000Z",
    "buyerName": "John Doe",
    "buyerEmail": "john.doe@email.com",
    "buyerDocument": { … },
    "buyerPhone": { … },
    "code": "AB12CD",
    "qrCodeLink": "https://cdn.example.com/vouchers/qrcode/9b6f1a2d.png",
    "status": "created",
    "image": { … },
    "voucherTemplateId": "c1e6c4f3-1d32-4f76-9c5b-2bfaeec3f901"
  }
}

Redeem voucher

Request

Redeems a voucher using its unique identifier. Once redeemed, the voucher cannot be used again.

Path
voucherIdstring(uuid)required

Unique identifier of the voucher to be redeemed.

curl -i -X PATCH \
  'https://docs.easyflow.digital/_mock/openapi/vouchers/redeem/{voucherId}'

Responses

Voucher successfully redeemed.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "redeemed": true
  }
}

Cancel voucher redemption

Request

Cancels a previously redeemed voucher. This operation is intended for cases where the redemption happened by mistake. The redemption can only be reverted within 15 minutes after it was performed.

Path
voucherIdstring(uuid)required

Unique identifier of the voucher whose redemption will be canceled.

curl -i -X PATCH \
  'https://docs.easyflow.digital/_mock/openapi/vouchers/cancel-redeem/{voucherId}'

Responses

Voucher redemption successfully canceled.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "cancelRedemption": true
  }
}

Events

Webhooks