Get all Products

Retrieve a comprehensive list of products available across all affiliate brands. This endpoint provides detailed product information including pricing, availability, images, and specifications.

HTTP Request

GET https://api-beta.lomadee.com.br/affiliate/products

Query Parameters

page

integer

Page number for pagination. Starts at 1. Default: 1 Example: 2

limit

integer

Number of products per page. Maximum 100. Default: 10 Maximum: 100 Example: 25

string

Search term to filter products by name or description. Example: “smartphone”

price

string

Price range filter in cents. Format: from:to Format: {minPrice}: {maxPrice} (in cents) Example: “7400:8000” (R

74,00 to R

80,00)

organizationIds

string

Filter products by specific brand organization IDs. Multiple IDs separated by commas. Format: UUID separated by commas Example: “e36f5bbb-3e5f-42e2-be4c-6c32dac101c2,12345678-1234-1234-1234-123456789012”

Example Requests

Basic Request

curl -X GET "https://api-beta.lomadee.com.br/affiliate/products" \
  -H "x-api-key: your-api-key"

With Pagination

curl -X GET "https://api-beta.lomadee.com.br/affiliate/products?page=1&limit=20" \
  -H "x-api-key: your-api-key"

curl -X GET "https://api-beta.lomadee.com.br/affiliate/products?search=ar%20condicionado&price=5000:6000" \
  -H "x-api-key: your-api-key"

Filter by Specific Brands

curl -X GET "https://api-beta.lomadee.com.br/affiliate/products?organizationIds=e36f5bbb-3e5f-42e2-be4c-6c32dac101c2" \
  -H "x-api-key: your-api-key"

Response Format

data

array

Array of product objects

Product Object Structure

organizationId

string

Brand organization UUID

string

Product identifier

available

boolean

Product availability status

createdAt

string

Product creation timestamp (ISO 8601)

updatedAt

string

Last update timestamp (ISO 8601)

name

string

Product name/title

description

string

Product description (HTML format)

url

string

Product page URL

images

array

Product images

Show properties

url

string

Image URL

options

array

Product variants/options

Show properties

string

Option identifier

ean

string

European Article Number

name

string

Option name

available

boolean

Option availability

seller

string

Seller identifier

images

array

Option-specific images

Example Response

{
  "data": [
    {
      "_id": "6851c116cd2fe4fb974f9351",
      "organizationId": "e36f5bbb-3e5f-42e2-be4c-6c32dac101c2",
      "id": "1027452",
      "available": true,
      "createdAt": "2025-06-17T19:25:06.152Z",
      "updatedAt": "2025-08-18T12:26:02.179Z",
      "name": "Ar Condicionado Split Hi Wall Philco Inverter 24000 BTU/h Frio Monofásico PAC24000IFM15 - 220 Volts",
      "description": "<h2>Ar Condicionado Split Hi Wall Philco Inverter...</h2>",
      "url": "https://www.friopecas.com.br/split-philco-hw-24k-220-1-f-in-1027452/p",
      "integration": "vtex",
      "images": [
        {
          "url": "https://friopecas.vteximg.com.br/arquivos/ids/241735/17.png.png?v=638663374020100000"
        }
      ],
      "options": [
        {
          "id": "1027452",
          "ean": "7899963913617",
          "name": "Ar Condicionado Split Hi Wall Philco Inverter 24000 BTU/h Frio Monofásico PAC24000IFM15 - 220 Volts",
          "available": true,
          "seller": "friopecas",
          "images": [
            {
              "url": "https://friopecas.vteximg.com.br/arquivos/ids/241735/17.png.png?v=638663374020100000"
            }
          ],
          "categories": [],
          "brands": [],
          "pricing": [
            {
              "listPrice": 5098,
              "price": 5098,
              "metadata": []
            }
          ],
          "stocks": [
            {
              "value": 99999,
              "metadata": []
            }
          ],
          "metadata": []
        }
      ],
      "metadata": []
    }
  ],
  "meta": {
    "total": 1500,
    "page": 1,
    "limit": 10,
    "totalPages": 150
  }
}

Error Responses

400 Bad Request

{
  "message": "Invalid price range format. Expected format: from:to",
  "error": "BadRequest",
  "statusCode": 400
}

401 Unauthorized

