🎁
OFERTA LIMITADA: €997 en bonos GRATIS con el Plan Business Ver Oferta
🎁

API Documentation

Integrate your applications with PosDo's powerful REST API

Getting Started

The PosDo API allows you to integrate your restaurant management system with third-party applications. Our RESTful API provides programmatic access to read and write PosDo data.

Base URL

https://pos.do/api/v1

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

Authorization: Bearer YOUR_API_KEY

Orders

GET /orders

Retrieve a list of orders

Parameters

Name Type Description
status string Filter by order status (pending, completed, cancelled)
limit integer Number of results per page (default: 20)
page integer Page number (default: 1)
POST /orders

Create a new order

Request Body

{ "customer_id": "123", "items": [ { "menu_item_id": "456", "quantity": 2, "notes": "No onions" } ], "delivery_address": "123 Main St", "payment_method": "card" }
GET /orders/{id}

Get a specific order by ID

PUT /orders/{id}/status

Update order status

Request Body

{ "status": "completed" }

Menu

GET /menu

Get all menu categories and items

GET /menu/items/{id}

Get details of a specific menu item

POST /menu/items

Add a new menu item

Request Body

{ "name": "Margherita Pizza", "description": "Fresh tomato sauce, mozzarella, basil", "price": 12.99, "category_id": "789", "available": true }

Reservations

GET /reservations

Get list of reservations

Parameters

Name Type Description
date date Filter by reservation date (YYYY-MM-DD)
status string Filter by status (confirmed, pending, cancelled)
POST /reservations

Create a new reservation

Request Body

{ "customer_name": "John Doe", "customer_email": "john@example.com", "customer_phone": "+1234567890", "date": "2024-12-25", "time": "19:30", "party_size": 4, "special_requests": "Window table preferred" }

Response Codes

Code Description
200 OK - Request successful
201 Created - Resource created successfully
400 Bad Request - Invalid parameters
401 Unauthorized - Authentication required
404 Not Found - Resource not found
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error

Rate Limiting

API requests are limited to 1000 requests per hour per API key. The rate limit status is included in response headers:

X-RateLimit-Limit: 1000 X-RateLimit-Remaining: 999 X-RateLimit-Reset: 1640995200

Support

For API support, questions, or to report issues, please contact our developer support team:

!

Contacta'ns!

T'ajudem amb qualsevol dubte