Update a customer address

cURL

curl -X PUT \
 /customer-addresses/{id} \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "countryCode": "DE",
    "vatId": "DE123456789",
    "companyName": "Acme Inc.",
    "street": "Musterstra\u00dfe 1",
    "houseNumber": "1a",
    "zip": "12345",
    "city": "Berlin",
    "addition": "c\/o John Doe",
    "costCentre": "12345"
}'

import requests

url = "https://coreapi.io/customer-addresses/{id}"

payload = {
    "countryCode": "DE",
    "firstName": "John",
    "lastName": "Doe",
    "vatId": "DE123456789",
    "companyName": "Acme Inc.",
    "street": "Musterstraße 1",
    "houseNumber": "1a",
    "zip": "12345",
    "city": "Berlin",
    "addition": "c/o John Doe",
    "salutation": "Herr",
    "costCentre": "12345",
    "type": "TYPE_DEFAULT"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    countryCode: 'DE',
    firstName: 'John',
    lastName: 'Doe',
    vatId: 'DE123456789',
    companyName: 'Acme Inc.',
    street: 'Musterstraße 1',
    houseNumber: '1a',
    zip: '12345',
    city: 'Berlin',
    addition: 'c/o John Doe',
    salutation: 'Herr',
    costCentre: '12345',
    type: 'TYPE_DEFAULT'
  })
};

fetch('https://coreapi.io/customer-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://coreapi.io/customer-addresses/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'countryCode' => 'DE',
    'firstName' => 'John',
    'lastName' => 'Doe',
    'vatId' => 'DE123456789',
    'companyName' => 'Acme Inc.',
    'street' => 'Musterstraße 1',
    'houseNumber' => '1a',
    'zip' => '12345',
    'city' => 'Berlin',
    'addition' => 'c/o John Doe',
    'salutation' => 'Herr',
    'costCentre' => '12345',
    'type' => 'TYPE_DEFAULT'
  ]),
  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;
}

{
  "id": "<string>",
  "vatId": "DE123456789",
  "type": "TYPE_DEFAULT",
  "default": "true",
  "status": "active",
  "city": "Berlin",
  "zip": "12345",
  "street": "Musterstraße",
  "houseNumber": "1a",
  "countryCode": "DE",
  "companyName": "ACME Inc.",
  "salutation": "Herr",
  "addition": "c/o John Doe",
  "costCentre": "123456789",
  "firstName": "John",
  "lastName": "Doe"
}

PUT

customer-addresses

{id}

cURL

curl -X PUT \
 /customer-addresses/{id} \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "countryCode": "DE",
    "vatId": "DE123456789",
    "companyName": "Acme Inc.",
    "street": "Musterstra\u00dfe 1",
    "houseNumber": "1a",
    "zip": "12345",
    "city": "Berlin",
    "addition": "c\/o John Doe",
    "costCentre": "12345"
}'

import requests

url = "https://coreapi.io/customer-addresses/{id}"

payload = {
    "countryCode": "DE",
    "firstName": "John",
    "lastName": "Doe",
    "vatId": "DE123456789",
    "companyName": "Acme Inc.",
    "street": "Musterstraße 1",
    "houseNumber": "1a",
    "zip": "12345",
    "city": "Berlin",
    "addition": "c/o John Doe",
    "salutation": "Herr",
    "costCentre": "12345",
    "type": "TYPE_DEFAULT"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    countryCode: 'DE',
    firstName: 'John',
    lastName: 'Doe',
    vatId: 'DE123456789',
    companyName: 'Acme Inc.',
    street: 'Musterstraße 1',
    houseNumber: '1a',
    zip: '12345',
    city: 'Berlin',
    addition: 'c/o John Doe',
    salutation: 'Herr',
    costCentre: '12345',
    type: 'TYPE_DEFAULT'
  })
};

