# Easyflow This is the API documentation and must be used by everyone who wants to integrate with the Easyflow platform. - [Pixel SDK](https://www.npmjs.com/package/@easyflow/pixel) - [Web SDK](https://www.npmjs.com/package/@easyflow/javascript-sdk) Easyflow API Document Version: 1.0 License: ## Servers ``` https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com ``` ## Security ### token Type: http Scheme: bearer ## Download OpenAPI description [Easyflow](https://docs.easyflow.digital/_spec/openapi.yaml) ## Businesses ### Get balance - [GET /business/balance](https://docs.easyflow.digital/openapi/businesses/business/balance.md): Api to retreive balance from business. ### List businesses by owner - [GET /business/list-businesses-by-owner](https://docs.easyflow.digital/openapi/businesses/get-business-list-business-by-owner.md): Returns all businesses associated with the owner ## Refunds ### List order revert request - [GET /order-revert-requests/list](https://docs.easyflow.digital/openapi/refunds/get-order-revert-requests-list.md): Returns a list of refunds. ## Sales ### Filter sales - [POST /sales/filter](https://docs.easyflow.digital/openapi/sales/post-sales-list.md): Returns a list of sales. ## Subscriptions ### Filter subscription - [POST /subscriptions/filter](https://docs.easyflow.digital/openapi/subscriptions/post-subscriptions-list.md): Returns a list of subscriptions. ### Get subscription - [GET /subscriptions/{subscriptionId}](https://docs.easyflow.digital/openapi/subscriptions/get-subscriptions-:subscriptionid.md): Use it to get subscription ## Financials ### Filter withdraw request - [POST /withdraw-requests/filter](https://docs.easyflow.digital/openapi/financials/post-withdraw-requests-list.md): Returns a list of withdraw requests. ### Filter movement - [POST /movement/filter](https://docs.easyflow.digital/openapi/financials/post-movement-list.md): Returns a list of movements. ### List commissions - [GET /commissions/list](https://docs.easyflow.digital/openapi/financials/get-commissions-list.md): Returns a list of commissions. ## Products ### Filter products - [POST /products/filter](https://docs.easyflow.digital/openapi/products/post-products-list.md): Returns a list of products. ### List offers by product id - [GET /offers/list-by-product/{productId}](https://docs.easyflow.digital/openapi/products/get-offers-list-by-product-:productid.md): Returns a list of offers. ## Orders ### Get order - [GET /orders/{orderId}](https://docs.easyflow.digital/openapi/orders/get-orders-:orderid.md): Use it to get order ### Create charge - [POST /orders/create-charge](https://docs.easyflow.digital/openapi/orders/get-orders-charge.md): route to create charge ## Customers ### List customers - [GET /customers/list](https://docs.easyflow.digital/openapi/customers/get-customers-list.md): Returns a list of customers. ### Get customers - [GET /customers/{customerId}](https://docs.easyflow.digital/openapi/customers/get-customers-customerid.md): Use it to get order ### Remove customer - [DELETE /customers/remove/{customerId}](https://docs.easyflow.digital/openapi/customers/remove-customer.md): Use it to remove customer ### Create customer - [POST /customers](https://docs.easyflow.digital/openapi/customers/create-customers.md): Route to create customer ### Update customer - [PATCH /customers/update/{customerId}](https://docs.easyflow.digital/openapi/customers/patch-customers-update-customerid.md) ## Payment Link ### Create payment link - [POST /payment-links](https://docs.easyflow.digital/openapi/payment-link/get-payment-links.md): Route to create payment link ### Update payment link - [PATCH /payment-links/{paymentLinkId}](https://docs.easyflow.digital/openapi/payment-link/get-payment-links-paymentlinkid.md): Route to update payment link. ⚠️ It will not be possible to update the payment link if there is a sale. ### List payments link - [GET /payment-links/list](https://docs.easyflow.digital/openapi/payment-link/get-payments-link-list.md): Returns a list of payment links. ### Get payment link - [GET /payment-links/details/{paymentLinkId}](https://docs.easyflow.digital/openapi/payment-link/get-payment-links-details-paymentlinkid.md): Use it to get order ### Active payment link - [PATCH /payment-links/publish/{paymentLinkId}](https://docs.easyflow.digital/openapi/payment-link/get-payment-links-publish-paymentlinkid.md): Activate a payment link ### Inactive payment link - [PATCH /payment-links/unpublish/{paymentLinkId}](https://docs.easyflow.digital/openapi/payment-link/get-payment-links-unpublish-paymentlinkid.md): Inactive a payment link ### Delete payment link - [DELETE /payment-links/delete/{paymentLinkId}](https://docs.easyflow.digital/openapi/payment-link/get-payment-links-delete-paymentlinkid.md): Delete a payment link ### Upload image payment link - [PATCH /payment-links/upload-image/{paymentLinkId}](https://docs.easyflow.digital/openapi/payment-link/get-payment-links-upload-image-paymentlinkid.md): Add an image to the payment link. ⚠️ File upload may not work here due to documentation limitations. Try using Postman or curl to test it properly. ⚠️ It will not be possible to update the image if there is a sale on the payment link ## Pixel ### Create pixel - [POST /pixels](https://docs.easyflow.digital/openapi/pixel/post-pixels.md): This route allows you to create a tracking pixel linked to your account, with support for Google and Meta platforms. After creation, the pixel must be integrated into your website or application using our official SDK to ensure proper event sending and tracking. 👉 Access the SDK and usage instructions: SDK ### Update pixel - [PATCH /pixels/{pixelId}](https://docs.easyflow.digital/openapi/pixel/patch-pixels-id.md): Route to update pixel. ### List pixels - [GET /pixels/list](https://docs.easyflow.digital/openapi/pixel/get-pixels-list.md): Returns a list of pixels. ### Get pixel - [GET /pixels/details/{pixelId}](https://docs.easyflow.digital/openapi/pixel/get-pixels-details-pixelid.md): returns the details of a pixel ### Delete pixel - [DELETE /pixels/delete/{pixelId}](https://docs.easyflow.digital/openapi/pixel/delete-pixels-pixelid.md): route to delete pixel