Customer

Your customers, wether they a private or companies.

Operations

GET/v1/customers/specGET/v1/customersPOST/v1/customersGET/v1/customers/{customerId}DELETE/v1/customers/{customerId}PATCH/v1/customers/{customerId}

---

OpenAPI Spec

GET

/v1/customers/spec

Get OpenAPI 3.1.0 spec for Customer API

Responses

The spec itself as json

Content-Type

application/json

{

}

GET

/v1/customers/spec

Playground

Samples

cURL

JavaScript

PHP

Python

---

List Customers

GET

/v1/customers

List Customers

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Query Parameters

page

Typenumber

minimum0

default0

size

Typenumber

minimum1

maximum20

default10

number

companyName

externalId

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

"page": 0,

"pages": 0,

"size": 10,

"items": [

{

"id": 0,

"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": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string"

},

"createdAt": "string",

"updatedAt": "string"

}

]

}

GET

/v1/customers

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

number

companyName

externalId

createdAt

updatedAt

Samples

cURL

JavaScript

PHP

Python

---

Create a new Customer

POST

/v1/customers

Create a new Customer

Authorizations

apiKey

TypeHTTP (bearer)

Request Body

application/json

{

"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": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"externalId": "string"

}

}

Responses

Customer found

Content-Type

application/json

{

"id": 0,

"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": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string"

},

"createdAt": "string",

"updatedAt": "string"

}

POST

/v1/customers

Playground

Server

Authorization

apiKey

Body

Samples

cURL

JavaScript

PHP

Python

---

Get a Customer

GET

/v1/customers/{customerId}

Get a Customer by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

customerId*

Typeinteger

Required

formatint32

Responses

Customer found

Content-Type

application/json

{

"id": 0,

"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": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string"

},

"createdAt": "string",

"updatedAt": "string"

}

GET

/v1/customers/{customerId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

customerId*

Samples

cURL

JavaScript

PHP

Python

---

Delete a Customer

DELETE

/v1/customers/{customerId}

Delete a Customer by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

customerId*

Typeinteger

Required

formatint32

Responses

Successfully removed

DELETE

/v1/customers/{customerId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

customerId*

Samples

cURL

JavaScript

PHP

Python

---

Update a Customer

PATCH

/v1/customers/{customerId}

Update a Customer by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

customerId*

Typeinteger

Required

formatint32

Request Body

application/json

{

"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": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"externalId": "string"

}

}

Responses

Customer found

Content-Type

application/json

{

"id": 0,

"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": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string"

},

"createdAt": "string",

"updatedAt": "string"

}

PATCH

/v1/customers/{customerId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

customerId*

Body

Samples

cURL

JavaScript

PHP

Python

---