Customer Addresses
Update customer address
Update customer address
curl --request PATCH \
--url https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/customers/{customer_pk}/addresses/{id}/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"company": "",
"phone": "",
"street_1": "<string>",
"street_2": "",
"city": "<string>",
"state_province": "",
"postal_code": "",
"country_iso2": "<string>",
"is_default_shipping": false,
"is_default_billing": false
}
'import requests
url = "https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/customers/{customer_pk}/addresses/{id}/"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"company": "",
"phone": "",
"street_1": "<string>",
"street_2": "",
"city": "<string>",
"state_province": "",
"postal_code": "",
"country_iso2": "<string>",
"is_default_shipping": False,
"is_default_billing": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
last_name: '<string>',
company: '',
phone: '',
street_1: '<string>',
street_2: '',
city: '<string>',
state_province: '',
postal_code: '',
country_iso2: '<string>',
is_default_shipping: false,
is_default_billing: false
})
};
fetch('https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/customers/{customer_pk}/addresses/{id}/', 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://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/customers/{customer_pk}/addresses/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'first_name' => '<string>',
'last_name' => '<string>',
'company' => '',
'phone' => '',
'street_1' => '<string>',
'street_2' => '',
'city' => '<string>',
'state_province' => '',
'postal_code' => '',
'country_iso2' => '<string>',
'is_default_shipping' => false,
'is_default_billing' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/customers/{customer_pk}/addresses/{id}/"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"company\": \"\",\n \"phone\": \"\",\n \"street_1\": \"<string>\",\n \"street_2\": \"\",\n \"city\": \"<string>\",\n \"state_province\": \"\",\n \"postal_code\": \"\",\n \"country_iso2\": \"<string>\",\n \"is_default_shipping\": false,\n \"is_default_billing\": false\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<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.patch("https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/customers/{customer_pk}/addresses/{id}/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"company\": \"\",\n \"phone\": \"\",\n \"street_1\": \"<string>\",\n \"street_2\": \"\",\n \"city\": \"<string>\",\n \"state_province\": \"\",\n \"postal_code\": \"\",\n \"country_iso2\": \"<string>\",\n \"is_default_shipping\": false,\n \"is_default_billing\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/customers/{customer_pk}/addresses/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"company\": \"\",\n \"phone\": \"\",\n \"street_1\": \"<string>\",\n \"street_2\": \"\",\n \"city\": \"<string>\",\n \"state_province\": \"\",\n \"postal_code\": \"\",\n \"country_iso2\": \"<string>\",\n \"is_default_shipping\": false,\n \"is_default_billing\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"last_name": "<string>",
"street_1": "<string>",
"city": "<string>",
"country_iso2": "<string>",
"company": "",
"phone": "",
"street_2": "",
"state_province": "",
"postal_code": "",
"is_default_shipping": false,
"is_default_billing": false
}Authorizations
Body
application/json
Required string length:
1 - 255Required string length:
1 - 255Maximum string length:
255Maximum string length:
50Required string length:
1 - 100Maximum string length:
100Required string length:
1 - 100The full state/province name ("North Carolina"). Required for some countries.
Maximum string length:
255Postal/ZIP code. Required for some countries.
Maximum string length:
30ISO 3166-1 alpha-2 country code ("US").
Required string length:
2Response
200 - application/json
Required string length:
1 - 255Required string length:
1 - 255Required string length:
1 - 100Required string length:
1 - 100ISO 3166-1 alpha-2 country code ("US").
Required string length:
2Maximum string length:
255Maximum string length:
50Maximum string length:
100The full state/province name ("North Carolina"). Required for some countries.
Maximum string length:
255Postal/ZIP code. Required for some countries.
Maximum string length:
30⌘I
Update customer address
curl --request PATCH \
--url https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/customers/{customer_pk}/addresses/{id}/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"company": "",
"phone": "",
"street_1": "<string>",
"street_2": "",
"city": "<string>",
"state_province": "",
"postal_code": "",
"country_iso2": "<string>",
"is_default_shipping": false,
"is_default_billing": false
}
'import requests
url = "https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/customers/{customer_pk}/addresses/{id}/"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"company": "",
"phone": "",
"street_1": "<string>",
"street_2": "",
"city": "<string>",
"state_province": "",
"postal_code": "",
"country_iso2": "<string>",
"is_default_shipping": False,
"is_default_billing": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
last_name: '<string>',
company: '',
phone: '',
street_1: '<string>',
street_2: '',
city: '<string>',
state_province: '',
postal_code: '',
country_iso2: '<string>',
is_default_shipping: false,
is_default_billing: false
})
};
fetch('https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/customers/{customer_pk}/addresses/{id}/', 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://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/customers/{customer_pk}/addresses/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'first_name' => '<string>',
'last_name' => '<string>',
'company' => '',
'phone' => '',
'street_1' => '<string>',
'street_2' => '',
'city' => '<string>',
'state_province' => '',
'postal_code' => '',
'country_iso2' => '<string>',
'is_default_shipping' => false,
'is_default_billing' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/customers/{customer_pk}/addresses/{id}/"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"company\": \"\",\n \"phone\": \"\",\n \"street_1\": \"<string>\",\n \"street_2\": \"\",\n \"city\": \"<string>\",\n \"state_province\": \"\",\n \"postal_code\": \"\",\n \"country_iso2\": \"<string>\",\n \"is_default_shipping\": false,\n \"is_default_billing\": false\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<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.patch("https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/customers/{customer_pk}/addresses/{id}/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"company\": \"\",\n \"phone\": \"\",\n \"street_1\": \"<string>\",\n \"street_2\": \"\",\n \"city\": \"<string>\",\n \"state_province\": \"\",\n \"postal_code\": \"\",\n \"country_iso2\": \"<string>\",\n \"is_default_shipping\": false,\n \"is_default_billing\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/customers/{customer_pk}/addresses/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"company\": \"\",\n \"phone\": \"\",\n \"street_1\": \"<string>\",\n \"street_2\": \"\",\n \"city\": \"<string>\",\n \"state_province\": \"\",\n \"postal_code\": \"\",\n \"country_iso2\": \"<string>\",\n \"is_default_shipping\": false,\n \"is_default_billing\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"last_name": "<string>",
"street_1": "<string>",
"city": "<string>",
"country_iso2": "<string>",
"company": "",
"phone": "",
"street_2": "",
"state_province": "",
"postal_code": "",
"is_default_shipping": false,
"is_default_billing": false
}
