List offers by product id

GET/offers/list-by-product/{productId}

Returns a list of offers of the product.

Offers of products of the types face-to-face event and voucher are not returned. For these products, the list is empty.
pix, billet and creditCard turn on their filter with any non-empty value, false included. To skip a filter, do not send the parameter or send it empty.

Request

curl --request GET \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/offers/list-by-product/PRODUCT_ID?page=1&limit=10' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/offers/list-by-product/PRODUCT_ID?page=1&limit=10', {
  method: 'GET',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
  },
});

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

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/offers/list-by-product/PRODUCT_ID?page=1&limit=10"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
}

response = requests.get(url, headers=headers)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "docs": [
      {
        "id": "6b8d0f2b-4d6f-4b0d-8f4b-6d8f0b2d0024",
        "businessId": "8b1d2f4e-5a6c-4e7f-9a0b-1c2d3e4f5a6b",
        "name": "Monthly plan",
        "checkoutTemplateId": "7c9e1a3c-5e7a-4c1e-8a5c-7e9a1c3e0025",
        "checkoutTemplateName": "Default checkout",
        "description": "Monthly access to the course",
        "endDate": "2026-12-31",
        "initialDate": "2026-01-01",
        "warrantyInDays": 7,
        "status": "active",
        "createdAt": "2025-04-28T17:06:02.120Z",
        "preference": {
          "showSellerName": true,
          "requestAddress": true,
          "acceptNaturalPersonBuyer": true,
          "acceptCorporationBuyer": true,
          "requestDeliveryAddress": false,
          "requireEmailReentry": false,
          "disableCouponForm": false
        },
        "paymentConfiguration": {
          "pix": {
            "expirationInMinutes": 40
          },
          "billet": {
            "dueDateDelay": 1
          },
          "creditCard": {
            "defaultInstallments": 1,
            "maxInstallments": 2,
            "invoiceDescription": "MonthlyPlan"
          }
        },
        "advanced": {
          "redirect": {
            "url": "https://example.com/thank-you",
            "buttonName": "Access the course",
            "delayInSeconds": 5
          }
        },
        "items": [
          {
            "id": "8d0f2b4d-6f8b-4d2f-8b6d-8f0b2d4f0026",
            "name": "Monthly plan",
            "priceWithoutDiscountValueInCents": 1500,
            "product": {
              "id": "9e1a3c5e-7a9c-4e3a-8c7e-9a1c3e5a0027",
              "name": "Online course",
              "description": "Lifetime access to the online course",
              "type": "Online-Course",
              "image": {
                "name": null,
                "path": null,
                "url": null,
                "isPublic": null,
                "extension": null
              }
            },
            "priceInCents": 1000,
            "optional": false,
            "offerItemType": "recurrent",
            "recurrence": {
              "periodicity": "Monthly",
              "numberRecurrence": 0,
              "recurrenceValueInCents": 1500,
              "repeatIndefinitely": true,
              "customValue": {
                "recurrenceFrom": 1,
                "recurrenceTo": 5,
                "valueInCents": 1000
              }
            }
          }
        ]
      }
    ],
    "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.

Path parameters

productIdstringrequired

Query parameters

pageintegerrequired
Page number to access

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

Example:10
namestring
Part of the name of the offer. The search is case sensitive. field ignores case, but it also matches the name of the product and the ID of the offer.
offerTypestring
Returns only the offers with items of this type.

Possible values:unique-purchaserecurrentinvoicetax
pixboolean
Send true to return only the offers with PIX configured. Any non-empty value turns on this filter, false included.
billetboolean
Send true to return only the offers with bank billet configured. Any non-empty value turns on this filter, false included.
creditCardboolean
Send true to return only the offers with credit card configured. Any non-empty value turns on this filter, false included.
fieldstring
Text searched in the name of the offer, in the name of the product or in the ID of the offer. The search ignores uppercase and lowercase and matches part of the text.
orderBy[orderByField]string
Field to order by. Send it together with orderBy[orderDirection].

Possible values:createdAtupdatedAtnamevalueInCentstype
orderBy[orderDirection]string
Ascending (ASC) or descending (DESC) order. Send it together with orderBy[orderByField].

Possible values:ASCDESC