REST Account Address

List, get, create, update or delete addresses and relations to orders and contacts. The address is the general address data record. The address relation is the relation between the address and the contact or order. In the address relation, the type of address, e.g. delivery address, is also defined.

Get an address

Gets an address. The ID of the address must be specified.

/rest/accounts/addresses/{addressId}

Success 200

Field Type Description
id Int The ID of the address
gender String The gender (female or male)
name1 String The name 1 field (default: company name)
name2 String The name 2 field (default: first name)
name3 String The name 3 field (default: last name)
name4 String The name 4 field (default: c/o)
companyName String The company name (read only)
firstName String The first name (read only)
lastName String The last name (read only)
careOf String The c/o (read only)
address1 String The address 1 field (street|PACKSTATION|POSTFILIALE)
address2 String The address 2 field (house no|packstation id)
address3 String The address 3 field (additional)
address4 String The address 4 field is currently undefined and can be freely used.
street String The street (read only)
houseNumber String The house number (read only)
additional String The additional address information (read only)
postalCode String The postcode
town String The town
countryId Int The ID of the country
stateId Int The ID of the state
readOnly Bool Flag that indicates if the data record is read only
sessionId String The session ID that was used when the address was created
checkedAt String|\Carbon The time the address was checked as unix timestamp
createdAt String|\Carbon The time the address was created as unix timestamp
updatedAt String|\Carbon The time the address was last updated as unix timestamp
taxIdNumber String The taxIdNumber option
title String The title option
externalId String The externalId option
entryCertificate Bool The entryCertificate option
phone String The phone option
email String The email option
postident String The PostIdent option
fsk String The age rating option
birthday String The birthday option
personalNumber String The personal number option
packstationNo String The packstation number
isPackstation Bool Flag that indicates if the address is a packstation
isPostfiliale Bool Flag that indicates if the address is a postfiliale (post office)

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create an address

/rest/accounts/addresses

Request

Field Type Description
name1 String The name 1 field (default: company name)
name2 String The name 2 field (default: first name)
name3 String The name 3 field (default: last name)
address1 String The address 1 field (street|PACKSTATION|POSTFILIALE)
address2 String The address 2 field (house no|packstation id)
address3 String The address 3 field (additional)
town String The town required
countryId Int The ID of the country required
options \Collection A collection of address options optional array
 typeId required
 value optional
{"isPrimary":1,"gender":"male","name1":"","name2":"John","name3":"Doe","address1":"B\u00fcrgermeister-Brunner-Stra\u00dfe","address2":"15","address3":"third floor, left side","postalCode":"34117","town":"Kassel","countryId":1,"options":[{"typeId":5,"value":"john@account.com"},{"typeId":4,"value":"05683 4798354"}]}

Success 200

Field Type Description
id Int The ID of the address
gender String The gender (female or male)
name1 String The name 1 field (default: company name)
name2 String The name 2 field (default: first name)
name3 String The name 3 field (default: last name)
name4 String The name 4 field (default: c/o)
companyName String The company name (read only)
firstName String The first name (read only)
lastName String The last name (read only)
careOf String The c/o (read only)
address1 String The address 1 field (street|PACKSTATION|POSTFILIALE)
address2 String The address 2 field (house no|packstation id)
address3 String The address 3 field (additional)
address4 String The address 4 field is currently undefined and can be freely used.
street String The street (read only)
houseNumber String The house number (read only)
additional String The additional address information (read only)
postalCode String The postcode
town String The town
countryId Int The ID of the country
stateId Int The ID of the state
readOnly Bool Flag that indicates if the data record is read only
sessionId String The session ID that was used when the address was created
checkedAt String|\Carbon The time the address was checked as unix timestamp
createdAt String|\Carbon The time the address was created as unix timestamp
updatedAt String|\Carbon The time the address was last updated as unix timestamp
taxIdNumber String The taxIdNumber option
title String The title option
externalId String The externalId option
entryCertificate Bool The entryCertificate option
phone String The phone option
email String The email option
postident String The PostIdent option
fsk String The age rating option
birthday String The birthday option
personalNumber String The personal number option
packstationNo String The packstation number
isPackstation Bool Flag that indicates if the address is a packstation
isPostfiliale Bool Flag that indicates if the address is a postfiliale (post office)
{"id":5,"gender":"male","name1":"","name2":"Michael","name3":"Stefan","name4":null,"address1":"B\u00fcrgermeister-Brunner-Stra\u00dfe","address2":"15","address3":"third floor, left side","address4":null,"postalCode":"34117","town":"Kassel","countryId":1,"stateId":null,"readOnly":false,"checkedAt":null,"createdAt":"2016-09-13T17:34:25+02:00","updatedAt":"2016-09-13T17:34:25+02:00","options":[{"id":10,"addressId":5,"typeId":4,"value":"05683 4798354","position":"0","createdAt":"2016-09-13 17:34:25","updatedAt":"2016-09-13 17:34:25"},{"id":9,"addressId":5,"typeId":5,"value":"john@account.com","position":"0","createdAt":"2016-09-13 17:34:25","updatedAt":"2016-09-13 17:34:25"}]}

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update an address

