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

Filter sales

Request

Returns a list of sales.

Query
pagestringrequired

Page number to access

limitstringrequired

Number of items to be loaded per page

Headers
x-api-keystringrequired

Api key provided on integrations tab in Easyflow platform.

x-api-secretstringrequired

Api Secret provided on integrations tab in Easyflow platform.

business-idstringrequired

Business Identifier

Bodyapplication/json

Optional Fields for Sales Filtering

codesArray of strings
emailstring
namestring
cpfstring
initialDatestring
endDatestring
productNamestring
statusArray of strings

Filter by the specified status, such as: pending, paid, canceled, reversed, refunded, charged-back, partially-paid

initialValueinteger
endValueinteger
typesArray of strings

Filter by the specified types, such as: credit-card, pix, bank-billet, crypto, debit-card

productIdsArray of strings
fieldstring
orderByobject
curl -i -X POST \
  'https://docs.easyflow.digital/_mock/openapi/sales/filter?page=string&limit=string' \
  -H 'Content-Type: application/json' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -d '{
    "codes": [
      "string"
    ],
    "email": "string",
    "name": "string",
    "cpf": "string",
    "initialDate": "string",
    "endDate": "string",
    "productName": "string",
    "status": [
      "string"
    ],
    "initialValue": 0,
    "endValue": 0,
    "types": [
      "string"
    ],
    "productIds": [
      "string"
    ],
    "field": "string",
    "orderBy": {
      "orderByField": "string",
      "orderDirection": "string"
    }
  }'

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
  }
}

Subscriptions

Operations

Financials

Operations

Products

Operations

Orders

Operations

Customers

Operations

Webhooks

Operations

Pixel

Operations

Events

Webhooks