Customers
Create a new customer
Scopes: customer:create
POST
/
v0
/
business
/
{business_id}
/
customers
Create a new customer
curl --request POST \
--url https://api.sandbox.getasset.com/v0/business/{business_id}/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"external_id": "<string>",
"email": "<string>",
"billing_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"shipping_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"phone_number": "<string>"
}
'import requests
url = "https://api.sandbox.getasset.com/v0/business/{business_id}/customers"
payload = {
"name": "<string>",
"external_id": "<string>",
"email": "<string>",
"billing_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"shipping_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"phone_number": "<string>"
}
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>',
external_id: '<string>',
email: '<string>',
billing_address: {
street_1: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>',
street_2: '<string>'
},
shipping_address: {
street_1: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>',
street_2: '<string>'
},
phone_number: '<string>'
})
};
fetch('https://api.sandbox.getasset.com/v0/business/{business_id}/customers', 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.sandbox.getasset.com/v0/business/{business_id}/customers",
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>',
'external_id' => '<string>',
'email' => '<string>',
'billing_address' => [
'street_1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>',
'street_2' => '<string>'
],
'shipping_address' => [
'street_1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>',
'street_2' => '<string>'
],
'phone_number' => '<string>'
]),
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://api.sandbox.getasset.com/v0/business/{business_id}/customers"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"email\": \"<string>\",\n \"billing_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"shipping_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"phone_number\": \"<string>\"\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://api.sandbox.getasset.com/v0/business/{business_id}/customers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"email\": \"<string>\",\n \"billing_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"shipping_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"phone_number\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.getasset.com/v0/business/{business_id}/customers")
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 \"external_id\": \"<string>\",\n \"email\": \"<string>\",\n \"billing_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"shipping_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"phone_number\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"name": "<string>",
"id": "<string>",
"is_disabled": true,
"external_id": "<string>",
"email": "<string>",
"billing_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"shipping_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"phone_number": "<string>"
}
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Body
application/json
The name of the customer
Maximum string length:
255The external ID of the customer
Maximum string length:
255The email address of the customer
Maximum string length:
255The billing address of the customer
Show child attributes
Show child attributes
The shipping address of the customer
Show child attributes
Show child attributes
The phone number of the customer
Maximum string length:
32Response
Successful Response
Show child attributes
Show child attributes
⌘I
Create a new customer
curl --request POST \
--url https://api.sandbox.getasset.com/v0/business/{business_id}/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"external_id": "<string>",
"email": "<string>",
"billing_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"shipping_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"phone_number": "<string>"
}
'import requests
url = "https://api.sandbox.getasset.com/v0/business/{business_id}/customers"
payload = {
"name": "<string>",
"external_id": "<string>",
"email": "<string>",
"billing_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"shipping_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"phone_number": "<string>"
}
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>',
external_id: '<string>',
email: '<string>',
billing_address: {
street_1: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>',
street_2: '<string>'
},
shipping_address: {
street_1: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>',
street_2: '<string>'
},
phone_number: '<string>'
})
};
fetch('https://api.sandbox.getasset.com/v0/business/{business_id}/customers', 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.sandbox.getasset.com/v0/business/{business_id}/customers",
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>',
'external_id' => '<string>',
'email' => '<string>',
'billing_address' => [
'street_1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>',
'street_2' => '<string>'
],
'shipping_address' => [
'street_1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>',
'street_2' => '<string>'
],
'phone_number' => '<string>'
]),
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://api.sandbox.getasset.com/v0/business/{business_id}/customers"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"email\": \"<string>\",\n \"billing_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"shipping_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"phone_number\": \"<string>\"\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://api.sandbox.getasset.com/v0/business/{business_id}/customers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"email\": \"<string>\",\n \"billing_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"shipping_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"phone_number\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.getasset.com/v0/business/{business_id}/customers")
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 \"external_id\": \"<string>\",\n \"email\": \"<string>\",\n \"billing_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"shipping_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"phone_number\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"name": "<string>",
"id": "<string>",
"is_disabled": true,
"external_id": "<string>",
"email": "<string>",
"billing_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"shipping_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"phone_number": "<string>"
}
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}