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

Get customers

Request

Use it to get order

Path
customerIdstringrequired
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/customers/{customerId}' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

returns the details of a customer

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

Remove customer

Request

Use it to remove customer

Path
customerIdstringrequired
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 DELETE \
  'https://docs.easyflow.digital/_mock/openapi/customers/remove/{customerId}' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

returns true if you managed to delete the customer.

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

Create customer

Request

Route to create customer

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.

Bodyapplication/json
businessIdstringrequired
namestringrequired
emailstringrequired
addressobject
deliveryAddressobject
documentobjectrequired
document.​typestring
Enum"CPF""CNPJ"
document.​numberstring
phoneobject
curl -i -X POST \
  https://docs.easyflow.digital/_mock/openapi/customers \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -d '{
    "businessId": "string",
    "name": "string",
    "email": "string",
    "address": {
      "zipCode": "string",
      "street": "string",
      "complement": "string",
      "neighborhood": "string",
      "city": "string",
      "state": "string",
      "number": "string"
    },
    "deliveryAddress": {
      "zipCode": "string",
      "street": "string",
      "complement": "string",
      "neighborhood": "string",
      "city": "string",
      "state": "string",
      "number": "string"
    },
    "document": {
      "type": "CPF",
      "number": "string"
    },
    "phone": {
      "areaCode": "string",
      "ddd": "string",
      "number": "string",
      "isMobile": true
    }
  }'

Responses

returns customer if you managed to create the customer.

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

Webhooks

Operations

Pixel

Operations

Events

Webhooks