Integração de Pedidos PDV

https://saipos-docs-order-api.readme.io/reference/
Admin
Este projeto documenta a API e os processos para a integração de sistemas de Ponto de Venda (PDV)...
Tokens:34,365
Snippets:188
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example Error: Order Not Found

Source: https://saipos-docs-order-api.readme.io/reference/transferencia-pedido-mesa

This example shows the response when a requested order does not exist.

```json
{
  "t": "sale",
  "dateTime": "2021-12-24T13:35:05.577Z",
  "errorMessage": "Não existe pedido com esse identificador.",
  "guidRequest": "40757446-73b4-4995-b802-dcce4741146e"
}
```

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

### Example Error: Internal Server Error

Source: https://saipos-docs-order-api.readme.io/reference/transferencia-pedido-mesa

This example shows a generic internal server error response, advising to contact technical support.

```json
{
    "t": "sale",
    "dateTime": "2021-12-24T13:35:41.780Z",
    "errorMessage": "Erro interno, comunique o time técnico.",
    "guidRequest": "7d99d6ea-371b-48f7-9eeb-a48b57467615"
}
```

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

### Example Error: Non-existent Table

Source: https://saipos-docs-order-api.readme.io/reference/transferencia-pedido-mesa

This error message is returned when the specified table does not exist in the system.

```json
{
  "t": "sale",
  "dateTime": "2021-12-24T13:35:05.577Z",
  "errorMessage": "Esta mesa não existe.",
  "guidRequest": "40757446-73b4-4995-b802-dcce4741146e"
}
```

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

### Payment Type Configuration Example

Source: https://saipos-docs-order-api.readme.io/reference/rotinas-pdv

Example JSON structure for defining payment types, including code, amount, complement, and online/offline status. Use 'ONLINE' for 'PGTO ONLINE' marked payments.

```json
{
    ...
    "payment_types":[
        {
            "code":"CRE",
            "amount":3,
            "change_for":0,
            "complement": "Visa",
            "type": "ONLINE"
        },{
            "code":"DEB",
            "amount":3,
            "change_for":0,
            "complement": "Mastercard",
            "type": "OFFLINE"
        }
    ]
    ...
}
```

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

### Example: Online Payment via Pix (with Complement)

Source: https://saipos-docs-order-api.readme.io/reference/formas-de-pagamento

Use this snippet for 'PARTNER_PAYMENT' when the payment is online and the complement is 'pix'. This indicates an online Pix payment.

```json
{
    "code": "PARTNER_PAYMENT",
    "amount": 29.9,
    "change_for": 0,
    "complement": "pix",
    "type": "ONLINE"
}
```

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

### Example: Vale (Voucher) Payment

Source: https://saipos-docs-order-api.readme.io/reference/formas-de-pagamento

Use this snippet for 'VALE' payment codes. The 'complement' field should be empty.

```json
{
    "code": "VALE",
    "amount": 29.9,
    "change_for": 0,
    "complement": "",
    "type": "OFFLINE"
}
```

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

### Example Error: Invalid Order Type

Source: https://saipos-docs-order-api.readme.io/reference/transferencia-pedido-mesa

This example illustrates the error response when an order is not of the 'mesa' or 'mesa/comanda' type.

```json
{
  "t": "sale",
  "dateTime": "2021-12-24T13:35:05.577Z",
  "errorMessage": "Pedido deve ser do tipo mesa ou mesa/comanda.",
  "guidRequest": "40757446-73b4-4995-b802-dcce4741146e"
}
```

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

### Example: Generic Online Payment

Source: https://saipos-docs-order-api.readme.io/reference/formas-de-pagamento

Use this snippet for 'PARTNER_PAYMENT' when the payment is online and no specific complement is provided. The 'type' is 'ONLINE'.

```json
{
    "code": "PARTNER_PAYMENT",
    "amount": 29.9,
    "change_for": 0,
    "complement": "",
    "type": "ONLINE"
}
```

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

### Example: Debit Card Payment

Source: https://saipos-docs-order-api.readme.io/reference/formas-de-pagamento