Updates an address. The ID of the address must be specified.

/rest/accounts/addresses/{addressId}

Request

Field Type Description
name1 String The name 1 field (default: company name)
name2 String The name 2 field (default: first name)
name3 String The name 3 field (default: last name)
address1 String The address 1 field (street|PACKSTATION|POSTFILIALE)
address2 String The address 2 field (house no|packstation id)
address3 String The address 3 field (additional)
town String The town required
countryId Int The ID of the country required
options \Collection A collection of address options optional array
 typeId required
 value optional
{"isPrimary":1,"gender":"male","name1":"","name2":"John","name3":"Doe","address1":"B\u00fcrgermeister-Brunner-Stra\u00dfe","address2":"15","address3":"third floor, left side","postalCode":"34117","town":"Kassel","countryId":1,"options":[{"typeId":5,"value":"john@account.com"},{"typeId":4,"value":"05683 4798354"}]}

Success 200

Field Type Description
id Int The ID of the address
gender String The gender (female or male)
name1 String The name 1 field (default: company name)
name2 String The name 2 field (default: first name)
name3 String The name 3 field (default: last name)
name4 String The name 4 field (default: c/o)
companyName String The company name (read only)
firstName String The first name (read only)
lastName String The last name (read only)
careOf String The c/o (read only)
address1 String The address 1 field (street|PACKSTATION|POSTFILIALE)
address2 String The address 2 field (house no|packstation id)
address3 String The address 3 field (additional)
address4 String The address 4 field is currently undefined and can be freely used.
street String The street (read only)
houseNumber String The house number (read only)
additional String The additional address information (read only)
postalCode String The postcode
town String The town
countryId Int The ID of the country
stateId Int The ID of the state
readOnly Bool Flag that indicates if the data record is read only
sessionId String The session ID that was used when the address was created
checkedAt String|\Carbon The time the address was checked as unix timestamp
createdAt String|\Carbon The time the address was created as unix timestamp
updatedAt String|\Carbon The time the address was last updated as unix timestamp
taxIdNumber String The taxIdNumber option
title String The title option
externalId String The externalId option
entryCertificate Bool The entryCertificate option
phone String The phone option
email String The email option
postident String The PostIdent option
fsk String The age rating option
birthday String The birthday option
personalNumber String The personal number option
packstationNo String The packstation number
isPackstation Bool Flag that indicates if the address is a packstation
isPostfiliale Bool Flag that indicates if the address is a postfiliale (post office)
{"id":5,"gender":"male","name1":"","name2":"Michael","name3":"Stefan","name4":null,"address1":"B\u00fcrgermeister-Brunner-Stra\u00dfe","address2":"15","address3":"third floor, left side","address4":null,"postalCode":"34117","town":"Kassel","countryId":1,"stateId":null,"readOnly":false,"checkedAt":null,"createdAt":"2016-09-13T17:34:25+02:00","updatedAt":"2016-09-13T17:34:25+02:00","options":[{"id":10,"addressId":5,"typeId":4,"value":"05683 4798354","position":"0","createdAt":"2016-09-13 17:34:25","updatedAt":"2016-09-13 17:34:25"},{"id":9,"addressId":5,"typeId":5,"value":"john@account.com","position":"0","createdAt":"2016-09-13 17:34:25","updatedAt":"2016-09-13 17:34:25"}]}

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Delete an address

