Customer

The customers assignments are carried out for, whether private persons or companies.

Operations

GET/v2/customers/specGET/v2/customersPOST/v2/customersGET/v2/customers/{customerUuid}DELETE/v2/customers/{customerUuid}PATCH/v2/customers/{customerUuid}

---

OpenAPI Spec

GET

/v2/customers/spec

Get OpenAPI 3.1.0 spec for Customer API

Responses

Returns OpenAPI 3.1.0 spec for Customer API

Content-Type

application/json

{

}

GET

/v2/customers/spec

Playground

Samples

---

List Customers

GET

/v2/customers

List Customers

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Query Parameters

page

Type

number

Minimum

0

Default

0

size

Type

number

Minimum

1

Maximum

20

Default

10

uuid

number

companyName

externalId

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

  

"page": 0,

  

"pages": 0,

  

"size": 10,

  

"items": [

  

  

{

  

  

  

"uuid": "string",

  

  

  

"number": "string",

  

  

  

"companyName": "string",

  

  

  

"externalId": "string",

  

  

  

"title": "string",

  

  

  

"salutation": "string",

  

  

  

"firstName": "string",

  

  

  

"surname": "string",

  

  

  

"telephones": [

  

  

  

  

{

  

  

  

  

  

"label": "string",

  

  

  

  

  

"isDefault": true,

  

  

  

  

  

"telephoneNumber": "string"

  

  

  

  

}

  

  

  

],

  

  

  

"emails": [

  

  

  

  

{

  

  

  

  

  

"label": "main",

  

  

  

  

  

"isDefault": true,

  

  

  

  

  

"emailAddress": "string"

  

  

  

  

}

  

  

  

],

  

  

  

"urls": [

  

  

  

  

{

  

  

  

  

  

"label": "homepage",

  

  

  

  

  

"url": "string"

  

  

  

  

}

  

  

  

],

  

  

  

"billingAddress": {

  

  

  

  

"link": "custom",

  

  

  

  

"supplement": "string",

  

  

  

  

"street": "string",

  

  

  

  

"clarification": "string",

  

  

  

  

"zip": "string",

  

  

  

  

"city": "string",

  

  

  

  

"state": "string",

  

  

  

  

"country": "string",

  

  

  

  

"externalId": "string",

  

  

  

  

"latitude": 0,

  

  

  

  

"longitude": 0

  

  

  

},

  

  

  

"createdAt": "string",

  

  

  

"updatedAt": "string"

  

  

}

  

]

}

GET

/v2/customers

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

uuid

number

companyName

externalId

createdAt

updatedAt

Samples

---

Create a new Customer

POST

/v2/customers

Create a new Customer

Authorizations

apiKey

Type

HTTP (bearer)

Request Body

application/json

{

  

"uuid": "string",

  

"number": "string",

  

"companyName": "string",

  

"externalId": "string",

  

"title": "string",

  

"salutation": "string",

  

"firstName": "string",

  

"surname": "string",

  

"telephones": [

  

  

{

  

  

  

"label": "string",

  

  

  

"telephoneNumber": "string"

  

  

}

  

],

  

"emails": [

  

  

{

  

  

  

"label": "main",

  

  

  

"emailAddress": "string"

  

  

}

  

],

  

"urls": [

  

  

{

  

  

  

"label": "homepage",

  

  

  

"url": "string"

  

  

}

  

],

  

"billingAddress": {

  

  

"link": "custom",

  

  

"supplement": "string",

  

  

"street": "string",

  

  

"clarification": "string",

  

  

"zip": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"country": "string",

  

  

"externalId": "string"

  

}

}

Responses

Customer found

Content-Type

application/json

{

  

"uuid": "string",

  

"number": "string",

  

"companyName": "string",

  

"externalId": "string",

  

"title": "string",

  

"salutation": "string",

  

"firstName": "string",

  

"surname": "string",

  

"telephones": [

  

  

{

  

  

  

"label": "string",

  

  

  

"isDefault": true,

  

  

  

"telephoneNumber": "string"

  

  

}

  

],

  

"emails": [

  

  

{

  

  

  

"label": "main",

  

  

  

"isDefault": true,

  

  

  

"emailAddress": "string"

  

  

}

  

],

  

"urls": [

  

  

{

  

  

  

"label": "homepage",

  

  

  

"url": "string"

  

  

}

  

],

  

"billingAddress": {

  

  

"link": "custom",

  

  

"supplement": "string",

  

  

"street": "string",

  

  

"clarification": "string",

  

  

"zip": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"country": "string",

  

  

"externalId": "string",

  

  

"latitude": 0,

  

  

"longitude": 0

  

},

  

"createdAt": "string",

  

"updatedAt": "string"

}

