Get a Brand

cURL

curl --request GET \
  --url https://api.lomadee.com.br/affiliate/brands/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.lomadee.com.br/affiliate/brands/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lomadee.com.br/affiliate/brands/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lomadee.com.br/affiliate/brands/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.lomadee.com.br/affiliate/brands/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "logo": "<string>",
    "slug": "<string>",
    "site": "<string>",
    "segment": "<string>",
    "network": {
      "active": true,
      "isPublic": true,
      "trait": {
        "isExclusive": true,
        "isHighlight": true,
        "isFavorite": true
      },
      "rating": {
        "approval": 123,
        "commission": 123,
        "conversion": 123,
        "popularity": 123,
        "validation": 123
      }
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "channels": [
      {
        "id": "<string>",
        "name": "<string>",
        "availableChannel": {
          "id": "<string>",
          "name": "<string>"
        },
        "shortUrls": [
          "<string>"
        ],
        "message": "<string>"
      }
    ],
    "commission": {
      "value": 123,
      "transfer": "<string>"
    }
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "statusCode": 123
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>"
}

{
  "statusCode": 404,
  "message": "Brand with ID {brandId} not found or not available"
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>"
}

GET

affiliate

brands

{id}

cURL

curl --request GET \
  --url https://api.lomadee.com.br/affiliate/brands/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.lomadee.com.br/affiliate/brands/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lomadee.com.br/affiliate/brands/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lomadee.com.br/affiliate/brands/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.lomadee.com.br/affiliate/brands/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "logo": "<string>",
    "slug": "<string>",
    "site": "<string>",
    "segment": "<string>",
    "network": {
      "active": true,
      "isPublic": true,
      "trait": {
        "isExclusive": true,
        "isHighlight": true,
        "isFavorite": true
      },
      "rating": {
        "approval": 123,
        "commission": 123,
        "conversion": 123,
        "popularity": 123,
        "validation": 123
      }
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "channels": [
      {
        "id": "<string>",
        "name": "<string>",
        "availableChannel": {
          "id": "<string>",
          "name": "<string>"
        },
        "shortUrls": [
          "<string>"
        ],
        "message": "<string>"
      }
    ],
    "commission": {
      "value": 123,
      "transfer": "<string>"
    }
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "statusCode": 123
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>"
}

{
  "statusCode": 404,
  "message": "Brand with ID {brandId} not found or not available"
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>"
}

Retrieve detailed information about a specific affiliate brand by its ID. This endpoint provides comprehensive brand data including commission rates, available channels, and brand details.

HTTP Request

GET https://api-beta.lomadee.com.br/affiliate/brands/{id}

Path Parameters

string

The unique identifier of the brand to retrieve

Example Requests

Basic Request

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

Response Format

object

Brand object with detailed information

Brand Object Structure

string

The unique identifier of the brand

string

The logo URL of the brand

string

The name of the brand

string

The URL-friendly slug of the brand

string

The website URL of the brand

string

Brand segment/category

object

Network information for the brand

Show properties

boolean

Whether the network is active

boolean

Whether the network is public

object

Brand traits

Show properties

boolean

Whether the brand is exclusive

boolean

Whether the brand is highlighted

boolean

Whether the brand is favorite

object

Brand rating information

Show properties

number

Approval rate (0-5)

number

Commission rate (%)

number

Conversion rate (%)

number

Popularity index (0-100)

number

Validation rate (0-5)

string

Creation date (ISO 8601)

object

Commission information for the brand

Show properties

number

Commission value calculated for the affiliate (%)

string

Commission payment model (e.g., cpa - Cost Per Action). Currently, the system primarily uses CPA model for all organizations.

array

Available affiliate channels for the brand

Show properties

string

Channel identifier

string

Channel name

object

Available channel information

Show properties

string

Available channel identifier

string

Available channel name

array

Shortened URLs for the channel

string

Restriction message if channel has limitations

Example Response

