Create a vendor
curl --request POST \
--url https://rest.staging.nickel.com/vendor \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"emails": [
"<string>"
],
"address": {
"street1": "<string>",
"street2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>"
},
"syncToQbo": true
}
'import requests
url = "https://rest.staging.nickel.com/vendor"
payload = {
"name": "<string>",
"emails": ["<string>"],
"address": {
"street1": "<string>",
"street2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>"
},
"syncToQbo": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
emails: ['<string>'],
address: {
street1: '<string>',
street2: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>',
country: '<string>'
},
syncToQbo: true
})
};
fetch('https://rest.staging.nickel.com/vendor', 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://rest.staging.nickel.com/vendor",
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' => '<string>',
'emails' => [
'<string>'
],
'address' => [
'street1' => '<string>',
'street2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>',
'country' => '<string>'
],
'syncToQbo' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://rest.staging.nickel.com/vendor"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"emails\": [\n \"<string>\"\n ],\n \"address\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"syncToQbo\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://rest.staging.nickel.com/vendor")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"emails\": [\n \"<string>\"\n ],\n \"address\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"syncToQbo\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.staging.nickel.com/vendor")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"emails\": [\n \"<string>\"\n ],\n \"address\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"syncToQbo\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"emails": [
"<string>"
],
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"type": "<string>",
"vendorDeliveryMethods": [
{
"id": "<string>",
"type": "<string>",
"routingNumber": "<string>",
"accountType": "<string>",
"bankName": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>",
"swiftCode": "<string>",
"iban": "<string>",
"countryCode": "<string>"
}
],
"vendorPayoutMethods": [
{
"id": "<string>",
"type": "<string>",
"routingNumber": "<string>",
"accountType": "<string>",
"bankName": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>",
"swiftCode": "<string>",
"iban": "<string>",
"countryCode": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Vendor
Create a vendor
POST
/
vendor
Create a vendor
curl --request POST \
--url https://rest.staging.nickel.com/vendor \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"emails": [
"<string>"
],
"address": {
"street1": "<string>",
"street2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>"
},
"syncToQbo": true
}
'import requests
url = "https://rest.staging.nickel.com/vendor"
payload = {
"name": "<string>",
"emails": ["<string>"],
"address": {
"street1": "<string>",
"street2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>"
},
"syncToQbo": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
emails: ['<string>'],
address: {
street1: '<string>',
street2: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>',
country: '<string>'
},
syncToQbo: true
})
};
fetch('https://rest.staging.nickel.com/vendor', 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://rest.staging.nickel.com/vendor",
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' => '<string>',
'emails' => [
'<string>'
],
'address' => [
'street1' => '<string>',
'street2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>',
'country' => '<string>'
],
'syncToQbo' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://rest.staging.nickel.com/vendor"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"emails\": [\n \"<string>\"\n ],\n \"address\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"syncToQbo\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://rest.staging.nickel.com/vendor")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"emails\": [\n \"<string>\"\n ],\n \"address\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"syncToQbo\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.staging.nickel.com/vendor")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"emails\": [\n \"<string>\"\n ],\n \"address\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"syncToQbo\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"emails": [
"<string>"
],
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"type": "<string>",
"vendorDeliveryMethods": [
{
"id": "<string>",
"type": "<string>",
"routingNumber": "<string>",
"accountType": "<string>",
"bankName": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>",
"swiftCode": "<string>",
"iban": "<string>",
"countryCode": "<string>"
}
],
"vendorPayoutMethods": [
{
"id": "<string>",
"type": "<string>",
"routingNumber": "<string>",
"accountType": "<string>",
"bankName": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>",
"swiftCode": "<string>",
"iban": "<string>",
"countryCode": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Create a new vendor
Response
Successful operation
The vendor's delivery methods.
Show child attributes
Show child attributes
Deprecated alias of vendorDeliveryMethods, retained for backwards compatibility.
Show child attributes
Show child attributes
