Filter products

POST/products/filter

Returns a list of products.

Request

curl --request POST \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/products/filter?page=1&limit=10' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'business-id: YOUR_BUSINESS_ID' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "available",
  "type": "Online-Course",
  "productIds": [
    "4f6b8d0f-2b4d-4f8b-8d2f-4b6d8f0b0022",
    "5a7c9e1a-3c5e-4a9c-8e3a-5c7e9a1c0023"
  ]
}'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/products/filter?page=1&limit=10', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
    'business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "status": "available",
    "type": "Online-Course",
    "productIds": [
      "4f6b8d0f-2b4d-4f8b-8d2f-4b6d8f0b0022",
      "5a7c9e1a-3c5e-4a9c-8e3a-5c7e9a1c0023"
    ]
  }),
});

const data = await response.json();
console.log(data);

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/products/filter?page=1&limit=10"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "business-id": "YOUR_BUSINESS_ID",
}
payload = {
    "status": "available",
    "type": "Online-Course",
    "productIds": [
        "4f6b8d0f-2b4d-4f8b-8d2f-4b6d8f0b0022",
        "5a7c9e1a-3c5e-4a9c-8e3a-5c7e9a1c0023",
    ],
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "docs": [
      {
        "id": "2d4f6b8d-0f2b-4d6f-8b0d-2f4b6d8f0020",
        "name": "Project Management",
        "description": "Project Management",
        "status": "available",
        "type": "Subscription",
        "businessId": "8b1d2f4e-5a6c-4e7f-9a0b-1c2d3e4f5a6b",
        "userId": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
        "image": {
          "name": "cover.jpeg",
          "path": "product/2d4f6b8d-0f2b-4d6f-8b0d-2f4b6d8f0020",
          "url": "https://example.com/product/2d4f6b8d-0f2b-4d6f-8b0d-2f4b6d8f0020/cover.jpeg",
          "isPublic": true,
          "extension": "jpeg"
        },
        "createdAt": "2025-01-27T18:46:14.139Z",
        "supportContact": {
          "name": "Support team",
          "email": "support@example.com",
          "validated": true
        },
        "categories": [
          {
            "id": "3e5a7c9e-1a3c-4e7a-8c1e-3a5c7e9a0021",
            "name": "Ecologia e meio ambiente"
          }
        ]
      }
    ],
    "limit": 1,
    "currentPage": 1,
    "nextPage": 2,
    "totalPages": 2,
    "totalDocs": 2,
    "hasNext": true
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

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

Query parameters

pageintegerrequired
Page number to access

Example:1
limitintegerrequired
Number of items to be loaded per page

Example:10

Request body

Optional Fields for products Filtering

Content typeapplication/jsonobject

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
Show child attributesHide child attributes
- startsAtstring
- endsAtstring
updatedAtobject
Show child attributesHide child attributes
- startsAtstring
- endsAtstring

Responses

200Returns a list of withdraw requests.

Returns a list of withdraw requests.

Content typeapplication/jsonobject

statusCodeinteger
Example:200
dataobject
Show child attributesHide child attributes
- docsarray of objects
  Show child attributesHide child attributes
  idstring
  namestring
  descriptionstring
  statusstring
  status returning: draft, available, unavailable
  
  typestring
  type returning: Online-Course, Mentoring, Consultancy, Subscription, Community, Online-Event, Face-to-face-Event, E-Book, Downloadable-File, App, Physical-Product, Others, Services
  
  businessIdstring
  userIdstring
  imageobject
  Show child attributesHide child attributes
  namestring
  pathstring
  urlstring
  isPublicboolean
  extensionstring
  createdAtstring
  updatedAtstring
  supportContactobject
  Show child attributesHide child attributes
  namestring
  emailstring
  validatedboolean
  categoriesarray of objects
  Show child attributesHide child attributes
  idstring
  namestring
- limitinteger
- currentPageinteger
- nextPageintegernullable
- totalPagesinteger
- totalDocsinteger
- hasNextboolean

400If the provided parameter is invalid, the API will return the following error response:

If the provided parameter is invalid, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Invalid param: []

Example:Invalid param: []
errorstring
Bad Request

Example:Bad Request
statusCodeinteger
400

Example:400
errorCodestring
Code that identifies the error. Present only on some errors.

401If the request is unauthorized, the API will return the following error response:

If the request is unauthorized, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Invalid field

Example:Unauthorized
errorstring
Unauthorized

Example:Unauthorized
statusCodeinteger
401

Example:401

403If the request is forbidden, the API will return the following error response:

If the request is forbidden, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Forbidden resource

Example:Forbidden resource
errorstring
Forbidden

Example:Forbidden
statusCodeinteger
403

Example:403

500If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

Content typeapplication/jsonobject

statusCodeinteger
HTTP status code.

Example:500
messagestring
Explanation of the error.

Example:Internal Server Error