{
  "message": "API key is required",
  "error": "Unauthorized",
  "statusCode": 401
}

500 Internal Server Error

{
  "message": "Internal server error",
  "error": "InternalServerError",
  "statusCode": 500
}

Usage Examples

JavaScript/Node.js

const axios = require("axios");

async function getProducts() {
  try {
    const response = await axios.get(
      "https://api-beta.lomadee.com.br/affiliate/products",
      {
        headers: {
          "x-api-key": "your-api-key",
        },
        params: {
          page: 1,
          limit: 20,
          search: "smartphone",
          price: "5000:10000",
        },
      }
    );

    console.log("Products:", response.data.data);
    console.log("Pagination:", response.data.meta);
  } catch (error) {
    console.error("Error:", error.response.data);
  }
}

Python

import requests

def get_products():
    url = 'https://api-beta.lomadee.com.br/affiliate/products'
    headers = {'x-api-key': 'your-api-key'}
    params = {
        'page': 1,
        'limit': 20,
        'search': 'smartphone',
        'price': '5000:10000'
    }

    response = requests.get(url, headers=headers, params=params)

    if response.status_code == 200:
        data = response.json()
        print('Products:', data['data'])
        print('Pagination:', data['meta'])
    else:
        print('Error:', response.json())

PHP

<?php
$url = 'https://api-beta.lomadee.com.br/affiliate/products';
$headers = ['x-api-key: your-api-key'];

$params = [
    'page' => 1,
    'limit' => 20,
    'search' => 'smartphone',
    'price' => '5000:10000'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . '?' . http_build_query($params));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode === 200) {
    $data = json_decode($response, true);
    echo 'Products: ' . print_r($data['data'], true);
    echo 'Pagination: ' . print_r($data['meta'], true);
} else {
    echo 'Error: ' . $response;
}
?>

Best Practices

Pagination: Always implement pagination for large datasets
Caching: Cache product data when appropriate (TTL: 60 seconds)
Search Optimization: Use specific search terms for better results
Price Filtering: Use price ranges to narrow down products
Error Handling: Implement proper error handling for all responses
Rate Limiting: Respect the 10 requests per minute limit

Common Use Cases

Product Catalog: Display available products with filtering
Price Comparison: Compare prices across different brands
Inventory Management: Check product availability and stock levels
Search Integration: Implement product search functionality
Recommendation Engine: Build product recommendation systems

Authorizations

x-api-key

string

header

required

Query Parameters

page

integer<int32>

default:1

Page number for pagination. Starts at 1.

limit

integer<int32>

default:10

Number of products per page. Maximum 100.

Required range: x <= 100

string

Search term to filter products by name or description.

price

string

Price range filter in cents. Format: from:to

organizationIds

string

Filter products by specific brand organization IDs. Multiple IDs separated by commas.

isAvailable

boolean

Filter products by availability status

Response

Products response

data

object[]

Show child attributes

API Documentation

Orders

Brands

Campaigns

Shorten

Products

Get all Products

Get all Products

HTTP Request

Query Parameters

Example Requests

Basic Request

With Search and Price Filter

Filter by Specific Brands

Response Format

Product Object Structure

Example Response

Error Responses

400 Bad Request

401 Unauthorized

500 Internal Server Error

Usage Examples

JavaScript/Node.js

Python

PHP

Best Practices

Common Use Cases

Authorizations

Query Parameters

Response

API Documentation

Orders

Brands

Campaigns

Shorten

Products

​Get all Products

​HTTP Request

​Query Parameters

​Example Requests

​Basic Request

​With Pagination

​With Search and Price Filter

​Filter by Specific Brands

​Response Format

​Product Object Structure

​Example Response

​Error Responses

​400 Bad Request

​401 Unauthorized

​500 Internal Server Error

​Usage Examples

​JavaScript/Node.js

​Python

​PHP

​Best Practices

​Common Use Cases

Authorizations

Query Parameters

Response

Get all Products

HTTP Request

Query Parameters

Example Requests

Basic Request

With Pagination

With Search and Price Filter

Filter by Specific Brands

Response Format

Product Object Structure

Example Response

Error Responses

400 Bad Request

401 Unauthorized

500 Internal Server Error

Usage Examples

JavaScript/Node.js

Python

PHP

Best Practices

Common Use Cases