Create a new vendor
curl --request POST \
--url https://production-api.puppetvendors.com/vendors \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"name": "Acme Corporation",
"alias": "acme",
"email": "vendor@acme.com",
"commissionType": "percentage",
"commissionRate": 15
}
'import requests
url = "https://production-api.puppetvendors.com/vendors"
payload = {
"name": "Acme Corporation",
"alias": "acme",
"email": "vendor@acme.com",
"commissionType": "percentage",
"commissionRate": 15
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Acme Corporation',
alias: 'acme',
email: 'vendor@acme.com',
commissionType: 'percentage',
commissionRate: 15
})
};
fetch('https://production-api.puppetvendors.com/vendors', 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://production-api.puppetvendors.com/vendors",
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([
'name' => 'Acme Corporation',
'alias' => 'acme',
'email' => 'vendor@acme.com',
'commissionType' => 'percentage',
'commissionRate' => 15
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://production-api.puppetvendors.com/vendors"
payload := strings.NewReader("{\n \"name\": \"Acme Corporation\",\n \"alias\": \"acme\",\n \"email\": \"vendor@acme.com\",\n \"commissionType\": \"percentage\",\n \"commissionRate\": 15\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
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("https://production-api.puppetvendors.com/vendors")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corporation\",\n \"alias\": \"acme\",\n \"email\": \"vendor@acme.com\",\n \"commissionType\": \"percentage\",\n \"commissionRate\": 15\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/vendors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Corporation\",\n \"alias\": \"acme\",\n \"email\": \"vendor@acme.com\",\n \"commissionType\": \"percentage\",\n \"commissionRate\": 15\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"_id": "507f1f77bcf86cd799439011",
"name": "Acme Corporation",
"alias": "acme",
"email": "vendor@acme.com",
"commissionType": "percentage",
"commissionRate": 15,
"isHidden": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}Vendors
Create a new vendor
Create a new vendor in the shop. Merchant scope only.
POST
/
vendors
Create a new vendor
curl --request POST \
--url https://production-api.puppetvendors.com/vendors \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"name": "Acme Corporation",
"alias": "acme",
"email": "vendor@acme.com",
"commissionType": "percentage",
"commissionRate": 15
}
'import requests
url = "https://production-api.puppetvendors.com/vendors"
payload = {
"name": "Acme Corporation",
"alias": "acme",
"email": "vendor@acme.com",
"commissionType": "percentage",
"commissionRate": 15
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Acme Corporation',
alias: 'acme',
email: 'vendor@acme.com',
commissionType: 'percentage',
commissionRate: 15
})
};
fetch('https://production-api.puppetvendors.com/vendors', 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://production-api.puppetvendors.com/vendors",
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([
'name' => 'Acme Corporation',
'alias' => 'acme',
'email' => 'vendor@acme.com',
'commissionType' => 'percentage',
'commissionRate' => 15
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://production-api.puppetvendors.com/vendors"
payload := strings.NewReader("{\n \"name\": \"Acme Corporation\",\n \"alias\": \"acme\",\n \"email\": \"vendor@acme.com\",\n \"commissionType\": \"percentage\",\n \"commissionRate\": 15\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
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("https://production-api.puppetvendors.com/vendors")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corporation\",\n \"alias\": \"acme\",\n \"email\": \"vendor@acme.com\",\n \"commissionType\": \"percentage\",\n \"commissionRate\": 15\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/vendors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Corporation\",\n \"alias\": \"acme\",\n \"email\": \"vendor@acme.com\",\n \"commissionType\": \"percentage\",\n \"commissionRate\": 15\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"_id": "507f1f77bcf86cd799439011",
"name": "Acme Corporation",
"alias": "acme",
"email": "vendor@acme.com",
"commissionType": "percentage",
"commissionRate": 15,
"isHidden": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}Authorizations
JWT minted from a merchant API key (mk_live_…) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.
Body
application/json
Vendor name
Example:
"Acme Corporation"
Vendor alias/short name
Example:
"acme"
Vendor email address
Example:
"vendor@acme.com"
Commission type
Available options:
percentage, flat Example:
"percentage"
Commission rate
Example:
15
Whether vendor is hidden
Example:
false
Was this page helpful?