{
"openapi": "3.0.3",
"info": {
"title": "Beepay",
"description": "",
"version": "1.0.0"
},
"servers": [
{
"url": "http://beepay.test"
}
],
"paths": {
"/api/accesses": {
"get": {
"summary": "Buscar acessos",
"operationId": "buscarAcessos",
"description": "",
"parameters": [
{
"in": "query",
"name": "cpf",
"description": "O CPF do usuário.",
"example": "999.999.999-99",
"required": false,
"schema": {
"type": "string",
"description": "O CPF do usuário.",
"example": "999.999.999-99"
}
},
{
"in": "query",
"name": "pdv_id",
"description": "O ID do PDV.",
"example": 1,
"required": false,
"schema": {
"type": "integer",
"description": "O ID do PDV.",
"example": 1
}
},
{
"in": "query",
"name": "dates[]",
"description": "Data de criação do acesso.",
"example": [
"2022-08-15T11:45:38",
"2022-08-15T11:45:38"
],
"required": false,
"schema": {
"type": "array",
"description": "Data de criação do acesso.",
"example": [
"2022-08-15T11:45:38",
"2022-08-15T11:45:38"
],
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"current_page": "int",
"data": [
{
"id": "int",
"created_at": "datetime",
"user_name": "string",
"user_cpf": "string",
"user_telefone": "string",
"pdv": "string",
"device": "string",
"access_order_time": "int",
"order_lifetime": "int",
"order": [
{
"id": "int",
"status_pedido_id": "int"
}
]
}
],
"first_page_url": "string",
"from": "int",
"last_page": "int",
"last_page_url": "string",
"links": [
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
},
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
}
],
"next_page_url": "nullable_string",
"path": "string",
"per_page": "int",
"prev_page_url": "nullable_string",
"to": "int",
"total": "int"
},
"properties": {
"current_page": {
"type": "string",
"example": "int"
},
"data": {
"type": "array",
"example": [
{
"id": "int",
"created_at": "datetime",
"user_name": "string",
"user_cpf": "string",
"user_telefone": "string",
"pdv": "string",
"device": "string",
"access_order_time": "int",
"order_lifetime": "int",
"order": [
{
"id": "int",
"status_pedido_id": "int"
}
]
}
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "int"
},
"created_at": {
"type": "string",
"example": "datetime"
},
"user_name": {
"type": "string",
"example": "string"
},
"user_cpf": {
"type": "string",
"example": "string"
},
"user_telefone": {
"type": "string",
"example": "string"
},
"pdv": {
"type": "string",
"example": "string"
},
"device": {
"type": "string",
"example": "string"
},
"access_order_time": {
"type": "string",
"example": "int"
},
"order_lifetime": {
"type": "string",
"example": "int"
},
"order": {
"type": "array",
"example": [
{
"id": "int",
"status_pedido_id": "int"
}
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "int"
},
"status_pedido_id": {
"type": "string",
"example": "int"
}
}
}
}
}
}
},
"first_page_url": {
"type": "string",
"example": "string"
},
"from": {
"type": "string",
"example": "int"
},
"last_page": {
"type": "string",
"example": "int"
},
"last_page_url": {
"type": "string",
"example": "string"
},
"links": {
"type": "array",
"example": [
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
},
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
}
],
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "nullable_string"
},
"label": {
"type": "string",
"example": "string"
},
"active": {
"type": "string",
"example": "boolean"
}
}
}
},
"next_page_url": {
"type": "string",
"example": "nullable_string"
},
"path": {
"type": "string",
"example": "string"
},
"per_page": {
"type": "string",
"example": "int"
},
"prev_page_url": {
"type": "string",
"example": "nullable_string"
},
"to": {
"type": "string",
"example": "int"
},
"total": {
"type": "string",
"example": "int"
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string",
"errors": {
"field": "string"
}
},
"properties": {
"message": {
"type": "string",
"example": "string"
},
"errors": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "string"
}
}
}
}
}
}
}
}
},
"tags": [
"Acessos"
]
}
},
"/api/blocklist": {
"get": {
"summary": "Get Usuários na Blocklist",
"operationId": "getUsuriosNaBlocklist",
"description": "",
"parameters": [
{
"in": "query",
"name": "cpf",
"description": "O CPF do usuário.",
"example": "123.456.789-00",
"required": false,
"schema": {
"type": "string",
"description": "O CPF do usuário.",
"example": "123.456.789-00"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"data": [
{
"email": "string",
"cpf": "nullable_string",
"blocked_at": "datetime",
"reason": "nullable_string"
}
],
"links": {
"first": "string",
"last": "string",
"prev": "nullable_string",
"next": "nullable_string"
},
"meta": {
"current_page": "int",
"from": "int",
"last_page": "int",
"links": [
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
},
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
}
],
"path": "string",
"per_page": "int",
"to": "int",
"total": "int"
}
},
"properties": {
"data": {
"type": "array",
"example": [
{
"email": "string",
"cpf": "nullable_string",
"blocked_at": "datetime",
"reason": "nullable_string"
}
],
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"example": "string"
},
"cpf": {
"type": "string",
"example": "nullable_string"
},
"blocked_at": {
"type": "string",
"example": "datetime"
},
"reason": {
"type": "string",
"example": "nullable_string"
}
}
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": "string",
"example": "string"
},
"last": {
"type": "string",
"example": "string"
},
"prev": {
"type": "string",
"example": "nullable_string"
},
"next": {
"type": "string",
"example": "nullable_string"
}
}
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "string",
"example": "int"
},
"from": {
"type": "string",
"example": "int"
},
"last_page": {
"type": "string",
"example": "int"
},
"links": {
"type": "array",
"example": [
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
},
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
}
],
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "nullable_string"
},
"label": {
"type": "string",
"example": "string"
},
"active": {
"type": "string",
"example": "boolean"
}
}
}
},
"path": {
"type": "string",
"example": "string"
},
"per_page": {
"type": "string",
"example": "int"
},
"to": {
"type": "string",
"example": "int"
},
"total": {
"type": "string",
"example": "int"
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string",
"errors": {
"field": "string"
}
},
"properties": {
"message": {
"type": "string",
"example": "string"
},
"errors": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "string"
}
}
}
}
}
}
}
}
},
"tags": [
"Blocklist"
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cpf": {
"type": "string",
"description": "",
"example": "delectus"
}
}
}
}
}
}
},
"post": {
"summary": "Insere um usuário na Blocklist",
"operationId": "insereUmUsurioNaBlocklist",
"description": "",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "Usuário bloqueado com sucesso",
"blocked_user": {
"e-mail": "joe@example.com",
"CPF": "123.456.789-00",
"blocked_at": "2025-06-11 17:23:50",
"motivo": "Roubou a Loja"
}
},
"properties": {
"message": {
"type": "string",
"example": "Usuário bloqueado com sucesso"
},
"blocked_user": {
"type": "object",
"properties": {
"e-mail": {
"type": "string",
"example": "joe@example.com"
},
"CPF": {
"type": "string",
"example": "123.456.789-00"
},
"blocked_at": {
"type": "string",
"format": "datetime",
"example": "2025-06-11 17:23:50"
},
"motivo": {
"type": "string",
"example": "Roubou a Loja"
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string",
"errors": {
"field": "string"
}
},
"properties": {
"message": {
"type": "string",
"example": "string"
},
"errors": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "string"
}
}
}
}
}
}
}
}
},
"tags": [
"Blocklist"
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cpf": {
"type": "string",
"description": "required=true",
"example": "123.456.789-00"
},
"email": {
"type": "string",
"description": "required=true",
"example": "paxton68@example.com"
},
"reason": {
"type": "string",
"description": "required=true",
"example": "Roubou a Loja"
},
"action": {
"type": "string",
"enum": [
"Block",
"Unblock"
],
"description": "required=true",
"example": "Block"
}
},
"required": [
"cpf",
"email",
"reason",
"action"
]
}
}
}
}
}
},
"/api/import/groups": {
"post": {
"summary": "Cria um grupo",
"operationId": "criaUmGrupo",
"description": "",
"parameters": [],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"id": "int",
"name": "string",
"market_id": "int",
"id_externo": "string",
"created_at": "datetime",
"updated_at": "datetime",
"active": "boolean"
},
"properties": {
"id": {
"type": "string",
"example": "int"
},
"name": {
"type": "string",
"example": "string"
},
"market_id": {
"type": "string",
"example": "int"
},
"id_externo": {
"type": "string",
"example": "string"
},
"created_at": {
"type": "string",
"example": "datetime"
},
"updated_at": {
"type": "string",
"example": "datetime"
},
"active": {
"type": "string",
"example": "boolean"
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string",
"errors": {
"field": "string"
}
},
"properties": {
"message": {
"type": "string",
"example": "string"
},
"errors": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "string"
}
}
}
}
}
}
}
}
},
"tags": [
"Grupos"
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nome do grupo",
"example": "et"
},
"active": {
"type": "boolean",
"description": "Ativo",
"example": true
},
"id_externo": {
"type": "string",
"description": "Id externo",
"example": "ipsam"
},
"market_id": {
"type": "integer",
"description": "Id do mercado",
"example": 11
}
}
}
}
}
}
},
"get": {
"summary": "Lista todos os grupos",
"operationId": "listaTodosOsGrupos",
"description": "",
"parameters": [
{
"in": "query",
"name": "id_externo",
"description": "Id externo example: 322552",
"example": "velit",
"required": false,
"schema": {
"type": "string",
"description": "Id externo example: 322552",
"example": "velit"
}
},
{
"in": "query",
"name": "market_id",
"description": "Id do mercado example: 1",
"example": 7,
"required": false,
"schema": {
"type": "integer",
"description": "Id do mercado example: 1",
"example": 7
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"current_page": "int",
"data": [
{
"id": "int",
"name": "string",
"market_id": "int",
"id_externo": "string",
"created_at": "datetime",
"updated_at": "datetime",
"active": "boolean"
}
],
"first_page_url": "string",
"from": "int",
"last_page": "int",
"last_page_url": "string",
"links": [
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
}
],
"next_page_url": "string",
"path": "string",
"per_page": "int",
"prev_page_url": "nullable_string",
"to": "int",
"total": "int"
},
"properties": {
"current_page": {
"type": "string",
"example": "int"
},
"data": {
"type": "array",
"example": [
{
"id": "int",
"name": "string",
"market_id": "int",
"id_externo": "string",
"created_at": "datetime",
"updated_at": "datetime",
"active": "boolean"
}
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "int"
},
"name": {
"type": "string",
"example": "string"
},
"market_id": {
"type": "string",
"example": "int"
},
"id_externo": {
"type": "string",
"example": "string"
},
"created_at": {
"type": "string",
"example": "datetime"
},
"updated_at": {
"type": "string",
"example": "datetime"
},
"active": {
"type": "string",
"example": "boolean"
}
}
}
},
"first_page_url": {
"type": "string",
"example": "string"
},
"from": {
"type": "string",
"example": "int"
},
"last_page": {
"type": "string",
"example": "int"
},
"last_page_url": {
"type": "string",
"example": "string"
},
"links": {
"type": "array",
"example": [
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
}
],
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "nullable_string"
},
"label": {
"type": "string",
"example": "string"
},
"active": {
"type": "string",
"example": "boolean"
}
}
}
},
"next_page_url": {
"type": "string",
"example": "string"
},
"path": {
"type": "string",
"example": "string"
},
"per_page": {
"type": "string",
"example": "int"
},
"prev_page_url": {
"type": "string",
"example": "nullable_string"
},
"to": {
"type": "string",
"example": "int"
},
"total": {
"type": "string",
"example": "int"
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
}
},
"tags": [
"Grupos"
]
}
},
"/api/orders": {
"get": {
"summary": "Get orders",
"operationId": "getOrders",
"description": "",
"parameters": [
{
"in": "query",
"name": "id",
"description": "The ID of the order to filter orders by.",
"example": 8,
"required": false,
"schema": {
"type": "integer",
"description": "The ID of the order to filter orders by.",
"example": 8
}
},
{
"in": "query",
"name": "order_id",
"description": "The ID of the order to filter orders by.",
"example": 12345,
"required": false,
"schema": {
"type": "integer",
"description": "The ID of the order to filter orders by.",
"example": 12345
}
},
{
"in": "query",
"name": "pdv_id",
"description": "The ID of the PDV to filter orders by.",
"example": 981,
"required": false,
"schema": {
"type": "integer",
"description": "The ID of the PDV to filter orders by.",
"example": 981
}
},
{
"in": "query",
"name": "payment_method",
"description": "The ID of the payment method to filter orders by.",
"example": 1,
"required": false,
"schema": {
"type": "integer",
"description": "The ID of the payment method to filter orders by.",
"example": 1
}
},
{
"in": "query",
"name": "status",
"description": "The ID of the status to filter orders by.",
"example": 1,
"required": false,
"schema": {
"type": "integer",
"description": "The ID of the status to filter orders by.",
"example": 1
}
},
{
"in": "query",
"name": "delivery",
"description": "Specifies if only delivery orders should be returned to filter orders by.",
"example": true,
"required": false,
"schema": {
"type": "boolean",
"description": "Specifies if only delivery orders should be returned to filter orders by.",
"example": true
}
},
{
"in": "query",
"name": "userId",
"description": "The ID of the user to filter orders by.",
"example": 1,
"required": false,
"schema": {
"type": "integer",
"description": "The ID of the user to filter orders by.",
"example": 1
}
},
{
"in": "query",
"name": "dates",
"description": "",
"example": [
"2022-08-15T11:45:38",
"2022-08-15T11:45:38"
],
"required": false,
"schema": {
"type": "array",
"description": "",
"example": [
"2022-08-15T11:45:38",
"2022-08-15T11:45:38"
],
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"data": [
{
"id": "int",
"user_name": "string",
"user_cpf": "string",
"user_cep": "string",
"created_at": "datetime",
"time_to_pay": "int",
"status_pedido": "int",
"pdv_id": "int",
"pdv_description": "string",
"delivery": "boolean",
"paid_at": "datetime",
"payment_method": "int",
"itens": {
"data": [
{
"code": "string",
"description": "string",
"value": "float",
"total_value": "float",
"delivery": "boolean",
"unit": "string",
"amount": "int"
}
]
}
}
],
"links": {
"first": "string",
"last": "string",
"prev": "nullable_string",
"next": "string"
},
"meta": {
"current_page": "int",
"from": "int",
"last_page": "int",
"links": [
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
}
],
"path": "string",
"per_page": "int",
"to": "int",
"total": "int"
}
},
"properties": {
"data": {
"type": "array",
"example": [
{
"id": "int",
"user_name": "string",
"user_cpf": "string",
"user_cep": "string",
"created_at": "datetime",
"time_to_pay": "int",
"status_pedido": "int",
"pdv_id": "int",
"pdv_description": "string",
"delivery": "boolean",
"paid_at": "datetime",
"payment_method": "int",
"itens": {
"data": [
{
"code": "string",
"description": "string",
"value": "float",
"total_value": "float",
"delivery": "boolean",
"unit": "string",
"amount": "int"
}
]
}
}
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "int"
},
"user_name": {
"type": "string",
"example": "string"
},
"user_cpf": {
"type": "string",
"example": "string"
},
"user_cep": {
"type": "string",
"example": "string"
},
"created_at": {
"type": "string",
"example": "datetime"
},
"time_to_pay": {
"type": "string",
"example": "int"
},
"status_pedido": {
"type": "string",
"example": "int"
},
"pdv_id": {
"type": "string",
"example": "int"
},
"pdv_description": {
"type": "string",
"example": "string"
},
"delivery": {
"type": "string",
"example": "boolean"
},
"paid_at": {
"type": "string",
"example": "datetime"
},
"payment_method": {
"type": "string",
"example": "int"
},
"itens": {
"type": "object",
"properties": {
"data": {
"type": "array",
"example": [
{
"code": "string",
"description": "string",
"value": "float",
"total_value": "float",
"delivery": "boolean",
"unit": "string",
"amount": "int"
}
],
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "string"
},
"description": {
"type": "string",
"example": "string"
},
"value": {
"type": "string",
"example": "float"
},
"total_value": {
"type": "string",
"example": "float"
},
"delivery": {
"type": "string",
"example": "boolean"
},
"unit": {
"type": "string",
"example": "string"
},
"amount": {
"type": "string",
"example": "int"
}
}
}
}
}
}
}
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": "string",
"example": "string"
},
"last": {
"type": "string",
"example": "string"
},
"prev": {
"type": "string",
"example": "nullable_string"
},
"next": {
"type": "string",
"example": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "string",
"example": "int"
},
"from": {
"type": "string",
"example": "int"
},
"last_page": {
"type": "string",
"example": "int"
},
"links": {
"type": "array",
"example": [
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
}
],
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "nullable_string"
},
"label": {
"type": "string",
"example": "string"
},
"active": {
"type": "string",
"example": "boolean"
}
}
}
},
"path": {
"type": "string",
"example": "string"
},
"per_page": {
"type": "string",
"example": "int"
},
"to": {
"type": "string",
"example": "int"
},
"total": {
"type": "string",
"example": "int"
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string",
"errors": {
"field": "string"
}
},
"properties": {
"message": {
"type": "string",
"example": "string"
},
"errors": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "string"
}
}
}
}
}
}
}
}
},
"tags": [
"Pedidos"
]
}
},
"/api/order": {
"post": {
"summary": "Post orders",
"operationId": "postOrders",
"description": "",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"data": [
{
"id": "int",
"user_name": "string",
"user_cpf": "string",
"user_cep": "string",
"created_at": "datetime",
"time_to_pay": "int",
"status_pedido": "int",
"pdv_id": "int",
"pdv_description": "string",
"delivery": "boolean",
"paid_at": "datetime",
"payment_method": "int",
"itens": {
"data": [
{
"code": "string",
"description": "string",
"value": "float",
"total_value": "float",
"delivery": "boolean",
"unit": "string",
"amount": "int"
}
]
}
}
],
"links": {
"first": "string",
"last": "string",
"prev": "nullable_string",
"next": "string"
},
"meta": {
"current_page": "int",
"from": "int",
"last_page": "int",
"links": [
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
}
],
"path": "string",
"per_page": "int",
"to": "int",
"total": "int"
}
},
"properties": {
"data": {
"type": "array",
"example": [
{
"id": "int",
"user_name": "string",
"user_cpf": "string",
"user_cep": "string",
"created_at": "datetime",
"time_to_pay": "int",
"status_pedido": "int",
"pdv_id": "int",
"pdv_description": "string",
"delivery": "boolean",
"paid_at": "datetime",
"payment_method": "int",
"itens": {
"data": [
{
"code": "string",
"description": "string",
"value": "float",
"total_value": "float",
"delivery": "boolean",
"unit": "string",
"amount": "int"
}
]
}
}
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "int"
},
"user_name": {
"type": "string",
"example": "string"
},
"user_cpf": {
"type": "string",
"example": "string"
},
"user_cep": {
"type": "string",
"example": "string"
},
"created_at": {
"type": "string",
"example": "datetime"
},
"time_to_pay": {
"type": "string",
"example": "int"
},
"status_pedido": {
"type": "string",
"example": "int"
},
"pdv_id": {
"type": "string",
"example": "int"
},
"pdv_description": {
"type": "string",
"example": "string"
},
"delivery": {
"type": "string",
"example": "boolean"
},
"paid_at": {
"type": "string",
"example": "datetime"
},
"payment_method": {
"type": "string",
"example": "int"
},
"itens": {
"type": "object",
"properties": {
"data": {
"type": "array",
"example": [
{
"code": "string",
"description": "string",
"value": "float",
"total_value": "float",
"delivery": "boolean",
"unit": "string",
"amount": "int"
}
],
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "string"
},
"description": {
"type": "string",
"example": "string"
},
"value": {
"type": "string",
"example": "float"
},
"total_value": {
"type": "string",
"example": "float"
},
"delivery": {
"type": "string",
"example": "boolean"
},
"unit": {
"type": "string",
"example": "string"
},
"amount": {
"type": "string",
"example": "int"
}
}
}
}
}
}
}
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": "string",
"example": "string"
},
"last": {
"type": "string",
"example": "string"
},
"prev": {
"type": "string",
"example": "nullable_string"
},
"next": {
"type": "string",
"example": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "string",
"example": "int"
},
"from": {
"type": "string",
"example": "int"
},
"last_page": {
"type": "string",
"example": "int"
},
"links": {
"type": "array",
"example": [
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
}
],
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "nullable_string"
},
"label": {
"type": "string",
"example": "string"
},
"active": {
"type": "string",
"example": "boolean"
}
}
}
},
"path": {
"type": "string",
"example": "string"
},
"per_page": {
"type": "string",
"example": "int"
},
"to": {
"type": "string",
"example": "int"
},
"total": {
"type": "string",
"example": "int"
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string",
"errors": {
"field": "string"
}
},
"properties": {
"message": {
"type": "string",
"example": "string"
},
"errors": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "string"
}
}
}
}
}
}
}
}
},
"tags": [
"Pedidos"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"pedido_id_externo": {
"type": "integer",
"description": "",
"example": 4
},
"created_at": {
"type": "string",
"description": "Must be a valid date in the format Y-m-d H:i:s.",
"example": "2024-09-12 12:18:43"
},
"dt_pagamento": {
"type": "string",
"description": "Must be a valid date in the format Y-m-d H:i:s. O campo value deve conter uma data superior ou igual a created_at.",
"example": "2110-06-06"
},
"status_pedido_id": {
"type": "integer",
"description": "",
"example": 19
},
"cpf": {
"type": "string",
"description": "",
"example": "animi"
},
"forma_pagamento": {
"type": "integer",
"description": "",
"example": " 8",
"enum": [
"1",
" 2",
" 3",
" 4",
" 5",
" 6",
" 7",
" 8",
" 9",
" 10",
" 11",
" 12",
" 13"
]
},
"itens": {
"type": "array",
"description": "",
"example": [
[]
],
"items": {
"type": "object",
"properties": {
"id_externo": {
"type": "integer",
"description": "",
"example": 12
},
"quantidade": {
"type": "integer",
"description": "O campo value deve conter um número superior ou igual a 1.",
"example": 79
}
},
"required": [
"id_externo",
"quantidade"
]
}
},
"pdv_id": {
"type": "integer",
"description": "",
"example": 16
},
"telefone": {
"type": "string",
"description": "",
"example": null
}
},
"required": [
"pedido_id_externo",
"created_at",
"dt_pagamento",
"status_pedido_id",
"cpf",
"forma_pagamento",
"itens",
"pdv_id"
]
}
}
}
}
}
},
"/api/order/{pedido}": {
"put": {
"summary": "Update order status",
"operationId": "updateOrderStatus",
"description": "Atualiza o status de um pedido que esteja em \"A pagar\" (1) para \"Pago\" (6) ou \"Cancelado\" (8). Pedidos em qualquer outro status são rejeitados e permanecem inalterados. O pedido precisa pertencer ao mercado da chave de API autenticada.",
"parameters": [
{
"in": "path",
"name": "pedido",
"description": "ID do pedido a ser atualizado.",
"example": 7599,
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Pedido atualizado com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"data": {
"id": "int",
"user_name": "string",
"user_cpf": "string",
"user_cep": "string",
"created_at": "datetime",
"time_to_pay": "int",
"status_pedido": "int",
"pdv_id": "int",
"pdv_description": "string",
"delivery": "boolean",
"paid_at": "datetime",
"payment_method": "int",
"itens": {
"data": [
{
"code": "string",
"description": "string",
"value": "float",
"total_value": "float",
"delivery": "boolean",
"unit": "string",
"amount": "int"
}
]
}
}
},
"properties": {
"data": {
"type": "object",
"example": {
"id": "int",
"user_name": "string",
"user_cpf": "string",
"user_cep": "string",
"created_at": "datetime",
"time_to_pay": "int",
"status_pedido": "int",
"pdv_id": "int",
"pdv_description": "string",
"delivery": "boolean",
"paid_at": "datetime",
"payment_method": "int",
"itens": {
"data": [
{
"code": "string",
"description": "string",
"value": "float",
"total_value": "float",
"delivery": "boolean",
"unit": "string",
"amount": "int"
}
]
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"404": {
"description": "Pedido inexistente ou pertencente a outro mercado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"422": {
"description": "Pedido em status diferente de \"A pagar\".",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string",
"errors": {
"status": [
"string"
]
}
},
"properties": {
"message": {
"type": "string",
"example": "string"
},
"errors": {
"type": "object",
"properties": {
"status": {
"type": "array",
"items": {
"type": "string",
"example": "string"
}
},
"forma_pagamento_id": {
"type": "array",
"items": {
"type": "string",
"example": "string"
}
}
}
}
}
}
}
}
}
},
"tags": [
"Pedidos"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Novo status do pedido. Aceita apenas 6 (Pago) ou 8 (Cancelado).",
"example": 8,
"enum": [
6,
8
]
},
"forma_pagamento_id": {
"type": "integer",
"description": "Forma de pagamento do pedido. Obrigatório quando status for 6 (Pago). Deve existir em forma_pagamento.",
"example": 2
}
},
"required": [
"status"
]
}
}
}
}
}
},
"/api/products-by-pdv": {
"get": {
"summary": "Buscar preços por PDV",
"operationId": "buscarPreosPorPDV",
"description": "",
"parameters": [
{
"in": "query",
"name": "id",
"description": "O ID do PDV para buscar preços.",
"example": 4,
"required": false,
"schema": {
"type": "integer",
"description": "O ID do PDV para buscar preços.",
"example": 4
}
},
{
"in": "query",
"name": "ativo",
"description": "O status do produto.",
"example": 0,
"required": false,
"schema": {
"type": "integer",
"description": "O status do produto.",
"example": 0
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"current_page": "int",
"data": [
{
"ID do produto": "int",
"Descrição": "string",
"Unidade": "string",
"Quantidade": "int",
"Valor unitário": "float",
"PLU": "int",
"EAN": "string",
"Ativo": "boolean"
}
],
"first_page_url": "string",
"from": "int",
"last_page": "int",
"last_page_url": "string",
"next_page_url": "string",
"path": "string",
"per_page": "int",
"prev_page_url": "nullable_string",
"to": "int",
"total": "int"
},
"properties": {
"current_page": {
"type": "string",
"example": "int"
},
"data": {
"type": "array",
"example": [
{
"ID do produto": "int",
"Descrição": "string",
"Unidade": "string",
"Quantidade": "int",
"Valor unitário": "float",
"PLU": "int",
"EAN": "string",
"Ativo": "boolean"
}
],
"items": {
"type": "object",
"properties": {
"ID do produto": {
"type": "string",
"example": "int"
},
"Descrição": {
"type": "string",
"example": "string"
},
"Unidade": {
"type": "string",
"example": "string"
},
"Quantidade": {
"type": "string",
"example": "int"
},
"Valor unitário": {
"type": "string",
"example": "float"
},
"PLU": {
"type": "string",
"example": "int"
},
"EAN": {
"type": "string",
"example": "string"
},
"Ativo": {
"type": "string",
"example": "boolean"
}
}
}
},
"first_page_url": {
"type": "string",
"example": "string"
},
"from": {
"type": "string",
"example": "int"
},
"last_page": {
"type": "string",
"example": "int"
},
"last_page_url": {
"type": "string",
"example": "string"
},
"next_page_url": {
"type": "string",
"example": "string"
},
"path": {
"type": "string",
"example": "string"
},
"per_page": {
"type": "string",
"example": "int"
},
"prev_page_url": {
"type": "string",
"example": "nullable_string"
},
"to": {
"type": "string",
"example": "int"
},
"total": {
"type": "string",
"example": "int"
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string",
"errors": {
"field": "string"
}
},
"properties": {
"message": {
"type": "string",
"example": "string"
},
"errors": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "string"
}
}
}
}
}
}
}
}
},
"tags": [
"Produtos"
]
}
},
"/api/import/{mercado_id}/products": {
"post": {
"summary": "Importa os produtos",
"operationId": "importaOsProdutos",
"description": "",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"errors": [
"array"
],
"successes": [
{
"id": "int",
"id_externo": "int",
"plu": "int"
}
]
},
"properties": {
"errors": {
"type": "array",
"example": [
"array"
],
"items": {
"type": "string"
}
},
"successes": {
"type": "array",
"example": [
{
"id": "int",
"id_externo": "int",
"plu": "int"
}
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "int"
},
"id_externo": {
"type": "string",
"example": "int"
},
"plu": {
"type": "string",
"example": "int"
}
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
}
},
"tags": [
"Produtos"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "",
"example": [
{
"EAN": 7896017200341,
"descricao": "Achocolatado Em Pó",
"unidade": 20,
"plu": 50014,
"ativo": true,
"mercado_id": 13,
"over18": false,
"foto": {
"tipo": "url",
"conteudo": "https://fakeimg.pl/300/"
},
"id_externo": 8,
"group_id": "010101010",
"pre_paid": true
}
],
"items": {
"type": "object",
"required": [
"EAN",
"descricao",
"unidade",
"plu",
"ativo",
"mercado_id",
"over18",
"id_externo"
],
"properties": {
"EAN": {
"type": "string",
"description": "Código de barras do produto",
"example": 78960172003500000
},
"descricao": {
"type": "string",
"description": "Nome ou título comercial exibido para o produto",
"example": "Achocolatado Em Pó"
},
"unidade": {
"type": "integer",
"description": "example: Define a unidade de comercialização",
"example": 1
},
"plu": {
"type": "integer",
"description": "example: Identificador interno no PDV",
"example": 50015
},
"ativo": {
"type": "boolean",
"description": "Indica se o produto deve ficar disponível para venda",
"example": true
},
"mercado_id": {
"type": "integer",
"description": "Identificador do mercado",
"example": 13
},
"over18": {
"type": "boolean",
"description": "Sinaliza se há restrição de venda para maiores de idade",
"example": true
},
"foto": {
"type": "object",
"description": "Foto do produto",
"example": {
"tipo": "url"
},
"properties": {
"tipo": {
"type": "string",
"description": "Forma como a imagem está sendo enviada. \"url\" ou \"base64\"",
"example": "url"
},
"conteudo": {
"type": "string",
"description": "URL ou conteúdo base64 da imagem",
"example": "https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"
}
}
},
"id_externo": {
"type": "integer",
"description": "Identificador externo do produto",
"example": 8
},
"group_id": {
"type": "string",
"description": "Identificador externo de um grupo de produtos",
"example": 10101010
},
"pre_paid": {
"type": "boolean",
"default": false,
"description": "Indica se o produto está classificado como pré-pago",
"example": true
}
}
}
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "mercado_id",
"description": "The ID of the mercado.",
"example": 1,
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/api/import/{mercado_id}/products/pdv": {
"post": {
"summary": "Importa os produtos para o PDV",
"operationId": "importaOsProdutosParaOPDV",
"description": "",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"errors": [
"array"
],
"successes": [
{
"id": 18399,
"plu": 445,
"id_externo": 413
}
]
},
"properties": {
"errors": {
"type": "array",
"example": [
"array"
],
"items": {
"type": "string"
}
},
"successes": {
"type": "array",
"example": [
{
"id": 18399,
"plu": 445,
"id_externo": 413
}
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 18399
},
"plu": {
"type": "integer",
"example": 445
},
"id_externo": {
"type": "integer",
"example": 413
}
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
}
},
"tags": [
"Produtos"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "",
"example": [
{
"id_pdv": 5,
"id_produto": 7,
"preco_com_imposto": 244.082633,
"preco_sem_imposto": 16.562473824,
"ativo": false,
"delivery": false,
"quantidade": 4
}
],
"items": {
"type": "object",
"properties": {
"id_pdv": {
"type": "integer",
"description": "example: 10",
"example": 5
},
"id_produto": {
"type": "integer",
"description": "example: 10",
"example": 7
},
"preco_com_imposto": {
"type": "number",
"description": "example: 10",
"example": 244.082633
},
"preco_sem_imposto": {
"type": "number",
"description": "example: 10",
"example": 16.562473824
},
"ativo": {
"type": "boolean",
"description": "example: true",
"example": false
},
"delivery": {
"type": "boolean",
"description": "example: true",
"example": false
},
"quantidade": {
"type": "integer",
"description": "example: 10",
"example": 4
}
}
}
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "mercado_id",
"description": "The ID of the mercado.",
"example": 1,
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/api/users": {
"get": {
"summary": "Buscar usuários",
"operationId": "buscarUsurios",
"description": "",
"parameters": [
{
"in": "query",
"name": "id",
"description": "The ID of the user to filter users by.",
"example": 1,
"required": false,
"schema": {
"type": "integer",
"description": "The ID of the user to filter users by.",
"example": 1
}
},
{
"in": "query",
"name": "cep",
"description": "O CEP para filtrar usuários por.",
"example": "03982-000",
"required": false,
"schema": {
"type": "string",
"description": "O CEP para filtrar usuários por.",
"example": "03982-000"
}
},
{
"in": "query",
"name": "cpf",
"description": "O CPF para filtrar usuários por.",
"example": "999.999.999-99",
"required": false,
"schema": {
"type": "string",
"description": "O CPF para filtrar usuários por.",
"example": "999.999.999-99"
}
},
{
"in": "query",
"name": "gender",
"description": "O gênero do usuário.",
"example": "M, F, A",
"required": false,
"schema": {
"type": "string",
"description": "O gênero do usuário.",
"example": "M, F, A"
}
},
{
"in": "query",
"name": "registerDate",
"description": "Data de registro do usuário.",
"example": [
"2022-08-15T11:45:38",
"2022-08-15T11:45:38"
],
"required": false,
"schema": {
"type": "array",
"description": "Data de registro do usuário.",
"example": [
"2022-08-15T11:45:38",
"2022-08-15T11:45:38"
],
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "attached_at",
"description": "Data de vinculação do usuário.",
"example": [
"2022-08-15T11:45:38",
"2022-08-15T11:45:38"
],
"required": false,
"schema": {
"type": "array",
"description": "Data de vinculação do usuário.",
"example": [
"2022-08-15T11:45:38",
"2022-08-15T11:45:38"
],
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "birthdate",
"description": "Data de nascimento do usuário.",
"example": [
"2022-08-15T11:45:38",
"2022-08-15T11:45:38"
],
"required": false,
"schema": {
"type": "array",
"description": "Data de nascimento do usuário.",
"example": [
"2022-08-15T11:45:38",
"2022-08-15T11:45:38"
],
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "updated_at",
"description": "Data mínima da última atualização do cadastro no formato ISO 8601.",
"example": "2024-01-02T15:00:00Z",
"required": false,
"schema": {
"type": "string",
"description": "Data mínima da última atualização do cadastro no formato ISO 8601.",
"example": "2024-01-02T15:00:00Z"
}
},
{
"in": "query",
"name": "blacklist",
"description": "O status do usuário.",
"example": true,
"required": false,
"schema": {
"type": "boolean",
"description": "O status do usuário.",
"example": true
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"data": [
{
"name": "string",
"cpf": "string",
"birthdate": "date",
"gender": "string",
"registerDate": "datetime",
"email": "string",
"phone": "string",
"zipcode": "string",
"balance": "float",
"updated_at": "datetime",
"id": "int",
"blacklist": "boolean",
"pdvs": {
"data": [
"array"
]
},
"address": {
"neighborhood": "string",
"state": "string",
"address": "string",
"number": "string",
"complement": "string",
"city": "string"
}
}
],
"links": {
"self": "string",
"first": "string",
"last": "string",
"prev": "nullable_string",
"next": "nullable_string"
},
"meta": {
"current_page": "int",
"from": "int",
"last_page": "int",
"links": [
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
},
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
}
],
"path": "string",
"per_page": "int",
"to": "int",
"total": "int"
}
},
"properties": {
"data": {
"type": "array",
"example": [
{
"name": "string",
"cpf": "string",
"birthdate": "date",
"gender": "string",
"registerDate": "datetime",
"email": "string",
"phone": "string",
"zipcode": "string",
"balance": "float",
"updated_at": "datetime",
"id": "int",
"blacklist": "boolean",
"pdvs": {
"data": [
"array"
]
},
"address": {
"neighborhood": "string",
"state": "string",
"address": "string",
"number": "string",
"complement": "string",
"city": "string"
}
}
],
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "string"
},
"cpf": {
"type": "string",
"example": "string"
},
"birthdate": {
"type": "string",
"example": "date"
},
"gender": {
"type": "string",
"example": "string"
},
"registerDate": {
"type": "string",
"example": "datetime"
},
"email": {
"type": "string",
"example": "string"
},
"phone": {
"type": "string",
"example": "string"
},
"zipcode": {
"type": "string",
"example": "string"
},
"balance": {
"type": "string",
"example": "float"
},
"updated_at": {
"type": "string",
"example": "datetime"
},
"id": {
"type": "string",
"example": "int"
},
"blacklist": {
"type": "string",
"example": "boolean"
},
"pdvs": {
"type": "object",
"properties": {
"data": {
"type": "array",
"example": [
"array"
],
"items": {
"type": "string"
}
}
}
},
"address": {
"type": "object",
"properties": {
"neighborhood": {
"type": "string",
"example": "string"
},
"state": {
"type": "string",
"example": "string"
},
"address": {
"type": "string",
"example": "string"
},
"number": {
"type": "string",
"example": "string"
},
"complement": {
"type": "string",
"example": "string"
},
"city": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"example": "string"
},
"first": {
"type": "string",
"example": "string"
},
"last": {
"type": "string",
"example": "string"
},
"prev": {
"type": "string",
"example": "nullable_string"
},
"next": {
"type": "string",
"example": "nullable_string"
}
}
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "string",
"example": "int"
},
"from": {
"type": "string",
"example": "int"
},
"last_page": {
"type": "string",
"example": "int"
},
"links": {
"type": "array",
"example": [
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
},
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
}
],
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "nullable_string"
},
"label": {
"type": "string",
"example": "string"
},
"active": {
"type": "string",
"example": "boolean"
}
}
}
},
"path": {
"type": "string",
"example": "string"
},
"per_page": {
"type": "string",
"example": "int"
},
"to": {
"type": "string",
"example": "int"
},
"total": {
"type": "string",
"example": "int"
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string"
},
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "string",
"errors": {
"field": "string"
}
},
"properties": {
"message": {
"type": "string",
"example": "string"
},
"errors": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "string"
}
}
}
}
}
}
}
}
},
"tags": [
"Usuários"
]
}
},
"/api/v1/cs/active-clients": {
"get": {
"summary": "CS — Base de clientes ativos (snapshot diário)",
"operationId": "csActiveClients",
"description": "Retorna a base ativa aninhada (Rede Master → Redes → Mercados → agregados de PDV) servida a partir do snapshot diário (cs:build-snapshot). Auth: Bearer token dedicado (cs.token) via AWS Secrets Manager. Premissa em revisão: \"parceiro de porta\" = automações de acesso + dispositivos de porta.",
"security": [
{
"csToken": []
}
],
"tags": [
"CS"
],
"parameters": [
{
"in": "query",
"name": "created_from",
"required": false,
"description": "Filtra redes master com created_at >= esta data (YYYY-MM-DD).",
"schema": {
"type": "string",
"format": "date",
"example": "2026-01-01"
}
},
{
"in": "query",
"name": "created_to",
"required": false,
"description": "Filtra redes master com created_at <= esta data (YYYY-MM-DD).",
"schema": {
"type": "string",
"format": "date",
"example": "2026-06-16"
}
},
{
"in": "query",
"name": "per_page",
"required": false,
"description": "Número de redes master por página. Omitir retorna todas.",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 500
}
}
],
"responses": {
"200": {
"description": "Snapshot da base ativa",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
}
}
},
"401": {
"description": "Token ausente ou inválido"
},
"422": {
"description": "Parâmetros de data inválidos"
}
}
}
},
"/api/v1/webhooks/partner-access": {
"post": {
"summary": "Receber evento de abertura de porta",
"operationId": "receberEventoAberturaPorta",
"description": "Webhook para o parceiro notificar um evento de abertura de porta (acesso).\nO horário do acesso registrado é o valor de `timestamp` enviado no payload, não o horário de chegada na Beepay.\nO endpoint é idempotente por `event_id`: reenviar um `event_id` já processado retorna 200 com o mesmo `id`.",
"parameters": [],
"security": [
{
"partnerToken": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"event_id",
"device_id",
"user_id",
"timestamp"
],
"properties": {
"event_id": {
"type": "string",
"format": "uuid",
"description": "Identificador único do evento (UUID v4). Usado para idempotência.",
"example": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"
},
"device_id": {
"type": "string",
"description": "Código do dispositivo (dispositivos.codigo) que registrou o acesso.",
"example": "DEV-001"
},
"user_id": {
"type": "integer",
"description": "ID do usuário que realizou o acesso.",
"example": 12345
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Data/hora em que o acesso ocorreu. Não pode ser uma data futura.",
"example": "2026-06-17T18:23:24-03:00"
}
}
}
}
}
},
"responses": {
"201": {
"description": "Acesso registrado",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 987
}
}
}
}
}
},
"200": {
"description": "Evento já processado (idempotência) — retorna o log existente",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 987
}
}
}
}
}
},
"401": {
"description": "Unauthorized — token de parceiro ausente ou inválido",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"422": {
"description": "Unprocessable Entity — falha de validação ou dispositivo não pertence ao mercado autenticado",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "string"
},
"errors": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "string"
}
}
}
}
}
}
}
}
},
"tags": [
"Webhooks"
]
}
}
},
"tags": [
{
"name": "Acessos",
"description": "Esse endpoint permite que você busque acessos por vários parâmetros."
},
{
"name": "Blocklist",
"description": "Esse endpoint permite que você busque usuários na Blocklist"
},
{
"name": "Grupos",
"description": "Cria um grupo"
},
{
"name": "Pedidos",
"description": "This endpoint allows you to get all orders, filtered by various parameters."
},
{
"name": "Produtos",
"description": "Esse endpoint permite que você busque preços por PDV."
},
{
"name": "Usuários",
"description": "Esse endpoint permite que você busque usuários por vários parâmetros."
},
{
"name": "Webhooks",
"description": "Webhooks recebidos de parceiros integrados."
}
],
"components": {
"securitySchemes": {
"default": {
"type": "http",
"scheme": "bearer",
"description": "You can retrieve your token by visiting your dashboard and clicking API."
},
"csToken": {
"type": "http",
"scheme": "bearer",
"description": "Shared secret fornecido ao time de CS (config services.cs.token). Rotação via AWS Secrets Manager."
},
"partnerToken": {
"type": "apiKey",
"in": "header",
"name": "X-Partner-Token",
"description": "Token de parceiro. Envie no header X-Partner-Token ou como Authorization: Bearer ."
}
}
},
"security": [
{
"default": []
}
]
}