Use this snippet for 'DEB' payment codes, representing debit card payments. The 'complement' field should be empty.

```json
{
    "code": "DEB",
    "amount": 29.9,
    "change_for": 0,
    "complement": "",
    "type": "OFFLINE"
}
```

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

### Create Order JSON Example

Source: https://saipos-docs-order-api.readme.io/reference/criar-pedido

This JSON payload represents a sample order for a 'Comanda' (order/tab) system. It includes details such as order ID, store information, customer details, and a list of items with their choices and additional prices.

```json
{
  "order_id": "54515487548787",
  "display_id": "5457",
  "cod_store": "123",
  "created_at": "2020-10-08T01:25:49.992093Z",
  "notes": "",
  "total_discount": 10,
  "total_amount": 10,
  "customer": {
    "id": "247559798",
    "name": "PEDIDO DE TESTE - Jonathan Stein",
    "phone": "51996033508",
    "email": "testes@gmail.com.br",
    "document_number": "22919153048"
  },
  "order_method": {
    "mode": "TABLE",
    "table_reference": ""
  },
  "items": [
    {
      "integration_code": "1234",
      "desc_item": "PEDIDO DE TESTE - PEQUENO",
      "quantity": 1,
      "unit_price": 0,
      "notes": "",
      "id_store_waiter": "10",
      "choice_items": [
        {
          "integration_code": "1111",
          "desc_item_choice": "Massa massa doce + Borda normal",
          "aditional_price": 3,
          "quantity": 1,
          "notes": ""
        },
        {
          "integration_code": "2222",
          "desc_item_choice": "Queijo",
          "aditional_price": 10,
          "quantity": 1,
          "notes": ""
        }
      ]
    }
  ],
  "table": {
    "desc_order_pad": "12345"
  }
}
```

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

### Example: Pix Payment on Delivery (Offline)

Source: https://saipos-docs-order-api.readme.io/reference/formas-de-pagamento

Use this snippet for 'PARTNER_PAYMENT' when the payment is made via Pix on delivery, but processed offline. The 'type' is 'OFFLINE'.

```json
{
    "code": "PARTNER_PAYMENT",
    "amount": 29.9,
    "change_for": 0,
    "complement": "pix",
    "type": "OFFLINE"
}
```

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

### Example: Generic Card Payment

Source: https://saipos-docs-order-api.readme.io/reference/formas-de-pagamento

Use this snippet for 'CARD' payment codes, representing a generic card payment. The 'complement' field should be empty.

```json
{
    "code": "CARD",
    "amount": 29.9,
    "change_for": 0,
    "complement": "",
    "type": "OFFLINE"
}		
```

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

### Example Error: Sale Already Open on Table

Source: https://saipos-docs-order-api.readme.io/reference/transferencia-pedido-mesa

This response indicates that a sale is already active on the specified table, suggesting to select another or use item transfer.

```json
{
  "t": "sale",
  "dateTime": "2021-12-24T13:35:05.577Z",
  "errorMessage": "Venda já aberta nesta mesa, selecione outra ou use a transferência de itens.",
  "guidRequest": "40757446-73b4-4995-b802-dcce4741146e"
}
```

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

### Example: Credit Card Payment

Source: https://saipos-docs-order-api.readme.io/reference/formas-de-pagamento

Use this snippet for 'CRE' payment codes, representing credit card payments. The 'complement' field should be empty.

```json
{
    "code": "CRE",
    "amount": 29.9,
    "change_for": 0,
    "complement": "",
    "type": "OFFLINE"
}
```

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

### Example: Other Payment Method

Source: https://saipos-docs-order-api.readme.io/reference/formas-de-pagamento

Use this snippet for 'OTHER' payment codes when the payment is not registered in Saipos PDV. The 'complement' field should be empty.

```json
{
    "code": "OTHER",
    "amount": 29.9,
    "change_for": 0,
    "complement": "",
    "type": "OFFLINE"
}
```

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

### Definição OpenAPI para Consultar Status de Comanda

Source: https://saipos-docs-order-api.readme.io/reference/consultar-status-de-uma-comanda

