Get Order by ID

cURL

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

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

fetch('https://api.lomadee.com.br/affiliate/orders/{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/orders/{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/orders/{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/orders/{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": {
    "data": {
      "id": "<string>",
      "orderId": "<string>",
      "status": "pending",
      "value": 123,
      "createdAt": "<string>",
      "commission": 123,
      "commissionStatus": "pending",
      "items  ": [
        {
          "id": "<string>",
          "name": "<string>",
          "quantity": 123,
          "price": 123,
          "categories": 123
        }
      ],
      "organizationId": "<string>",
      "mdasc": "<string>"
    },
    "meta": {
      "total": 123,
      "page": 123,
      "limit": 123,
      "totalPages": 123
    }
  }
}

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

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

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

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

GET

affiliate

orders

{id}

cURL

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

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

fetch('https://api.lomadee.com.br/affiliate/orders/{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/orders/{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/orders/{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/orders/{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": {
    "data": {
      "id": "<string>",
      "orderId": "<string>",
      "status": "pending",
      "value": 123,
      "createdAt": "<string>",
      "commission": 123,
      "commissionStatus": "pending",
      "items  ": [
        {
          "id": "<string>",
          "name": "<string>",
          "quantity": 123,
          "price": 123,
          "categories": 123
        }
      ],
      "organizationId": "<string>",
      "mdasc": "<string>"
    },
    "meta": {
      "total": 123,
      "page": 123,
      "limit": 123,
      "totalPages": 123
    }
  }
}

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

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

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

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

Returns a single order by orderId, or orders matching mdasc when passed as query parameter. Requires scope orders:read.

HTTP Request

GET https://api-beta.lomadee.com.br/affiliate/orders/{orderId}

Path Parameters

Parameter	Description
`id`	Order identifier (`orderId`)

Query Parameters

Parameter	Description
`mdasc`	When set, returns matching orders as array with `meta.total`

Response (by orderId)

{
  "data": {
    "orderId": "12345",
    "organizationId": "..."
  }
}

Example

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

Authorizations

x-api-key

string

header

required

Path Parameters

string

required

The id of the order to return

Response

Order response

data

object

Show child attributes

API Documentation

Orders

Brands

Channels

Campaigns

Shorten

Products

Get Order by ID

Get Order by ID

HTTP Request

Path Parameters

Query Parameters

Response (by orderId)

Example

Authorizations

Path Parameters

Response

​Get Order by ID

​HTTP Request

​Path Parameters

​Query Parameters

​Response (by orderId)

​Example

Authorizations

Path Parameters

Response

Get Order by ID

HTTP Request

Path Parameters

Query Parameters

Response (by orderId)

Example