Skip to main content
POST
/
v1
/
admin
/
partners
/
brands
Create a partner brand
curl --request POST \
  --url http://localhost:3000/v1/admin/partners/brands \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_name": "<string>",
  "contact_email": "jsmith@example.com",
  "contact_phone": "<string>",
  "website_url": "<string>",
  "company_logo_url": "<string>",
  "return_address_line1": "<string>",
  "return_address_line2": "<string>",
  "return_city": "<string>",
  "return_state": "<string>",
  "return_postal_code": "<string>",
  "return_country_code": "US",
  "default_commission_rate_ambient": 0.5,
  "default_commission_rate_cold": 0.5,
  "approval_status": "pending",
  "notes": "<string>"
}
'
import requests

url = "http://localhost:3000/v1/admin/partners/brands"

payload = {
    "company_name": "<string>",
    "contact_email": "jsmith@example.com",
    "contact_phone": "<string>",
    "website_url": "<string>",
    "company_logo_url": "<string>",
    "return_address_line1": "<string>",
    "return_address_line2": "<string>",
    "return_city": "<string>",
    "return_state": "<string>",
    "return_postal_code": "<string>",
    "return_country_code": "US",
    "default_commission_rate_ambient": 0.5,
    "default_commission_rate_cold": 0.5,
    "approval_status": "pending",
    "notes": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    company_name: '<string>',
    contact_email: 'jsmith@example.com',
    contact_phone: '<string>',
    website_url: '<string>',
    company_logo_url: '<string>',
    return_address_line1: '<string>',
    return_address_line2: '<string>',
    return_city: '<string>',
    return_state: '<string>',
    return_postal_code: '<string>',
    return_country_code: 'US',
    default_commission_rate_ambient: 0.5,
    default_commission_rate_cold: 0.5,
    approval_status: 'pending',
    notes: '<string>'
  })
};

fetch('http://localhost:3000/v1/admin/partners/brands', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/v1/admin/partners/brands",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'company_name' => '<string>',
    'contact_email' => 'jsmith@example.com',
    'contact_phone' => '<string>',
    'website_url' => '<string>',
    'company_logo_url' => '<string>',
    'return_address_line1' => '<string>',
    'return_address_line2' => '<string>',
    'return_city' => '<string>',
    'return_state' => '<string>',
    'return_postal_code' => '<string>',
    'return_country_code' => 'US',
    'default_commission_rate_ambient' => 0.5,
    'default_commission_rate_cold' => 0.5,
    'approval_status' => 'pending',
    'notes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

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

func main() {

	url := "http://localhost:3000/v1/admin/partners/brands"

	payload := strings.NewReader("{\n  \"company_name\": \"<string>\",\n  \"contact_email\": \"jsmith@example.com\",\n  \"contact_phone\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"company_logo_url\": \"<string>\",\n  \"return_address_line1\": \"<string>\",\n  \"return_address_line2\": \"<string>\",\n  \"return_city\": \"<string>\",\n  \"return_state\": \"<string>\",\n  \"return_postal_code\": \"<string>\",\n  \"return_country_code\": \"US\",\n  \"default_commission_rate_ambient\": 0.5,\n  \"default_commission_rate_cold\": 0.5,\n  \"approval_status\": \"pending\",\n  \"notes\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("http://localhost:3000/v1/admin/partners/brands")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_name\": \"<string>\",\n  \"contact_email\": \"jsmith@example.com\",\n  \"contact_phone\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"company_logo_url\": \"<string>\",\n  \"return_address_line1\": \"<string>\",\n  \"return_address_line2\": \"<string>\",\n  \"return_city\": \"<string>\",\n  \"return_state\": \"<string>\",\n  \"return_postal_code\": \"<string>\",\n  \"return_country_code\": \"US\",\n  \"default_commission_rate_ambient\": 0.5,\n  \"default_commission_rate_cold\": 0.5,\n  \"approval_status\": \"pending\",\n  \"notes\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/admin/partners/brands")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_name\": \"<string>\",\n  \"contact_email\": \"jsmith@example.com\",\n  \"contact_phone\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"company_logo_url\": \"<string>\",\n  \"return_address_line1\": \"<string>\",\n  \"return_address_line2\": \"<string>\",\n  \"return_city\": \"<string>\",\n  \"return_state\": \"<string>\",\n  \"return_postal_code\": \"<string>\",\n  \"return_country_code\": \"US\",\n  \"default_commission_rate_ambient\": 0.5,\n  \"default_commission_rate_cold\": 0.5,\n  \"approval_status\": \"pending\",\n  \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "partner_brand": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_name": "<string>",
    "contact_email": "jsmith@example.com",
    "contact_phone": "<string>",
    "business_type": "<string>",
    "company_logo_url": "<string>",
    "website_url": "<string>",
    "return_address_line1": "<string>",
    "return_address_line2": "<string>",
    "return_city": "<string>",
    "return_state": "<string>",
    "return_postal_code": "<string>",
    "return_country_code": "<string>",
    "approved_at": "2023-11-07T05:31:56Z",
    "rejection_reason": "<string>",
    "default_commission_rate_ambient": 123,
    "default_commission_rate_cold": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}
{
  "error": "<string>",
  "message": "<string>"
}
{
  "error": "<string>",
  "message": "<string>"
}

Body

application/json
​
company_name
string
required
Minimum string length: 1
​
contact_email
string<email>
required
​
contact_phone
string
​
website_url
string<uri>
​
business_type
enum<string>
Available options:
manufacturer,
distributor,
artisan,
farm,
importer,
other
​
company_logo_url
string<uri>
​
return_address_line1
string
​
return_address_line2
string
​
return_city
string
​
return_state
string
​
return_postal_code
string
​
return_country_code
string
default:US
​
default_commission_rate_ambient
number
Required range: 0 <= x <= 1
​
default_commission_rate_cold
number
Required range: 0 <= x <= 1
​
approval_status
enum<string>
default:pending
Available options:
pending,
approved
​
notes
string

Response

Partner brand created

​
partner_brand
object
required