docs
  1. Admin Api
  2. Resources
  3. Customer
  4. Customer Address
  5. Create A New Customer Address

Create a new customer address

Create a new customer address

Rate Limit: 300 Max attempts within 1 minute.

Path Parameters

ParameterDetails
shopKey
  • required
string
Example:
ms
countryCode
  • required
string
Example:
de
customerIdentifier
  • required
string
Examples:
  • ^[1-9][0-9]*$
  • ^key%3D[0-9a-zA-Z\-\\_\.\@|%5C]*$

Request body

required
ParameterDetails
id
  • readonly
integer
referenceKey
  • MinLength: 1
  • MaxLength: 100
string
Example:
my-key
street
string
Example:
Domstraße
houseNumber
string
additional
string
zipCode
string
city
string
countryCode
  • MinLength: 3
  • MaxLength: 3
string
collectionPoint
  • required
object
customerKey
string
Pattern:
[A-z0-9]
description
string
key
string
Pattern:
[A-z0-9]
type
string
isDefault
object
billing
boolean
shipping
boolean
recipient
  • required
object
firstName
string
lastName
string
gender
string
Enum:
f
m
d
n
title
string
  • nullable
  • MaxLength: 30
type
string
Enum:
personal
retail
organization
family
phone
  • readonly
string
state
string
type
  • readonly
string
Enum:
shipping
billing
Example:
shipping
shopCountry
  • required
object
countryCode
string
  • MinLength: 2
  • MaxLength: 2
Example:
DE
defaultLanguageCode
string
  • MaxLength: 5
Example:
de_DE
supportedLanguageCodes
array
url
string
Example:
https://www.example.com
currencyCode
string
  • nullable
Example:
EUR
customData
  • nullable
assortment
object

Responses

201
Customer address was successfully created.
application/json
Success
id
integer
referenceKey
string
Example:
my-key
streetrequired
string
Example:
Domstraße
houseNumber
string
additional
string
zipCoderequired
string
cityrequired
string
countryCoderequired
string
object
object
required
object
phone
string
state
string
type
string
Example:
shipping
object
400
Bad Request
application/json
Error
401
Unauthorized
application/json
Error
404
Not Found
application/json
Error
412
Precondition failed
application/json
Error
POST/shops/{shopKey}/countries/{countryCode}/customers/{customerIdentifier}/addresses

Request samples

Response samples

201
Customer Address:
Content type: application/json
Provide Feedback