🔒 Create delivery address V3

post

https://{xentralId}.xentral.biz/api/v3/customers/{customerId}/deliveryAddresses

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: customer:update.

Create a new delivery address for a customer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

string

required

Body Params

Data for creating a new delivery address

type

string

enum

Type of the delivery address recipient. Use 'company' for business addresses, 'mrs' for female recipients, 'mr' for male recipients, and 'other' for other types.

Allowed:

name

string

required

Full name of the delivery address recipient. For companies, this is the company name. For persons, this is the full name.

title

string

Title of the contact person.

contactPerson

string

Name of the contact person at this delivery address. This is typically used for company addresses to specify who should receive the delivery.

salutation

string

Salutation or greeting phrase for the delivery address. Can be used for personalized communication.

department

string

Department name at the delivery address. Useful for routing deliveries within larger organizations.

subDepartment

string

Sub department name at the delivery address. Useful for routing deliveries within larger organizations.

street

string

required

Street name and house number of the delivery address

addressSupplement

string

Additional address information such as building name, floor, hall, or specific delivery instructions for the location

zipCode

string

required

Postal code (ZIP code) of the delivery address

city

string

required

City name of the delivery address

state

string

State or region code in ISO 3166-2 format (without country prefix). Required for countries with states/provinces.

country

string

required

Country code in ISO 3166-1 alpha-2 format

gln

string

^[0-9]{13}$

Global Location Number (GLN) - a 13-digit number used to uniquely identify physical locations or legal entities globally. Used in supply chain and logistics for automated identification.

phone

string

Primary phone number for the delivery address. Used for delivery coordination and communication.

mobile

string

Mobile phone number for the delivery address contact. Useful for urgent delivery notifications.

fax

string

Fax number for the delivery address. Still used by some organizations for official communications.

string

Email address for delivery notifications and communication

deliveryDetails

object

Delivery-specific settings and information for the address

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

404

Not Found

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Create a new delivery address for a customer.

400Failed validation

429Too Many Requests