docs
  1. Admin Api
  2. Resources
  3. Customer
  4. Customer Address
  5. Update A Customer Address Reference Key

Update a customer address reference key

Update a customer address reference key

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]*$
addressId
  • required
integer

Request body

required
ParameterDetails
referenceKey
  • required
  • MinLength: 1
  • MaxLength: 100
string

Responses

200
Customer address reference key was successfully updated.
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
PUT/shops/{shopKey}/countries/{countryCode}/customers/{customerIdentifier}/addresses/{addressId}/reference-key

Request samples

Response samples

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