Deletes an address. The ID of the address must be specified.

/rest/accounts/addresses/{addressId}

Success 200

This call does not have a response output.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List order addresses

Lists order addresses. The ID of the order must be specified.

/rest/orders/{orderId}/addresses/{relationTypeId?}

Success 200

Field Type Description
id Int The ID of the address order relation
orderId Int The ID of the order
typeId Int The ID of the address type
  • Billing address = 1
  • Delivery address = 2
  • Sender address = 3
  • Return address = 4
  • Client address = 5
  • Contractor address = 6
  • Warehouse address = 7
addressId Int The ID of the address
address \Address The address of the relation (Object)
 id Int The ID of the address
 gender String The gender (female or male)
 name1 String The name 1 field (default: company name)
 name2 String The name 2 field (default: first name)
 name3 String The name 3 field (default: last name)
 name4 String The name 4 field (default: c/o)
 companyName String The company name (read only)
 firstName String The first name (read only)
 lastName String The last name (read only)
 careOf String The c/o (read only)
 address1 String The address 1 field (street|PACKSTATION|POSTFILIALE)
 address2 String The address 2 field (house no|packstation id)
 address3 String The address 3 field (additional)
 address4 String The address 4 field is currently undefined and can be freely used.
 street String The street (read only)
 houseNumber String The house number (read only)
 additional String The additional address information (read only)
 postalCode String The postcode
 town String The town
 countryId Int The ID of the country
 stateId Int The ID of the state
 readOnly Bool Flag that indicates if the data record is read only
 sessionId String The session ID that was used when the address was created
 checkedAt String|\Carbon The time the address was checked as unix timestamp
 createdAt String|\Carbon The time the address was created as unix timestamp
 updatedAt String|\Carbon The time the address was last updated as unix timestamp
 taxIdNumber String The taxIdNumber option
 title String The title option
 externalId String The externalId option
 entryCertificate Bool The entryCertificate option
 phone String The phone option
 email String The email option
 postident String The PostIdent option
 fsk String The age rating option
 birthday String The birthday option
 personalNumber String The personal number option
 packstationNo String The packstation number
 isPackstation Bool Flag that indicates if the address is a packstation
 isPostfiliale Bool Flag that indicates if the address is a postfiliale (post office)

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create an address for existing order

Creates an address for an existing order.

/rest/orders/addresses

Success 200

Field Type Description
id Int The ID of the address order relation
orderId Int The ID of the order
typeId Int The ID of the address type
  • Billing address = 1
  • Delivery address = 2
  • Sender address = 3
  • Return address = 4
  • Client address = 5
  • Contractor address = 6
  • Warehouse address = 7
addressId Int The ID of the address
address \Address The address of the relation (Object)
 id Int The ID of the address
 gender String The gender (female or male)
 name1 String The name 1 field (default: company name)
 name2 String The name 2 field (default: first name)
 name3 String The name 3 field (default: last name)
 name4 String The name 4 field (default: c/o)
 companyName String The company name (read only)
 firstName String The first name (read only)
 lastName String The last name (read only)
 careOf String The c/o (read only)
 address1 String The address 1 field (street|PACKSTATION|POSTFILIALE)
 address2 String The address 2 field (house no|packstation id)
 address3 String The address 3 field (additional)
 address4 String The address 4 field is currently undefined and can be freely used.
 street String The street (read only)
 houseNumber String The house number (read only)
 additional String The additional address information (read only)
 postalCode String The postcode
 town String The town
 countryId Int The ID of the country
 stateId Int The ID of the state
 readOnly Bool Flag that indicates if the data record is read only
 sessionId String The session ID that was used when the address was created
 checkedAt String|\Carbon The time the address was checked as unix timestamp
 createdAt String|\Carbon The time the address was created as unix timestamp
 updatedAt String|\Carbon The time the address was last updated as unix timestamp
 taxIdNumber String The taxIdNumber option
 title String The title option
 externalId String The externalId option
 entryCertificate Bool The entryCertificate option
 phone String The phone option
 email String The email option
 postident String The PostIdent option
 fsk String The age rating option
 birthday String The birthday option
 personalNumber String The personal number option
 packstationNo String The packstation number
 isPackstation Bool Flag that indicates if the address is a packstation
 isPostfiliale Bool Flag that indicates if the address is a postfiliale (post office)

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List warehouse addresses

