ServeU for developers

Connect a POS, accounting system, kitchen screen or automation tool to a ServeU business. Each business creates its own API keys; a key only ever sees that business.

Get a key in Settings → Developers.

Endpoints

Method	Path	Permission	Idempotency-Key	What it does
GET	/api/v1/business	business:read	—	The business this key belongs to
GET	/api/v1/branches	business:read	—	Branches
GET	/api/v1/orders	orders:read	—	List orders
GET	/api/v1/orders/summary	orders:read	—	Sales summary
GET	/api/v1/orders/{id}	orders:read	—	Get an order
POST	/api/v1/orders/{id}/actions	orders:write	Required	Move an order along
POST	/api/v1/cards/lookup	loyalty:read	—	Find a card by phone or scanned card
POST	/api/v1/cards	loyalty:write	Optional	Join a customer
GET	/api/v1/cards/{id}	loyalty:read	—	Get a card
GET	/api/v1/cards/{id}/events	loyalty:read	—	A card's history
POST	/api/v1/cards/{id}/earn	loyalty:write	Required	Add stamps or points for a sale
POST	/api/v1/cards/{id}/redeem	loyalty:write	Required	Redeem a reward
POST	/api/v1/loyalty-events/{id}/void	loyalty:write	Required	Undo an earn or redeem
GET	/api/v1/menu	menu:read	—	The whole menu
POST	/api/v1/menu/categories	menu:write	Optional	Create a category
PATCH	/api/v1/menu/categories/{id}	menu:write	Optional	Update a category
DELETE	/api/v1/menu/categories/{id}	menu:write	Optional	Delete an empty category
PUT	/api/v1/menu/categories/by-external-id/{externalId}	menu:write	Optional	Create or update a category by your code
POST	/api/v1/menu/items	menu:write	Optional	Create an item
GET	/api/v1/menu/items/{id}	menu:read	—	Get an item
PATCH	/api/v1/menu/items/{id}	menu:write	Optional	Update an item
DELETE	/api/v1/menu/items/{id}	menu:write	Optional	Delete an item
PUT	/api/v1/menu/items/by-external-id/{externalId}	menu:write	Optional	Create or update an item by your code
POST	/api/v1/menu/items/{id}/availability	menu:write	Optional	Mark sold out or back
PUT	/api/v1/menu/items/{id}/stock	stock:write	Optional	Set an item's stock at a branch
PUT	/api/v1/menu/items/by-external-id/{externalId}/stock	stock:write	Optional	Set stock by your code
POST	/api/v1/stock	stock:write	Optional	Set stock for many items at once
GET	/api/v1/webhook-endpoints	webhooks:manage	—	List webhook endpoints
POST	/api/v1/webhook-endpoints	webhooks:manage	—	Create a webhook endpoint
GET	/api/v1/webhook-endpoints/{id}	webhooks:manage	—	Get a webhook endpoint
PATCH	/api/v1/webhook-endpoints/{id}	webhooks:manage	Optional	Update or turn a webhook endpoint on/off
DELETE	/api/v1/webhook-endpoints/{id}	webhooks:manage	Optional	Delete a webhook endpoint
POST	/api/v1/webhook-endpoints/{id}/test	webhooks:manage	—	Send a signed test event (ping)
POST	/api/v1/webhook-endpoints/{id}/rotate-secret	webhooks:manage	—	Rotate the signing secret