Create address

Create customer address

Request body

Parameter	Details
additional	string
city required	string
state	string
collectionPoint required	object customerKey string Pattern: [A-z0-9] description string Pattern: [!-ɏ0-9 ] key string Pattern: [A-z0-9] type Enum: hermes_parcelshop dhl_packstation dhl_postoffice postsk_postoffice postsk_parcelbox gls_postoffice post_office
countryCode required MinLength: 3 MaxLength: 3	string
customer required	object Examples: { "required": [ "id" ] } { "required": [ "referenceKey" ] } id integer referenceKey string MinLength: 1 MaxLength: 100 Pattern: ^[0-9a-zA-Z\-\\_]*$ One of (required): - id - referenceKey
houseNumber	string
isDefault	object billing boolean shipping boolean
recipient required	object firstName string Pattern: [!-ɏ0-9 ] gender Enum: m f lastName string Pattern: [!-ɏ0-9 ] title string nullable MaxLength: 30
referenceKey MinLength: 1 MaxLength: 100	string
street required	string
zipCode nullable	string integer

Responses

200

request was successful

application/json

Success

additional

string

cityrequired

string

state

string

object

countryCoderequired

string

createdAtrequired

string

required

object

houseNumber

string

idrequired

integer

required

object

required

object

referenceKey

string

streetrequired

string

updatedAtrequired

string

null

400

Bad Request (the information provided is invalid or inaccurate)

Error

401

Unauthorized (unable to verify provided API credentials)

Error

403

invalid access token

Error

404

customer not found

Error

405

Method Not Allowed (wrong HTTP method used)

Error

406

Not Acceptable (wrong Content-Type provided)

Error

422

formal validation failure (see schema)

Error

POST/oauth/customer/address

Response samples

200

Content type: application/json