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://mobile-docs.easyflow.digital/_mock/openapi/

Production environment URL

https://wz0ppvhzw7.execute-api.sa-east-1.amazonaws.com/

Authentication

Operations

Users

Operations

Organizations

Operations

Sales

Operations

Filter Sales

Request

Retrieve a paginated list of sales with filtering and ordering options.

Security
bearerAuth
Query
pagestringrequired

Page number to access

limitstringrequired

Number of items to be loaded per page

Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

business-idstringrequired

Business Identifier

Bodyapplication/jsonrequired
codesArray of strings

Filter by one or more coupon codes.

emailstring(email)

Filter by buyer email.

namestring

Filter by buyer name.

initialDatestring(date-time)

Filter sales created after this date.

endDatestring(date-time)

Filter sales created before this date.

productNamestring

Filter by product name.

statusArray of strings

Filter by sale status.

Items Enum"pending""paid""partially-paid""canceled""reversed""refunded""charged-back""delayed""failed""charged"
initialValuenumber(float)

Minimum transaction value filter.

endValuenumber(float)

Maximum transaction value filter.

typesArray of strings

Filter by payment types (credit-card, pix, bank-billet).

productIdsArray of strings(uuid)

Filter by one or more product IDs.

fieldstring(uuid)

Field used for text search across multiple sale attributes, such as buyer.name, buyer.email, buyer.document.number, items.name and items.id.

orderByobject

Ordering configuration for the sales list.

curl -i -X POST \
  'https://mobile-docs.easyflow.digital/_mock/openapi/easyflow/sales/list?page=string&limit=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'business-id: string' \
  -H 'x-fingerprint-id: string' \
  -d '{
    "codes": [
      "SALE-12345"
    ],
    "email": "john.doe@example.com",
    "name": "John Doe",
    "cpf": "12345678901",
    "initialDate": "2024-09-12T00:00:00.000Z",
    "endDate": "2024-09-13T23:00:00.000Z",
    "productName": "Curso de Programação",
    "status": [
      "paid",
      "reversed"
    ],
    "initialValue": 0,
    "endValue": 5000,
    "types": [
      "credit-card",
      "pix"
    ],
    "productIds": [
      "e55b40af-935f-4d6a-b520-8820f84b06a7"
    ],
    "field": "76fb9f83-0b48-4fce-9350-1246227728e8",
    "orderBy": {
      "orderByField": "createdAt",
      "orderDirection": "DESC"
    }
  }'

Responses

Successfully retrieved list of sales.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "sales": { … },
    "ticketsCount": 16,
    "totalTransactionValue": 240000,
    "totalCommissions": 15000
  }
}

Get order details

Request

Retrieve detailed information about a specific order, including buyer, items, payments, commissions, and refund information.

Security
bearerAuth
Path
orderIdstringrequired

Unique identifier of the order to retrieve.

Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

business-idstringrequired

Business Identifier

curl -i -X GET \
  'https://mobile-docs.easyflow.digital/_mock/openapi/easyflow/orders/{orderId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'business-id: string' \
  -H 'x-fingerprint-id: string'

Responses

Successful response with order details

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "id": "string",
    "date": "2019-08-24T14:15:22Z",
    "paidAt": "2019-08-24T14:15:22Z",
    "status": "pending",
    "totalCommissionValueInCents": 0,
    "orderBuyer": { … },
    "coupon": { … },
    "refundable": true,
    "refundableUntil": "2019-08-24T14:15:22Z",
    "refundRequest": { … },
    "items": [ … ],
    "payments": [ … ],
    "statusHistory": [ … ]
  }
}

Filter total sales

Request

Retrieve the total number of transactions per payment method based on optional filters such as date range, status, or free sales.

Security
bearerAuth
Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

business-idstringrequired

Business Identifier

Bodyapplication/json
freeSalesboolean

Include or exclude free sales.

initialDatestring(date-time)
endDatestring(date-time)
statusArray of strings
Items Enum"pending""paid""partially-paid""canceled""reversed""refunded""charged-back"
curl -i -X POST \
  https://mobile-docs.easyflow.digital/_mock/openapi/easyflow/sales/total-sales \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'business-id: string' \
  -H 'x-fingerprint-id: string' \
  -d '{
    "freeSales": true,
    "initialDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "status": [
      "pending"
    ]
  }'

Responses

Total sales per payment method successfully retrieved.

Bodyapplication/json
statusCodeinteger
dataobject
Response
application/json
{
  "statusCode": 0,
  "data": {
    "count": 0,
    "pix": { … },
    "creditCard": { … },
    "boleto": { … },
    "free": { … }
  }
}

Commissions

Operations

Financial

Operations

Subscriptions

Operations