Customer
namestringrequired
>= 1 characters<= 255 characters
createNewCustomer
Register as new customer
post
Body
application/json
Body
application/json
Response
Response
Customer Created
post/api/v1/customers
Body
{
"name": "name"
}
getByCustomerId
Get customer by Id
get
Path Parameters
customerIdstring(uuid)required
Customer Id
Response
application/json
Response
application/json
HTTP Okay
Customer
idstring | null(uuid)read-only
versioninteger | nullread-only
createdDatestring | null(date-time)read-only
lastModifiedDatestring | null(date-time)read-only
namestringrequired
>= 1 characters<= 255 characters
get/api/v1/customers/{customerId}
Path Parameters
application/json
UpdateByCustomerId
Update Customer by Id
put
Path Parameters
customerIdstring(uuid)required
Customer Id
Body
application/json
Body
application/json
Customer
namestringrequired
>= 1 characters<= 255 characters
Response
Response
Beer Updated
put/api/v1/customers/{customerId}
Path Parameters
Body
{
"name": "name"
}
listCustomerOrders
List Orders
get
Query Parameters
pageNumberinteger(int32)
Page number.
Default:1
pageSizeinteger(int32)
Page size.
Default:25
Path Parameters
customerIdstring(uuid)required
Customer Id
Response
200 application/json
Response
200 application/json
List Order Reponse
BeerOrderPagedList
pageableobject
Show Child Parameters
totalPagesinteger(int32)
lastboolean
totalElementsinteger(int32)
sizeinteger(int32)
numberinteger(int32)
numberOfElementsinteger(int32)
sortobject
Show Child Parameters
firstboolean
contentarray[object]
Show Child Parameters
get/api/v1/customers/{customerId}/orders
Path Parameters
Query Parameters
200 application/json
createOrder
Place Order
post
Query Parameters
pageNumberinteger(int32)
Page number.
Default:1
pageSizeinteger(int32)
Page size.
Default:25
Path Parameters
customerIdstring(uuid)required
Customer Id
Body
application/json
Body
application/json
BeerOrder
customerIdstring(uuid)required
customerRefstring | null
beerOrderLinesarray[object]
Show Child Parameters
orderStatusstring | null
Allowed values:NEWVERIFIEDALLOCATEDREADYPICKED_UP
orderStatusCallbackUrlstring(uri)
Response
Response
Order Created
Callbacks
Callbacks
description
{$request.body#/orderStatusCallback}
Callback Response
Callback Response
post/api/v1/customers/{customerId}/orders
Path Parameters
Query Parameters
Body
{
"customerId": "customerId"
}