WRestaurant API Documentation

https://docs.wrestaurantapi.com
Admin
This project provides comprehensive documentation for the WRestaurantAPI service, including details...
Tokens:7,080
Snippets:52
Trust Score:2.1
Update:4 months ago
Show doc for...
Tokens:
Raw
### Create Order (New Account) Request Body Example

Source: https://docs.wrestaurantapi.com/api

Example of a request body for creating a new order, which also creates a new account. This includes details like table number, waiter ID, and products.

```json
{
  "turnDependent": true,
  "mesa": "string",
  "idMesero": "string",
  "estacion": "string",
  "serie": "string",
  "idEmpresa": "string",
  "noPersonas": 0,
  "productos": [
    {
      "folio": 0,
      "serieFolio": "string",
      "numcheque": 0,
      "fecha": "2024-08-25T15:00:00Z",
      "cierre": "2024-08-25T15:00:00Z",
      "mesa": "string",
      "noPersonas": 0,
      "idMesero": "string",
      "pagado": true,
      "cancelado": true,
      "impreso": true,
      "impresiones": 0,
      "descuento": 0,
      "razonCancelado": "string",
      "orden": "string",
      "facturado": true,
      "idTurno": 0,
      "usuarioCancelo": "string",
      "comentarioDescuento": "string",
      "usuarioPago": "string",
      "totalArticulos": 0,
      "subtotal": 0,
      "subtotalSinImpuestos": 0,
      "total": 0,
      "totalConPropina": 0,
      "totalImpuestod1": 0,
      "totalImpuestod2": 0,
      "totalImpuestod3": 0,
      "efectivo": 0,
      "tarjeta": 0,
      "vales": 0,
      "otros": 0,
      "propina": 0,
      "totalSinDescuento": 0,
      "totalAlimentos": 0,
      "totalBebidas": 0,
      "totalOtros": 0,
      "totalDescuentos": 0,
      "totalCortesias": 0,
      "totalCortesiaAlimentos": 0,
      "items": [
        {
          "folioDet": 0,
          "movimiento": 0,
          "comanda": "string",
          "cantidad": 0,
          "idProducto": "string",
          "descuento": 0,
          "precio": 0,
          "precioSinImpuestos": 0,
          "comentario": "string",
          "tiempo": "2024-08-25T15:00:00Z",
          "mitad": 0,
          "hora": "2024-08-25T15:00:00Z",
          "modificador": 0,
          "idEstacion": "string",
          "impuesto1": 0,
          "impuesto2": 0,
          "impuesto3": 0,
          "usuarioDescuento": "string",
          "comentarioDescuento": "string",
          "idTipoDescuento": "string",
          "idProductoCompuesto": "string",
          "productoCompuestoPrincipal": 0,
          "precioCatalogo": 0,
          "marcar": 0,
          "idMeseroProducto": "string",
          "idCortesia": "string",
          "numeroTarjeta": "string",
          "folioProduccion": 0,
          "nivel": 0,
          "sistemaEnvio": 0,
          "promoVolumen": 0
        }
      ]
    }
  ]
}
```

--------------------------------

### List Temporary Orders Response Example

Source: https://docs.wrestaurantapi.com/api

Example JSON response for a successful request to list temporary orders. This includes pagination details and a list of orders.

```json
{   "workerId": "00000000-0000-0000-0000-000000000000",   "dispatchedAt": "2024-08-25T15:00:00Z",   "page": 0,   "pageSize": 0,   "totalResults": 0,   "totalPages": 0,   "hasNextPage": true,   "orders": [     {       "folio": 0,       "serieFolio": "serieFolio",       "numcheque": 0,       "fecha": "2024-08-25T15:00:00Z",       "cierre": "2024-08-25T15:00:00Z",       "mesa": "mesa",       "noPersonas": 0,       "idMesero": "idMesero",       "pagado": true,       "cancelado": true,       "impreso": true,       "impresiones": 0,       "descuento": 0,       "razonCancelado": "razonCancelado",       "orden": "orden",       "facturado": true,       "idTurno": 0,       "usuarioCancelo": "usuarioCancelo",       "comentarioDescuento": "comentarioDescuento",       "usuarioPago": "usuarioPago",       "totalArticulos": 0,       "subtotal": 0,       "subtotalSinImpuestos": 0,       "total": 0,       "totalConPropina": 0,       "totalImpuestod1": 0,       "totalImpuestod2": 0,       "totalImpuestod3": 0,       "efectivo": 0,       "tarjeta": 0,       "vales": 0,       "otros": 0,       "propina": 0,       "totalSinDescuento": 0,       "totalAlimentos": 0,       "totalBebidas": 0,       "totalOtros": 0,       "totalDescuentos": 0,       "totalCortesias": 0,       "totalCortesiaAlimentos": 0,       "items": [         {           "folioDet": 0,           "movimiento": 0,           "comanda": "comanda",           "cantidad": 0,           "idProducto": "idProducto",           "descuento": 0,           "precio": 0,           "precioSinImpuestos": 0,           "comentario": "comentario",           "tiempo": "2024-08-25T15:00:00Z",           "mitad": 0,           "hora": "2024-08-25T15:00:00Z",           "modificador": 0,           "idEstacion": "idEstacion",           "impuesto1": 0,           "impuesto2": 0,           "impuesto3": 0,           "usuarioDescuento": "usuarioDescuento",           "comentarioDescuento": "comentarioDescuento",           "idTipoDescuento": "idTipoDescuento",           "idProductoCompuesto": "idProductoCompuesto",           "productoCompuestoPrincipal": 0,           "precioCatalogo": 0,           "marcar": 0,           "idMeseroProducto": "idMeseroProducto",           "idCortesia": "idCortesia",           "numeroTarjeta": "numeroTarjeta",           "folioProduccion": 0,           "nivel": 0,           "sistemaEnvio": 0,           "promoVolumen": 0         }       ]     }   ] }
```

