Create new address
curl --request POST \
--url https://api.example.com/v1/addresses \
--header 'Content-Type: application/json' \
--data '
{
"rec_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"street": "<string>",
"postal_code": "<string>",
"city": "<string>",
"country": "<string>",
"number": "<string>",
"additional": "<string>",
"state": "<string>",
"is_primary": false,
"metadata": {}
}
'import requests
url = "https://api.example.com/v1/addresses"
payload = {
"rec_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"street": "<string>",
"postal_code": "<string>",
"city": "<string>",
"country": "<string>",
"number": "<string>",
"additional": "<string>",
"state": "<string>",
"is_primary": False,
"metadata": {}
}
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({
rec_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
street: '<string>',
postal_code: '<string>',
city: '<string>',
country: '<string>',
number: '<string>',
additional: '<string>',
state: '<string>',
is_primary: false,
metadata: {}
})
};
fetch('https://api.example.com/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.example.com/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([
'rec_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'street' => '<string>',
'postal_code' => '<string>',
'city' => '<string>',
'country' => '<string>',
'number' => '<string>',
'additional' => '<string>',
'state' => '<string>',
'is_primary' => false,
'metadata' => [
]
]),
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 := "https://api.example.com/v1/addresses"
payload := strings.NewReader("{\n \"rec_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"street\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"number\": \"<string>\",\n \"additional\": \"<string>\",\n \"state\": \"<string>\",\n \"is_primary\": false,\n \"metadata\": {}\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("https://api.example.com/v1/addresses")
.header("Content-Type", "application/json")
.body("{\n \"rec_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"street\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"number\": \"<string>\",\n \"additional\": \"<string>\",\n \"state\": \"<string>\",\n \"is_primary\": false,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/addresses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"rec_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"street\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"number\": \"<string>\",\n \"additional\": \"<string>\",\n \"state\": \"<string>\",\n \"is_primary\": false,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rec_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rec_type": "<string>",
"type": "<string>",
"street": "<string>",
"number": "<string>",
"additional": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"is_primary": true,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Management
Create Address
POST
/
v1
/
addresses
Create new address
curl --request POST \
--url https://api.example.com/v1/addresses \
--header 'Content-Type: application/json' \
--data '
{
"rec_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"street": "<string>",
"postal_code": "<string>",
"city": "<string>",
"country": "<string>",
"number": "<string>",
"additional": "<string>",
"state": "<string>",
"is_primary": false,
"metadata": {}
}
'import requests
url = "https://api.example.com/v1/addresses"
payload = {
"rec_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"street": "<string>",
"postal_code": "<string>",
"city": "<string>",
"country": "<string>",
"number": "<string>",
"additional": "<string>",
"state": "<string>",
"is_primary": False,
"metadata": {}
}
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({
rec_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
street: '<string>',
postal_code: '<string>',
city: '<string>',
country: '<string>',
number: '<string>',
additional: '<string>',
state: '<string>',
is_primary: false,
metadata: {}
})
};
fetch('https://api.example.com/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.example.com/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([
'rec_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'street' => '<string>',
'postal_code' => '<string>',
'city' => '<string>',
'country' => '<string>',
'number' => '<string>',
'additional' => '<string>',
'state' => '<string>',
'is_primary' => false,
'metadata' => [
]
]),
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 := "https://api.example.com/v1/addresses"
payload := strings.NewReader("{\n \"rec_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"street\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"number\": \"<string>\",\n \"additional\": \"<string>\",\n \"state\": \"<string>\",\n \"is_primary\": false,\n \"metadata\": {}\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("https://api.example.com/v1/addresses")
.header("Content-Type", "application/json")
.body("{\n \"rec_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"street\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"number\": \"<string>\",\n \"additional\": \"<string>\",\n \"state\": \"<string>\",\n \"is_primary\": false,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/addresses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"rec_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"street\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"number\": \"<string>\",\n \"additional\": \"<string>\",\n \"state\": \"<string>\",\n \"is_primary\": false,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rec_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rec_type": "<string>",
"type": "<string>",
"street": "<string>",
"number": "<string>",
"additional": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"is_primary": true,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Body
application/json
Available options:
customer, user, company Available options:
registration, actual, operational, correspondence, billing Maximum string length:
255Required string length:
3 - 10Maximum string length:
100Required string length:
2Maximum string length:
50Maximum string length:
255Maximum string length:
100Response
201 - application/json
Address created successfully
⌘I