List warehouse addresses. The ID of the warehouse must be specified.

/rest/stockmanagement/warehouses/{warehouseId}/addresses/{relationTypeId?}

Success 200

Field Type Description
id Int The ID of the address warehouse relation
warehouseId Int The ID of the warehouse
typeId Int The ID of the type
addressId Int The ID of the address
address \Address The address of the relation (Object)
 id Int The ID of the address
 gender String The gender (female or male)
 name1 String The name 1 field (default: company name)
 name2 String The name 2 field (default: first name)
 name3 String The name 3 field (default: last name)
 name4 String The name 4 field (default: c/o)
 companyName String The company name (read only)
 firstName String The first name (read only)
 lastName String The last name (read only)
 careOf String The c/o (read only)
 address1 String The address 1 field (street|PACKSTATION|POSTFILIALE)
 address2 String The address 2 field (house no|packstation id)
 address3 String The address 3 field (additional)
 address4 String The address 4 field is currently undefined and can be freely used.
 street String The street (read only)
 houseNumber String The house number (read only)
 additional String The additional address information (read only)
 postalCode String The postcode
 town String The town
 countryId Int The ID of the country
 stateId Int The ID of the state
 readOnly Bool Flag that indicates if the data record is read only
 sessionId String The session ID that was used when the address was created
 checkedAt String|\Carbon The time the address was checked as unix timestamp
 createdAt String|\Carbon The time the address was created as unix timestamp
 updatedAt String|\Carbon The time the address was last updated as unix timestamp
 taxIdNumber String The taxIdNumber option
 title String The title option
 externalId String The externalId option
 entryCertificate Bool The entryCertificate option
 phone String The phone option
 email String The email option
 postident String The PostIdent option
 fsk String The age rating option
 birthday String The birthday option
 personalNumber String The personal number option
 packstationNo String The packstation number
 isPackstation Bool Flag that indicates if the address is a packstation
 isPostfiliale Bool Flag that indicates if the address is a postfiliale (post office)

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create an address for existing warehouse

/rest/stockmanagement/warehouses/addresses

Success 200

Field Type Description
id Int The ID of the address warehouse relation
warehouseId Int The ID of the warehouse
typeId Int The ID of the type
addressId Int The ID of the address
address \Address The address of the relation (Object)
 id Int The ID of the address
 gender String The gender (female or male)
 name1 String The name 1 field (default: company name)
 name2 String The name 2 field (default: first name)
 name3 String The name 3 field (default: last name)
 name4 String The name 4 field (default: c/o)
 companyName String The company name (read only)
 firstName String The first name (read only)
 lastName String The last name (read only)
 careOf String The c/o (read only)
 address1 String The address 1 field (street|PACKSTATION|POSTFILIALE)
 address2 String The address 2 field (house no|packstation id)
 address3 String The address 3 field (additional)
 address4 String The address 4 field is currently undefined and can be freely used.
 street String The street (read only)
 houseNumber String The house number (read only)
 additional String The additional address information (read only)
 postalCode String The postcode
 town String The town
 countryId Int The ID of the country
 stateId Int The ID of the state
 readOnly Bool Flag that indicates if the data record is read only
 sessionId String The session ID that was used when the address was created
 checkedAt String|\Carbon The time the address was checked as unix timestamp
 createdAt String|\Carbon The time the address was created as unix timestamp
 updatedAt String|\Carbon The time the address was last updated as unix timestamp
 taxIdNumber String The taxIdNumber option
 title String The title option
 externalId String The externalId option
 entryCertificate Bool The entryCertificate option
 phone String The phone option
 email String The email option
 postident String The PostIdent option
 fsk String The age rating option
 birthday String The birthday option
 personalNumber String The personal number option
 packstationNo String The packstation number
 isPackstation Bool Flag that indicates if the address is a packstation
 isPostfiliale Bool Flag that indicates if the address is a postfiliale (post office)

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create an address warehouse relation

