cURL
curl --request GET \
--url 'https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer' \
--header 'X-Api-Key: YOUR_PLATFORM_KEY'
const response = await fetch("https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
});
const data = await response.json();
import requests
response = requests.request(
"GET",
"https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer",
headers={
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
)
data = response.json()
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PLATFORM_KEY"
],
]);
$response = curl_exec($curl);
curl_close($curl);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "YOUR_PLATFORM_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.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP.const_get("GET".capitalize).new(url)
request["X-Api-Key"] = "YOUR_PLATFORM_KEY"
response = http.request(request)
puts response.read_body
using var client = new HttpClient();
using var request = new HttpRequestMessage(
new HttpMethod("GET"),
"https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer");
request.Headers.TryAddWithoutValidation("X-Api-Key", "YOUR_PLATFORM_KEY");
using var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class BranduoRequest {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer"))
.header("X-Api-Key", "YOUR_PLATFORM_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
{
"shop": "northwind-goods.myshopify.com",
"headline": "Claim 20% off",
"products": [
{
"title": "Sateen Sheet Set",
"price": "99.00",
"currency": "USD",
"imageUrl": "https://cdn.example.com/sheet-set.jpg"
}
],
"discountPercent": 20
}
{
"error": "not_approved",
"message": "This brand has not approved your platform."
}
Partner API
Get the brand's offer
The merchant’s own offer, to show in your app.
GET
/
platform
/
brands
/
{domain}
/
offer
cURL
curl --request GET \
--url 'https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer' \
--header 'X-Api-Key: YOUR_PLATFORM_KEY'
const response = await fetch("https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
});
const data = await response.json();
import requests
response = requests.request(
"GET",
"https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer",
headers={
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
)
data = response.json()
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PLATFORM_KEY"
],
]);
$response = curl_exec($curl);
curl_close($curl);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "YOUR_PLATFORM_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.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP.const_get("GET".capitalize).new(url)
request["X-Api-Key"] = "YOUR_PLATFORM_KEY"
response = http.request(request)
puts response.read_body
using var client = new HttpClient();
using var request = new HttpRequestMessage(
new HttpMethod("GET"),
"https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer");
request.Headers.TryAddWithoutValidation("X-Api-Key", "YOUR_PLATFORM_KEY");
using var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class BranduoRequest {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer"))
.header("X-Api-Key", "YOUR_PLATFORM_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
{
"shop": "northwind-goods.myshopify.com",
"headline": "Claim 20% off",
"products": [
{
"title": "Sateen Sheet Set",
"price": "99.00",
"currency": "USD",
"imageUrl": "https://cdn.example.com/sheet-set.jpg"
}
],
"discountPercent": 20
}
{
"error": "not_approved",
"message": "This brand has not approved your platform."
}
Returns the offer Branduo shows for this merchant to partners’ shoppers: a headline, up to three products, and the discount. Show it in your app so the merchant sees what’s running. The merchant edits it in Branduo.
The merchant must have approved your platform.
cURL
curl --request GET \
--url 'https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer' \
--header 'X-Api-Key: YOUR_PLATFORM_KEY'
const response = await fetch("https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
});
const data = await response.json();
import requests
response = requests.request(
"GET",
"https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer",
headers={
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
)
data = response.json()
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PLATFORM_KEY"
],
]);
$response = curl_exec($curl);
curl_close($curl);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "YOUR_PLATFORM_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.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP.const_get("GET".capitalize).new(url)
request["X-Api-Key"] = "YOUR_PLATFORM_KEY"
response = http.request(request)
puts response.read_body
using var client = new HttpClient();
using var request = new HttpRequestMessage(
new HttpMethod("GET"),
"https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer");
request.Headers.TryAddWithoutValidation("X-Api-Key", "YOUR_PLATFORM_KEY");
using var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class BranduoRequest {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com/offer"))
.header("X-Api-Key", "YOUR_PLATFORM_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
Path parameters
Response
The merchant’s discount for new customers, as a whole percent.
null when
they have none.Errors
| Status | error | Cause |
|---|---|---|
400 | invalid_request | domain is not a store hostname. |
401 | unauthorized | The platform key is missing or invalid. |
403 | not_approved | The merchant hasn’t approved your platform. |
403 | platform_inactive | Your platform isn’t active on Branduo. |
{
"shop": "northwind-goods.myshopify.com",
"headline": "Claim 20% off",
"products": [
{
"title": "Sateen Sheet Set",
"price": "99.00",
"currency": "USD",
"imageUrl": "https://cdn.example.com/sheet-set.jpg"
}
],
"discountPercent": 20
}
{
"error": "not_approved",
"message": "This brand has not approved your platform."
}

