Class AddressesApiV2Controller

{post} /addresses Create Address

400-BadRequest Address data were not provided.

Error-Response HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Address data were not provided." }

Addresses

CreateAddress

{int} customerId The customer's record ID to whom the address belong.
{string} gender Provide either "m" or "f" for male and female.
{string} company The address company name.
{string} firstname The address firstname.
{string} lastname The address lastname.
{string} street The address street.
{string} houseNumber The address house number.
{string} additionalAddressInfo Additional information about the address.
{string} suburb The address suburb.
{string} postcode The address postcode.
{string} city The address city.

{int} countryId Provide an existing "countryId", if it does not exist create it through the "countries" API methods.

{int} zoneId Provide an existing "countryId", if it does not exist create it through the "zones" API methods.

{string} class The address class can be any string used for distinguishing the address from other records.

{bool} b2bStatus Defines the Business-to-Business status of the address.

{json} Request-Body { "customerId": 1, "gender": "m", "company": "Test Company", "firstname": "John", "lastname": "Doe", "street": "Test Street", "houseNumber": "123", "additionalAddressInfo": "1. Etage", "suburb": "Test Suburb", "postcode": "23983", "city": "Test City", "countryId": 81, "zoneId": 84, "class": null, "b2bStatus": false }

(Success 201) Response-Body If successful, this method returns a complete Customers resource in the response body.

2.2.0

{put} /addresses/:id Update Address

Update an existing address record by providing new data. You do not have to provide the full presentation of the address in the JSON string of the request, rather just the fields to be updated. The address ID will be taken from the URI of the request so it is not required that it is included withing the request JSON.

{json} Request-Body { "company": "Test Company - UPDATED", "firstname": "John - UPDATED", "lastname": "Doe - UPDATED", "street": "Test Street - UPDATED", "houseNumber": "1 - UPDATED", "additionalAddressInfo": "1. Etage - UPDATED", "suburb": "Test Suburb - UPDATED", "city": "Test City - UPDATED" }

Addresses

UpdateAddress

Response-Body If successful, this method returns the updated address resource in the response body.

2.1.0

{delete} /addresses/:id Delete Address

Remove an address record from the system. This method will always return success even if the address record does not exist (due to internal architecture decisions, which strive to avoid unnecessary failures).

400-BadRequest Address record ID was not provided in the resource URL.

Error-Response HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Address record ID was not provided in the resource URL." }

{curl} Delete Address with ID = 811 curl -X DELETE --user admin@shop.de:12345 http://shop.de/api.php/v2/addresses/811

Addresses

DeleteAddress

{json} Success-Response { "code": 200, "status": "success", "action": "delete", "addressId": 811 }

2.1.0

{get} /addresses/:id Get Address

Get multiple or a single address records through a GET requets. This method supports all the GET parameters that are mentioned in the "Introduction" section of this documentation.

{curl} Delete Address with ID = 243 curl --user admin@shop.de:12345 http://shop.de/api.php/v2/addresses/243

Addresses

GetAddress

Response-Body If successful, this method will return the address resource in JSON format.

2.1.0