/rest/accounts/addresses/warehouse_relations

Success 200

Field Type Description
id Int The ID of the address warehouse relation
warehouseId Int The ID of the warehouse
typeId Int The ID of the type
addressId Int The ID of the address
address \Address The address of the relation (Object)
 id Int The ID of the address
 gender String The gender (female or male)
 name1 String The name 1 field (default: company name)
 name2 String The name 2 field (default: first name)
 name3 String The name 3 field (default: last name)
 name4 String The name 4 field (default: c/o)
 companyName String The company name (read only)
 firstName String The first name (read only)
 lastName String The last name (read only)
 careOf String The c/o (read only)
 address1 String The address 1 field (street|PACKSTATION|POSTFILIALE)
 address2 String The address 2 field (house no|packstation id)
 address3 String The address 3 field (additional)
 address4 String The address 4 field is currently undefined and can be freely used.
 street String The street (read only)
 houseNumber String The house number (read only)
 additional String The additional address information (read only)
 postalCode String The postcode
 town String The town
 countryId Int The ID of the country
 stateId Int The ID of the state
 readOnly Bool Flag that indicates if the data record is read only
 sessionId String The session ID that was used when the address was created
 checkedAt String|\Carbon The time the address was checked as unix timestamp
 createdAt String|\Carbon The time the address was created as unix timestamp
 updatedAt String|\Carbon The time the address was last updated as unix timestamp
 taxIdNumber String The taxIdNumber option
 title String The title option
 externalId String The externalId option
 entryCertificate Bool The entryCertificate option
 phone String The phone option
 email String The email option
 postident String The PostIdent option
 fsk String The age rating option
 birthday String The birthday option
 personalNumber String The personal number option
 packstationNo String The packstation number
 isPackstation Bool Flag that indicates if the address is a packstation
 isPostfiliale Bool Flag that indicates if the address is a postfiliale (post office)

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update an address warehouse relation

Updates an address warehouse relation. The ID of the relation must be specified.

/rest/accounts/addresses/warehouse_relations/{relationId}

Success 200

Field Type Description
id Int The ID of the address warehouse relation
warehouseId Int The ID of the warehouse
typeId Int The ID of the type
addressId Int The ID of the address
address \Address The address of the relation (Object)
 id Int The ID of the address
 gender String The gender (female or male)
 name1 String The name 1 field (default: company name)
 name2 String The name 2 field (default: first name)
 name3 String The name 3 field (default: last name)
 name4 String The name 4 field (default: c/o)
 companyName String The company name (read only)
 firstName String The first name (read only)
 lastName String The last name (read only)
 careOf String The c/o (read only)
 address1 String The address 1 field (street|PACKSTATION|POSTFILIALE)
 address2 String The address 2 field (house no|packstation id)
 address3 String The address 3 field (additional)
 address4 String The address 4 field is currently undefined and can be freely used.
 street String The street (read only)
 houseNumber String The house number (read only)
 additional String The additional address information (read only)
 postalCode String The postcode
 town String The town
 countryId Int The ID of the country
 stateId Int The ID of the state
 readOnly Bool Flag that indicates if the data record is read only
 sessionId String The session ID that was used when the address was created
 checkedAt String|\Carbon The time the address was checked as unix timestamp
 createdAt String|\Carbon The time the address was created as unix timestamp
 updatedAt String|\Carbon The time the address was last updated as unix timestamp
 taxIdNumber String The taxIdNumber option
 title String The title option
 externalId String The externalId option
 entryCertificate Bool The entryCertificate option
 phone String The phone option
 email String The email option
 postident String The PostIdent option
 fsk String The age rating option
 birthday String The birthday option
 personalNumber String The personal number option
 packstationNo String The packstation number
 isPackstation Bool Flag that indicates if the address is a packstation
 isPostfiliale Bool Flag that indicates if the address is a postfiliale (post office)

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Delete an address warehouse relation