Estrutura OpenAPI detalhando o endpoint GET /order-card-status, incluindo parâmetros e respostas.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "order-integration",
    "version": "2.5"
  },
  "servers": [
    {
      "url": "https://order-api.saipos.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "query",
        "name": "api_key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/order-card-status": {
      "get": {
        "description": "",
        "responses": {
          "200": {
            "description": ""
          }
        },
        "parameters": [
          {
            "in": "query",
            "name": "order_card",
            "schema": {
              "type": "string"
            },
            "required": true,
            "description": "Identificador de exibição da comanda (display_order_card)"
          },
          {
            "in": "header",
            "name": "Authorization",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "get_order-card-status",
        "summary": "Consultar status de uma comanda"
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

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

### Example: Cash Payment with Change

Source: https://saipos-docs-order-api.readme.io/reference/formas-de-pagamento

Use this snippet for 'DIN' payment codes (Cash). The 'change_for' field specifies the change amount to be returned.

```json
{
    "code": "DIN",
    "amount": 29.9,
    "change_for": 0,
    "complement": "",
    "type": "OFFLINE"
}
```

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

### Converter Pedido Manual em Pedido de Integração

Source: https://saipos-docs-order-api.readme.io/reference/converter-pedido-manual-em-pedido-integracao

Converte um pedido criado manualmente em um pedido de integração. Este endpoint é útil para adicionar itens a uma mesa ou comanda onde o pedido original não foi criado via integração. Pedidos manuais de Delivery não podem ser convertidos. Ao converter, o `order_id` do pedido convertido, juntamente com o número da mesa (`table`) e da comanda (`pad`), são retornados para uso na adição de novos itens.

```APIDOC
## POST /convert-orders-in-table

### Description
Converte um pedido criado manualmente em um pedido de integração.

### Method
POST

### Endpoint
/convert-orders-in-table

### Parameters
#### Request Body
- **table** (string) - Required - Número da mesa na Saipos

### Request Example
{
  "table": "1"
}

### Response
#### Success Response (200)
- **order_ids** (array) - Lista de pedidos convertidos, cada um contendo `order_id`, `table`, e `pad`.

#### Response Example
{
    "order_ids": [
        {
            "order_id": "123456",
            "table": "1",
            "pad": "1"
        }
    ]
}
```

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

### GET /order

Source: https://saipos-docs-order-api.readme.io/reference/estrutura-campos-endpoints

Retrieves order details based on provided order ID and store code.

```APIDOC
## GET /order

### Description
Retrieves order details using the order ID and store code.

### Method
GET

### Endpoint
/order

### Parameters
#### Query Parameters
- **order_id** (String) - Required - ID do pedido.
- **cod_store** (String) - Required - Código da loja.
```

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

### GET /sale-status-by-table-or-pad

Source: https://saipos-docs-order-api.readme.io/reference/estrutura-campos-endpoints

Retrieves sales status filtered by table or pad. Either 'table' or 'pad' must be provided.

```APIDOC
## GET /sale-status-by-table-or-pad

### Description
Retrieves the status of sales based on table or pad identifiers.

### Method
GET

### Endpoint
/sale-status-by-table-or-pad

### Parameters
#### Query Parameters
- **table** (String) - Conditional - Array in string format for querying tables (required if `pad` is not sent).
- **pad** (String) - Conditional - Array in string format for querying pads (required if `table` is not sent).
```

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

### Exemplo de Resposta de Sucesso - Comanda Livre

Source: https://saipos-docs-order-api.readme.io/reference/consultar-status-de-uma-comanda

Demonstra a resposta da API quando uma comanda está disponível para uso.

```json
{
  "order_card": "001",
  "status": "OPEN"
}
```

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

### Consultar Comandas

Source: https://saipos-docs-order-api.readme.io/reference/consultar-comandas

Fetches the list of registered order pads for a store, along with the current operating mode for order pad assignment.

```APIDOC
## GET /consultar-comandas

### Description
Retrieves a list of registered order pads and the current pad mode.

### Method
GET

### Endpoint
/consultar-comandas

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200 OK)
- **pad_mode** (String) - The operating mode for order pads (`MANUAL` or `AUTO`).
- **pads** (Array) - A list of registered order pads.
  - **pads[].order_card** (String) - The display identifier for the order pad.
  - **pads[].enabled** (String/Boolean) - Indicates if the order pad is enabled.
  - **pads[].have_open_sales** (String) - Indicates if the order pad has open sales (`"Y"` or `"N"`).

### Response Example
```json
{
  "pad_mode": "AUTO",
  "pads": [
    {
      "order_card": "001",
      "enabled": true,
      "have_open_sales": "N"
    },
    {
      "order_card": "002",
      "enabled": true,
      "have_open_sales": "S"
    },
    {
      "order_card": "003",
      "enabled": false,
      "have_open_sales": "N"
    }
  ]
}
```

### Error Handling
- **401 Unauthorized** (`errorCode`: 901) - Invalid or expired token.
- **400 Bad Request** (`errorCode`: 917) - Integration token is invalid.
- **404 Not Found** (`errorCode`: 946) - Restaurant has no registered order pads.
- **500 Internal Server Error** (`errorCode`: 900) - Internal server error.
```

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

### Exemplo de Requisição para Converter Pedido Manual

Source: https://saipos-docs-order-api.readme.io/reference/converter-pedido-manual-em-pedido-integracao

Este snippet demonstra como formatar uma requisição para converter um pedido manual em um pedido de integração. Utilize o número da mesa como parâmetro.

```json
{
  "table": "1"
}
```

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

### POST /auth

Source: https://saipos-docs-order-api.readme.io/reference/token-autenticacao

Creates an authorization token by sending partner ID and secret.

```APIDOC
## POST /auth

### Description
This endpoint is used to generate an authorization token. It requires the `idPartner` and `secret` of the partner.

### Method
POST

### Endpoint
/auth

### Parameters
#### Request Body
- **RAW_BODY** (string) - Required - The JSON payload containing `idPartner` and `secret`.

### Request Example
```json
{
  "RAW_BODY": "{\"idPartner\":\"174b0de210d98ce317d7c76f9fc478a9\", \"secret\":\"1416cc518fe9ddeb4b254dc17703fde4\"}"
}
```

### Response
#### Success Response (200)
- **token** (string) - The generated authorization token.

#### Response Example
```json
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZ3123121nRuZXIiOiIxNzRiMGRlMjEwZDk4Y2UzMTdkN2M3NmY5ZmM0NzhhOSIsImNyZWF0ZWQiOjE2Mzg5NzQzOTAwMTIsImlhdCI6MTYzODk3NDM5MCwiZXhwIjoxNjM5MTQ3MTkwfQ.OuLbzameyBQnmgt28e5btt-h4H_IlzXHJjjn-y5xOHw"
}
```

#### Error Response (400)
- **t** (string) - Type of error, typically "auth".
- **dateTime** (string) - Timestamp of the error.
- **errorMessage** (string) - Description of the error, e.g., "Erro na validação dos dados enviados. >> Id do parceiro ou secret inválidos!".
- **guidRequest** (string) - Unique identifier for the request.

#### Error Response Example (400)
```json
{
  "t": "auth",
  "dateTime": "2021-12-08T14:40:18.833Z",
  "errorMessage": "Erro na validação dos dados enviados. >> Id do parceiro ou secret inválidos!",
  "guidRequest": "4a48bf5a-91b2-4a4b-b457-694e352e0806"
}
```

#### Error Response (500)
- **t** (string) - Type of error, typically "auth".
- **dateTime** (string) - Timestamp of the error.
- **errorMessage** (string) - Description of the error, e.g., "Erro interno, comunique o time técnico.".
- **guidRequest** (string) - Unique identifier for the request.

#### Error Response Example (500)
```json
{
  "t": "auth",
  "dateTime": "2021-12-08T14:40:18.833Z",
  "errorMessage": "Erro interno, comunique o time técnico.",
  "guidRequest": "4a48bf5a-91b2-4a4b-b457-694e352e0806"
}
```
```

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

### Exemplo de Resposta de Sucesso - Comanda em Uso

Source: https://saipos-docs-order-api.readme.io/reference/consultar-status-de-uma-comanda

Demonstra a resposta da API quando uma comanda está em uso com uma venda em andamento.

```json
{
  "order_card": "002",
  "status": "IN_USE"
}
```

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

### Definição OpenAPI para consulta de garçons

Source: https://saipos-docs-order-api.readme.io/reference/consultar-garcons

Esta é a definição OpenAPI para o endpoint de consulta de garçons. Ela especifica o método HTTP, o caminho, os parâmetros esperados, e os esquemas de resposta para sucesso (200) e erro (400).

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "order-integration",
    "version": "2.5"
  },
  "servers": [
    {
      "url": "https://order-api.saipos.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "query",
        "name": "api_key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/waiters": {
      "get": {
        "summary": "Consultar garçons",
        "description": "Por meio deste endpoint é possível consultar os garçons cadastrados na loja.",
        "operationId": "consultar-garcons",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "schema": {
              "type": "string",
              "default": "TOKEN_GERADO"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "[\n    {\n        \"table\": \"20\",\n        \"pad\": \"45\",\n        \"order_id\": \"1678716468\",\n        \"id_partner_sale\": 28,\n        \"id_table_order_status\": 2\n    }\n]"
                  }
                },
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "table": {
                        "type": "string",
                        "example": "20"
                      },
                      "pad": {
                        "type": "string",
                        "example": "45"
                      },
                      "order_id": {
                        "type": "string",
                        "example": "1678716468"
                      },
                      "id_partner_sale": {
                        "type": "integer",
                        "example": 28,
                        "default": 0
                      },
                      "id_table_order_status": {
                        "type": "integer",
                        "example": 2,
                        "default": 0
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

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

### JSON Example for Takeout Orders

Source: https://saipos-docs-order-api.readme.io/reference/criar-pedido

This JSON payload is used for 'TAKEOUT' mode orders, commonly integrated as counter orders. It includes a 'localizer' field for the customer and pickup details.

```json
{
  "order_id": "54515487548787",
  "display_id": "5457",
  "cod_store": "123",
  "created_at": "2020-10-08T01:25:49.992093Z",
  "notes": "",
  "total_increase": 10,
  "total_discount": 10,
  "total_amount": 10,
  "customer": {
    "id": "247559798",
    "name": "PEDIDO DE TESTE - Jonathan Stein",
    "phone": "51996033508",
    "email": "testes@gmail.com.br",
    "document_number": "22919153048",
    "localizer": "12345B5"
  },
  "order_method": {
    "mode": "TAKEOUT",
    "scheduled": false,
    "delivery_date_time": "2020-10-08T01:25:49.992093Z",
    "pickupCode": "423432"
  },
  "items": [
    {
      "integration_code": "1234",
      "desc_item": "PEDIDO DE TESTE - PEQUENO",
      "quantity": 1,
      "unit_price": 0,
      "notes": "",
      "choice_items": [
        {
          "integration_code": "1111",
          "desc_item_choice": "Massa massa doce + Borda normal",
          "aditional_price": 3,
          "quantity": 1,
          "notes": ""
        },
        {
          "integration_code": "2222",
          "desc_item_choice": "Queijo",
          "aditional_price": 10,
          "quantity": 1,
          "notes": ""
        }
      ]
    }
  ],
  "payment_types": [
    {
      "code": "DIN",
      "amount": 3,
      "change_for": 0
    }
  ]
}
```

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

### Example JSON for Table Orders

Source: https://saipos-docs-order-api.readme.io/reference/criar-pedido

This JSON structure represents a typical order placed for a table in the Saipos system. It includes details about the order, customer, items, and table assignment.

```json
{
  "order_id": "54515487548787",
  "display_id": "5457",
  "cod_store": "123",
  "created_at": "2020-10-08T01:25:49.992093Z",
  "notes": "",
  "total_discount": 10,
  "total_amount": 10,
  "customer": {
    "id": "247559798",
    "name": "PEDIDO DE TESTE - Jonathan Stein",
    "phone": "51996033508",
    "email": "testes@gmail.com.br",
    "document_number": "22919153048"
  },
  "order_method": {
    "mode": "TABLE",
    "table_reference": ""
  },
  "items": [
    {
      "integration_code": "1234",
      "desc_item": "PEDIDO DE TESTE - PEQUENO",
      "quantity": 1,
      "unit_price": 0,
      "notes": "",
      "id_store_waiter": "10",
      "choice_items": [
        {
          "integration_code": "1111",
          "desc_item_choice": "Massa massa doce + Borda normal",
          "aditional_price": 3,
          "quantity": 1,
          "notes": ""
        },
        {
          "integration_code": "2222",
          "desc_item_choice": "Queijo",
          "aditional_price": 10,
          "quantity": 1,
          "notes": ""
        }
      ]
    }
  ],
  "table": {
    "desc_table": "12345"
  }
}
```

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

### Exemplo de Resposta de Consulta

Source: https://saipos-docs-order-api.readme.io/reference/consulta-por-mesas-ou-comandas

Este é um exemplo da estrutura de resposta ao consultar pedidos por mesa ou comanda. Ele mostra os detalhes de um pedido, incluindo mesa, comanda, ID do pedido e status.

```json
[
    {
        "table": "20",
        "pad": "45",
        "order_id": "1678716468",
        "id_partner_sale": 28,
        "id_table_order_status": 2
    }
]
```

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

### JSON Example for Ticket Orders

Source: https://saipos-docs-order-api.readme.io/reference/criar-pedido

This JSON payload is used for 'TICKET' mode orders, commonly used in shopping mall operations. It includes details about the order, customer, and items.

```json
{
  "order_id": "54515487548787",
  "display_id": "5457",
  "cod_store": "123",
  "created_at": "2020-10-08T01:25:49.992093Z",
  "notes": "",
  "total_increase": 10,
  "total_discount": 10,
  "total_amount": 10,
  "customer": {
    "id": "247559798",
    "name": "PEDIDO DE TESTE - Jonathan Stein",
    "phone": "51996033508",
    "email": "testes@gmail.com.br",
    "document_number": "22919153048"
  },
  "order_method": {
    "mode": "TICKET",
    "ticket_reference": "Ticket 02"
  },
  "items": [
    {
      "integration_code": "1234",
      "desc_item": "PEDIDO DE TESTE - PEQUENO",
      "quantity": 1,
      "unit_price": 0,
      "notes": "",
      "choice_items": [
        {
          "integration_code": "1111",
          "desc_item_choice": "Massa massa doce + Borda normal",
          "aditional_price": 3,
          "quantity": 1,
          "notes": ""
        },
        {
          "integration_code": "2222",
          "desc_item_choice": "Queijo",
          "aditional_price": 10,
          "quantity": 1,
          "notes": ""
        }
      ]
    }
  ],
  "payment_types": [
    {
      "code": "DIN",
      "amount": 3,
      "change_for": 0
    }
  ]
}
```

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

### Erro: Mesa de Destino Inexistente

Source: https://saipos-docs-order-api.readme.io/reference/transferencia-pedido-mesa

Ocorre quando a mesa especificada para a qual o pedido será transferido não existe no sistema.

```json
{
    "t": "sale",
    "dateTime": "2021-12-24T13:35:05.577Z",
    "errorMessage": "Esta mesa não existe.",
    "guidRequest": "40757446-73b4-4995-b802-dcce4741146e"
}
```

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

### Exemplo de Resposta de Sucesso - Comanda em Fechamento

Source: https://saipos-docs-order-api.readme.io/reference/consultar-status-de-uma-comanda

Demonstra a resposta da API quando uma solicitação de fechamento para uma comanda foi feita.

```json
{
  "order_card": "003",
  "status": "CLOSING_REQUESTED"
}
```

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

### Erro: Venda Já Aberta na Mesa de Destino

Source: https://saipos-docs-order-api.readme.io/reference/transferencia-pedido-mesa

Impede a transferência se já houver uma venda ativa na mesa de destino. Sugere selecionar outra mesa ou usar a transferência de itens.

```json
{
    "t": "sale",
    "dateTime": "2021-12-24T13:35:05.577Z",
    "errorMessage": "Venda já aberta nesta mesa, selecione outra ou use a transferência de itens.",
    "guidRequest": "40757446-73b4-4995-b802-dcce4741146e"
}
```

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

### Exemplo de Resposta de Sucesso da Conversão de Pedido

Source: https://saipos-docs-order-api.readme.io/reference/converter-pedido-manual-em-pedido-integracao

Ao converter um pedido manual com sucesso, a API retorna o order_id do pedido convertido, juntamente com o número da mesa e da comanda. Estes dados são essenciais para adicionar novos itens ao pedido.

```json
{
    "order_ids": [
        {
            "order_id": "123456",
            "table": "1",
            "pad": "1"
        }
    ]
}
```

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

### POST /order - TAKEOUT

Source: https://saipos-docs-order-api.readme.io/reference/estrutura-campos-endpoints

Creates a new takeout order. This endpoint requires detailed information about the order, customer, items, and payment.

```APIDOC
## POST /order - TAKEOUT

### Description
Creates a new takeout order with specified details.

### Method
POST

### Endpoint
/order

### Request Body
- **order_id** (String) - Required - ID do pedido.
- **display_id** (String) - Required - Identificador visível do pedido.
- **cod_store** (String) - Required - Código da loja.
- **created_at** (String) - Required - Data/hora de criação do pedido.
- **notes** (String) - Optional - Observações do pedido.
- **total_discount** (Number) - Required - Valor total de desconto.
- **total_increase** (Number) - Optional - Valor total de acréscimo.
- **total_amount** (Number) - Optional - Valor total informado pelo parceiro.
- **customer** (Object) - Required - Dados do cliente.
  - **customer.id** (String) - Required - ID do cliente.
  - **customer.name** (String) - Required - Nome do cliente.
  - **customer.phone** (String) - Required - Telefone do cliente.
  - **customer.email** (String) - Optional - E-mail do cliente.
  - **customer.document_number** (String) - Optional - Documento do cliente.
  - **customer.localizer** (String) - Optional - Localizador externo do cliente.
- **order_method** (Object) - Required - Dados do método do pedido.
  - **order_method.mode** (String) - Required - Tipo do pedido (`TAKEOUT`).
  - **order_method.scheduled** (Boolean) - Required - Indica se o pedido é agendado.
  - **order_method.delivery_date_time** (String) - Required - Data/hora da retirada.
  - **order_method.pickupCode** (String) - Optional - Código de retirada/validação.
- **items** (Array) - Required - Lista de itens do pedido.
  - **items[].integration_code** (String) - Required - Código de integração do item.
  - **items[].desc_item** (String) - Required - Descrição do item.
  - **items[].quantity** (Integer) - Required - Quantidade do item.
  - **items[].unit_price** (Number) - Required - Preço unitário do item.
  - **items[].notes** (String) - Optional - Observações do item.
  - **items[].id_store_waiter** (String) - Optional - Identificador do garçom.
  - **items[].choice_items** (Array) - Optional - Lista de adicionais/complementos.
    - **items[].choice_items[].integration_code** (String) - Required - Código de integração do adicional.
    - **items[].choice_items[].desc_item_choice** (String) - Required - Descrição do adicional.
    - **items[].choice_items[].aditional_price** (Number) - Required - Preço adicional.
    - **items[].choice_items[].quantity** (Integer) - Required - Quantidade do adicional.
    - **items[].choice_items[].notes** (String) - Optional - Observações do adicional.
- **payment_types** (Array) - Required - Lista de formas de pagamento.
  - **payment_types[].code** (String) - Required - Código da forma de pagamento.
  - **payment_types[].amount** (Number) - Required - Valor pago na forma de pagamento.
  - **payment_types[].change_for** (Number) - Required - Valor para troco.
  - **payment_types[].complement** (String) - Optional - Complemento da forma de pagamento.
  - **payment_types[].type** (String) - Optional - Tipo do pagamento (`ONLINE` ou `OFFLINE`).
```
Tokens:
Raw