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/

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

Businesses

Operations

Refunds

Operations

Sales

Operations

Subscriptions

Operations

Financials

Operations

Products

Operations

Orders

Operations

Get order

Request

Use it to get order

Path
orderIdstringrequired
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/orders/{orderId}' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

returns the details of a order

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "id": "string",
    "date": "string",
    "paidAt": "string",
    "status": "string",
    "orderBuyer": { … },
    "coupon": { … },
    "items": [ … ],
    "payments": [ … ],
    "statusHistory": [ … ]
  }
}

Create charge

Request

route to create charge

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
buyerobject
itemsArray of objectsrequired
items[].​externalReferenceIdstring
items[].​namestringrequired
items[].​descriptionstringrequired
items[].​imageReferencestring
items[].​quantityintegerrequired
items[].​priceInCentsintegerrequired
items[].​paymentLinkIdstring
items[].​commissionedParticipantsArray of objects
paymentsArray of objectsrequired
payments[].​methodstringrequired

method, such as: pix, credit-card, bank-billet

payments[].​numberInstallmentsintegerrequired
payments[].​valueInCentsintegerrequired
payments[].​creditCardobject

in the case of credit card purchases, all this information is mandatory

curl -i -X POST \
  https://docs.easyflow.digital/_mock/openapi/orders/create-charge \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -d '{
    "businessId": "string",
    "buyer": {
      "customerId": "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": "string",
        "number": "string"
      },
      "phone": {
        "areaCode": "string",
        "ddd": "string",
        "number": "string",
        "isMobile": true
      }
    },
    "items": [
      {
        "externalReferenceId": "string",
        "name": "string",
        "description": "string",
        "imageReference": "string",
        "quantity": 0,
        "priceInCents": 0,
        "paymentLinkId": "string",
        "commissionedParticipants": [
          {
            "commissionedId": "string",
            "commissionedValueInCents": 0,
            "commissionedPercentage": 0
          }
        ]
      }
    ],
    "payments": [
      {
        "method": "string",
        "numberInstallments": 0,
        "valueInCents": 0,
        "creditCard": {
          "token": "string",
          "flag": "string",
          "last4Numbers": "string",
          "expiresAtMonth": 0,
          "expiresAtYear": 0,
          "holderName": "string"
        }
      }
    ]
  }'

Responses

order creation was successful

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

Customers

Operations

Pixel

Operations