Deletes an address warehouse relation. The ID of the relation must be specified.

/rest/accounts/addresses/warehouse_relations/{relationId}

Success 200

This call does not have a response output.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List address options

Lists address options. The ID of the address must be specified.

/rest/accounts/addresses/{addressId}/options

Success 200

Field Type Description
id Int The ID of the address option
addressId Int The ID of the address
typeId Int The ID of the address option type
value String The option value
position Int The position for sorting
createdAt String|\Carbon The time the option was created as unix timestamp
updatedAt String|\Carbon The time the option was last updated as unix timestamp

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create an address option

Creates an address option. The ID of the address must be specified.

/rest/accounts/addresses/{addressId}/options

Request

Field Type Description
typeId Int The ID of the address option type required
value String The option value required
position Int The position for sorting optional
[{"typeId":12,"value":"Erika Musterfrau","position":0}]

Success 200

Field Type Description
id Int The ID of the address option
addressId Int The ID of the address
typeId Int The ID of the address option type
value String The option value
position Int The position for sorting
createdAt String|\Carbon The time the option was created as unix timestamp
updatedAt String|\Carbon The time the option was last updated as unix timestamp

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update the address options for an address

/rest/accounts/addresses/{addressId}/options

Success 200

Field Type Description
id Int The ID of the address option
addressId Int The ID of the address
typeId Int The ID of the address option type
value String The option value
position Int The position for sorting
createdAt String|\Carbon The time the option was created as unix timestamp
updatedAt String|\Carbon The time the option was last updated as unix timestamp

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Delete an address option by the address ID

Deletes an address option. The ID of the address must be specified.

/rest/accounts/addresses/{addressId}/options

Success 200

This call does not have a response output.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get an address option

Gets an address option. The ID of the option must be specified.

/rest/accounts/addresses/options/{optionId}

Success 200

Field Type Description
id Int The ID of the address option
addressId Int The ID of the address
typeId Int The ID of the address option type
value String The option value
position Int The position for sorting
createdAt String|\Carbon The time the option was created as unix timestamp
updatedAt String|\Carbon The time the option was last updated as unix timestamp

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update an address option

Updates an address option. The ID of the option must be specified.

/rest/accounts/addresses/options/{optionId}

Success 200

Field Type Description
id Int The ID of the address option
addressId Int The ID of the address
typeId Int The ID of the address option type
value String The option value
position Int The position for sorting
createdAt String|\Carbon The time the option was created as unix timestamp
updatedAt String|\Carbon The time the option was last updated as unix timestamp

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Delete an address option by the option ID

Deletes an address option. The ID of the option must be specified.

/rest/accounts/addresses/options/{optionId}

Success 200

This call does not have a response output.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List address relation types

Lists address relation types. The application and the language must be specified.
Possible applications:

  • contact
  • order
  • warehouse
  • pos

/rest/accounts/addresses/relations/types/applications/{application}/{lang}

Success 200

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create an address POS relation

/rest/accounts/addresses/pos_relations

Success 200

Field Type Description
id Int The ID of the address POS relation
posBaseId String The ID of the POS base
addressId String The ID of the address
typeId Int The ID of the relation type
{"id":1,"posBaseId":2,"typeId":1,"addressId":5}

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update an address POS relation

Updates an address POS relation. The ID of the address POS relation must be specified.

/rest/accounts/addresses/pos_relations/{addressPosRelationId}

Success 200

