curl --request POST \
--url https://api.contracting.kukkingu.software/api/v1/addresses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'tenant-id: <tenant-id>' \
--data '
{
"name": "Acme Corporation",
"address1": "123 Main St",
"address2": "Suite 400",
"region": "California",
"country": "United States",
"city": "San Francisco",
"zip": "94103",
"clientId": "clnt_z2b3mo8qa5kzptgsu26q2wmh",
"registrationNumber": "ACME-123",
"vatNumber": "VAT-987654",
"order": 13
}
'import requests
url = "https://api.contracting.kukkingu.software/api/v1/addresses"
payload = {
"name": "Acme Corporation",
"address1": "123 Main St",
"address2": "Suite 400",
"region": "California",
"country": "United States",
"city": "San Francisco",
"zip": "94103",
"clientId": "clnt_z2b3mo8qa5kzptgsu26q2wmh",
"registrationNumber": "ACME-123",
"vatNumber": "VAT-987654",
"order": 13
}
headers = {
"tenant-id": "<tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'tenant-id': '<tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Acme Corporation',
address1: '123 Main St',
address2: 'Suite 400',
region: 'California',
country: 'United States',
city: 'San Francisco',
zip: '94103',
clientId: 'clnt_z2b3mo8qa5kzptgsu26q2wmh',
registrationNumber: 'ACME-123',
vatNumber: 'VAT-987654',
order: 13
})
};
fetch('https://api.contracting.kukkingu.software/api/v1/addresses', 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.contracting.kukkingu.software/api/v1/addresses",
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',
'address1' => '123 Main St',
'address2' => 'Suite 400',
'region' => 'California',
'country' => 'United States',
'city' => 'San Francisco',
'zip' => '94103',
'clientId' => 'clnt_z2b3mo8qa5kzptgsu26q2wmh',
'registrationNumber' => 'ACME-123',
'vatNumber' => 'VAT-987654',
'order' => 13
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"tenant-id: <tenant-id>"
],
]);
$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.contracting.kukkingu.software/api/v1/addresses"
payload := strings.NewReader("{\n \"name\": \"Acme Corporation\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Suite 400\",\n \"region\": \"California\",\n \"country\": \"United States\",\n \"city\": \"San Francisco\",\n \"zip\": \"94103\",\n \"clientId\": \"clnt_z2b3mo8qa5kzptgsu26q2wmh\",\n \"registrationNumber\": \"ACME-123\",\n \"vatNumber\": \"VAT-987654\",\n \"order\": 13\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("tenant-id", "<tenant-id>")
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.contracting.kukkingu.software/api/v1/addresses")
.header("tenant-id", "<tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corporation\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Suite 400\",\n \"region\": \"California\",\n \"country\": \"United States\",\n \"city\": \"San Francisco\",\n \"zip\": \"94103\",\n \"clientId\": \"clnt_z2b3mo8qa5kzptgsu26q2wmh\",\n \"registrationNumber\": \"ACME-123\",\n \"vatNumber\": \"VAT-987654\",\n \"order\": 13\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contracting.kukkingu.software/api/v1/addresses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["tenant-id"] = '<tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Corporation\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Suite 400\",\n \"region\": \"California\",\n \"country\": \"United States\",\n \"city\": \"San Francisco\",\n \"zip\": \"94103\",\n \"clientId\": \"clnt_z2b3mo8qa5kzptgsu26q2wmh\",\n \"registrationNumber\": \"ACME-123\",\n \"vatNumber\": \"VAT-987654\",\n \"order\": 13\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
"name": "Acme Corporation",
"address1": "123 Main St",
"address2": "Suite 400",
"region": "California",
"country": "United States",
"city": "San Francisco",
"zip": "94103",
"createdAt": "2023-10-05T14:48:00.000Z",
"updatedAt": "2023-10-05T14:48:00.000Z",
"client": "clnt_z2b3mo8qa5kzptgsu26q2wmh",
"registrationNumber": "ACME-123",
"vatNumber": "VAT-987654",
"order": 13
}
}{
"error": "ValidationError",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>",
"constraint": "<string>"
}
]
}{
"error": "Unauthorized",
"message": "Unauthorized"
}{
"error": "Forbidden",
"message": "Forbidden"
}{
"error": "NotFound",
"message": "Not Found"
}Create address
Creates a new address scoped to the provided clientId or tenant if omitted.
curl --request POST \
--url https://api.contracting.kukkingu.software/api/v1/addresses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'tenant-id: <tenant-id>' \
--data '
{
"name": "Acme Corporation",
"address1": "123 Main St",
"address2": "Suite 400",
"region": "California",
"country": "United States",
"city": "San Francisco",
"zip": "94103",
"clientId": "clnt_z2b3mo8qa5kzptgsu26q2wmh",
"registrationNumber": "ACME-123",
"vatNumber": "VAT-987654",
"order": 13
}
'import requests
url = "https://api.contracting.kukkingu.software/api/v1/addresses"
payload = {
"name": "Acme Corporation",
"address1": "123 Main St",
"address2": "Suite 400",
"region": "California",
"country": "United States",
"city": "San Francisco",
"zip": "94103",
"clientId": "clnt_z2b3mo8qa5kzptgsu26q2wmh",
"registrationNumber": "ACME-123",
"vatNumber": "VAT-987654",
"order": 13
}
headers = {
"tenant-id": "<tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'tenant-id': '<tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Acme Corporation',
address1: '123 Main St',
address2: 'Suite 400',
region: 'California',
country: 'United States',
city: 'San Francisco',
zip: '94103',
clientId: 'clnt_z2b3mo8qa5kzptgsu26q2wmh',
registrationNumber: 'ACME-123',
vatNumber: 'VAT-987654',
order: 13
})
};
fetch('https://api.contracting.kukkingu.software/api/v1/addresses', 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.contracting.kukkingu.software/api/v1/addresses",
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',
'address1' => '123 Main St',
'address2' => 'Suite 400',
'region' => 'California',
'country' => 'United States',
'city' => 'San Francisco',
'zip' => '94103',
'clientId' => 'clnt_z2b3mo8qa5kzptgsu26q2wmh',
'registrationNumber' => 'ACME-123',
'vatNumber' => 'VAT-987654',
'order' => 13
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"tenant-id: <tenant-id>"
],
]);
$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.contracting.kukkingu.software/api/v1/addresses"
payload := strings.NewReader("{\n \"name\": \"Acme Corporation\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Suite 400\",\n \"region\": \"California\",\n \"country\": \"United States\",\n \"city\": \"San Francisco\",\n \"zip\": \"94103\",\n \"clientId\": \"clnt_z2b3mo8qa5kzptgsu26q2wmh\",\n \"registrationNumber\": \"ACME-123\",\n \"vatNumber\": \"VAT-987654\",\n \"order\": 13\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("tenant-id", "<tenant-id>")
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.contracting.kukkingu.software/api/v1/addresses")
.header("tenant-id", "<tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corporation\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Suite 400\",\n \"region\": \"California\",\n \"country\": \"United States\",\n \"city\": \"San Francisco\",\n \"zip\": \"94103\",\n \"clientId\": \"clnt_z2b3mo8qa5kzptgsu26q2wmh\",\n \"registrationNumber\": \"ACME-123\",\n \"vatNumber\": \"VAT-987654\",\n \"order\": 13\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contracting.kukkingu.software/api/v1/addresses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["tenant-id"] = '<tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Corporation\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Suite 400\",\n \"region\": \"California\",\n \"country\": \"United States\",\n \"city\": \"San Francisco\",\n \"zip\": \"94103\",\n \"clientId\": \"clnt_z2b3mo8qa5kzptgsu26q2wmh\",\n \"registrationNumber\": \"ACME-123\",\n \"vatNumber\": \"VAT-987654\",\n \"order\": 13\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
"name": "Acme Corporation",
"address1": "123 Main St",
"address2": "Suite 400",
"region": "California",
"country": "United States",
"city": "San Francisco",
"zip": "94103",
"createdAt": "2023-10-05T14:48:00.000Z",
"updatedAt": "2023-10-05T14:48:00.000Z",
"client": "clnt_z2b3mo8qa5kzptgsu26q2wmh",
"registrationNumber": "ACME-123",
"vatNumber": "VAT-987654",
"order": 13
}
}{
"error": "ValidationError",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>",
"constraint": "<string>"
}
]
}{
"error": "Unauthorized",
"message": "Unauthorized"
}{
"error": "Forbidden",
"message": "Forbidden"
}{
"error": "NotFound",
"message": "Not Found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Specifies the tenant context for the request. All endpoints operate within this tenant scope.
"tnt_pfh0haxfpzowht3oi213cqos"
Body
Request body used to create an address resource.
Request body used to create an address resource.
Display label for the address, typically the legal entity name.
1 - 200"Acme Corporation"
Primary address line.
1 - 200"123 Main St"
Secondary address line.
200"Suite 400"
State or region for the address.
100"California"
Country for the address.
1 - 100"United States"
City for the address.
1 - 100"San Francisco"
Postal or ZIP code.
1 - 20"94103"
Unique identifier of the client.
1"clnt_z2b3mo8qa5kzptgsu26q2wmh"
Company registration number associated with the address.
100"ACME-123"
VAT number for the entity at this address.
100"VAT-987654"
Order of the resource for sorting purposes.
0 <= x <= 900719925474099113
Response
Default Response
Standard success response payload wrapped in a data property.
Address resource returned by the API.
Show child attributes
Show child attributes