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

Filter products

Request

Returns a list of products.

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 products Filtering

statusstring

Filter by the specified status, such as: draft, available, unavailable

typestring

Filter by the specified type, such as: Online-Course, Mentoring, Consultancy, Subscription, Community, Online-Event, Face-to-face-Event, E-Book, Downloadable-File, App, Physical-Product, Others, Services

productIdsArray of strings
createdAtobject
updatedAtobject
curl -i -X POST \
  'https://docs.easyflow.digital/_mock/openapi/products/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 '{
    "status": "string",
    "type": "string",
    "productIds": [
      "string"
    ],
    "createdAt": {
      "startsAt": "string",
      "endsAt": "string"
    },
    "updatedAt": {
      "startsAt": "string",
      "endsAt": "string"
    }
  }'

Responses

Returns a list of withdraw requests.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "docs": [ … ],
    "limit": 0,
    "currentPage": 0,
    "nextPage": 0,
    "totalPages": 0,
    "totalDocs": 0,
    "hasNext": true
  }
}

List offers by product id

Request

Returns a list of offers.

Path
productIdstringrequired
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.

curl -i -X GET \
  'https://docs.easyflow.digital/_mock/openapi/offers/list-by-product/{productId}?page=string&limit=string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

Returns a list of products.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "docs": [ … ],
    "limit": 0,
    "currentPage": 0,
    "nextPage": 0,
    "totalPages": 0,
    "totalDocs": 0,
    "hasNext": true
  }
}

Orders

Operations

Customers

Operations

Pixel

Operations