Field Type Description
id Int The ID of the address POS relation
posBaseId String The ID of the POS base
addressId String The ID of the address
typeId Int The ID of the relation type
{"id":1,"posBaseId":2,"typeId":1,"addressId":5}

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get an address POS relation

Gets an address POS relation. The ID of the address POS relation must be specified.

/rest/accounts/addresses/pos_relations/{addressPosRelationId}

Success 200

Field Type Description
id Int The ID of the address POS relation
posBaseId String The ID of the POS base
addressId String The ID of the address
typeId Int The ID of the relation type
{"id":1,"posBaseId":2,"typeId":1,"addressId":5}

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Delete an address POS relation

Deletes an address POS relation. The ID of the address POS relation must be specified.

/rest/accounts/addresses/pos_relations/{addressPosRelationId}

Success 200

This call does not have a response output.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List address POS relations

/rest/accounts/addresses/pos_relations

Parameters

Field Type Description
page Int page
itemsPerPage Int items per page
with String Includes the specified address pos relation information in the results. The following parameters are available: address and type. More than one parameter should be separated by commas.

Success 200

Field Type Description
page Int Current page of the response
totalsCount Int The total number of entries in the response
isLastPage Bool Flag that indicates if the page shown is the last page of the response
lastPageNumber Int The last page number
firstOnPage Int The index of the first item of the current page result
lastOnPage Int The index of the last item of the current page result
itemsPerPage Int The requested amount of items per result page
entries AddressPosRelation[] List of AddressPosRelation
 id Int The ID of the address POS relation
 posBaseId String The ID of the POS base
 addressId String The ID of the address
 typeId Int The ID of the relation type
{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"id":1,"posBaseId":2,"typeId":1,"addressId":5},{"id":1,"posBaseId":2,"typeId":1,"addressId":5}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create address contact relations

/rest/accounts/addresses/contact_relations

Request

Field Type Description
isPrimary Bool Flag that indicates if the address is primary optional
contactId Int The ID of the contact required
addressId Int The ID of the address required
typeId Int The type ID of the address. Possible values:
  • Invoice address = 1
  • Delivery address = 2
required
[{"contactId":9065,"typeId":1,"addressId":85432,"isPrimary":false},{"contactId":69475,"typeId":1,"addressId":23662,"isPrimary":false}]

Success 200

Field Type Description
id Int The ID of the address contact relation
contactId Int The ID of the contact
typeId Int The type ID of the address. Possible values:
  • Invoice address = 1
  • Delivery address = 2
addressId Int The ID of the address
isPrimary Bool Flag that indicates if the address is primary
[{"id":71872,"contactId":40091,"typeId":2,"addressId":22981,"isPrimary":false},{"id":51855,"contactId":61573,"typeId":2,"addressId":54392,"isPrimary":false}]

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update address contact relations

/rest/accounts/addresses/contact_relations

Request

Field Type Description
isPrimary Bool Flag that indicates if the address is primary optional
id Int The ID of the address contact relation required
contactId Int The ID of the contact optional
addressId Int The ID of the address optional
typeId Int The type ID of the address. Possible values:
  • Invoice address = 1
  • Delivery address = 2
optional
[{"id":48482,"contactId":27278,"typeId":1,"addressId":40441,"isPrimary":false},{"id":61147,"contactId":15535,"typeId":1,"addressId":62904,"isPrimary":false}]

Success 200

Field Type Description
id Int The ID of the address contact relation
contactId Int The ID of the contact
typeId Int The type ID of the address. Possible values:
  • Invoice address = 1
  • Delivery address = 2
addressId Int The ID of the address
isPrimary Bool Flag that indicates if the address is primary
[{"id":14470,"contactId":97093,"typeId":2,"addressId":53066,"isPrimary":false},{"id":52921,"contactId":38222,"typeId":1,"addressId":78623,"isPrimary":false}]

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get an address contact relation

Gets an address contact relation. The ID of the address contact relation must be specified.

/rest/accounts/addresses/contact_relations/{addressContactRelationId}

