API-Documentation - Addresses

Addresses

This module delivers all address information.

Function overview

add Create new client address.
delete Delete single address.
edit Edit existing address.
get Get single address.
getAll Get all available addresses.
getByClient Get all addresses for given client id.
add - Create new client address.post

Create new client address.

Url

/service/addresses/add

Parameter

Field Type Description
data Array

Address data to be added (required).

Request-Example

{
	"data": {
		"first_name": "Testvorname",
		"last_name": "Testnachname",
		"company": "Testcompany Inc.",
		"address": "Teststreet",
		"zip": "12345",
		"city": "Testcity",
		"countrycode": "de",
		"client_id": 123
	}
}
delete - Delete single address.post

Delete a single address by given id.

Url

/service/addresses/delete

Parameter

Field Type Description
id Integer

Unique ID of address (required).

Request-Example

{
  "id": 123
}
edit - Edit existing address.post

Edit an existing address.

Url

/service/addresses/edit

Parameter

Field Type Description
id Integer

Id of address to udate (required).

data Array

Address properties to be changed (required).

Request-Example

{
	"id": 123,
	"data": {
		"name": "New Name",
		"zip": "54321",
		"countrycode": "fr"
	}
}
get - Get single address.post

Access data of one single address by its id.

Url

/service/addresses/get

Parameter

Field Type Description
id Integer

Unique ID of address (required).

Request-Example

{
  "id": 123
}
getAll - Get all available addresses.post

Get all available addresses.

Url

/service/addresses/getAll

Parameter

Field Type Description
[client_id] Integer

Unique ID of client.

( Optional. )

[type] String

Address type to filter.

( Optional. )

getByClient - Get all addresses for given client id.post

Get all addresses for given client id.

Url

/service/addresses/getByClient

Parameter

Field Type Description
client_id Integer

Unique ID of client (required).

Request-Example

{
  "client_id": 123
}

© 2021 Vinou GmbH, Mombacher Straße 68, 55122 Mainz, Germany