--------------------------------

### Primera llamada a la API para obtener productos

Source: https://docs.wrestaurantapi.com/primeros-pasos

Ejemplo de cómo realizar una solicitud GET a la API para listar productos de una sucursal específica. Asegúrate de reemplazar 'wrst_live_TU_LLAVE_AQUI' con tu API key y 'DS5D2368HCME4O9X' con la license key de tu sucursal.

```bash
curl -H "X-Api-Key: wrst_live_TU_LLAVE_AQUI" \
  https://wrestaurant-api.inowu.store/api/v0/productos/DS5D2368HCME4O9X?page=1&limit=10
```

--------------------------------

### List Temporary Orders using cURL

Source: https://docs.wrestaurantapi.com/api/endpoints

Example of how to list temporary orders using cURL. Requires an API key and license key.

```Shell
curl -X GET \"https://api.wrestaurantapi.com/api/v1/temp_ordenes/DS5D2368HCME4O9X\" \-H \"X-Api-Key: YOUR_API_KEY\"
```

--------------------------------

### Creating a Closed Temporary Order with the TypeScript SDK

Source: https://docs.wrestaurantapi.com/idempotencia

This example demonstrates how to create a closed temporary order using the Wrestaurant SDK for TypeScript. The `idempotencyKey` is generated once and reused for retries to ensure safe reattempts.

```typescript
import { randomUUID } from "node:crypto";
import { WrestaurantApiClient } from "@wrestaurant/sdk";

const client = new WrestaurantApiClient({
  apiKey: process.env.WRESTAURANT_API_KEY!, // wrst_live_...
});

const idempotencyKey = randomUUID(); // genérala una vez, reúsala en reintentos

const venta = await client.endpoints.createClosedTempOrder({
  licenseKey: "DS5D2368HCME4O9X",
  "Idempotency-Key": idempotencyKey,
  estacion: "1",
  idEmpresa: "1",
  noPersonas: 1,
  productos: [],
  idFormaDePago: "1",
});
console.log(venta.folio);

```

--------------------------------

### Create Order (New Account)

Source: https://docs.wrestaurantapi.com/api/endpoints

Creates a new order, effectively opening a new account for a restaurant. Requires an API key and an idempotency key for safe operations.