Success 200

Field Type Description
id Int The ID of the address contact relation
contactId Int The ID of the contact
typeId Int The type ID of the address. Possible values:
  • Invoice address = 1
  • Delivery address = 2
addressId Int The ID of the address
isPrimary Bool Flag that indicates if the address is primary
{"id":19784,"contactId":43999,"typeId":2,"addressId":46385,"isPrimary":false}

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Delete an address contact relation

Deletes an address contact relation. The ID of the relation must be specified.

/rest/accounts/addresses/contact_relations/{addressContactRelationId}

Success 200

This call does not have a response output.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List address contact relations

/rest/accounts/addresses/contact_relations

Parameters

Field Type Description
id Int Filter that restricts the search result to address contact relations with a specific ID
contactId Int Filter that restricts the search result to contacts with a specific ID
typeId Int Filter that restricts the search result to address types with a specific ID
addressId Int Filter that restricts the search result to addresses with a specific ID
isPrimary Bool Filter that restricts the search result depending on the flag used. If the flag isPrimary=true is set, the filter restricts the search result to addresses that are primary addresses. If the flag isPrimary=false is set, the filter restricts the search results to addresses that are not primary addresses. If no flag is set, both primary and non-primary addresses are listed.
page Int The page of results to search for
itemsPerPage Int The number of items to list per page
with String Includes the specified address contact relation information in the results. The following parameters are available: contact and address. More than one parameter should be separated by commas.

Success 200

Field Type Description
page Int Current page of the response
totalsCount Int The total number of entries in the response
isLastPage Bool Flag that indicates if the page shown is the last page of the response
lastPageNumber Int The last page number
firstOnPage Int The index of the first item of the current page result
lastOnPage Int The index of the last item of the current page result
itemsPerPage Int The requested amount of items per result page
entries AddressContactRelation[] List of AddressContactRelation
 id Int The ID of the address contact relation
 contactId Int The ID of the contact
 typeId Int The type ID of the address. Possible values:
  • Invoice address = 1
  • Delivery address = 2
 addressId Int The ID of the address
 isPrimary Bool Flag that indicates if the address is primary
{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"id":65440,"contactId":86616,"typeId":1,"addressId":7061,"isPrimary":false},{"id":80629,"contactId":53638,"typeId":1,"addressId":18555,"isPrimary":false}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Find address data by address id

/rest/accounts/addresses/{addressId}/related_data

Success 200

Field Type Description
id Int The ID of the address
gender String The gender (female or male)
name1 String The name 1 field (default: company name)
name2 String The name 2 field (default: first name)
name3 String The name 3 field (default: last name)
name4 String The name 4 field (default: c/o)
companyName String The company name (read only)
firstName String The first name (read only)
lastName String The last name (read only)
careOf String The c/o (read only)
address1 String The address 1 field (street|PACKSTATION|POSTFILIALE)
address2 String The address 2 field (house no|packstation id)
address3 String The address 3 field (additional)
address4 String The address 4 field is currently undefined and can be freely used.
street String The street (read only)
houseNumber String The house number (read only)
additional String The additional address information (read only)
postalCode String The postcode
town String The town
countryId Int The ID of the country
stateId Int The ID of the state
readOnly Bool Flag that indicates if the data record is read only
sessionId String The session ID that was used when the address was created
checkedAt String|\Carbon The time the address was checked as unix timestamp
createdAt String|\Carbon The time the address was created as unix timestamp
updatedAt String|\Carbon The time the address was last updated as unix timestamp
taxIdNumber String The taxIdNumber option
title String The title option
externalId String The externalId option
entryCertificate Bool The entryCertificate option
phone String The phone option
email String The email option
postident String The PostIdent option
fsk String The age rating option
birthday String The birthday option
personalNumber String The personal number option
packstationNo String The packstation number
isPackstation Bool Flag that indicates if the address is a packstation
isPostfiliale Bool Flag that indicates if the address is a postfiliale (post office)

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Is this article helpful?

 

Thank you for your Feedback

you can close this field now!