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

List order revert request

Request

Returns a list of refunds.

Query
orderByFieldstring

Field to order by (createdAt)

orderDirectionstring

should be sorted in ascending (ASC) or descending (DESC) order

createdAt[startsAt]string
createdAt[endsAt]string
updatedAt[startsAt]string
updatedAt[endsAt]string
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

curl -i -X GET \
  'https://docs.easyflow.digital/_mock/openapi/order-revert-requests/list?orderByField=string&orderDirection=string&createdAt%5BstartsAt%5D=string&createdAt%5BendsAt%5D=string&updatedAt%5BstartsAt%5D=string&updatedAt%5BendsAt%5D=string&page=string&limit=string' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

Returns a list of refund requests.

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

Sales

Operations

Subscriptions

Operations

Financials

Operations

Products

Operations

Orders

Operations

Customers

Operations

Pixel

Operations