```APIDOC
## Create Order (New Account)

### Description
Creates a new order, which also initiates a new account for the restaurant. This endpoint is used to start a new customer session or table.

### Method
POST

### Endpoint
/api/v1/temp_ordenes/{licenseKey}

### Parameters
#### Path Parameters
- **licenseKey** (string) - Required - The license key for the restaurant.

#### Headers
- **X-Api-Key** (string) - Required - API key for authentication.
- **Idempotency-Key** (string) - Optional - Used to ensure that the request is processed only once.

#### Request Body
- **turnDependent** (boolean) - Indicates if the order is dependent on the current shift.
- **mesa** (string | null) - The table number or identifier.
- **idMesero** (string | null) - The identifier of the waiter.
- **estacion** (string | null) - The station identifier.
- **serie** (string | null) - The series identifier.
- **idEmpresa** (string | null) - The company identifier.
- **noPersonas** (integer) - int32 - The number of people at the table.
- **productos** (array | null) - A list of products to be added to the order.

### Request Example
```json
{
  "turnDependent": true,
  "mesa": "Table 5",
  "idMesero": "waiter123",
  "estacion": "stationA",
  "serie": "S1",
  "idEmpresa": "companyXYZ",
  "noPersonas": 4,
  "productos": [
    {
      "idProducto": "prod001",
      "cantidad": 2
    }
  ]
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the newly created order/account.

#### Error Response (401, 404, 429)
- Standard error response format for authentication, not found, or rate limiting issues.
```

--------------------------------

### Create Order (New Account)

Source: https://docs.wrestaurantapi.com/api

Creates a new account (temporary order) and returns its ID. Requires an API key and an idempotency key in the headers, and a license key as a path parameter.

```APIDOC
## POST /api/v1/temp_ordenes/{licenseKey}

### Description
Creates a new account and returns its ID.

### Method
POST

### Endpoint
/api/v1/temp_ordenes/{licenseKey}

### Parameters
#### Path Parameters
- **licenseKey** (string) - Required - The license key for the restaurant.

#### Headers
- **X-Api-Key** (string) - Required - API key for authentication.
- **Idempotency-Key** (string) - Optional - Used to ensure idempotency of the request.

#### Request Body
- **turnDependent** (boolean) - Optional
- **mesa** (string | null) - Optional - Table number.
- **idMesero** (string | null) - Optional - ID of the waiter.
- **estacion** (string | null) - Optional - Station identifier.
- **serie** (string | null) - Optional - Series identifier.
- **idEmpresa** (string | null) - Optional - Company ID.
- **noPersonas** (integer) - int32 - Optional - Number of people.
- **productos** (array | null) - Optional - List of products in the order.
```

--------------------------------

### List Temporary Orders using SDK

Source: https://docs.wrestaurantapi.com/api

Use the WrestaurantApiClient SDK to fetch temporary orders. Ensure your API key is correctly configured.

```typescript
import { WrestaurantApiClient } from "@wrestaurant/sdk";  const client = new WrestaurantApiClient({   apiKey: undefined!, // wrst_live_... });  const response = await client.endpoints.getTempOrders({   licenseKey: "DS5D2368HCME4O9X", }); console.log(response);
```

--------------------------------

### Respuesta esperada de la API

Source: https://docs.wrestaurantapi.com/primeros-pasos

Formato JSON que se espera recibir al consultar la lista de productos de una sucursal.

```json
{
  "items": [
    { "id": "...", "name": "Tacos al pastor", "price": 95.00 }
  ],
  "page": 1,
  "limit": 10,
  "totalCount": 142
}
```

--------------------------------

### Uso de License Key en Endpoints

Source: https://docs.wrestaurantapi.com/licencias

Incluye la license key en la ruta de las llamadas a endpoints de datos para identificar la sucursal.

```http
GET /api/v0/productos/{licenseKey}
GET /api/v0/estaciones/{licenseKey}
```

--------------------------------

### Ejemplo de Solicitud cURL con API Key

Source: https://docs.wrestaurantapi.com/autenticacion

Cómo incluir el encabezado X-Api-Key en una solicitud cURL para autenticarse.

```curl
curl -H "X-Api-Key: wrst_live_Abc123Def456Ghi789Jkl012Mno345Pq" \
  https://wrestaurant-api.inowu.store/api/v0/productos/DS5D2368HCME4O9X
```

--------------------------------

### Making a POST Request with Idempotency Key using cURL

Source: https://docs.wrestaurantapi.com/idempotencia

Use this cURL command to send a POST request to create a closed temporary order while ensuring idempotency. Include the `Idempotency-Key` header with a unique UUID v4 value for each distinct operation.

```bash
curl -X POST \
  -H "X-Api-Key: wrst_live_Abc123Def456Ghi789Jkl012Mno345Pq" \
  -H "Idempotency-Key: 5f8e2b1c-9a4d-4c6e-8f1a-2b3c4d5e6f70" \
  -H "Content-Type: application/json" \
  -d '{ "estacion": "1", "idEmpresa": "1", "noPersonas": 1, "productos": [], "idFormaDePago": "1" }' \
  https://wrestaurant-api.inowu.store/api/v1/temp_ordenes_cerradas/DS5D2368HCME4O9X
```

--------------------------------

### Formato de API Key

Source: https://docs.wrestaurantapi.com/autenticacion

El formato estándar para las API keys de WRestaurant.

```text
wrst_live_<32 caracteres alfanuméricos>
```

--------------------------------

### Ejemplo de License Key

Source: https://docs.wrestaurantapi.com/licencias

Formato de license key de 16 caracteres alfanuméricos.

```text
DS5D2368HCME4O9X
```

--------------------------------

### List Temporary Orders

Source: https://docs.wrestaurantapi.com/api

Retrieves a list of temporary orders. Requires an API key for authentication and accepts a license key as a path parameter.

```APIDOC
## GET /api/v1/temp_ordenes/{licenseKey}

### Description
Retrieves a list of temporary orders.

### Method
GET

### Endpoint
/api/v1/temp_ordenes/{licenseKey}

### Parameters
#### Path Parameters
- **licenseKey** (string) - Required - The license key for the restaurant.

#### Headers
- **X-Api-Key** (string) - Required - API key for authentication.

### Response
#### Success Response (200)
- **workerId** (string) - uuid - The ID of the worker.
- **dispatchedAt** (string) - date-time - The timestamp when the order was dispatched.
- **page** (integer) - int32 - The current page number.
- **pageSize** (integer) - int32 - The number of results per page.
- **totalResults** (integer) - int32 - The total number of results.
- **totalPages** (integer) - int32 - The total number of pages.
- **hasNextPage** (boolean) - Indicates if there is a next page.
- **orders** (array | null) - A list of temporary orders.

### Response Example
```json
{
  "workerId": "00000000-0000-0000-0000-000000000000",
  "dispatchedAt": "2024-08-25T15:00:00Z",
  "page": 0,
  "pageSize": 0,
  "totalResults": 0,
  "totalPages": 0,
  "hasNextPage": true,
  "orders": [
    {
      "folio": 0,
      "serieFolio": "serieFolio",
      "numcheque": 0,
      "fecha": "2024-08-25T15:00:00Z",
      "cierre": "2024-08-25T15:00:00Z",
      "mesa": "mesa",
      "noPersonas": 0,
      "idMesero": "idMesero",
      "pagado": true,
      "cancelado": true,
      "impreso": true,
      "impresiones": 0,
      "descuento": 0,
      "razonCancelado": "razonCancelado",
      "orden": "orden",
      "facturado": true,
      "idTurno": 0,
      "usuarioCancelo": "usuarioCancelo",
      "comentarioDescuento": "comentarioDescuento",
      "usuarioPago": "usuarioPago",
      "totalArticulos": 0,
      "subtotal": 0,
      "subtotalSinImpuestos": 0,
      "total": 0,
      "totalConPropina": 0,
      "totalImpuestod1": 0,
      "totalImpuestod2": 0,
      "totalImpuestod3": 0,
      "efectivo": 0,
      "tarjeta": 0,
      "vales": 0,
      "otros": 0,
      "propina": 0,
      "totalSinDescuento": 0,
      "totalAlimentos": 0,
      "totalBebidas": 0,
      "totalOtros": 0,
      "totalDescuentos": 0,
      "totalCortesias": 0,
      "totalCortesiaAlimentos": 0,
      "items": [
        {
          "folioDet": 0,
          "movimiento": 0,
          "comanda": "comanda",
          "cantidad": 0,
          "idProducto": "idProducto",
          "descuento": 0,
          "precio": 0,
          "precioSinImpuestos": 0,
          "comentario": "comentario",
          "tiempo": "2024-08-25T15:00:00Z",
          "mitad": 0,
          "hora": "2024-08-25T15:00:00Z",
          "modificador": 0,
          "idEstacion": "idEstacion",
          "impuesto1": 0,
          "impuesto2": 0,
          "impuesto3": 0,
          "usuarioDescuento": "usuarioDescuento",
          "comentarioDescuento": "comentarioDescuento",
          "idTipoDescuento": "idTipoDescuento",
          "idProductoCompuesto": "idProductoCompuesto",
          "productoCompuestoPrincipal": 0,
          "precioCatalogo": 0,
          "marcar": 0,
          "idMeseroProducto": "idMeseroProducto",
          "idCortesia": "idCortesia",
          "numeroTarjeta": "numeroTarjeta",
          "folioProduccion": 0,
          "nivel": 0,
          "sistemaEnvio": 0,
          "promoVolumen": 0
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Estructura JSON de Error Genérico

Source: https://docs.wrestaurantapi.com/errores

Todos los errores devuelven un cuerpo JSON con esta estructura. Útil para entender la respuesta base de un error.

```json
{
  "status": 400,
  "message": "Descripción legible del problema",
  "errors": null
}
```

--------------------------------

### Ejemplo de Error de Validación JSON

Source: https://docs.wrestaurantapi.com/errores

Este JSON muestra la estructura de errores cuando ocurren problemas de validación. Los campos 'page' y 'limit' tienen mensajes de error específicos.

```json
{
  "status": 400,
  "message": "Uno o más errores de validación ocurrieron.",
  "errors": {
    "page": ["El valor debe ser mayor o igual a 1."],
    "limit": ["El valor debe estar entre 1 y 500."]
  }
}
```
Tokens:
Raw