{
  "data": {
    "id": "e36f5bbb-3e5f-42e2-be4c-6c32dac101c2",
    "logo": "https://example.com/logo.png",
    "name": "Example Brand",
    "slug": "example-brand",
    "site": "https://example.com",
    "segment": "Electronics",
    "network": {
      "active": true,
      "isPublic": true,
      "trait": {
        "isExclusive": false,
        "isHighlight": true,
        "isFavorite": false
      },
      "rating": {
        "approval": 4.5,
        "commission": 4.2,
        "conversion": 3.8,
        "popularity": 85,
        "validation": 4.8
      }
    },
    "createdAt": "2024-01-15T10:30:00Z",
    "commission": {
      "value": 4.2,
      "transfer": "cpa"
    },
    "channels": [
      {
        "id": "channel-1",
        "name": "Main Channel",
        "availableChannel": {
          "id": "available-1",
          "name": "Available Channel"
        },
        "shortUrls": ["https://lomadee.com/short-url-1"],
        "message": null
      },
      {
        "id": "channel-2",
        "name": "Secondary Channel",
        "availableChannel": {
          "id": "available-2",
          "name": "Secondary Available Channel"
        },
        "shortUrls": ["https://lomadee.com/short-url-2"],
        "message": null
      }
    ]
  }
}

Error Responses

404 Not Found

{
  "message": "Brand not found",
  "error": "NotFound",
  "statusCode": 404
}

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 getBrand(brandId) {
  try {
    const response = await axios.get(
      `https://api-beta.lomadee.com.br/affiliate/brands/${brandId}`,
      {
        headers: {
          "x-api-key": "your-api-key",
        },
      }
    );

    console.log("Brand:", response.data.data);
    console.log("Commission:", response.data.data.commission);
    console.log("Channels:", response.data.data.channels);
  } catch (error) {
    console.error("Error:", error.response.data);
  }
}

// Usage
getBrand("e36f5bbb-3e5f-42e2-be4c-6c32dac101c2");

Python

import requests

def get_brand(brand_id):
    url = f'https://api-beta.lomadee.com.br/affiliate/brands/{brand_id}'
    headers = {'x-api-key': 'your-api-key'}

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

    if response.status_code == 200:
        data = response.json()
        brand = data['data']
        print('Brand:', brand['name'])
        print('Commission:', brand['commission'])
        print('Channels:', brand['channels'])
    else:
        print('Error:', response.json())

# Usage
get_brand("e36f5bbb-3e5f-42e2-be4c-6c32dac101c2")

PHP

<?php
function getBrand($brandId) {
    $url = "https://api-beta.lomadee.com.br/affiliate/brands/{$brandId}";
    $headers = ['x-api-key: your-api-key'];

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    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);
        $brand = $data['data'];
        echo 'Brand: ' . $brand['name'] . "\n";
        echo 'Commission: ' . print_r($brand['commission'], true) . "\n";
        echo 'Channels: ' . print_r($brand['channels'], true) . "\n";
    } else {
        echo 'Error: ' . $response;
    }
}

// Usage
getBrand("e36f5bbb-3e5f-42e2-be4c-6c32dac101c2");
?>

Best Practices

Error Handling: Always handle 404 errors for invalid brand IDs
Caching: Cache brand data when appropriate (TTL: 60 seconds)
Commission Calculation: Use commission data to calculate potential earnings
Channel Validation: Check channel availability before generating links
Rate Limiting: Respect the 60 requests per 60 seconds limit

Common Use Cases

Brand Details: Display detailed information about a specific brand
Commission Analysis: Analyze commission rates for specific brands
Channel Management: Check available channels for a specific brand
Link Generation: Generate affiliate links for a specific brand
Performance Tracking: Monitor performance metrics for individual brands

Authorizations

x-api-key

string

header

required

Path Parameters

string

required

ID of brand to return (organizationId)

Response

Brand response

data

object

Show child attributes

API Documentation

Orders

Brands

Channels

Campaigns

Shorten

Products

Get a Brand

Get a Brand

HTTP Request

Path Parameters

Example Requests

Basic Request

Response Format

Brand Object Structure

Example Response

Error Responses

404 Not Found

401 Unauthorized

500 Internal Server Error

Usage Examples

JavaScript/Node.js

Python

PHP

Best Practices

Common Use Cases

Authorizations

Path Parameters

Response

​Get a Brand

​HTTP Request

​Path Parameters

​Example Requests

​Basic Request

​Response Format

​Brand Object Structure

​Example Response

​Error Responses

​404 Not Found

​401 Unauthorized

​500 Internal Server Error

​Usage Examples

​JavaScript/Node.js

​Python

​PHP

​Best Practices

​Common Use Cases

Authorizations

Path Parameters

Response

Get a Brand

HTTP Request

Path Parameters

Example Requests

Basic Request

Response Format

Brand Object Structure

Example Response

Error Responses

404 Not Found

401 Unauthorized

500 Internal Server Error

Usage Examples

JavaScript/Node.js

Python

PHP

Best Practices

Common Use Cases