Beers

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

BeerOrder

customerIdstring(uuid)required
customerRefstring | null
beerOrderLinesarray[object]
Show Child Parameters
orderStatusstring | null

Allowed values:NEWVERIFIEDALLOCATEDREADYPICKED_UP

orderStatusCallbackUrlstring(uri)

Response

Order Created

Callbacks

description
{$request.body#/orderStatusCallback}

Callback Response

post/api/v1/customers/{customerId}/orders

Body

{ "customerId": "customerId" }
 

getCustomerOrderById

Get Order By Id

get

Path Parameters

customerIdstring(uuid)required

Customer Id

orderIdstring(uuid)required

Order Id

Response

application/json

HTTP Okay

BeerOrder

idstring | null(uuid)read-only
versioninteger | nullread-only
createdDatestring | null(date-time)read-only
lastModifiedDatestring | null(date-time)read-only
customerIdstring(uuid)required
customerRefstring | null
beerOrderLinesarray[object]
Show Child Parameters
orderStatusstring | null

Allowed values:NEWVERIFIEDALLOCATEDREADYPICKED_UP

orderStatusCallbackUrlstring(uri)
get/api/v1/customers/{customerId}/orders/{orderId}
 
application/json

pickupCustomerOrder

Pickup Order

put

Path Parameters

customerIdstring(uuid)required

Customer Id

orderIdstring(uuid)required

Order Id

Response

No Content

put/api/v1/customers/{customerId}/orders/{orderId}/pickup
 

BaseItem

object
idstring(uuid)read-only
versionintegerread-only
createdDatestring(date-time)read-only
lastModifiedDatestring(date-time)read-only
Example

Beer

object
idstring(uuid)read-only
versionintegerread-only
createdDatestring(date-time)read-only
lastModifiedDatestring(date-time)read-only
beerNamestringrequired
beerStylestringrequired

Allowed values:LAGERPILSNERSTOUTGOSEPORTERALEWHEATIPAPALE_ALESAISON

upcstringrequired
quantityOnHandinteger
pricestring(decimal)required
Example