customer-silo API

Overview

Autogenerated customer-silo API documentation

Endpoints

Retrieve customers

GET /customers

Description

Retrieve customers by given filters

Parameters

Type Name Description Required Schema
QueryParameter queryParams queryParams true ref
BodyParameter pageable pageable false Pageable

Responses

HTTP Code Description Schema
200 OK PagedResultDto<Customer>
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • customer-controller

Create customer

POST /customers

Description

Create customer

Parameters

Type Name Description Required Schema
BodyParameter request request true CreateCustomer

Responses

HTTP Code Description Schema
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • /

Tags

  • customer-controller

Remove customer

DELETE /customers/{customerUuid}

Description

Remove customer

Parameters

Type Name Description Required Schema
PathParameter customerUuid customerUuid true string (uuid)

Responses

HTTP Code Description Schema
401 Unauthorized No Content
204 No Content No Content
403 Forbidden No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • customer-controller

Retrieve multiple

GET /customers/{customerUuid}/addresses

Description

Retrieve all addresses associated with one customer

Parameters

Type Name Description Required Schema
PathParameter customerUuid customerUuid true string (uuid)
BodyParameter pageable pageable false Pageable

Responses

HTTP Code Description Schema
200 OK PagedResultDto<AddressDto>
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • address-controller

Create customer address

POST /customers/{customerUuid}/addresses

Description

Create customer address

Parameters

Type Name Description Required Schema
PathParameter customerUuid customerUuid true string (uuid)
BodyParameter request request true CreateAddress

Responses

HTTP Code Description Schema
201 Created AddressDto
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • address-controller

Retrieve one

GET /customers/{customerUuid}/addresses/{addressUuid}

Description

Retrieve specific customer address

Parameters

Type Name Description Required Schema
PathParameter customerUuid customerUuid true string (uuid)
PathParameter addressUuid addressUuid true string (uuid)

Responses

HTTP Code Description Schema
200 OK AddressDto
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • address-controller

Update customer address

PUT /customers/{customerUuid}/addresses/{addressUuid}

Description

Update customer address

Parameters

Type Name Description Required Schema
PathParameter customerUuid customerUuid true string (uuid)
PathParameter addressUuid addressUuid true string (uuid)
BodyParameter updateAddress updateAddress true CreateAddress

Responses

HTTP Code Description Schema
200 null AddressDto
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • address-controller

Delete customer address

DELETE /customers/{customerUuid}/addresses/{addressUuid}

Description

Delete customer address

Parameters

Type Name Description Required Schema
PathParameter customerUuid customerUuid true string (uuid)
PathParameter addressUuid addressUuid true string (uuid)

Responses

HTTP Code Description Schema
401 Unauthorized No Content
204 No Content No Content
403 Forbidden No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • address-controller

Mark given address as usk 18 verified

PUT /customers/{customerUuid}/addresses/{addressUuid}/usk-18-verified

Description

Mark given address as usk 18 verified

Parameters

Type Name Description Required Schema
PathParameter customerUuid customerUuid true string (uuid)
PathParameter addressUuid addressUuid true string (uuid)

Responses

HTTP Code Description Schema
201 Created No Content
401 Unauthorized No Content
204 null No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • address-controller

Get buyalerts

GET /customers/{customerUuid}/buyalerts

Description

Retrieve all buyalerts associated with customer

Parameters

Type Name Description Required Schema
PathParameter customerUuid customerUuid true string (uuid)
QueryParameter queryParams queryParams true ref
BodyParameter pageable pageable false Pageable

Responses

HTTP Code Description Schema
200 OK PagedResultDto<Buyalert>
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • buyalert-controller

Create buyalert

POST /customers/{customerUuid}/buyalerts

Description

Create buyalert

Parameters

Type Name Description Required Schema
PathParameter customerUuid customerUuid true string (uuid)
BodyParameter dto dto true CreateBuyalert

Responses

HTTP Code Description Schema
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • buyalert-controller

Delete buyalert

DELETE /customers/{customerUuid}/buyalerts/{productId}

Description

Delete buyalert

Parameters

Type Name Description Required Schema
PathParameter customerUuid customerUuid true string (uuid)
PathParameter productId productId true integer (int64)

Responses

HTTP Code Description Schema
401 Unauthorized No Content
204 No Content No Content
403 Forbidden No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • buyalert-controller

Update customer password

PUT /customers/{customerUuid}/password

Description

Update customer password

Parameters

Type Name Description Required Schema
PathParameter customerUuid customerUuid true string (uuid)
BodyParameter request request true ChangePassword

Responses

HTTP Code Description Schema
201 Created No Content
401 Unauthorized No Content
204 null No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • customer-controller

Retrieve one customer

GET /customers/{uuid}

Description

Retrieve one customer

Parameters

Type Name Description Required Schema
PathParameter uuid uuid true string (uuid)

Responses

HTTP Code Description Schema
200 OK Customer
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • customer-controller