POST

/v2/customers

Playground

Server

Authorization

apiKey

Body

Samples

---

Get a Customer

GET

/v2/customers/{customerUuid}

Get a Customer by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

customerUuid*

Type

string

Required

Format

"uuid"

Responses

Customer found

Content-Type

application/json

{

  

"uuid": "string",

  

"number": "string",

  

"companyName": "string",

  

"externalId": "string",

  

"title": "string",

  

"salutation": "string",

  

"firstName": "string",

  

"surname": "string",

  

"telephones": [

  

  

{

  

  

  

"label": "string",

  

  

  

"isDefault": true,

  

  

  

"telephoneNumber": "string"

  

  

}

  

],

  

"emails": [

  

  

{

  

  

  

"label": "main",

  

  

  

"isDefault": true,

  

  

  

"emailAddress": "string"

  

  

}

  

],

  

"urls": [

  

  

{

  

  

  

"label": "homepage",

  

  

  

"url": "string"

  

  

}

  

],

  

"billingAddress": {

  

  

"link": "custom",

  

  

"supplement": "string",

  

  

"street": "string",

  

  

"clarification": "string",

  

  

"zip": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"country": "string",

  

  

"externalId": "string",

  

  

"latitude": 0,

  

  

"longitude": 0

  

},

  

"createdAt": "string",

  

"updatedAt": "string"

}

GET

/v2/customers/{customerUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

customerUuid*

Samples

---

Delete a Customer

DELETE

/v2/customers/{customerUuid}

Delete a Customer by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

customerUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully removed

DELETE

/v2/customers/{customerUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

customerUuid*

Samples

---

Update a Customer

PATCH

/v2/customers/{customerUuid}

Update a Customer by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

customerUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"number": "string",

  

"companyName": "string",

  

"externalId": "string",

  

"title": "string",

  

"salutation": "string",

  

"firstName": "string",

  

"surname": "string",

  

"telephones": [

  

  

{

  

  

  

"label": "string",

  

  

  

"telephoneNumber": "string"

  

  

}

  

],

  

"emails": [

  

  

{

  

  

  

"label": "main",

  

  

  

"emailAddress": "string"

  

  

}

  

],

  

"urls": [

  

  

{

  

  

  

"label": "homepage",

  

  

  

"url": "string"

  

  

}

  

],

  

"billingAddress": {

  

  

"link": "custom",

  

  

"supplement": "string",

  

  

"street": "string",

  

  

"clarification": "string",

  

  

"zip": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"country": "string",

  

  

"externalId": "string"

  

}

}

Responses

Customer found

Content-Type

application/json

{

  

"uuid": "string",

  

"number": "string",

  

"companyName": "string",

  

"externalId": "string",

  

"title": "string",

  

"salutation": "string",

  

"firstName": "string",

  

"surname": "string",

  

"telephones": [

  

  

{

  

  

  

"label": "string",

  

  

  

"isDefault": true,

  

  

  

"telephoneNumber": "string"

  

  

}

  

],

  

"emails": [

  

  

{

  

  

  

"label": "main",

  

  

  

"isDefault": true,

  

  

  

"emailAddress": "string"

  

  

}

  

],

  

"urls": [

  

  

{

  

  

  

"label": "homepage",

  

  

  

"url": "string"

  

  

}

  

],

  

"billingAddress": {

  

  

"link": "custom",

  

  

"supplement": "string",

  

  

"street": "string",

  

  

"clarification": "string",

  

  

"zip": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"country": "string",

  

  

"externalId": "string",

  

  

"latitude": 0,

  

  

"longitude": 0

  

},

  

"createdAt": "string",

  

"updatedAt": "string"

}

PATCH

/v2/customers/{customerUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

customerUuid*

Body

Samples

---