fetch('https://coreapi.io/customer-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://coreapi.io/customer-addresses/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'countryCode' => 'DE',
    'firstName' => 'John',
    'lastName' => 'Doe',
    'vatId' => 'DE123456789',
    'companyName' => 'Acme Inc.',
    'street' => 'Musterstraße 1',
    'houseNumber' => '1a',
    'zip' => '12345',
    'city' => 'Berlin',
    'addition' => 'c/o John Doe',
    'salutation' => 'Herr',
    'costCentre' => '12345',
    'type' => 'TYPE_DEFAULT'
  ]),
  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;
}

{
  "id": "<string>",
  "vatId": "DE123456789",
  "type": "TYPE_DEFAULT",
  "default": "true",
  "status": "active",
  "city": "Berlin",
  "zip": "12345",
  "street": "Musterstraße",
  "houseNumber": "1a",
  "countryCode": "DE",
  "companyName": "ACME Inc.",
  "salutation": "Herr",
  "addition": "c/o John Doe",
  "costCentre": "123456789",
  "firstName": "John",
  "lastName": "Doe"
}

Autorisierungen

Authorization

string

header

erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

string

erforderlich

CustomerAddress identifier

Body

The updated CustomerAddress resource

countryCode

string | null

If not provided, we will use the customer country code.

Beispiel:

"DE"

firstName

string | null

Can be empty if the customer is a company.

Maximum string length: 255

Beispiel:

"John"

lastName

string | null

Can be empty if the customer is a company.

Maximum string length: 255

Beispiel:

"Doe"

vatId

string | null

If not provided, we will use the customer vat id.

Required string length: 2 - 255

Beispiel:

"DE123456789"

companyName

string | null

Maximum string length: 255

Beispiel:

"Acme Inc."

street

string | null

The street of the customer. If not provided, we will use empty string.

Required string length: 2 - 255

Beispiel:

"Musterstraße 1"

houseNumber

string | null

The house number of the customer. If not provided, we will use empty string.

Maximum string length: 255

Beispiel:

"1a"

zip

string | null

The zip code of the customer. If not provided, we will use empty string.

Beispiel:

"12345"

city

string | null

The city of the customer. If not provided, we will use empty string.

Required string length: 2 - 255

Beispiel:

"Berlin"

addition

string | null

Additional address line of the customer. If not provided, we will use empty string.

Maximum string length: 255

Beispiel:

"c/o John Doe"

salutation

enum<string>

Verfügbare Optionen:

Firma,

Herr,

Frau

Beispiel:

"Herr"

costCentre

string | null

The cost centre of the customer. If not provided, we will use empty string.

Required string length: 2 - 255

Beispiel:

"12345"

type

enum<string>

Verfügbare Optionen:

TYPE_DEFAULT,

TYPE_INVOICE

Required string length: 2 - 255

Beispiel:

"TYPE_DEFAULT"

Antwort

CustomerAddress resource updated

string

read-only

vatId

string | null

VAT ID, which will be used to bill to. If not provided, we will use the customer vat id.

Beispiel:

"DE123456789"

type

enum<string>

Verfügbare Optionen:

TYPE_DEFAULT,

TYPE_INVOICE

Beispiel:

"TYPE_DEFAULT"

default

boolean

Beispiel:

"true"

status

enum<string>

read-only

Verfügbare Optionen:

active,

archived

Beispiel:

"active"

city

string

Beispiel:

"Berlin"

zip

string

Beispiel:

"12345"

street

string

Beispiel:

"Musterstraße"

houseNumber

string

Beispiel:

"1a"

countryCode

string

Beispiel:

"DE"

companyName

string | null

Company name, which will be used to bill to.

Beispiel:

"ACME Inc."

salutation

enum<string>

Verfügbare Optionen:

Firma,

Herr,

Frau

Beispiel:

"Herr"

addition

string | null

Additional address information, which will be shown on generated documents like invoices, reminders, etc.

Beispiel:

"c/o John Doe"

costCentre

string | null

Cost centre, which will be shown on generated documents like invoices, reminders, etc.

Beispiel:

"123456789"

firstName

string | null

First name, which will be shown on generated documents like invoices, reminders, etc.

Beispiel:

"John"

lastName

string | null

Last name, which will be shown on generated documents like invoices, reminders, etc.

Beispiel:

"Doe"

Get a customer address Delete a customer address