Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Customer Delivery Address

🔒 Create delivery address V3

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.

post/api/v3/customers/{customerId}/deliveryAddresses

Path parameters

customerIdstring required

Request body

type'mrs' | 'mr' | 'company' | 'other'

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

namestring required

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

titlestring

Title of the contact person.

contactPersonstring

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

salutationstring

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

departmentstring

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

subDepartmentstring

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

streetstring required

Street name and house number of the delivery address

addressSupplementstring

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

zipCodestring required

Postal code (ZIP code) of the delivery address

citystring required

City name of the delivery address

statestring

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

countrystring required

Country code in ISO 3166-1 alpha-2 format

glnstring

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.

phonestring

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

mobilestring

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

faxstring

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

emailstring email

Email address for delivery notifications and communication

Example request

{
  "type": "company",
  "name": "Acme Logistics Hub Berlin",
  "title": "Dr.",
  "contactPerson": "Marco Schmidt",
  "salutation": "Hallo Logistics Team",
  "department": "Logistics",
  "subDepartment": "Distribution Center",
  "street": "Lagerweg 22",
  "addressSupplement": "Hall B",
  "zipCode": "10437",
  "city": "Berlin",
  "state": "BE",
  "country": "DE",
  "gln": "4012345000300",
  "phone": "+491231234567",
  "mobile": "+49170123456",
  "fax": "+491231234567-1",
  "email": "name@provider.com",
  "deliveryDetails": {
    "taxType": "domestic",
    "termsOfDelivery": "EXW",
    "vatId": "DE123456789",
    "remark": "Main Berlin hub open 06:00 to 22:00",
    "note": "Deliveries after 10am only"
  }
}

Response

Create a new delivery address for a customer.

Example response

{
  "data": {
    "id": "1",
    "type": "company",
    "name": "Acme Logistics Hub Berlin",
    "title": "Dr.",
    "contactPerson": "Marco Schmidt",
    "salutation": "Hallo Logistics Team",
    "department": "Logistics",
    "subDepartment": "Distribution Center",
    "addressSupplement": "Hall B",
    "street": "Lagerweg 22",
    "zipCode": "10437",
    "city": "Berlin",
    "state": "BE",
    "country": "DE",
    "gln": "4012345000300",
    "phone": "+491231234567",
    "mobile": "+49170123456",
    "fax": "+491231234567-1",
    "email": "name@provider.com",
    "deliveryDetails": {
      "taxType": "domestic",
      "defaultDeliveryAddress": true,
      "termsOfDelivery": "EXW",
      "vatId": "DE123456789",
      "remark": "Main Berlin hub open 06:00 to 22:00",
      "note": "Deliveries after 10am only"
    }
  }
}