# Connect Plug API ## 📋 Changelog [Changelog](https://www.notion.so/deliverydireto/Changelog-da-API-V3-aa2bc3880bb0483aae7bbc3a40159b67) ## 🚀 Introdução A API da ConnectPlug permite que parceiros utilizem diversos recursos da plataforma como gerenciar suas lojas e seus pedidos. A ConnectPlug oferece soluções para a operação e gestão das suas vendas e permite integrar seu PDV/POS ou qualquer outro aplicativo. ### 🗂️ Organização da Documentação Esta documentação está organizada em categorias para facilitar a navegação: - **🔐 Autenticação**: Endpoints para obter tokens de acesso - **📦 Catálogo de Produtos**: Gerenciamento de produtos, categorias e unidades - **📦 Produtos - Funcionalidades Descontinuadas**: ⚠️ Endpoints que serão removidos em breve - **📱 Aplicativos**: Gerenciamento de aplicativos e disponibilidade de produtos - **💰 Financeiro**: Pagamentos, contas bancárias e transações - **🛒 Vendas**: Pedidos, vendas e promoções - **📦 Estoques**: Gerenciamento de estoque e compras - **🏢 Empresa**: Configurações da empresa e periféricos - **📊 Relatórios**: Relatórios de vendas e estatísticas ### 🏗️ Arquitetura da API A API está organizada utilizando os padrões [REST](https://en.wikipedia.org/wiki/REST). Os recursos são orientados pelas URLs, aceitamos corpo de requisições (*Body Requests*) no formato [JSON](https://www.json.org/json-en.html). As respostas também utilizam o formato JSON. Sendo assim, todas as *requests* devem conter os *Headers* ``` Content-Type: application/json Accept: application/json ``` Além disso, utilizamos os padrões HTTP: *response codes*, verbos HTTP e autenticação. # 📚 Conhecimento Geral ## 🔐 Autenticação A API utiliza Oauth2 com o fluxo `password` (Grant Type Password). Todos os *endpoints* devem conter o Token de acesso no *Header* `Authorization`, exceto os endpoints `/oauth/token` e `oauth/scopes` que são utilizados para gerar os Tokens de Acesso (*Access Token*). Para obter o `access_token`, você irá precisar das seguintes informações: - `CLIENT_ID` e `CLIENT_SECRET` do seu aplicativo. - `email` e `password` do usuário com acesso à API. Exemplo de chamada para gerar o *Access Token* utilizando cURL: ``` curl --location --request POST 'http://connectplug.com.br/oauth/token' \ --header 'Content-Type: application/json' \ --data-raw '{ "grant_type": "password", "client_id": "", "client_secret": "", "username": "", "password": "", "scope": "*" }' ``` Exemplo de chamada para renovação do *Access Token* via *Refresh Token* utilizando cURL: ``` curl --location --request POST 'http://connectplug.com.br/oauth/token' \ --header 'Content-Type: application/json' \ --data-raw '{ "grant_type": "refresh_token", "client_id": "", "client_secret": "", "refresh_token": "", "scope": "*" }' ``` Exemplo do uso do *Access Token* nas chamadas à API: ``` curl --location --request POST 'http://connectplug.com.br/api/v3/categories' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ' ``` ## 🔄 Verbos HTTP Para cada *endpoint*, detalharemos as especificações dos parâmetros da requisição e do retorno, além dos métodos de requisição disponíveis (`GET`, `PUT`, `POST` e/ou `DELETE`). Parâmetros que exigem explicações mais detalhadas serão destacados após as informações de requisição e retorno de cada *endpoint*. ## 🔢 HTTP Status | Código | Nome | Descrição | |--------|------|-----------| | 200 | OK | O recurso solicitado foi processado e retornado com sucesso. | | 201 | Created | O recurso informado foi criado com sucesso. | | 401 | Unauthorized | A chave da API está desativada, incorreta ou não foi informada corretamente. Consulte a seção sobre autenticação da documentação. | | 403 | Forbidden | O acesso ao recurso não foi autorizado. Isso pode acontecer quando a loja não tem permissão para acessar o recurso | | 404 | Not Found | O recurso solicitado ou o endpoint não foi encontrado. | | 422 | Unprocessable Entity | A requisição foi recebida com sucesso, porém contém parâmetros inválidos. | | 429 | Too Many Requests | O limite de requisições (Rate Limit) foi atingido. | | 400 | Bad Request | Não foi possível interpretar a requisição. Verifique as informações enviadas. | | 500 | Internal Server Error | Ocorreu uma falha na plataforma. Por favor, entre em contato com o suporte. | ## ⚠️ Códigos de Erro | Código | Descrição | |--------|-----------| | bad_request | É retornado quando o servidor não consegue entender ou processar a solicitação, pois a solicitação está malformada, incompleta ou contém parâmetros inválidos. | | not_found | É retornado quando o recurso solicitado não pode ser encontrado no servidor. | | method_not_allowed | É retornado quando o método HTTP não é permitido para o recurso solicitado. | | unprocessable_entity | É retornado quando houver erros de validação com os dados enviados. | | too_many_requests | É retornado quando houver um número excessivo de requisições à API. Verifique a sessão de Rate Limit. | | internal_server_error | É retornado quando houver uma falha na plataforma. Por favor, entre em contato com o suporte. | | missing_headers | É retornado quando um *header* obrigatório não estiver presente na requisição. | | max_upload_size_exceeded | Ocorre um retorno quando a imagem excede o limite de tamanho estabelecido. | | unauthorized | É retornado quando a autenticação foi expirada. | | invalid_scope | O retorno é gerado quando o escopo especificado na autenticação é inválido ou inexistente. | | forbidden | O retorno ocorre quando se tenta realizar uma ação para a qual não se possui permissão. | | uneditable_entity | Isso ocorre quando há uma tentativa de edição de um recurso que não é suscetível a modificações. | | undeleted_resource_association | Isso ocorre quando há a tentativa de excluir um recurso, contudo, tal exclusão é inviável devido à sua associação com outro recurso. | | product_combo_empty_components | Produtos do tipo "Combo" devem ter pelo menos um componente. | | product_combo_attributes_not_allowed | Produtos do tipo "Combo" não podem ter atributos. | | product_combo_component_combo_not_allowed | Produtos do tipo "Combo" não podem ter componentes do tipo "Combo". | | product_combo_invalid_price | O valor do preço passado no produto do tipo "Combo" não é compatível com o calculo do preço dos componentes. | | product_with_grid_cannot_have_components | Produtos com grade de preços não podem ter componentes. | | option_cannot_be_associated_with_grid | Acontece quando uma opção de um atributo não pode ser associado em uma grade de preço. | | grid_with_options_not_exclusive_by_attribute_group | Uma grade de preços de um produto não pode ter duas ou mais opções do mesmo grupo de atributos. | | grid_with_duplicate_set_of_options | Uma grade de preço de um produto não pode ter opções de atributos duplicados. | ## ⏱️ Rate Limit O Rate limit atual da API é de 60 requisições por minuto. ## 🔁 Chaves de Idempotência A API utiliza idempotência nos endpoints que ocorrem operações de criação e atualização. O `Idempotency-Key` é um ID aleatório gerado por você e deve ser passado no *header* `Idempotency-Key` das solicitações `POST` e `PUT`. Nós utilizamos esse *header* para evitar duplicidade de registros, ou seja, caso você não tenha recebido a resposta de alguma requisição e mandar o mesmo `Idempotency-Key`, nós não duplicaremos o registro. Assim, se repetir ou houver duplicidade acidental da mesma *request*, não corre o risco de criar um segundo objeto ou efetuar a atualização duas vezes. A idempotência funciona salvando o código de status resultante e o corpo da primeira solicitação feita para qualquer chave de idempotência, independentemente de ser bem-sucedida ou não. Os pedidos subsequentes com a mesma chave retornam o mesmo resultado, incluindo erros 500. No *response* dos métodos `POST` e `PUT` é retornado dois *headers* adicionais: - `Idempotency-Key`: que deve conter o identificador da *request* que você enviou. - `Idempotency-Replayed`: que indica se a *request* é um *replay* de uma chamada anterior ou não. Não é exigido um formato específico para o `Idempotency-Key`, porém sugerimos que utilize UUID ou alguma outra forma de geração de IDs aleatórios com entropia suficiente para evitar colisões. As chaves de idempotência têm um comprimento máximo de 100 caracteres. ## 📝 Formato dos Dados Visando facilitar a compreensão das nossas APIs para o maior número de desenvolvedores parceiros, alguns retornos tiveram seus formatos normalizados. A seguir, especificamos alguns dos formatos mais relevantes dos retornos da nossa API: ### 📅 Datas e horários Nossos campos que representam datas os horários são retornados no fuso horário da loja e são representadas em **UTC** utilizando o padrão [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). A informação de qual ***Timezone*** é utilizada na loja vem no próprio valor retornado. Para os métodos em que é necessário passar uma data e horário no parâmetro, basta enviar as informações do horário local com a informação que determina o fuso horário em UTC. ```text title='Formato datetime no padrão ISO 8601' YYYY-MM-DDThh:mm:ss+hh:mm ``` Onde: * `YYYY` representa os 4 dígitos do ano. * `MM` representa os 2 dígitos do mês. * `DD` representa os 2 dígitos do dia do mês. * `hh` representa os 2 dígitos da hora. * `mm` representa os 2 dígitos do minuto. * `ss` representa os 2 dígitos do segundo. * `+hh:mm` representa o timezone, que pode ser positivo ou negativo. Por exemplo: o *timezone* `America/Sao_Paulo` é representado por `-03:00`. ```text title='Exemplo de datetime no padrão ISO 8601' 2020-01-01T09:00:00-03:00 ``` ### 📅 Dias da semana Para campos que representam dias de semana, são numeramos de `1` à `7`, onde: * O dia `1` representa o domingo, e * o dia `7` representa o sábado. ## 📄 Paginação das respostas da API Alguns de nossos *endpoints* possuem **paginação**. Implementamos paginação para *endpoints* que tem o potencial de retornar um grande número de resultados. Neste caso, temos o parâmetro `page` para operar a paginação via *query string*. No retorno de *endpoints* com paginação enviamos o objeto `meta`, para consulta e referência do desenvolvedor parceiro. Todos os nossos *endpoints* com paginação seguem um formato específico. Retornamos os resultados no formato JSON, com os seguintes campos sempre presentes: * `data`: Campo utilizado para envolver a resposta da requisição. * `meta`: Campo utilizado para referência da paginação, para os *endpoints* que se utilizam de paginação. * `meta.current_page`: Campo utilizado para referência da paginação, para os *endpoints* que se utilizam de paginação. * `meta.last_page`: Campo que identifica a quantidade de páginas. * `meta.per_page`: Campo que identifica a quantidade por páginas. * `meta.total`: Campo que identifica a quantidade total de objetos. ```json title='Exemplo de resposta com paginação' { "data": { ... }, "meta": { "current_page": 1, "last_page": 2, "per_page": 15, "total": 17 } } ``` ## 📊 Tabela de Unidades de medida A tabela de Unidades de Medida armazena informações sobre diferentes unidades de medida e suas descrições. Essa tabela é usada para garantir a padronização das unidades de medida em diversos contextos. | Código | Descrição | |--------|-----------| | AMPOLA | AMPOLA | | BALDE | BALDE | | BANDEJ | BANDEJA | | BARRA | BARRA | | BISNAG | BISNAGA | | BLOCO | BLOCO | | BOBINA | BOBINA | | BOMB | BOMBONA | | CAPS | CAPSULA | | CART | CARTELA | | CENTO | CENTO | | CJ | CONJUNTO | | CM | CENTIMETRO | | CM2 | CENTIMETRO QUADRADO | | CX | CAIXA | | CX2 | CAIXA COM 2 UNIDADES | | CX3 | CAIXA COM 3 UNIDADES | | CX5 | CAIXA COM 5 UNIDADES | | CX10 | CAIXA COM 10 UNIDADES | | CX15 | CAIXA COM 15 UNIDADES | | CX20 | CAIXA COM 20 UNIDADES | | CX25 | CAIXA COM 25 UNIDADES | | CX50 | CAIXA COM 50 UNIDADES | | CX100 | CAIXA COM 100 UNIDADES | | DISP | DISPLAY | | DUZIA | DUZIA | | EMBAL | EMBALAGEM | | FARDO | FARDO | | FOLHA | FOLHA | | FRASCO | FRASCO | | GALAO | GALÃO | | GF | GARRAFA | | GRAMAS | GRAMAS | | JOGO | JOGO | | KG | QUILOGRAMA | | KIT | KIT | | LATA | LATA | | LITRO | LITRO | | M | METRO | | M2 | METRO QUADRADO | | M3 | METRO CÚBICO | | MILHEI | MILHEIRO | | ML | MILILITRO | | MWH | MEGAWATT HORA | | PACOTE | PACOTE | | PALETE | PALETE | | PARES | PARES | | PC | PEÇA | | POTE | POTE | | K | QUILATE | | RESMA | RESMA | | ROLO | ROLO | | SACO | SACO | | SACOLA | SACOLA | | TAMBOR | TAMBOR | | TANQUE | TANQUE | | TON | TONELADA | | TUBO | TUBO | | UNID | UNIDADE | | VASIL | VASILHAME | | VIDRO | VIDRO | ## Tabela de tipos de código de barras ### Tipos de código de barras 1D: | Código | Descrição | |--------|-----------| | C39 | C39 | | C39_PLUS | C39+ | | C39E | C39E | | C39E_PLUS | C39E+ | | C93 | C93 | | S25 | S25 | | S25_PLUS | S25+ | | I25 | I25 | | I25_PLUS | I25+ | | C128 | C128 | | C128_A | C128A | | C128_B | C128B | | C128_C | C128C | | EAN2 | EAN2 | | EAN5 | EAN5 | | EAN8 | EAN8 | | EAN13 | EAN13 | | UPCA | UPCA | | UPCE | UPCE | | MSI | MSI | | MSI_PLUS | MSI+ | | POSTNET | POSTNET | | PLANET | PLANET | | RMS4CC | RMS4CC | | KIX | KIX | | IMB | IMB | | CODABAR | CODABAR | | CODE11 | CODE11 | | PHARMA | PHARMA | | PHARMA2T | PHARMA2T | ### Tipos de código 2D: | Código | Descrição | |--------|-----------| | QRCODE | QRCODE | | PDF417 | PDF417 | | DATAMATRIX | DATAMATRIX | Version: 3.0.0 License: SAAS ## Servers Dev ``` http://connectplug.com.br ``` ## Security ### OAuth2 Type: oauth2 Token URL: http://connectplug.com.br/oauth/token Scopes: - `*`: Full Access - `accountPlans:*`: All Access Account Plans - `accountPlans:read`: Can Read Account Plans - `accountPlans:write`: Can Write/Update Account Plans - `accountPlans:delete`: Can Delete Account Plans - `accountTransactions:*`: All Access Account Transactions - `accountTransactions:read`: Can Read Account Transactions - `accountTransactions:write`: Can Write/Update Account Transactions - `accountTransactions:delete`: Can Delete Account Transactions - `apps:*`: All Access Apps - `apps:read`: Can Read Apps - `apps:write`: Can Write/Update Apps - `apps:write.image`: Can Update App Image - `apps:delete`: Can Delete Apps - `customizations:*`: All Access Customizations - `customizations:read`: Can Read Customizations - `customizations:write`: Can Write/Update Customizations - `customizations:delete`: Can Delete Customizations - `dre:*`: All Access Demonstrativo de Resultado do Exercício (DRE) - `dre:read`: Can Read Demonstrativo de Resultado do Exercício (DRE) - `suppliers:*`: All Access Suppliers - `suppliers:read`: Can read Suppliers - `suppliers:write`: Can Write/Update Suppliers - `suppliers:delete`: Can Delete Suppliers - `bankaccounts:*`: All Access Bank Account - `bankaccounts:read`: Can Read Bank Account - `bankaccounts:write`: Can Write/Update Bank Account - `bankaccounts:delete`: Can Delete Bank Account - `banks:*`: All Access Banks - `banks:read`: Can Read Banks - `banks:write`: Can Write/Update Banks - `banks:delete`: Can Delete Banks - `cards:*`: All Access Cards - `cards:read`: Can Read Cards - `cards:write`: Can Write/Update Cards - `cards:delete`: Can Delete Cards - `cardContracts:*`: All Access Card Contracts - `cardContracts:read`: Can Read Card Contracts - `cardContracts:write`: Can Write/Update Card Contracts - `cardContracts:delete`: Can Delete Card Contracts - `cardProviders:*`: All Access Card Providers - `cardProviders:read`: Can Read Card Providers - `categories:*`: All Access Category - `categories:read`: Can Read Category - `categories:write`: Can Write/Update Category - `categories:delete`: Can Delete Category - `cities:*`: All Access Cities - `cities:read`: Can Read Cities - `commandSeries:*`: All Access Command Series - `commandSeries:read`: Can Read Command Series - `commandSeries:write`: Can Write/Update Command Series - `commandSeries:delete`: Can Delete Command Series - `companies:*`: All Access Companies - `companies:read`: Can Read Companies - `companies:write`: Can Write/Update Companies - `companies:delete`: Can Delete Companies - `customerCategory:*`: All Access Customer Category - `customerCategory:read`: Can Read Customer Category - `customerCategory:write`: Can Write/Update Customer Category - `customerCategory:delete`: Can Delete Customer Category - `customers:*`: All Access Customers - `customers:read`: Can Read Customers - `customers:write`: Can Write/Update Customers - `customers:delete`: Can Delete Customers - `delivery-areas:*`: All Access Delivery Areas - `delivery-areas:read`: Can Read Delivery Areas - `delivery-areas:write`: Can Write/Update Delivery Areas - `delivery-areas:delete`: Can Delete Delivery Areas - `nfe:*`: All Access NFE - `nfe:read`: Can Read NFE - `nfeEmittedDocuments:*`: All Access NFE Emitted Documents - `nfeEmittedDocuments:read`: Can Read NFE Emitted Documents - `nfeEmittedDocuments:write`: Can Write/Update NFE Emitted Documents - `nfeEmittedDocuments:delete`: Can Delete NFE Emitted Documents - `nfeReceivedDocuments:*`: All Access Received Documents - `nfeReceivedDocuments:read`: Can Read Received Documents - `nfeReceivedDocuments:write`: Can Write/Update Received Documents - `digitalAccount:*`: All Access Digital Account - `digitalAccount:read`: Can Read Digital Account - `digitalAccount:write`: Can Write/Update Digital Account - `digitalAccount:delete`: Can Delete Digital Account - `filters:*`: All Access Filters - `filters:read`: Can Read Filters - `filters:write`: Can Write/Update Filters - `filters:delete`: Can Delete Filters - `grupoIcms:*`: All Access Grupo ICMS - `grupoIcms:read`: Can Read Grupo ICMS - `grupoIcms:write`: Can Write/Update Grupo ICMS - `grupoIcms:delete`: Can Delete Grupo ICMS - `grupoIpi:*`: All Access Grupo IPI - `grupoIpi:read`: Can Read Grupo IPI - `grupoIpi:write`: Can Write/Update Grupo IPI - `grupoIpi:delete`: Can Delete Grupo IPI - `grupoPisCofins:*`: All Access Grupo Pis/Cofins - `grupoPisCofins:read`: Can Read Grupo Pis/Cofins - `grupoPisCofins:write`: Can Write/Update Grupo Pis/Cofins - `grupoPisCofins:delete`: Can Delete Grupo Pis/Cofins - `icons:*`: All Access Icons - `icons:read`: Can Read Icons - `integrations:*`: All Access Integrations - `integrations:read`: Can Read Integrations - `integrations:write`: Can Write/Update Integrations - `integrations:delete`: Can Delete Integrations - `kds:*`: All Access KDS - `kds:read`: Can Read KDS - `kds:write`: Can Write/Update KDS - `kds:delete`: Can Delete KDS - `labels:*`: All Access Labels - `labels:read`: Can Read Labels - `labels:write`: Can Write/Update Labels - `labels:delete`: Can Delete Labels - `legalTerms:*`: All Access Legal Terms - `legalTerms:read`: Can Read Legal Terms - `legalTerms:write`: Can Write/Update Legal Terms - `legalTerms:delete`: Can Delete Legal Terms - `erpSettings:*`: All Access Erp Settings - `erpSettings:read`: Can Read Erp Settings - `erpSettings:write`: Can Write/Update Erp Settings - `erpSettings:delete`: Can Delete Erp Settings - `taxSettings:*`: All Access Tax Settings - `taxSettings:read`: Can Read Tax Settings - `taxSettings:write`: Can Write/Update Tax Settings - `taxSettings:delete`: Can Delete Tax Settings - `passwordPanel:*`: All Access Password Panel - `passwordPanel:read`: Can Read Password Panel - `passwordPanel:write`: Can Write/Update Password Panel - `passwordPanel:delete`: Can Delete Password Panel - `payments:*`: All Access Payments - `payments:read`: Can Read Payments - `payments:write`: Can Write/Update Payments - `payments:delete`: Can Delete Payments - `peripherals:*`: All Access Peripherals - `peripherals:read`: Can Read Peripherals - `peripherals:write`: Can Write/Update Peripherals - `peripherals:delete`: Can Delete Peripherals - `pos:*`: All Access Pos - `pos:read`: Can Read Pos - `pos:write`: Can Write/Update Pos - `pos:delete`: Can Delete Pos - `priceList:*`: All Access Price List - `priceList:read`: Can Read Price List - `priceList:write`: Can Write/Update Price List - `priceList:delete`: Can Delete Price List - `products:*`: All Access Products - `products:read`: Can Read Products - `products:write`: Can Write/Update Products - `products:write.image`: Can Update Product Image - `products:delete`: Can Delete Products - `productionOrders:*`: All Access Production Orders - `productionOrders:read`: Can Read Production Orders - `productionOrders:write`: Can Write/Update Production Orders - `productionOrders:delete`: Can Delete Production Orders - `promotions:*`: All Access Promotions - `promotions:read`: Can Read Promotions - `promotions:write`: Can Write/Update Promotions - `promotions:delete`: Can Delete Promotions - `purchase:*`: All Access Purchase - `purchase:read`: Can Read Purchase - `purchase:write`: Can Write/Update Purchase - `purchase:delete`: Can Delete Purchase - `purchaseInvoices:*`: All Access Purchase Invoices - `purchaseInvoices:read`: Can Read Purchase Invoices - `purchaseInvoices:write`: Can Write/Update Purchase Invoices - `purchaseInvoices:delete`: Can Delete Purchase Invoices - `reconciliations:*`: All Access Reconciliations - `reconciliations:read`: Can Read Reconciliations - `reconciliations:write`: Can Write/Update Reconciliations - `reconciliations:delete`: Can Delete Reconciliations - `saleorders:*`: All Access Sale Orders - `saleorders:read`: Can Read Sale Orders - `saleorders:write`: Can Write/Update Sale Orders - `saleorders:delete`: Can Delete Sale Orders - `sales:*`: All Access Sale - `sales:read`: Can Read Sale - `sales:write`: Can Write/Update Sale - `sales:delete`: Can Delete Sale - `statistics:*`: All Access Statistics - `statistics:read`: Can Read Statistics - `stockMovementCategories:*`: All Access stock Movement Categories - `stockMovementCategories:read`: Can Read stock Movement Categories - `stockMovementCategories:write`: Can Write/Update stock Movement Categories - `stockMovementCategories:delete`: Can Delete stock Movement Categories - `stocks:*`: All Access Stocks - `stocks:read`: Can Read Stocks - `stocks:write`: Can Write/Update Stocks - `stocks:delete`: Can Delete Stocks - `sources:*`: All Access Sources - `sources:read`: Can Read Sources - `sources:write`: Can Write/Update Sources - `sources:delete`: Can Delete Sources - `status:*`: All Access Status - `status:read`: Can Read Status - `status:write`: Can Write/Update Status - `status:delete`: Can Delete Status - `standardObservations:*`: All Access Standard Observations - `standardObservations:read`: Can Read Standard Observations - `standardObservations:write`: Can Write/Update Standard Observations - `standardObservations:delete`: Can Delete Standard Observations - `states:*`: All Access States - `states:read`: Can Read States - `tables:*`: All Access Tables - `tables:read`: Can Read Tables - `tables:write`: Can Write/Update Tables - `tables:delete`: Can Delete Tables - `terminalSettings:*`: All Access Terminal Settings - `terminalSettings:read`: Can Read Terminal Settings - `terminalSettings:write`: Can Write/Update Terminal Settings - `totemSettings:*`: All Access Totem Settings - `totemSettings:read`: Can Read Totem Settings - `totemSettings:write`: Can Write/Update Totem Settings - `units:*`: All Access Units - `units:read`: Can Read Units - `units:write`: Can Write/Update Units - `units:delete`: Can Delete Units - `users:*`: All Access Users - `users:read`: Can Read Users - `users:write`: Can Write/Update Users - `users:delete`: Can Delete Users - `whitelabel:*`: All Access Whitelabel Settings - `whitelabel:read`: Can Read Whitelabel Settings - `whitelabel:write`: Can Write/Update Whitelabel Settings - `whitelabel:delete`: Can Delete Whitelabel Settings ## Download OpenAPI description [Connect Plug API](https://cplug.redocly.app/_bundle/openapi.yaml) ## Oauth2 Operações para autenticar um usuário. ### Solicita Access Token - [POST /oauth/token](https://cplug.redocly.app/openapi/authentication/post-oauth-token.md): Solicita Access Token. ### Revogar Access Token - [DELETE /oauth/token](https://cplug.redocly.app/openapi/authentication/delete-oauth-token.md): Revogar Access Token. Invalida o Token de Acesso que for utilizado no Authorization: Bearer da requisição. ### Lista de escopos - [GET /api/v3/oauth/scopes](https://cplug.redocly.app/openapi/authentication/get-oauth-scopes.md): Retorna lista de escopos de autenticação disponíveis. ### Login legado - [POST /api/v3/legacy/login](https://cplug.redocly.app/openapi/authentication/post-legacy-login.md): Endpoint que faz login no sistema legado e redireciona de modo automático para o site da CPlug. ## Categorias Operações de categoria de produtos. ### Lista de categorias - [GET /api/v3/categories](https://cplug.redocly.app/openapi/categories/get-categories.md): Retorna lista de categorias de produtos disponíveis. ### Cria nova categoria - [POST /api/v3/categories](https://cplug.redocly.app/openapi/categories/post-categories.md): Cria nova categoria de produtos. ### Obtém uma categoria - [GET /api/v3/categories/{categoryId}](https://cplug.redocly.app/openapi/categories/get-categories-id.md): Obtém informações sobre uma categoria. ### Atualiza uma categoria - [PUT /api/v3/categories/{categoryId}](https://cplug.redocly.app/openapi/categories/put-categories.md): Atualiza uma categoria de produtos já existente. ### Apaga uma categoria - [DELETE /api/v3/categories/{categoryId}](https://cplug.redocly.app/openapi/categories/delete-categories.md): Apaga uma categoria de produtos. ### Reordena as categorias - [PUT /api/v3/categories/reorder](https://cplug.redocly.app/openapi/categories/reorder-categories.md): Reordena a lista de categorias de produtos. ## Listas de Preço Operações da lista de preço. ### Lista de Listas de preços - [GET /api/v3/price-lists](https://cplug.redocly.app/openapi/pricelists/get-price-lists.md): Retorna uma lista de Listas de Preços. ### Cria uma nova lista de preço - [POST /api/v3/price-lists](https://cplug.redocly.app/openapi/pricelists/post-price-list.md): Cria uma nova lista de preço. ### Obtém uma lista de preço - [GET /api/v3/price-lists/{priceListId}](https://cplug.redocly.app/openapi/pricelists/get-price-list-by-id.md): Resgata uma lista de preço. ### Atualiza uma lista de preço - [PUT /api/v3/price-lists/{priceListId}](https://cplug.redocly.app/openapi/pricelists/put-price-list.md): Atualiza uma lista de preço. ### Apaga uma lista de preço - [DELETE /api/v3/price-lists/{priceListId}](https://cplug.redocly.app/openapi/pricelists/delete-price-list.md): Apaga uma lista de preço. ### Duplica uma lista de preços - [POST /api/v3/price-lists/{priceListId}/duplicate](https://cplug.redocly.app/openapi/pricelists/post-price-list-duplicate.md): Duplica uma lista de preços e seus produtos. ### Atualiza a ordem das listas de preços - [POST /api/v3/price-lists/update-order](https://cplug.redocly.app/openapi/pricelists/post-price-list-update-order.md): Atualiza a ordem das listas de preços. ### Histórico de modificações de uma lista de preço - [GET /api/v3/price-lists/{priceListId}/logs](https://cplug.redocly.app/openapi/pricelists/get-price-list-logs.md): Histórico de modificações de uma lista de preço. ## ↳ Produtos de uma lista de preço Operações de produtos em uma lista de preço ### Obtém a lista de produtos - [GET /api/v3/price-lists/{priceListId}/items](https://cplug.redocly.app/openapi/pricelistproducts/get-price-list-products.md): Resgata uma lista produtos de uma lista de preço. ### Cria ou atualiza produtos - [PATCH /api/v3/price-lists/{priceListId}/items](https://cplug.redocly.app/openapi/pricelistproducts/patch-price-list-products.md): Cria ou atualiza uma lista de produtos na lista de preço. ### Apaga produtos em massa - [POST /api/v3/price-lists/{priceListId}/items](https://cplug.redocly.app/openapi/pricelistproducts/post-price-list-products-delete.md): Apaga uma lista de produtos na lista de preço. ### Atualiza os preços dos produtos em massa - [PUT /api/v3/price-lists/{priceListId}/items/update-prices](https://cplug.redocly.app/openapi/pricelistproducts/put-price-list-products-price-batch.md): Atualiza os preços dos produtos de uma lista em massa. ### Obtém uma lista produtos em CSV - [GET /api/v3/price-lists/{priceListId}/items/export](https://cplug.redocly.app/openapi/pricelistproducts/get-export-price-list-products.md): Resgata uma lista produtos de uma lista de preço em CSV. ### Obtém as opções de um produto - [GET /api/v3/price-lists/{priceListId}/items/{productId}/options](https://cplug.redocly.app/openapi/pricelistproducts/get-price-list-product-options.md): Resgata uma lista de opções de um produto de uma lista de preço. ### Cria ou atualiza uma opção de um produto - [POST /api/v3/price-lists/{priceListId}/items/{productId}/options](https://cplug.redocly.app/openapi/pricelistproducts/post-price-list-product-options.md): Cria ou atualiza uma opção de um produto de uma lista de preço. ### Lista as grades de preço de um produto - [GET /api/v3/price-lists/{priceListId}/items/{productId}/grids](https://cplug.redocly.app/openapi/pricelistproducts/get-price-list-product-grids.md): Resgata uma lista de grades de preço de um produto de uma lista de preço. ### Cria ou atualiza uma grade de preço de um produto - [POST /api/v3/price-lists/{priceListId}/items/{productId}/grids](https://cplug.redocly.app/openapi/pricelistproducts/post-price-list-product-grids.md): Cria ou atualiza uma grade de um produto de uma lista de preço. ### Obtém histórico de modificações do preço de um produto - [GET /api/v3/price-lists/{priceListId}/items/{productId}/logs](https://cplug.redocly.app/openapi/pricelistproducts/get-price-list-product-logs.md): Histórico de modificações do preço de um produto em uma determinada lista de preço. ## Atributos Operações do cadastro de atributos de produto. ### Lista de atributos - [GET /api/v3/attributes](https://cplug.redocly.app/openapi/attributes/get-attributes.md): Retorna a lista dos atributos de produto cadastrados. Os dados de atributos são compartilhados com todas as lojas da rede. ### Cria novo atributo - [POST /api/v3/attributes](https://cplug.redocly.app/openapi/attributes/post-attributes.md): Cria um novo atributo de produto. ### Obtém um atributo - [GET /api/v3/attributes/{attributeId}](https://cplug.redocly.app/openapi/attributes/get-attributes-id.md): Obtém informações sobre de atributo. ### Atualiza um atributo - [PUT /api/v3/attributes/{attributeId}](https://cplug.redocly.app/openapi/attributes/put-attributes.md): Atualiza os dados de um atributo. Atenção: No parâmetro options, se não for passado o id da Opção para atualização, será criada uma nova Opção. Para atualização de dados você deve passar o id da Opção no corpo da requisição. ### Apaga um atributo - [DELETE /api/v3/attributes/{attributeId}](https://cplug.redocly.app/openapi/attributes/delete-attributes.md): Apaga um atributo. ### Duplica um atributo - [POST /api/v3/attributes/{attributeId}/duplicate](https://cplug.redocly.app/openapi/attributes/post-attributes-duplicate.md): Duplica um atributo de produto. ### Apaga atributos em massa - [DELETE /api/v3/attributes/batch-delete](https://cplug.redocly.app/openapi/attributes/delete-batch-attributes.md): Apaga atributos em massa. ## ↳ Opções de um atributo Operações do cadastro de opções de um atributo. ### Lista opções - [GET /api/v3/attributes/{attributeId}/options](https://cplug.redocly.app/openapi/attributeoptions/get-attributes-options.md): Retorna a lista das opções cadastradas para um atributo. ### Cria uma nova opção - [POST /api/v3/attributes/{attributeId}/options](https://cplug.redocly.app/openapi/attributeoptions/post-attributes-options.md): Cria uma nova opção de atributo. ### Atualiza uma opção - [PUT /api/v3/attributes/{attributeId}/options/{optionId}](https://cplug.redocly.app/openapi/attributeoptions/put-attributes-options.md): Atualiza uma opção de um atributo. ### Apaga uma opção - [DELETE /api/v3/attributes/{attributeId}/options/{optionId}](https://cplug.redocly.app/openapi/attributeoptions/delete-attributes-options.md): Apaga uma opção de um atributo. ### Atualiza imagem da opção - [POST /api/v3/attributes/{attributeId}/options/{optionId}/image](https://cplug.redocly.app/openapi/attributeoptions/post-attributes-options-image.md): Adiciona ou atualiza a imagem de uma opção de um atributo. A imagem deve ser do tipo JPEG ou PNG em base64. O tamanho máximo do arquivo é 5 MB. ## Unidades de medidas Operações das unidades de medidas dos produtos. ### Lista de unidades de medidas - [GET /api/v3/units](https://cplug.redocly.app/openapi/units/get-units.md): Retorna lista das unidades de medidas disponíveis. ### Cria nova unidade de medida - [POST /api/v3/units](https://cplug.redocly.app/openapi/units/post-units.md): Cria uma nova unidade de medida de produtos. ### Obtém uma unidade de medida - [GET /api/v3/units/{unitId}](https://cplug.redocly.app/openapi/units/get-units-id.md): Obtém uma unidade de medida. ### Atualiza uma unidade de medida - [PUT /api/v3/units/{unitId}](https://cplug.redocly.app/openapi/units/put-units.md): Atualiza uma unidade de medida. ### Apaga uma unidade de medida - [DELETE /api/v3/units/{unitId}](https://cplug.redocly.app/openapi/units/delete-units.md): Apaga uma unidade de medida. ## Periféricos Operações do cadastro de periféricos. ### Lista de periféricos - [GET /api/v3/peripherals](https://cplug.redocly.app/openapi/peripherals/get-peripherals.md): Retorna lista de periféricos. ### Cria um novo periférico - [POST /api/v3/peripherals](https://cplug.redocly.app/openapi/peripherals/post-peripherals.md): Cria um novo periférico. ### Obtém um periférico - [GET /api/v3/peripherals/{peripheralId}](https://cplug.redocly.app/openapi/peripherals/get-peripherals-id.md): Resgata um periférico já existente. ### Atualiza um periférico - [PUT /api/v3/peripherals/{peripheralId}](https://cplug.redocly.app/openapi/peripherals/put-peripherals.md): Atualiza um periférico já existente. ### Apaga um periférico - [DELETE /api/v3/peripherals/{peripheralId}](https://cplug.redocly.app/openapi/peripherals/delete-peripherals.md): Apaga um periférico. ### Lista de fabricantes de periféricos - [GET /api/v3/peripherals/manufacturers](https://cplug.redocly.app/openapi/peripherals/get-peripherals-manufacturers.md): Retorna lista de fabricantes de periféricos. ### Lista de produtos relacionados ao periférico - [GET /api/v3/peripherals/{peripheralId}/products](https://cplug.redocly.app/openapi/peripherals/get-peripheral-products.md): Retorna lista de produtos relacionados a um periférico. ### Associa produtos a um periférico - [PATCH /api/v3/peripherals/{peripheralId}/products](https://cplug.redocly.app/openapi/peripherals/patch-peripheral-products.md): Associa uma lista de produtos a um periférico específico. ### Associa um produto a um periférico - [POST /api/v3/peripherals/{peripheralId}/products/{productId}](https://cplug.redocly.app/openapi/peripherals/post-peripheral-product.md): Associa um produto a um periférico. ### Desassociar um produto de um periférico - [DELETE /api/v3/peripherals/{peripheralId}/products/{productId}](https://cplug.redocly.app/openapi/peripherals/delete-peripheral-product.md): Desassocia um produto a um periférico. ## Fornecedores Fornecedores de serviços ou produtos. Podem ser pessoas jurídicas ou físicas ### Lista de fornecedores - [GET /api/v3/suppliers](https://cplug.redocly.app/openapi/suppliers/get-suppliers.md): Retorna lista de fornecedores. ### Cria um novo fornecedor - [POST /api/v3/suppliers](https://cplug.redocly.app/openapi/suppliers/post-suppliers.md): Cria um novo fornecedor. ### Obtém um fornecedor - [GET /api/v3/suppliers/{supplierId}](https://cplug.redocly.app/openapi/suppliers/get-supplier.md): Obtém os dados de um fornecedor. ### Atualiza um fornecedor - [PUT /api/v3/suppliers/{supplierId}](https://cplug.redocly.app/openapi/suppliers/put-suppliers.md): Atualiza um fornecedor. ### Apaga um fornecedor - [DELETE /api/v3/suppliers/{supplierId}](https://cplug.redocly.app/openapi/suppliers/delete-suppliers.md): Apaga um fornecedor. ### Restaura um fornecedor - [POST /api/v3/suppliers/{supplierId}/restore](https://cplug.redocly.app/openapi/suppliers/post-restore-suppliers.md): Restaura um fornecedor removido. ## Transportadoras Operações de transportadoras. ### Lista de transportadoras - [GET /api/v3/carriers](https://cplug.redocly.app/openapi/carriers/get-carriers.md): Retorna lista de transportadoras. ### Cria uma nova transportadora - [POST /api/v3/carriers](https://cplug.redocly.app/openapi/carriers/post-carriers.md): Cria uma nova transportadora. ### Obtém uma transportadora - [GET /api/v3/carriers/{carrierId}](https://cplug.redocly.app/openapi/carriers/get-carrier.md): Obtém os dados de uma transportadora. ### Atualiza uma transportadora - [PUT /api/v3/carriers/{carrierId}](https://cplug.redocly.app/openapi/carriers/put-carriers.md): Atualiza uma transportadora. ### Apaga uma transportadora - [DELETE /api/v3/carriers/{carrierId}](https://cplug.redocly.app/openapi/carriers/delete-carriers.md): Apaga uma transportadora. ### Restaura uma transportadora - [POST /api/v3/carriers/{carrierId}/restore](https://cplug.redocly.app/openapi/carriers/post-restore-carriers.md): Restaura uma transportadora removida. ## Produtos Operações de cadastro de produtos. ### Lista de produtos - [GET /api/v3/products](https://cplug.redocly.app/openapi/products/get-products.md): Retorna lista de produtos cadastrados. ### Cria novo produto - [POST /api/v3/products](https://cplug.redocly.app/openapi/products/post-products.md): Cria uma novo produto. ### Obtém um produto - [GET /api/v3/products/{productId}](https://cplug.redocly.app/openapi/products/get-products-id.md): Resgata um produto já existente. ### Atualiza um produto - [PUT /api/v3/products/{productId}](https://cplug.redocly.app/openapi/products/put-products.md): Atualiza um produto já existente. ATENÇÃO: Esse _endpoint_ sempre realiza o sync de dados dos compos attributes e components, ou seja, se por exemplo um produto já tenha atributos relacionados à ele e na edição o compo attributes for um array vazio, comportamento esperado é a remoção dos atributos do produto. ### Apaga um produto - [DELETE /api/v3/products/{productId}](https://cplug.redocly.app/openapi/products/delete-products.md): Apaga um produto. ### Restaura um produto - [POST /api/v3/products/{productId}/restore](https://cplug.redocly.app/openapi/products/post-products-id-restore.md): Restaura um produto que foi previamente excluído. ### Duplica um produto - [POST /api/v3/products/{productId}/duplicate](https://cplug.redocly.app/openapi/products/post-products-id-duplicate.md): Duplica um produto. ### Atualiza imagem do produto - [POST /api/v3/products/{productId}/image](https://cplug.redocly.app/openapi/products/post-products-image.md): Adiciona ou atualiza a imagem principal do produto. A imagem deve ser do tipo JPEG ou PNG em base64. O tamanho máximo do arquivo é 5 MB. ### Gera códigos de barras - [GET /api/v3/products/barcodes](https://cplug.redocly.app/openapi/products/get-barcodes.md): Gera códigos de barras EAN-13 ou EAN-8 para utilizar em produtos. ### Obtém saldo em estoque - [GET /api/v3/products/{productId}/balance](https://cplug.redocly.app/openapi/products/get-products-id-stocks-balance.md): Obtém informações sobre a quantidade produto em todos os estoques. ### Atualiza tipo de balança e códigos de barras - [PATCH /api/v3/products/{productId}/weight-scale](https://cplug.redocly.app/openapi/products/patch-products-id-weight-scale.md): Atualiza o tipo de balança do produto e também os códigos de barras do mesmo. Ambos os campos são opcionais: - Se balance_type não for enviado, o valor padrão será null - Se barcodes não for enviado, os códigos de barras do produto não serão alterados ### Obtém custo de um produto - [GET /api/v3/products/{productId}/cost-history](https://cplug.redocly.app/openapi/products/get-products-id-cost-history.md): Obtém informações sobre o custo de um produto. ### Lista integrações de um produto - [GET /api/v3/products/{productId}/integrations](https://cplug.redocly.app/openapi/products/get-products-integrations.md): Retorna a lista de integrações associadas ao produto. ## ↳ Atributos de um produto Operações de atributos de um produto. ### Lista os atributos - [GET /api/v3/products/{productId}/attributes](https://cplug.redocly.app/openapi/productattributes/get-products-attributes.md): Retorna a lista de atributos associados ao produto. ### Atualiza os atributos - [PUT /api/v3/products/{productId}/attributes](https://cplug.redocly.app/openapi/productattributes/put-products-attributes.md): Atualiza os atributos associados ao produto. ### Apaga atributo - [DELETE /api/v3/products/{productId}/attributes/{attributeId}](https://cplug.redocly.app/openapi/productattributes/delete-products-attributes.md): Apaga a associação do atributo com o produto em específico. ## ↳ Componentes de um produto Operações de componentes de um produto. ### Lista as composições - [GET /api/v3/products/{productId}/compositions](https://cplug.redocly.app/openapi/productcompositions/getproductcompositions.md): Retorna as composições de um produto específico com filtros opcionais. ### Cria ou atualiza composições - [PUT /api/v3/products/{productId}/compositions](https://cplug.redocly.app/openapi/productcompositions/update-products-compositions.md): Atualiza ou insere itens na lista de composições de um produto. Esse endpoint deleta todos os componentes que não estiverem na lista de componentes informada. Importante: - O produto que receberá os componentes deve ser COMBO ou PROCESSO-PRODUTIVO - Todos os produtos na lista de componentes devem ser do tipo componente - flg_component = true - composition_type = 0 - Produtos com grade de preços não podem ter composições - Se o campo id for informado, o sistema fará um update da composição existente - Se o campo id não for informado, o sistema fará um insert de uma nova composição ### Apaga uma composição - [DELETE /api/v3/products/{productId}/compositions/{componentId}](https://cplug.redocly.app/openapi/productcompositions/delete-products-components.md): Apaga a associação da composição com o produto em específico. ### Lista produtos que utilizam este componente - [GET /api/v3/products/{productId}/composes](https://cplug.redocly.app/openapi/productcompositions/getproductcomposes.md): Retorna os produtos que são compostos por um determinado produto/componente. Este endpoint mostra onde um produto/componente específico é utilizado como componente de outros produtos. ## ↳ Grade de preços de um produto Operações de grade de preços de um produto. ### Lista as grades de preço - [GET /api/v3/products/{productId}/grids](https://cplug.redocly.app/openapi/productgrids/get-product-grids.md): Retorna as grades de preços de um produto. ### Cria ou atualiza as grades de preços - [PUT /api/v3/products/{productId}/grids](https://cplug.redocly.app/openapi/productgrids/put-product-grids.md): Atualiza as grades de preços de um produto. Nota: Esta operação substitui completamente as grades de preços existentes. - Para criar uma nova grade de preço, não informe o campo id. - Para atualizar uma grade de preço existente, informe o campo id. - Grades de preços existentes que não forem enviadas na requisição serão removidas. ### Remove uma grade de preços - [DELETE /api/v3/products/{productId}/grids/{gridId}](https://cplug.redocly.app/openapi/productgrids/delete-product-grid.md): Remove uma grade de preços específica de um produto. Nota: Esta operação remove permanentemente a grade de preços. ### Atualiza imagem de uma grade de preço - [POST /api/v3/products/{productId}/grids/{gridId}/image](https://cplug.redocly.app/openapi/productgrids/post-products-grids-image.md): Adiciona, atualiza ou remove a imagem de uma grade de preço. A imagem deve ser do tipo JPEG ou PNG em base64. Para remover a imagem existente, envie o campo image como null ou uma string vazia. O tamanho máximo do arquivo é 5 MB. ## ↳ Fornecedores de um produto Operações de fornecedores de um produto. ### Lista fornecedores - [GET /api/v3/products/{productId}/suppliers](https://cplug.redocly.app/openapi/productsuppliers/get-products-suppliers.md): Retorna a lista de fornecedores associados ao produto. ### Adiciona fornecedor - [POST /api/v3/products/{productId}/suppliers](https://cplug.redocly.app/openapi/productsuppliers/post-products-suppliers.md): Adiciona um novo fornecedor ao produto. ### Obtém fornecedor - [GET /api/v3/products/{productId}/suppliers/{productSupplierId}](https://cplug.redocly.app/openapi/productsuppliers/get-products-suppliers-by-id.md): Retorna os detalhes de um fornecedor específico associado ao produto. ### Atualiza fornecedor - [PUT /api/v3/products/{productId}/suppliers/{productSupplierId}](https://cplug.redocly.app/openapi/productsuppliers/put-products-suppliers.md): Atualiza os dados de um fornecedor específico associado ao produto. ### Apaga fornecedor - [DELETE /api/v3/products/{productId}/suppliers/{productSupplierId}](https://cplug.redocly.app/openapi/productsuppliers/delete-products-suppliers.md): Remove um fornecedor específico associado ao produto. ## ↳ Operações fiscais de produtos Operações de configurações fiscais de produtos. ### Lista informações tributárias dos produtos - [GET /api/v3/products/tax-settings](https://cplug.redocly.app/openapi/producttaxes/get-products-tax-settings.md): Retorna uma lista de produtos com suas respectivas configurações fiscais. ### Obtém informações tributárias de um produto - [GET /api/v3/products/{productId}/tax-settings](https://cplug.redocly.app/openapi/producttaxes/get-product-tax-settings.md): Retorna as configurações fiscais de um produto específico. ### Cria ou atualiza informações tributárias - [PUT /api/v3/products/{productId}/tax-settings](https://cplug.redocly.app/openapi/producttaxes/put-product-tax-settings.md): Cria ou atualiza as configurações fiscais de um produto específico. ### Lista de CFOP - [GET /api/v3/products/cfop](https://cplug.redocly.app/openapi/producttaxes/get-cfop.md): Retorna lista de CFOP disponíveis. ### Lista de NCM - [GET /api/v3/products/ncm](https://cplug.redocly.app/openapi/producttaxes/get-ncm.md): Retorna lista de NCM disponíveis. ### Lista de ICMS de Origem - [GET /api/v3/products/origin](https://cplug.redocly.app/openapi/producttaxes/get-origin.md): Retorna lista de ICMS de Origem disponíveis. ### Lista de CEST - [GET /api/v3/products/cest](https://cplug.redocly.app/openapi/producttaxes/get-cest.md): Retorna lista de CEST disponíveis. ## ↳ Aplicativos de um produto Operações de disponibilidade de um aplicativo em um produto. ### Lista os aplicativos - [GET /api/v3/products/{productId}/apps](https://cplug.redocly.app/openapi/productapps/get-product-apps.md): Lista os aplicativos de um produto. ### Cria ou atualiza aplicativos - [PUT /api/v3/products/{productId}/apps](https://cplug.redocly.app/openapi/productapps/put-product-apps.md): Cria ou atualiza aplicativos de um produto. ### Obtém um aplicativo - [GET /api/v3/products/{productId}/apps/{appId}](https://cplug.redocly.app/openapi/productapps/get-product-apps-by-id.md): Obtém um aplicativo de um produto. ### Atualiza um aplicativo - [PUT /api/v3/products/{productId}/apps/{appId}](https://cplug.redocly.app/openapi/productapps/put-product-apps-by-id.md): Atualiza um aplicativo de um produto. ### Apaga um aplicativo de um produto - [DELETE /api/v3/products/{productId}/apps/{appId}](https://cplug.redocly.app/openapi/productapps/delete-product-apps-by-id.md): Apaga um aplicativo de um produto. ### Apaga todos os horário de um produto no aplicativo - [DELETE /api/v3/products/{productId}/apps/{appId}/shifts](https://cplug.redocly.app/openapi/productapps/delete-product-apps-shifts.md): Apaga todos os horário de um produto no aplicativo. ## ↳ Fichas de Consumo de Produtos Operações de fichas de consumo de produtos. ### Lista as configurações de fichas de consumo de produtos - [GET /api/v3/products/consumption-coupons](https://cplug.redocly.app/openapi/productconsumptioncoupons/get-product-consumption-coupons.md): Lista as configurações de fichas de consumo de produtos. ### Atualiza as configurações de fichas de consumo de produtos - [PUT /api/v3/products/consumption-coupons](https://cplug.redocly.app/openapi/productconsumptioncoupons/put-product-consumption-coupons.md): Atualiza as configurações de fichas de consumo de produtos. Atenção: Só é permitido atualizar as informações quando a empresa estiver com as fichas de consumo de produtos habilitadas nas Configurações do ERP. ## Estoques Operações de cadastro de estoques. ### Lista de estoques - [GET /api/v3/stocks](https://cplug.redocly.app/openapi/stocks/get-stocks.md): Retorna lista de estoques. ### Cria novo estoque - [POST /api/v3/stocks](https://cplug.redocly.app/openapi/stocks/post-stocks.md): Cria novo estoque. ### Obtém um estoque - [GET /api/v3/stocks/{stockId}](https://cplug.redocly.app/openapi/stocks/get-single-stocks.md): Obtém um estoque. ### Atualiza um estoque - [PUT /api/v3/stocks/{stockId}](https://cplug.redocly.app/openapi/stocks/put-stocks.md): Atualiza um estoque existente. ### Apaga um estoque - [DELETE /api/v3/stocks/{stockId}](https://cplug.redocly.app/openapi/stocks/delete-stocks.md): Apaga um estoque. ## Movimentação de estoque Operações de entrada e saída de produtos no estoque. ### Registra uma nova movimentação - [POST /api/v3/stocks/{stockId}/movements](https://cplug.redocly.app/openapi/stockmovements/post-register-stocks-movements.md): Registra uma nova movimentação de estoque. ### Obtém detalhes de uma movimentação - [GET /api/v3/stocks/{stockId}/movements/{stockMovementId}/composition](https://cplug.redocly.app/openapi/stockmovements/get-stocks-stock-movement-composition-detail.md): Obtém os detalhes de uma movimentação de estoque. ### Apaga movimentações de um estoque - [DELETE /api/v3/stocks/{stockId}/reset](https://cplug.redocly.app/openapi/stockmovements/reset-movements.md): Apaga todas as movimentações de um estoque. ### Obtém situação da remoção de movimentações - [GET /api/v3/stocks/{stockId}/reset-status](https://cplug.redocly.app/openapi/stockmovements/get-stock-reset-status.md): Obtém a situação da solicitação para remoção das movimentações de um estoque. ## Categoria de movimentação de estoque Operações de cadastro da categoria de movimentação de estoque. ### Lista de categorias de movimentação de estoque - [GET /api/v3/stocks/movements/categories](https://cplug.redocly.app/openapi/stockmovementcategories/get-stock-movement-categories.md): Retorna lista de categoria de movimentação de estoque. ### Cria nova categoria de movimentação de estoque - [POST /api/v3/stocks/movements/categories](https://cplug.redocly.app/openapi/stockmovementcategories/post-stock-movement-categories.md): Cria nova categoria de movimentação de estoque. ### Obtém uma categoria de movimentação de estoque - [GET /api/v3/stocks/movements/categories/{stockMovementCategoryId}](https://cplug.redocly.app/openapi/stockmovementcategories/get-single-stock-movement-categories.md): Obtém uma categoria de movimentação de estoque. ### Atualiza uma categoria de movimentação de estoque - [PUT /api/v3/stocks/movements/categories/{stockMovementCategoryId}](https://cplug.redocly.app/openapi/stockmovementcategories/put-stock-movement-categories.md): Atualiza uma categoria de movimentação de estoque existente. ### Apaga uma categoria de movimentação de estoque - [DELETE /api/v3/stocks/movements/categories/{stockMovementCategoryId}](https://cplug.redocly.app/openapi/stockmovementcategories/delete-stock-movement-categories.md): Apaga uma categoria de movimentação de estoque. ## Movimentação de estoque de um produto Operações de movimentação de estoque de um produto no estoque. ### Lista os produtos de um estoque - [GET /api/v3/stocks/{stockId}/products](https://cplug.redocly.app/openapi/stockproducts/get-stocks-products.md): Lista os produtos de um estoque. ### Obtém o balanço do produto no estoque - [GET /api/v3/stocks/{stockId}/products/{productId}/balance](https://cplug.redocly.app/openapi/stockproducts/get-stocks-products-balance.md): Obtém o balanço do produto no estoque. ### Obtém os lotes de entrada de um produto - [GET /api/v3/stocks/{stockId}/products/{productId}/batches](https://cplug.redocly.app/openapi/stockproducts/get-product-batches.md): Obtém os movimentos de estoque de entrade de um produto num determinado estoque. ### Lista as movimentações de um produto - [GET /api/v3/stocks/{stockId}/products/{productId}/movements](https://cplug.redocly.app/openapi/stockproducts/get-stocks-products-movements.md): Lista as movimentações de um produto em um estoque.. ### Apaga uma movimentação de um produto - [PATCH /api/v3/stocks/{stockId}/products/{productId}/movements/{stockMovementId}](https://cplug.redocly.app/openapi/stockproducts/delete-stock-product-movement.md): Apaga uma movimentação de um produto em um estoque. ### Apaga todas as movimentações de um produto - [DELETE /api/v3/stocks/{stockId}/products/{productId}/reset](https://cplug.redocly.app/openapi/stockproducts/stock-product-reset.md): Apaga todas as movimentações de um produto em um estoque. ## Transferência entre estoques Operações de transferência de produtos entre estoques. ### Lista transferências entre estoques - [GET /api/v3/stock-transfers](https://cplug.redocly.app/openapi/stocktransfers/get-stock-transfers.md): Retorna lista transferências entre estoques. ### Cria uma nova transferência entre estoques - [POST /api/v3/stock-transfers](https://cplug.redocly.app/openapi/stocktransfers/post-stock-transfers.md): Cria uma nova transferência entre estoques. ### Apaga uma transferência entre estoques - [DELETE /api/v3/stock-transfers/{transferId}](https://cplug.redocly.app/openapi/stocktransfers/delete-stock-transfers.md): Apaga uma transferência entre estoques. ### Download PDF da transferência de estoque - [GET /api/v3/stock-transfers/{transferId}/download-pdf](https://cplug.redocly.app/openapi/stocktransfers/get-download-pdf-stock-transfers.md): Download do PDF de informações sobre as transferência entre estoque. ## Inventários de um estoque Operações de cadastro de inventários de um estoque. ### Lista os inventários - [GET /api/v3/stocks/{stockId}/inventories](https://cplug.redocly.app/openapi/stockinventories/get-stock-inventories.md): Lista os inventários de um estoque. ### Cria novo inventário - [POST /api/v3/stocks/{stockId}/inventories](https://cplug.redocly.app/openapi/stockinventories/post-stocks-inventories.md): Cria novo inventário. ### Obtém um inventário - [GET /api/v3/stocks/{stockId}/inventories/{inventoryId}](https://cplug.redocly.app/openapi/stockinventories/get-stock-inventory.md): Obtém um inventário de um estoque. ### Atualiza um inventário - [PUT /api/v3/stocks/{stockId}/inventories/{inventoryId}](https://cplug.redocly.app/openapi/stockinventories/put-stocks-inventories.md): Atualiza um inventário existente. ### Apaga um inventário - [DELETE /api/v3/stocks/{stockId}/inventories/{inventoryId}](https://cplug.redocly.app/openapi/stockinventories/delete-stock-inventory.md): Apaga um inventário. ### Lista os itens de um inventário - [GET /api/v3/stocks/{stockId}/inventories/{inventoryId}/items](https://cplug.redocly.app/openapi/stockinventories/get-stock-inventory-items.md): Lista os itens de um inventário de um estoque. ### Cria, atualiza e remove itens de um inventário - [PUT /api/v3/stocks/{stockId}/inventories/{inventoryId}/items](https://cplug.redocly.app/openapi/stockinventories/put-stocks-inventories-items.md): Cria, atualiza e remove itens de um inventário de um estoque. Funcionamento: 1. Se passar um item que está no inventário, ele será removido. 2. Se não passar um item que não está no inventário, ele será adicionado. 3. Para remover um atributo de um item, basta preencher o campo removed_inventory_product_attribute_ids 4. Se adicionar um atributo de um item que não está no produto de um inventário, ele será adicionado. ### Upload de uma planilha de inventário - [POST /api/v3/stocks/{stockId}/inventories/{inventoryId}/upload](https://cplug.redocly.app/openapi/stockinventories/post-stocks-inventories-upload.md): Upload de uma planilha de inventário. Este endpoint aceita solicitações HTTP no formato Form-Data. Veja um exemplo: curl --location 'http://{BASE_URL}/api/v3/stocks/{stockId}/inventories/{inventoryId}/upload' \ --header 'CPlug-Company-Id: COMPANY_ID' \ --header 'Idempotency-Key: IDEMPOTENCY_KEY' \ --header 'Authorization: Bearer TOKEN' \ --form 'file=@"/path/to/spreadsheet.xlsx"' * Quando o arquivo é validado com sucesso, este endpoint já salva os itens no inventário. * Se o arquivo não for validado com sucesso, este endpoint retorna todos os itens da planilha e em cada item, mostra qual foi o(s) erro(s) encontrado(s). * Neste caso, o usuário deve corrigir os itens e enviar novamente ou * Enviar os itens para o endpoint de importação que foram devolvidos neste endpoint. ### Importação de uma planilha de inventário - [POST /api/v3/stocks/{stockId}/inventories/{inventoryId}/import](https://cplug.redocly.app/openapi/stockinventories/post-stocks-inventories-import.md): Importa os itens de um inventário de um estoque através de uma planilha seguindo exportado neste endpoint. ### Finaliza um inventário - [POST /api/v3/stocks/{stockId}/inventories/{inventoryId}/finalize](https://cplug.redocly.app/openapi/stockinventories/post-stocks-inventories-finalize.md): Finaliza um inventário de estoque. Após finalizar, o inventário não pode ser alterado. ### Exporta planilha de produtos para inventário - [GET /api/v3/products/export-inventory](https://cplug.redocly.app/openapi/stockinventories/get-export-inventory-products.md): Este endpoint exporta uma planilha com os produtos de um estoque para ser importado em um inventário. ## Ordens de Produção Operações de ordens de produção. ### Lista de ordens de produção - [GET /api/v3/production-orders](https://cplug.redocly.app/openapi/productionorders/get-production-orders.md): Retorna lista das ordens de produção disponíveis. ### Cria uma ordem de produção - [POST /api/v3/production-orders](https://cplug.redocly.app/openapi/productionorders/create-production-order.md): Cria uma nova ordem de produção com produtos, componentes e opções especificados. ### Obtém uma ordem de produção - [GET /api/v3/production-orders/{productionOrderId}](https://cplug.redocly.app/openapi/productionorders/get-production-order.md): Retorna os detalhes de uma ordem de produção específica, incluindo seus itens, componentes, etc. ### Atualiza uma ordem de produção - [PUT /api/v3/production-orders/{productionOrderId}](https://cplug.redocly.app/openapi/productionorders/update-production-order.md): Atualiza uma ordem de produção existente. As permissões de alteração variam conforme o status da ordem: - order: Permite alterar todos os campos - in_production: Permite alterar apenas componentes dos produtos (quantidade, stock_id), proibido enviar 'options' - finished: Permite alterar apenas dados do produto (stock_id, quantidade) ### Avança etapa da ordem de produção - [POST /api/v3/production-orders/{productionOrderId}/advance](https://cplug.redocly.app/openapi/productionorders/advance-production-order.md): Avança o status da ordem de produção através das etapas do processo. Sequência de status: 1. order → in_progress (inicia a produção) 2. in_progress → finished (finaliza a produção) Não é possível retroceder etapas. Uma vez que uma ordem de produção avança de status, não pode retornar ao status anterior. ### Cancela uma ordem de produção - [POST /api/v3/production-orders/{productionOrderId}/cancel](https://cplug.redocly.app/openapi/productionorders/cancel-production-order.md): Cancela uma ordem de produção existente e opcionalmente reverte as movimentações de estoque. Comportamento: - Altera o status da ordem de produção para canceled - Se is_revert_stock for true, reverte as movimentações de estoque dos componentes consumidos e produtos produzidos - Se is_revert_stock for false ou não informado, mantém as movimentações de estoque Restrições: - A ordem de produção deve estar em um status válido para cancelamento ### Finaliza uma ordem de produção - [POST /api/v3/production-orders/{productionOrderId}/finish](https://cplug.redocly.app/openapi/productionorders/finish-production-order.md): Finaliza e conclui definitivamente uma ordem de produção que está com status finished. Restrições: - A ordem de produção deve estar com status finished para ser finalizada - Ordens com outros status não podem ser finalizadas através deste endpoint ## Compras Operações de compras. ### Lista de compras - [GET /api/v3/purchases](https://cplug.redocly.app/openapi/purchase/get-purchases.md): Retorna listas de compras. ### Cria uma nova compra - [POST /api/v3/purchases](https://cplug.redocly.app/openapi/purchase/post-purchase.md): Cria uma nova compra. ### Obtém uma compra - [GET /api/v3/purchases/{purchaseId}](https://cplug.redocly.app/openapi/purchase/get-purchase-by-id.md): Resgata uma compra. ### Atualiza uma compra - [PUT /api/v3/purchases/{purchaseId}](https://cplug.redocly.app/openapi/purchase/put-purchase.md): Atualiza uma compra. ### Apaga uma compra - [DELETE /api/v3/purchases/{purchaseId}](https://cplug.redocly.app/openapi/purchase/delete-purchase.md): Apaga uma compra. ### Marca todos os itens da compra como entregues - [POST /api/v3/purchases/{purchaseId}/mark-all-items-delivered](https://cplug.redocly.app/openapi/purchase/post-purchase-mark-all-items-delivered.md): Marca todos os itens da compra como entregues. ### Adiciona anexo a uma compra - [POST /api/v3/purchases/{purchaseId}/files](https://cplug.redocly.app/openapi/purchase/post-purchase-files.md): Adiciona um novo arquivo para anexar à compra. Este endpoint aceita solicitações HTTP no formato Form-Data. Veja um exemplo: curl --location 'http://{BASE_URL}/api/v3/purchase/{purchaseId}/files' \ --header 'CPlug-Company-Id: COMPANY_ID' \ --header 'Idempotency-Key: IDEMPOTENCY_KEY' \ --header 'Authorization: Bearer TOKEN' \ --form 'files[0]=@"/path/to/file0.png"' --form 'files[1]=@"/path/to/file1.pdf"' O tamanho máximo do arquivo é 5 MB. ### Apaga um anexo - [DELETE /api/v3/purchases/{purchaseId}/files/{fileId}](https://cplug.redocly.app/openapi/purchase/delete-purchase-file-by-id.md): Apaga um anexo. ### Download PDF de uma compra - [GET /api/v3/purchases/{purchaseId}/download-pdf](https://cplug.redocly.app/openapi/purchase/get-purchase-print.md): Retorna o blob do PDF da compra. ### Envia email de uma compra - [POST /api/v3/purchases/{purchaseId}/send-email](https://cplug.redocly.app/openapi/purchase/post-purchase-send-email.md): Envia email de uma compra. ### Lista os produtos de uma compra - [GET /api/v3/purchases/{purchaseId}/items](https://cplug.redocly.app/openapi/purchase/get-purchase-items.md): Retorna os produtos de uma compra. ## Importação de XML de Entrada Importação de XML de Entrada. Fluxo de importação padrão: 1) Faz o [upload](#tag/PurchaseInvoices/operation/post-purchase-invoices-file) da nota fiscal de entrada. 2) [Obtém informações sobre o XML](#tag/PurchaseInvoices/operation/get-purchase-invoice-info-by-id) para verificase se o fornecedor está cadastrado; a) Se o campo `data.supplier.id` estiver com valor `null`, quer dizer que precisa [cadastrar um novo fornecedor](#tag/Suppliers/operation/post-suppliers). 3) "Baixa" os itens do XML para o sistema por meio do endpoint [Faz um pré-processamento dos itens da nota](#tag/PurchaseInvoices/operation/put-purchase-invoice-prepare-items); 4) [Obtém a lista de itens do XML](#tag/PurchaseInvoices/operation/get-purchase-invoice-items) para ver se precisa fazer alguma alteração ou associar um produto já cadastrado; 5) Faça as operações necessárias do item; a) [Salva os itens em massa](#tag/PurchaseInvoices/operation/get-purchase-invoices) ou b) [Salva um item](#tag/PurchaseInvoices/operation/put-purchase-invoice-save-single-item) ou c) [Apaga um item do XML](#tag/PurchaseInvoices/operation/delete-purchase-invoice-a-single-item) ou d) [Reverte uma alteração para o estado inicial do XML](#tag/PurchaseInvoices/operation/put-purchase-invoice-revert-single-item) ou e) [Atualiza o preço de venda de todos os itens](#tag/PurchaseInvoices/operation/put-purchase-invoice-items-update-all-unitary-sale-price) ou f) [Atualiza os itens com os produtos do fornecedor](#tag/PurchaseInvoices/operation/put-purchase-invoice-items-update-linked-items). 6) E finalmente [faz a importação dos itens que foram salvos](#tag/PurchaseInvoices/operation/put-purchase-invoice-import) no item anterior, adicionando as formas de pagamento para poder gerar uma compra no sistema. ### Lista os XMLs de entrada - [GET /api/v3/purchase-invoices](https://cplug.redocly.app/openapi/purchaseinvoices/get-purchase-invoices.md): Retorna uma lista de XMLs de entrada. ### Upload de XML - [POST /api/v3/purchase-invoices](https://cplug.redocly.app/openapi/purchaseinvoices/post-purchase-invoices-file.md): Adiciona um novo arquivo xml. Este endpoint aceita solicitações HTTP no formato Form-Data. Veja um exemplo: curl --location 'http://{BASE_URL}/api/v3/purchase-invoices' \ --header 'CPlug-Company-Id: COMPANY_ID' \ --header 'Idempotency-Key: IDEMPOTENCY_KEY' \ --header 'Authorization: Bearer TOKEN' \ --form 'files=@"/path/to/nfeIn.xml"' O tamanho máximo do arquivo é 5 MB. ### Pré-processa os itens da nota - [PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/prepare-items](https://cplug.redocly.app/openapi/purchaseinvoices/put-purchase-invoice-prepare-items.md): Um pré-processamento dos itens da nota, guardando eles no banco e associando a um fornecedor, caso tenha. ### Obtém informações sobre o XML - [GET /api/v3/purchase-invoices/{purchaseInvoiceId}/info](https://cplug.redocly.app/openapi/purchaseinvoices/get-purchase-invoice-info-by-id.md): Retorna informações sobre o XML. ### Lista os itens do XML - [GET /api/v3/purchase-invoices/{purchaseInvoiceId}/items](https://cplug.redocly.app/openapi/purchaseinvoices/get-purchase-invoice-items.md): Retorna uma lista de itens do XML. ### Salva os itens em massa - [PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/items](https://cplug.redocly.app/openapi/purchaseinvoices/put-purchase-invoice-save-all-item.md): Salva os itens em massa. ### Reverte alterações de itens - [PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/rollback-items](https://cplug.redocly.app/openapi/purchaseinvoices/put-purchase-invoice-items-rollback.md): Atenção Este endpoint irá reverter todas as alterações feitas em todos os itens da nota para o seu estado original. ### Atualiza o preço de venda em massa - [PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/update-all-unitary-sale-price](https://cplug.redocly.app/openapi/purchaseinvoices/put-purchase-invoice-items-update-all-unitary-sale-price.md): Este endpoint irá atualizar o preço de venda de todos os itens da nota conforme a porcetagem informada. Exemplo: - Considere que o preço unitário de um item é R$ 10,00: - Se a porcetagem for 200%, o preço de venda deste item será de R$ 30,00. Esse cálculo é aplicado individualmente para cada item da nota. ### Sincroniza itens com produtos do fornecedor - [PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/update-linked-items](https://cplug.redocly.app/openapi/purchaseinvoices/put-purchase-invoice-items-update-linked-items.md): Essa ação irá atualizar, em massa, os itens da nota comparando com produtos cujo código do fornecedor corresponde ao da nota fiscal, sincronizando suas informações. ### Salva um item do XML - [PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/items/{purchaseInvoiceItemId}](https://cplug.redocly.app/openapi/purchaseinvoices/put-purchase-invoice-save-single-item.md): Salva apenas um item do do XML. ### Apaga um item do XML - [DELETE /api/v3/purchase-invoices/{purchaseInvoiceId}/items/{purchaseInvoiceItemId}](https://cplug.redocly.app/openapi/purchaseinvoices/delete-purchase-invoice-a-single-item.md): Apaga um item, ou seja, este item não vai ser importado. ### Reverte uma alteração de um item - [PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/items/{purchaseInvoiceItemId}/revert](https://cplug.redocly.app/openapi/purchaseinvoices/put-purchase-invoice-revert-single-item.md): Reverte uma alteração de um item para a configuração original do XML. ### Finalizar importação - [PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/import](https://cplug.redocly.app/openapi/purchaseinvoices/put-purchase-invoice-import.md): Finaliza a importação dos itens salvos da nota. ### Apaga XML - [DELETE /api/v3/purchase-invoices/{purchaseInvoiceId}](https://cplug.redocly.app/openapi/purchaseinvoices/delete-purchase-invoices.md): Apaga um XML. ### Download do XML da NF-e - [GET /api/v3/purchase-invoices/{purchaseInvoiceId}/download](https://cplug.redocly.app/openapi/purchaseinvoices/get-purchase-invoice-download-file.md): Faz o download do arquivo XML da NF-e. ## Vendas Operações de vendas. ### Lista de vendas - [GET /api/v3/sales](https://cplug.redocly.app/openapi/sales/get-sales.md): Retorna lista de Vendas. ### Cria uma nova venda - [POST /api/v3/sales](https://cplug.redocly.app/openapi/sales/post-sale.md): Cria uma nova venda com status em aberto. ### Obtém uma venda - [GET /api/v3/sales/{saleId}](https://cplug.redocly.app/openapi/sales/get-sales-id.md): Resgata uma venda. ### Cancela uma venda - [DELETE /api/v3/sales/{saleId}](https://cplug.redocly.app/openapi/sales/delete-sales-id.md): Cancela uma venda. ### Download PDF de uma venda - [GET /api/v3/sales/{saleId}/download-pdf](https://cplug.redocly.app/openapi/sales/get-sale-download-pdf.md): Retorna o blob do PDF da venda. ### Imprimir uma venda - [GET /api/v3/sales/{saleId}/print](https://cplug.redocly.app/openapi/sales/get-sale-print.md): Retorna o HTML da venda. ### Envia o recibo de venda por e-mail - [POST /api/v3/sales/{saleId}/send-receipt-by-email](https://cplug.redocly.app/openapi/sales/post-sales-send-receipt-by-email.md): Envia o recibo de venda por e-mail. ### Lista recebimentos de uma venda - [GET /api/v3/sales/{saleId}/incomes](https://cplug.redocly.app/openapi/sales/get-sale-incomes.md): Retorna os recebimentos de uma venda. ## Pedidos de Venda Operações de pedidos de venda. ### Lista de pedidos de venda - [GET /api/v3/sale-orders](https://cplug.redocly.app/openapi/saleorders/get-sale-orders.md): Retorna lista de pedidos de Venda. ### Cria um novo pedido de venda - [POST /api/v3/sale-orders](https://cplug.redocly.app/openapi/saleorders/post-sale-orders.md): Cria um novo pedido de venda com status em aberto. ### Converte um pedido de venda em uma venda - [POST /api/v3/sale-orders/convert-to-sale](https://cplug.redocly.app/openapi/saleorders/post-sale-orders-convert-to-sale.md): Converte um pedido de venda em uma venda. ### Obtém um pedido de venda - [GET /api/v3/sale-orders/{saleOrderId}](https://cplug.redocly.app/openapi/saleorders/get-sale-orders-ids.md): Resgata um pedido de venda. ### Atualiza um pedido de venda - [PUT /api/v3/sale-orders/{saleOrderId}](https://cplug.redocly.app/openapi/saleorders/put-sale-orders.md): Atualiza um pedido de venda. Só permite que o pedido seja atualizado enquanto ele estiver em aberto, caso contrário, não será possível. ### Apaga um pedido de venda - [DELETE /api/v3/sale-orders/{saleOrderId}](https://cplug.redocly.app/openapi/saleorders/delete-sale-orders-id.md): Apaga um pedido de venda. ### Download PDF de um pedido de venda - [GET /api/v3/sale-orders/{saleOrderId}/download-pdf](https://cplug.redocly.app/openapi/saleorders/get-sale-order-download-pdf.md): Retorna o blob do PDF do pedido de venda. ### Imprimir um pedido de venda - [GET /api/v3/sale-orders/{saleOrderId}/print](https://cplug.redocly.app/openapi/saleorders/get-sale-order-print.md): Retorna o HTML do pedido de venda. ### Atualiza um status de pedido de venda - [PUT /api/v3/sale-orders/{saleOrderId}/status](https://cplug.redocly.app/openapi/saleorders/put-sale-orders-status.md): Atualiza um status de pedido de venda. ### Envia o recibo de pedido de venda por e-mail - [POST /api/v3/sale-orders/{saleOrderId}/send-receipt-by-email](https://cplug.redocly.app/openapi/saleorders/post-sale-orders-send-receipt-by-email.md): Envia o recibo de pedido de venda por e-mail. ## Clientes Operações de cadastro de clientes. ### Lista de clientes - [GET /api/v3/customers](https://cplug.redocly.app/openapi/customers/get-customers.md): Retorna lista de clientes pessoas física ou jurídica. ### Cria um novo cliente - [POST /api/v3/customers](https://cplug.redocly.app/openapi/customers/post-customers.md): Cria umnovo cliente. ### Obtém um cliente - [GET /api/v3/customers/{customerId}](https://cplug.redocly.app/openapi/customers/get-customers-id.md): Resgata um cliente já existente. ### Atualiza um cliente - [PUT /api/v3/customers/{customerId}](https://cplug.redocly.app/openapi/customers/put-customers.md): Atualiza um cliente já existente. ### Apaga um cliente - [DELETE /api/v3/customers/{customerId}](https://cplug.redocly.app/openapi/customers/delete-customers.md): Apaga um cliente. ### Deleta clientes em massa - [POST /api/v3/customers/batch-delete](https://cplug.redocly.app/openapi/customers/batch-delete-customers.md): Apaga clientes em massa. ### Lista os endereços do cliente - [GET /api/v3/customers/{customerId}/addresses](https://cplug.redocly.app/openapi/customers/get-customers-id-addresses.md): Lista os endereços do cliente. ### Cria ou atualiza endereços - [POST /api/v3/customers/{customerId}/addresses](https://cplug.redocly.app/openapi/customers/post-customers-id-addresses.md): Cria ou atualiza endereços para um cliente. Se na requisição tiver o campo id, então o endereço que possui esse id será atualizado, caso contrário será criado. O Sistema permite que um cliente tenha multiplos endereços do tipo 'other' mas somente um endereço de cada para os tipos 'default' e 'shipping'. Se um novo endereço 'shipping' ou 'default' for enviado, o endereço atual será sobrescrito. ### Apaga um endereço - [DELETE /api/v3/customers/{customerId}/addresses/{addressId}](https://cplug.redocly.app/openapi/customers/delete-customers-id-addresses-id.md): Apaga um endereço. ### Lista os documentos do cliente - [GET /api/v3/customers/{customerId}/documents](https://cplug.redocly.app/openapi/customers/get-customers-id-documents.md): Lista documentos do cliente. ### Salva lista de documentos - [POST /api/v3/customers/{customerId}/documents](https://cplug.redocly.app/openapi/customers/post-customers-id-documents.md): Cria ou atualiza um documento. ### Apaga um documento - [DELETE /api/v3/customers/{customerId}/documents/{documentType}](https://cplug.redocly.app/openapi/customers/delete-customers-id-documents-documenttype.md): Apaga um documento. ## Categoria de Clientes Operações de cadastro de categoria de clientes. ### Lista de categorias de clientes - [GET /api/v3/customer-categories](https://cplug.redocly.app/openapi/customercategory/get-customer-categories.md): Retorna lista de categorias de clientes. ### Cria uma nova categoria de cliente - [POST /api/v3/customer-categories](https://cplug.redocly.app/openapi/customercategory/post-customer-category.md): Cria uma nova categoria de cliente. ### Obtém uma categoria de cliente - [GET /api/v3/customer-categories/{customerCategoryId}](https://cplug.redocly.app/openapi/customercategory/get-customer-category-id.md): Resgata uma categoria de cliente já existente. ### Atualiza uma categoria de cliente - [PUT /api/v3/customer-categories/{customerCategoryId}](https://cplug.redocly.app/openapi/customercategory/put-customer-category.md): Atualiza um categoria de cliente já existente. ### Apaga uma categoria de cliente - [DELETE /api/v3/customer-categories/{customerCategoryId}](https://cplug.redocly.app/openapi/customercategory/delete-customer-category.md): Apaga uma categoria de cliente. ## Status Operações do cadastro dos status na ConnectPlug. ### Lista de status - [GET /api/v3/status](https://cplug.redocly.app/openapi/status/get-status.md): Retorna lista de status. ### Lista de detalhes do status - [GET /api/v3/status/{statusId}/details](https://cplug.redocly.app/openapi/status/get-status-details.md): Retorna lista de detalhes do status. ### Sincroniza detalhes dos status - [PUT /api/v3/status/sync-details](https://cplug.redocly.app/openapi/status/put-status-sync-details.md): Sincroniza detalhes dos status. ## Promoções Operações de promoções. ### Lista de Promoções - [GET /api/v3/promotions](https://cplug.redocly.app/openapi/promotions/get-promotions.md): Retorna uma lista das promoções. ### Cria uma nova promoção - [POST /api/v3/promotions](https://cplug.redocly.app/openapi/promotions/post-promotions.md): Cria uma nova promoção. ### Obtém uma promoção - [GET /api/v3/promotions/{promotionId}](https://cplug.redocly.app/openapi/promotions/get-promotion-id.md): Retorna uma promoção já existente. ### Atualiza uma promoção - [PUT /api/v3/promotions/{promotionId}](https://cplug.redocly.app/openapi/promotions/put-promotions-id.md): Atualiza uma promoção já existente. ### Apaga uma promoção - [DELETE /api/v3/promotions/{promotionId}](https://cplug.redocly.app/openapi/promotions/delete-promotion-id.md): Apaga uma promoção. ### Lista os vouchers de uma promoção - [GET /api/v3/promotions/{promotionId}/vouchers](https://cplug.redocly.app/openapi/promotions/get-promotions-id-vouchers.md): Retorna uma lista dos vouchers de uma promoção. ### Exporta os vouchers de uma promoção - [GET /api/v3/promotions/{promotionId}/vouchers/export](https://cplug.redocly.app/openapi/promotions/get-promotions-id-vouchers-export.md): Exporta um arquivo xlsx com os códigos dos vouchers de uma promoção. ## Caixas Registradoras Operações de caixas registradoras. ### Lista caixas registradoras - [GET /api/v3/cash-registers](https://cplug.redocly.app/openapi/cashregisters/list-cash-registers.md): Retorna uma lista paginada de caixas registradoras. ### Criar caixa registradora - [POST /api/v3/cash-registers](https://cplug.redocly.app/openapi/cashregisters/create-cash-register.md): Cria uma nova caixa registradora. ### Obter caixa registradora - [GET /api/v3/cash-registers/{cashRegisterId}](https://cplug.redocly.app/openapi/cashregisters/get-cash-register.md): Resgata uma caixa registradora já existente. ### Atualizar caixa registradora - [PUT /api/v3/cash-registers/{cashRegisterId}](https://cplug.redocly.app/openapi/cashregisters/update-cash-register.md): Atualiza uma caixa registradora existente. ### Excluir caixa registradora - [DELETE /api/v3/cash-registers/{cashRegisterId}](https://cplug.redocly.app/openapi/cashregisters/delete-cash-register.md): Exclui uma caixa registradora existente. ## PDV Operações de PDV. ### Abrir caixa - [POST /api/v3/pos/{posId}/drawer-open](https://cplug.redocly.app/openapi/pos/open-pos.md): Abre um caixa do PDV. ### Fechar caixa - [POST /api/v3/pos/{posId}/drawer-close](https://cplug.redocly.app/openapi/pos/close-pos.md): Fecha um caixa do PDV. ### Listar fechamentos de caixa - [GET /api/v3/pos/drawer-list](https://cplug.redocly.app/openapi/pos/get-drawer-list.md): Lista todos os fechamentos de caixa do PDV. ### Listar vendas de um fechamento de caixa - [GET /api/v3/pos/drawer-list/{drawerListId}/sales](https://cplug.redocly.app/openapi/pos/get-drawer-list-sales.md): Lista todas as vendas de um fechamento de caixa. ## Séries de Comandas Operações de séries de comandas. ### Lista de séries de comanda - [GET /api/v3/command-series](https://cplug.redocly.app/openapi/commandseries/get-command-series.md): Retorna lista de séries de comanda. ### Cria nova série de comanda - [POST /api/v3/command-series](https://cplug.redocly.app/openapi/commandseries/post-command-series.md): Cria uma nova série de comanda. ### Obtém uma série de comanda - [GET /api/v3/command-series/{commandSeriesId}](https://cplug.redocly.app/openapi/commandseries/get-command-series-by-id.md): Retorna uma série de comanda. ### Atualiza uma série de comanda - [PUT /api/v3/command-series/{commandSeriesId}](https://cplug.redocly.app/openapi/commandseries/put-command-series.md): Atualiza uma série de comanda já existente. ### Apaga uma série de comanda - [DELETE /api/v3/command-series/{commandSeriesId}](https://cplug.redocly.app/openapi/commandseries/delete-command-series.md): Apaga uma série de comanda. ## Aplicativos Operações do cadastro dos aplicativos ConnectPlug. ### Lista de aplicativos - [GET /api/v3/apps](https://cplug.redocly.app/openapi/applications/get-apps.md): Retorna lista dos aplicativos disponíveis. ### Cria novo aplicativo - [POST /api/v3/apps](https://cplug.redocly.app/openapi/applications/post-apps.md): Cria novo aplicativo. ### Obtém um aplicativo - [GET /api/v3/apps/{appId}](https://cplug.redocly.app/openapi/applications/get-apps-id.md): Obtém as informações de um aplicativo. ### Atualiza um aplicativo - [PUT /api/v3/apps/{appId}](https://cplug.redocly.app/openapi/applications/put-apps.md): Atualiza um aplicativo já existente. ### Apaga um aplicativo - [DELETE /api/v3/apps/{appId}](https://cplug.redocly.app/openapi/applications/delete-apps.md): Apaga um aplicativo. ### Restaurar um aplicativo - [PUT /api/v3/apps/{appId}/restore](https://cplug.redocly.app/openapi/applications/put-apps-id-restore.md): Restaura um aplicativo que foi apagado. ### Duplicar aplicativo - [POST /api/v3/apps/{appId}/duplicate](https://cplug.redocly.app/openapi/applications/post-apps-id-duplicate.md): Duplica um aplicativo já existente. ### Atualiza logo do aplicativo - [POST /api/v3/apps/{appId}/image](https://cplug.redocly.app/openapi/applications/post-apps-image.md): Adiciona ou substitui a imagem principal (logo) do aplicativo. Este endpoint aceita solicitações HTTP no formato JSON. A imagem deve ser do tipo JPEG ou PNG encodada em base64, seguindo o exemplo: curl --location --request POST 'http://{BASE_URL}/api/v3/apps/{appId}/image' \ --header 'Authorization: Bearer TOKEN' \ --header 'Content-Type: application/json' \ --data-raw '{ "image": "data:image/png;base64," }' O tamanho máximo do arquivo é 5 MB. ### Lista de aplicativos por canal de venda - [GET /api/v3/apps/grouped-by-source](https://cplug.redocly.app/openapi/applications/get-apps-grouped-by-source.md): Retorna uma lista de aplicativos agrupados por canais de venda. ## ↳ Administração de aplicativos Operações gerais de aplicativos. ### Revogar licença - [POST /api/v3/apps/{appId}/revoke-license](https://cplug.redocly.app/openapi/appadministration/post-apps-id-revoke-license.md): Revoga as licenças existentes de um aplicativo do tipo Server e gera uma nova licença. Esta operação requer: - Confirmação através da senha do usuário - Frase de confirmação específica ("revogar") para evitar revogações acidentais - O aplicativo deve ser do tipo Server Atenção: Esta operação invalidará todas as licenças existentes do aplicativo e gerará uma nova licença. Dispositivos conectados com as licenças antigas perderão o acesso até serem reconfigurados com a nova licença. ### Gerenciar configurações da VPN - [POST /api/v3/apps/{appId}/tefs/{action}](https://cplug.redocly.app/openapi/appadministration/post-apps-tefs-action.md): Gerencia as configurações da VPN para aplicativos do tipo totem e terminal. Aplicativos permitidos: Apenas aplicativos do tipo totem e terminal são permitidos para operações de VPN. Ações disponíveis: - install: Instala uma nova configuração de VPN. Requer payload com name e opcionalmente ip. - reinstall: Reinstala a configuração de VPN existente. Só é possível se o app já tiver informações da VPN instaladas. - cancel: Cancela/remove a configuração de VPN existente. Só é possível se o app já tiver informações da VPN instaladas. ### Obtém credenciais do aplicativo - [GET /api/v3/apps/{appId}/credentials](https://cplug.redocly.app/openapi/appadministration/get-apps-credentials.md): Obtém as credenciais de acesso (login_code e PIN) para um aplicativo específico que suporta autenticação via PIN. Tipos de aplicativo suportados: - TOTEM - DIGITAL-MENU - DESKTOP - POS-A - MOBILE-APP - ORDERSHEET-CHECK - REALTIME-MANAGEMENT - KDS-ANDROID - POS-TEF - CONFERENCE-APP Comportamento do PIN: - Gerado automaticamente quando não existe ou está expirado - Válido por 90 segundos - Formato: número de 6 dígitos (100000-999999) - Apenas um dispositivo pode usar a licença por vez ### Enviar sincronização para aplicativos - [POST /api/v3/apps/syncs](https://cplug.redocly.app/openapi/appadministration/post-apps-syncs.md): Envia uma sincronização para os aplicativos informados. ### Confirmar sincronização de aplicativos - [PUT /api/v3/apps/syncs/{notificationId}/confirm](https://cplug.redocly.app/openapi/appadministration/put-apps-syncs-notificationid-confirm.md): Confirma a sincronização de aplicativos. ## ↳ Produtos de um aplicativo Operações de disponibilidade de um produto. ### Lista os produtos - [GET /api/v3/apps/{appId}/items](https://cplug.redocly.app/openapi/appproducts/get-app-products.md): Lista os produtos de um aplicativo. ### Cria ou atualiza produtos - [PUT /api/v3/apps/{appId}/items](https://cplug.redocly.app/openapi/appproducts/put-app-products.md): Cria ou atualiza produtos em um aplicativo. ### Lista as opções de um produto - [GET /api/v3/apps/{appId}/items/{productId}/options](https://cplug.redocly.app/openapi/appproducts/get-apps-item-options.md): Lista as opções de um produto em um aplicativo. ### Cria ou atualiza as opções do produto - [PUT /api/v3/apps/{appId}/items/{productId}/options](https://cplug.redocly.app/openapi/appproducts/put-apps-item-options.md): Cria ou atualiza as opções do produto em um aplicativo. ### Apaga uma opção de um produto - [DELETE /api/v3/apps/{appId}/items/{productId}/options/{optionId}](https://cplug.redocly.app/openapi/appproducts/delete-apps-item-options.md): Apaga uma opção de um produto no aplicativo. ### Lista as grades de preço de um produto - [GET /api/v3/apps/{appId}/items/{productId}/grids](https://cplug.redocly.app/openapi/appproducts/get-apps-item-grids.md): Lista as grades de preço de um produto. ### Cria ou atualiza as grades de preço de um produto - [PUT /api/v3/apps/{appId}/items/{productId}/grids](https://cplug.redocly.app/openapi/appproducts/put-apps-item-grids.md): Cria ou atualiza as grades de preço de um produto em um aplicativo. ### Apaga uma grade de preço de um produto - [DELETE /api/v3/apps/{appId}/items/{productId}/grids/{gridId}](https://cplug.redocly.app/openapi/appproducts/delete-apps-item-grids.md): Apaga uma grade de preço de um produto. ## ↳ Categorias de produtos de um aplicativo Operações de disponibilidade de uma categoria. ### Lista as categorias de produto - [GET /api/v3/apps/{appId}/categories](https://cplug.redocly.app/openapi/appcategories/get-app-products-categories.md): Lista as categorias de produto vinculadas ao aplicativo. ### Cria ou atualiza categorias de produto - [PUT /api/v3/apps/{appId}/categories](https://cplug.redocly.app/openapi/appcategories/put-app-products-categories.md): Cria ou atualiza categorias de produtos vinculadas ao aplicativo. ### Apaga uma categoria de produto do aplicativo - [DELETE /api/v3/apps/{appId}/categories/{categoryId}](https://cplug.redocly.app/openapi/appcategories/delete-app-product-category.md): Apaga uma categoria de produto do aplicativo. ## ↳ Métodos de pagamento de um aplicativo Operações de métodos de pagamento do aplicativo. ### Lista métodos de pagamento - [GET /api/v3/apps/{appId}/payment-methods](https://cplug.redocly.app/openapi/apppaymentmethods/getapppaymentmethods.md): Lista os métodos de pagamento vinculados ao aplicativo. ### Sincroniza métodos de pagamento - [PUT /api/v3/apps/{appId}/payment-methods/sync](https://cplug.redocly.app/openapi/apppaymentmethods/post-app-payment-methods-sync.md): Sincroniza os métodos de pagamento do aplicativo. ## ↳ Contrato de cartão de um aplicativo Operações de contratos de cartão do aplicativo. ### Vincular contrato de cartão - [PATCH /api/v3/apps/{appId}/card-contracts/{cardContractId}](https://cplug.redocly.app/openapi/appcardcontracts/patch-apps-card-contract.md): Permite associar um contrato de cartão ao aplicativo. ### Desvincular contrato de cartão - [DELETE /api/v3/apps/{appId}/card-contracts/{cardContractId}](https://cplug.redocly.app/openapi/appcardcontracts/delete-apps-card-contract.md): Permite desvincular um contrato de cartão do aplicativo. ## Transações Financeiras Operações de movimentações financeiras (Contas a pagar e Contas a receber). ### Lista de transações financeiras - [GET /api/v3/financial/transactions](https://cplug.redocly.app/openapi/finances/get-financial-transactions.md): Retorna lista das transações financeiras (Contas a pagar e Contas a receber). ### Cria uma transação financeira - [POST /api/v3/financial/transactions](https://cplug.redocly.app/openapi/finances/post-financial-transactions.md): Cria uma transação financeira (Conta a pagar ou Conta a receber). Para criar uma movimentação de conta a pagar, é necessário que o campo type seja preenchido com expense. Para criar uma movimentação de conta a receber, é necessário que o campo type seja preenchido com income. ### Obtém uma transação financeira - [GET /api/v3/financial/transactions/{transactionId}](https://cplug.redocly.app/openapi/finances/get-financial-transaction.md): Obtém uma transação financeira (Conta a pagar ou Conta a receber). ### Atualiza uma transação financeira - [PUT /api/v3/financial/transactions/{transactionId}](https://cplug.redocly.app/openapi/finances/put-financial-transactions.md): Atualiza uma transação financeira (Conta a pagar ou Conta a receber). ### Apaga uma transação financeira - [DELETE /api/v3/financial/transactions/{transactionId}](https://cplug.redocly.app/openapi/finances/delete-financial-transaction.md): Apaga uma transação financeira (Conta a pagar ou Conta a receber). ### Transações financeiras de um agrupamento - [GET /api/v3/financial/transactions/{transactionId}/groupings](https://cplug.redocly.app/openapi/finances/get-financial-transactions-grouping.md): Retorna lista das transações financeiras (Contas a pagar e Contas a receber) de um agrupamento. ### Adiciona um anexo - [POST /api/v3/financial/transactions/{transactionId}/files](https://cplug.redocly.app/openapi/finances/post-financial-transactions-files.md): Adiciona um novo arquivo para anexar à transação financeira. Este endpoint aceita solicitações HTTP no formato Form-Data. Veja um exemplo: curl --location 'http://{BASE_URL}/api/v3/financial-transactions/{transactionId}/files' \ --header 'CPlug-Company-Id: COMPANY_ID' \ --header 'Idempotency-Key: IDEMPOTENCY_KEY' \ --header 'Authorization: Bearer TOKEN' \ --form 'file[]=@"/path/to/file.png"' --form 'file[]=@"/path/to/file2.png"' O tamanho máximo do arquivo é 5 MB. ### Apaga um anexo - [DELETE /api/v3/financial/transactions/{transactionId}/files/{fileId}](https://cplug.redocly.app/openapi/finances/delete-financial-transactions-files.md): Apaga um anexo de transação financeira. ## Plano de Contas Operações de plano de contas. ### Lista de plano de contas - [GET /api/v3/financial/account-plans](https://cplug.redocly.app/openapi/accountplan/get-financial-account-plans.md): Retorna a lista de plano de contas. ### Cria um plano de contas - [POST /api/v3/financial/account-plans](https://cplug.redocly.app/openapi/accountplan/post-financial-account-plans.md): Cria um plano de contas. ### Atualiza um plano de contas - [PUT /api/v3/financial/account-plans/{accountPlanId}](https://cplug.redocly.app/openapi/accountplan/put-financial-account-plans.md): Atualiza um plano de contas. ### Apaga um plano de contas - [DELETE /api/v3/financial/account-plans/{accountPlanId}](https://cplug.redocly.app/openapi/accountplan/delete-financial-account-plans.md): Apaga um plano de contas. ## Métodos de Pagamentos Operações do cadastro de métodos de pagamentos. ### Lista de formas de pagamentos - [GET /api/v3/payments](https://cplug.redocly.app/openapi/payments/get-payments.md): Retorna lista de formas de pagamentos disponíveis. ### Cria novo método de pagamento - [POST /api/v3/payments](https://cplug.redocly.app/openapi/payments/post-payments.md): Cria novo método de pagamento. ### Obtém método de pagamento - [GET /api/v3/payments/{paymentId}](https://cplug.redocly.app/openapi/payments/get-payments-id.md): Resgata um método de pagamento já existente. ### Atualiza método de pagamento - [PUT /api/v3/payments/{paymentId}](https://cplug.redocly.app/openapi/payments/put-payments.md): Atualiza um método de pagamento já existente. ### Apaga método de pagamento - [DELETE /api/v3/payments/{paymentId}](https://cplug.redocly.app/openapi/payments/delete-payments.md): Apaga um método de pagamento. ## Contas Bancárias Operações de cadastro de contas bancárias. ### Lista de contas bancárias - [GET /api/v3/bank-accounts](https://cplug.redocly.app/openapi/bankaccounts/get-bank-accounts.md): Retorna lista de contas bancárias. ### Cria nova conta bancária - [POST /api/v3/bank-accounts](https://cplug.redocly.app/openapi/bankaccounts/post-bank-accounts.md): Cria uma nova conta bancária. ### Obtém uma conta bancária - [GET /api/v3/bank-accounts/{bankAccountId}](https://cplug.redocly.app/openapi/bankaccounts/get-bank-account.md): Retorna uma conta bancária. ### Atualiza uma conta bancária - [PUT /api/v3/bank-accounts/{bankAccountId}](https://cplug.redocly.app/openapi/bankaccounts/put-bank-account.md): Atualiza uma conta bancária já existente. ### Apaga uma conta bancária - [DELETE /api/v3/bank-accounts/{bankAccountId}](https://cplug.redocly.app/openapi/bankaccounts/delete-bank-account.md): Apaga uma conta bancária. ### Obtém o histórico de uma conta bancária - [GET /api/v3/bank-accounts/{bankAccountId}/history](https://cplug.redocly.app/openapi/bankaccounts/get-bank-account-history.md): Retorna o histórico de uma conta bancária. ### Obtém as movimentações de uma conta bancária - [GET /api/v3/bank-accounts/{bankAccountId}/transactions](https://cplug.redocly.app/openapi/bankaccounts/get-bank-account-transactions.md): Retorna as movimentações de uma conta bancária. ## Centros de custos Operações de cadastro de centros de custos. ### Lista dos centros de custos - [GET /api/v3/cost-centers](https://cplug.redocly.app/openapi/costcenters/get-cost-centers.md): Retorna lista dos centros de custos disponíveis. ### Cria um centro de custo - [POST /api/v3/cost-centers](https://cplug.redocly.app/openapi/costcenters/post-cost-centers.md): Cria um centro de custo. ### Obtém um centro de custo - [GET /api/v3/cost-centers/{costCenterId}](https://cplug.redocly.app/openapi/costcenters/get-cost-centers-id.md): Resgata um centro de custo já existente. ### Atualiza um centro de custo - [PUT /api/v3/cost-centers/{costCenterId}](https://cplug.redocly.app/openapi/costcenters/put-cost-center.md): Atualiza um centro de custo já existente. ### Apaga um centro de custo - [DELETE /api/v3/cost-centers/{costCenterId}](https://cplug.redocly.app/openapi/costcenters/delete-cost-centers.md): Apaga um centro de custo. ## Contratos de cartão Operações de contratos de cartão. ### Lista de contratos de cartão - [GET /api/v3/cards/contracts](https://cplug.redocly.app/openapi/cardcontracts/get-cards-contracts.md): Retorna lista de contratos de cartão. ### Criar um novo contrato de cartão - [POST /api/v3/cards/contracts](https://cplug.redocly.app/openapi/cardcontracts/post-cards-contracts.md): Cria um novo contrato de cartão. ### Obtém um contrato de cartão - [GET /api/v3/cards/contracts/{cardContractId}](https://cplug.redocly.app/openapi/cardcontracts/get-single-cards-contract.md): Retorna um contrato de cartão. ### Atualiza um contrato de cartão - [PUT /api/v3/cards/contracts/{cardContractId}](https://cplug.redocly.app/openapi/cardcontracts/put-cards-contract.md): Atualiza um contrato de cartão. ### Apaga um contrato de cartão - [DELETE /api/v3/cards/contracts/{cardContractId}](https://cplug.redocly.app/openapi/cardcontracts/delete-cards-contract.md): Apaga um contrato de cartão. ## Provedores de cartão Operações de provedores de cartão. ### Lista de provedores de cartão - [GET /api/v3/cards/providers](https://cplug.redocly.app/openapi/cardproviders/get-cards-providers.md): Retorna lista de provedores de cartão. ## Grupos Financeiros Operações de grupos financeiros. ### Lista de grupos financeiros - [GET /api/v3/financial/groups](https://cplug.redocly.app/openapi/financialgroup/get-financial-groups.md): Retorna a lista de grupos financeiros. ### Cria um grupo financeiro - [POST /api/v3/financial/groups](https://cplug.redocly.app/openapi/financialgroup/post-financial-accounts.md): Cria um grupo financeiro. ### Atualiza um grupo financeiro - [PUT /api/v3/financial/groups/{groupId}](https://cplug.redocly.app/openapi/financialgroup/put-financial-group.md): Atualiza um grupo financeiro. ### Apaga um grupo financeiro - [DELETE /api/v3/financial/groups/{groupId}](https://cplug.redocly.app/openapi/financialgroup/delete-financial-group.md): Apaga um grupo financeiro. ## Bandeiras de cartão Operações de bandeiras de cartão. ### Lista de bandeiras de cartões - [GET /api/v3/cards/brands](https://cplug.redocly.app/openapi/cardbrands/get-cards-brands.md): Retorna lista de bandeiras de cartões. ## Bancos Operações de cadastro de bancos. ### Lista de bancos - [GET /api/v3/banks](https://cplug.redocly.app/openapi/banks/get-banks.md): Retorna lista de bancos. ## Conciliação bancária Operações de conciliação bancária. ### Lista de conciliações bancárias - [GET /api/v3/reconciliations](https://cplug.redocly.app/openapi/reconciliations/get-reconciliations.md): Retorna lista das conciliações bancárias disponíveis. ### Upload de um arquivo de conciliação bancária - [POST /api/v3/reconciliations/import](https://cplug.redocly.app/openapi/reconciliations/post-reconciliations-import.md): Upload de um arquivo de conciliação bancária. Este endpoint aceita solicitações HTTP no formato Form-Data. Veja um exemplo: ``` curl --location 'http://{BASE_URL}/api/v3/reconciliations/import' \ --header 'CPlug-Company-Id: COMPANY_ID' \ --header 'Idempotency-Key: IDEMPOTENCY_KEY' \ --header 'Authorization: Bearer TOKEN' \ --form 'file=@"/path/to/reconciliation.ofx"' ### Apaga uma conciliação bancária - [DELETE /api/v3/reconciliations/{reconciliationId}](https://cplug.redocly.app/openapi/reconciliations/delete-reconciliation.md): Apaga uma conciliação bancária. ### Obtém uma conciliação bancária - [GET /api/v3/reconciliations/{reconciliationId}](https://cplug.redocly.app/openapi/reconciliations/get-reconciliation.md): Resgata uma conciliação bancária. ### Download do arquivo de uma conciliação bancária - [GET /api/v3/reconciliations/{reconciliationId}/download](https://cplug.redocly.app/openapi/reconciliations/get-download-reconciliation-file.md): Faz o download do arquivo OFX original enviado na conciliação bancária. ### Lista de transações de uma conciliação bancária - [GET /api/v3/reconciliations/{reconciliationId}/transactions](https://cplug.redocly.app/openapi/reconciliations/get-reconciliations-transactions.md): Retorna lista das transações de uma conciliação bancária. ### Apaga uma transação de uma conciliação bancária - [DELETE /api/v3/reconciliations/{reconciliationId}/transactions/{transactionId}](https://cplug.redocly.app/openapi/reconciliations/delete-reconciliation-transaction.md): Apaga uma transação de uma conciliação bancária. ### Lista de sugestões de transações de uma conciliação bancária - [GET /api/v3/reconciliations/{reconciliationId}/transactions/{transactionId}/suggestions](https://cplug.redocly.app/openapi/reconciliations/get-reconciliations-transactions-suggestions.md): Retorna lista de sugestões de transações de uma conciliação bancária. ### Concilia uma transação bancária - [POST /api/v3/reconciliations/{reconciliationId}/transactions/reconcile](https://cplug.redocly.app/openapi/reconciliations/post-reconciliations-reconcile.md): Faz a conciliação de uma transação de uma conciliação bancária. ### Restaura uma transação bancária - [POST /api/v3/reconciliations/{reconciliationId}/transactions/restore](https://cplug.redocly.app/openapi/reconciliations/post-reconciliations-restore.md): Restaura uma transação de uma conciliação bancária. ### Desconcilia uma transação bancária - [POST /api/v3/reconciliations/{reconciliationId}/transactions/unreconcile](https://cplug.redocly.app/openapi/reconciliations/post-reconciliations-unreconcile.md): Desconcilia uma transação de uma conciliação bancária. ## Configurações gerais do ERP Operações de configurações gerais do ERP. ### Lista as configurações do ERP - [GET /api/v3/settings/erp](https://cplug.redocly.app/openapi/erpsettings/get-settings-erp.md): Retorna as configurações do ERP. ### Atualiza as configurações do ERP - [PATCH /api/v3/settings/erp](https://cplug.redocly.app/openapi/erpsettings/patch-settings-erp.md): Atualiza as configurações do ERP. ## Configurações gerais do terminal Configurações gerais do terminal. ### Lista as configurações do terminal - [GET /api/v3/settings/terminal](https://cplug.redocly.app/openapi/terminalsettings/get-settings-terminal.md): Retorna as configurações do terminal. ### Atualiza as configurações do terminal - [PATCH /api/v3/settings/terminal](https://cplug.redocly.app/openapi/terminalsettings/put-settings-terminal.md): Atualiza as configurações do terminal. ## Configurações gerais do totem Configurações gerais do totem. ### Lista as configurações do Totem - [GET /api/v3/settings/totem](https://cplug.redocly.app/openapi/totemsettings/get-totem-settings.md): Retorna as configurações do Totem. ### Atualiza as configurações do Totem - [PUT /api/v3/settings/totem](https://cplug.redocly.app/openapi/totemsettings/put-totem-settings.md): Atualiza as configurações do Totem existente com novas configurações. ## Monitor de pedidos (KDS) Operações de monitoração de pedidos. ### Lista os KDS - [GET /api/v3/kds](https://cplug.redocly.app/openapi/kds/get-kds.md): Retorna lista os KDS. ### Cria um novo KDS - [POST /api/v3/kds](https://cplug.redocly.app/openapi/kds/post-kds.md): Cria um novo KDS. ### Obtém um KDS - [GET /api/v3/kds/{kdsId}](https://cplug.redocly.app/openapi/kds/get-kds-by-id.md): Retorna um KDS. ### Atualiza um KDS - [PUT /api/v3/kds/{kdsId}](https://cplug.redocly.app/openapi/kds/put-kds.md): Atualiza um KDS. ### Apaga um KDS - [DELETE /api/v3/kds/{kdsId}](https://cplug.redocly.app/openapi/kds/delete-kds.md): Apaga um KDS. ## Painel de Senha Configurações do painel de senha do PDV. ### Lista as configurações do painel de senha - [GET /api/v3/settings/password-panel](https://cplug.redocly.app/openapi/passwordpanel/get-password-panel.md): Retorna as configurações do painel de senha da empresa logada. ### Atualiza as configurações do painel de senha - [PUT /api/v3/settings/password-panel](https://cplug.redocly.app/openapi/passwordpanel/put-password-panel.md): Atualiza as configurações do painel de senha da empresa logada. ## Customizações Operações de customizações. ### Lista de customizações - [GET /api/v3/customizations](https://cplug.redocly.app/openapi/customizations/get-customizations.md): Retorna lista de customizações cadastradas. ### Cria uma nova customização - [POST /api/v3/customizations](https://cplug.redocly.app/openapi/customizations/post-customizations.md): Cria uma nova customização. ### Obtém uma customização - [GET /api/v3/customizations/{customizationId}](https://cplug.redocly.app/openapi/customizations/get-customization.md): Retorna uma customização específica. ### Atualiza uma customização - [PUT /api/v3/customizations/{customizationId}](https://cplug.redocly.app/openapi/customizations/put-customization.md): Atualiza uma customização existente. ### Apaga uma customização - [DELETE /api/v3/customizations/{customizationId}](https://cplug.redocly.app/openapi/customizations/delete-customization.md): Apaga uma customização existente. ### Adiciona uma mídia em uma customização - [POST /api/v3/customizations/{customizationId}/media](https://cplug.redocly.app/openapi/customizations/post-customization-media.md): Adiciona uma mídia (imagem ou vídeo) em uma customização. ### Apaga uma mídia de uma customização - [DELETE /api/v3/customizations/{customizationId}/media/{mediaId}](https://cplug.redocly.app/openapi/customizations/delete-customization-media.md): Apaga uma mídia específica de uma customização. ## Mesas Operações de mesas. ### Lista de mesas - [GET /api/v3/tables](https://cplug.redocly.app/openapi/tables/get-tables.md): Retorna lista das mesas disponíveis. ### Cria uma nova mesa - [POST /api/v3/tables](https://cplug.redocly.app/openapi/tables/post-tables.md): Cria uma nova mesa. ### Obtém uma mesa - [GET /api/v3/tables/{tableId}](https://cplug.redocly.app/openapi/tables/get-table.md): Resgata uma mesa já existente. ### Atualiza uma mesa - [PUT /api/v3/tables/{tableId}](https://cplug.redocly.app/openapi/tables/put-table.md): Atualiza uma mesa já existente. ### Apaga uma mesa - [DELETE /api/v3/tables/{tableId}](https://cplug.redocly.app/openapi/tables/delete-table.md): Apaga uma mesa. ### Restaura uma mesa excluída - [POST /api/v3/tables/{tableId}/restore](https://cplug.redocly.app/openapi/tables/post-table-id-restore.md): Restaura uma mesa excluída. ### Cria novas mesas em massa - [POST /api/v3/tables/batch](https://cplug.redocly.app/openapi/tables/post-tables-batch.md): Cria novas mesas em massa. ## Ícones Lista de ícones. ### Lista de ícones - [GET /api/v3/icons](https://cplug.redocly.app/openapi/icons/get-icons.md): Retorna uma lista de ícones. ### Cria um novo ícone - [POST /api/v3/icons](https://cplug.redocly.app/openapi/icons/create-icon.md): Cria um novo ícone. ### Obtém um ícone - [GET /api/v3/icons/{iconId}](https://cplug.redocly.app/openapi/icons/get-icon-by-id.md): Retorna um ícone. ### Atualiza um ícone - [PUT /api/v3/icons/{iconId}](https://cplug.redocly.app/openapi/icons/update-icons-id.md): Atualiza um ícone. ### Apaga um ícone - [DELETE /api/v3/icons/{iconId}](https://cplug.redocly.app/openapi/icons/delete-icon.md): Apaga um Icone. ## Áreas de Entrega Operações de cadastro de áreas de entrega. ### Lista de áreas de entrega - [GET /api/v3/delivery-areas](https://cplug.redocly.app/openapi/deliveryareas/get-delivery-areas.md): Retorna uma lista de áreas de entrega. ### Cria uma área de entrega - [POST /api/v3/delivery-areas](https://cplug.redocly.app/openapi/deliveryareas/post-delivery-areas.md): Cria uma nova área de entrega. Atenção: Não é permitido criar áreas de entrega quando existe uma taxa fixa configurada. ### Obtém uma área de entrega - [GET /api/v3/delivery-areas/{deliveryAreaId}](https://cplug.redocly.app/openapi/deliveryareas/get-delivery-area-id.md): Retorna uma lista de áreas de entrega. ### Atualiza uma área de entrega - [PUT /api/v3/delivery-areas/{deliveryAreaId}](https://cplug.redocly.app/openapi/deliveryareas/put-delivery-area-id.md): Atualiza uma área de entrega já existente. ### Apaga uma área de entrega - [DELETE /api/v3/delivery-areas/{deliveryAreaId}](https://cplug.redocly.app/openapi/deliveryareas/delete-delivery-areas.md): Apaga uma área de entrega. ## Horário de funcionamento Operações do cadastro de horário de funcionamento. ### Lista de horários de funcionamento - [GET /api/v3/opening-hours](https://cplug.redocly.app/openapi/openinghours/get-opening-hours.md): Retorna lista dos horários de funcionamento. ### Sincroniza horários de funcionamento - [PUT /api/v3/opening-hours](https://cplug.redocly.app/openapi/openinghours/sync-opening-hours.md): Sincroniza lista dos horários de funcionamento. ## Configurações do Whitelabel Operações de configurações do whitelabel incluindo informações da empresa, contatos, cores e conteúdos. ### Configurações do whitelabel - [GET /api/v3/whitelabel/settings](https://cplug.redocly.app/openapi/whitelabelsettings/get-whitelabel-settings.md): Retorna as configurações do whitelabel incluindo informações da empresa, contatos, cores, conteúdos e outras configurações visuais. ## Etiquetas Operações de etiquetas. ### Lista de etiquetas - [GET /api/v3/labels](https://cplug.redocly.app/openapi/labels/get-labels.md): Retorna lista de etiquetas para impressão. ### Cria uma nova etiqueta - [POST /api/v3/labels](https://cplug.redocly.app/openapi/labels/post-labels.md): Cria uma nova etiqueta para impressão. ### Gera PDF de etiquetas - [POST /api/v3/labels/download](https://cplug.redocly.app/openapi/labels/post-labels-download.md): Gera um arquivo PDF com as etiquetas dos produtos especificados, permitido apenas para modelos de impressão PDF. ### Prepara etiquetas para impressão - [POST /api/v3/labels/print](https://cplug.redocly.app/openapi/labels/post-labels-print.md): Prepara os dados das etiquetas para envio à impressora, permitido apenas para modelos de impressão PPLA ou BPLB. ### Visualiza uma etiqueta - [GET /api/v3/labels/{labelId}](https://cplug.redocly.app/openapi/labels/get-label-by-id.md): Retorna os detalhes de uma etiqueta específica. ### Atualiza uma etiqueta - [PUT /api/v3/labels/{labelId}](https://cplug.redocly.app/openapi/labels/put-label.md): Atualiza os dados de uma etiqueta existente. ### Apaga uma etiqueta - [DELETE /api/v3/labels/{labelId}](https://cplug.redocly.app/openapi/labels/delete-labels.md): Apaga uma etiqueta marcando como desabilitada. ## Observações Padrões Operações de observações padrões. ### Lista as observações padrão - [GET /api/v3/standard-observations](https://cplug.redocly.app/openapi/standardobservations/get-standard-observations.md): Retorna uma lista de observações padrão disponíveis no sistema. ### Cria nova observação padrão - [POST /api/v3/standard-observations](https://cplug.redocly.app/openapi/standardobservations/post-standard-observations.md): Cria nova observação padrão. ### Obtém uma observação padrão - [GET /api/v3/standard-observations/{standardObservationId}](https://cplug.redocly.app/openapi/standardobservations/get-standard-observation-id.md): Retorna uma observação padrão específica. ### Atualiza uma observação padrão - [PUT /api/v3/standard-observations/{standardObservationId}](https://cplug.redocly.app/openapi/standardobservations/put-standard-observations-id.md): Atualiza uma observação padrão. ### Deleta uma observação padrão - [DELETE /api/v3/standard-observations/{standardObservationId}](https://cplug.redocly.app/openapi/standardobservations/delete-standard-observations-id.md): Deleta uma observação padrão. ## Bairros Operações de bairros. ### Lista os bairros de uma cidade - [GET /api/v3/settings/districts](https://cplug.redocly.app/openapi/districts/get-settings-districts.md): Retorna os bairros de uma cidade. ### Cria um bairro customizado - [POST /api/v3/settings/districts](https://cplug.redocly.app/openapi/districts/post-settings-districts.md): Cria um bairro customizado. ### Atualiza um bairro customizado - [PUT /api/v3/settings/districts/{id}](https://cplug.redocly.app/openapi/districts/put-settings-districts.md): Atualiza um bairro customizado. ### Apaga um bairro customizado - [DELETE /api/v3/settings/districts/{id}](https://cplug.redocly.app/openapi/districts/delete-settings-districts.md): Apaga um bairro customizado. ## Configurações Fiscais Operações de configurações fiscais da empresa para NF-e. ### Obtém as configurações gerais da NFe - [GET /api/v3/tax-settings/general-settings](https://cplug.redocly.app/openapi/taxsettingsnfe/get-tax-settings-general-settings.md): Retorna as configurações gerais para emissão de NFe/NFCe da empresa, incluindo configurações tributárias, de impostos, autenticação, justificativas padrão, acesso, taxas de serviço e outras configurações específicas. ### Atualiza as configurações gerais da NFe - [PATCH /api/v3/tax-settings/general-settings](https://cplug.redocly.app/openapi/taxsettingsnfe/patch-tax-settings-general-settings.md): Atualiza as configurações fiscais gerais de NFe da empresa. Regras de validação: - Ao menos um objeto deve ser enviado no PATCH - Se is_state_registration_exempt for true, state_registration deve ser vazio ou null - Para remover os xml_authorizeds deve ser enviado um array vazio, se não enviar nada não será atualizado - state_registration_st, além de seguir o mesmo princípio de remoção do xml_authorizeds, não pode enviar estados repetidos - transaction_intermediaries também segue a mesma lógica de remoção do xml_authorizeds - Em payment_settings, se enviar state é obrigatório enviar os dois outros campos. Se state for null ou vazio os outros campos devem ser null ou vazios também, sendo proibido algum valor para eles ## Grupo de ICMS Operações de grupos de ICMS. ### Lista os grupos de ICMS - [GET /api/v3/tax-settings/icms](https://cplug.redocly.app/openapi/icmsgroup/get-tax-settings-icms.md): Retorna uma lista de grupos de ICMS da Empresa. ### Cria um grupo de ICMS - [POST /api/v3/tax-settings/icms](https://cplug.redocly.app/openapi/icmsgroup/post-tax-settings-icms.md): Cria um novo grupo de ICMS com configurações específicas baseadas no grupo tributário. Para informações detalhadas sobre grupos tributários, validações e configurações, consulte a seção 📋 Grupos de ICMS na documentação principal. ### Obtém um grupo de ICMS - [GET /api/v3/tax-settings/icms/{id}](https://cplug.redocly.app/openapi/icmsgroup/get-tax-settings-icms-id.md): Retorna os detalhes completos de um grupo de ICMS específico, incluindo configurações tributárias e percentuais. Para informações detalhadas sobre grupos tributários e suas configurações, consulte a seção 📋 Grupos de ICMS na documentação principal. ### Atualiza um grupo de ICMS - [PUT /api/v3/tax-settings/icms/{id}](https://cplug.redocly.app/openapi/icmsgroup/put-tax-settings-icms-id.md): Atualiza um grupo de ICMS existente com novas configurações. 🔄 Limpeza de Campos: Se alterar o tipo do grupo de ICMS (tributary_group_id), os campos do grupo anterior serão automaticamente limpos e apenas os campos específicos do novo grupo serão aceitos. Para informações detalhadas sobre grupos tributários, validações e configurações, consulte a seção 📋 Grupos de ICMS na documentação principal. ### Apaga um grupo de ICMS - [DELETE /api/v3/tax-settings/icms/{id}](https://cplug.redocly.app/openapi/icmsgroup/delete-tax-settings-icms-id.md): Apaga um grupo de ICMS específico. 🔒 Guarda de Exclusão: Antes de excluir, o sistema verifica se o grupo de ICMS está sendo utilizado como "Taxa de Serviço da NF-e". A validação considera: - Se o campo flg_nfe_service_tax do grupo de ICMS está ativo - Se a configuração da empresa flg_service_tax_product está ativa ⚠️ Se ambas as condições forem verdadeiras, a API retorna um erro 409 Conflict com uma mensagem clara informando que o grupo não pode ser excluído. ✅ Se a validação passar, o grupo de ICMS será excluído permanentemente e a API retorna 204 No Content. ### Define um grupo de ICMS como padrão - [PUT /api/v3/tax-settings/icms/{id}/set-default](https://cplug.redocly.app/openapi/icmsgroup/post-tax-settings-icms-id-set-default.md): Define o grupo de ICMS especificado como o padrão para a empresa. Ao definir um grupo como padrão, todos os outros grupos de ICMS serão marcados como não padrão. ### Lista os grupos tributários - [GET /api/v3/tax-settings/icms/tributary-groups](https://cplug.redocly.app/openapi/icmsgroup/get-tax-settings-icms-tributary-groups.md): Retorna uma lista de grupos tributários de ICMS. ### Lista motivos de desoneração - [GET /api/v3/tax-settings/icms/exemptions](https://cplug.redocly.app/openapi/icmsgroup/get-tax-settings-icms-exemptions.md): Retorna uma lista de motivos de desoneração de ICMS disponíveis para um grupo tributário específico. ## Grupo de IPI Operações de grupos de IPI. ### Lista os grupos de IPI - [GET /api/v3/tax-settings/ipi](https://cplug.redocly.app/openapi/ipigroup/get-tax-settings-ipi.md): Retorna uma lista de grupos de IPI da Empresa. ### Cria um grupo de IPI - [POST /api/v3/tax-settings/ipi](https://cplug.redocly.app/openapi/ipigroup/post-tax-settings-ipi.md): Cria um novo grupo de IPI com configurações específicas baseadas no grupo tributário. Para informações detalhadas sobre grupos tributários, validações e configurações, consulte a seção 📋 Grupos de IPI na documentação principal. ### Obtém um grupo de IPI - [GET /api/v3/tax-settings/ipi/{id}](https://cplug.redocly.app/openapi/ipigroup/get-tax-settings-ipi-id.md): Retorna os detalhes completos de um grupo de IPI específico, incluindo grupo tributário, classificação legal e percentuais. Para informações detalhadas sobre grupos tributários, classificações legais e configurações, consulte a seção 📋 Grupos de IPI na documentação principal. ### Atualiza um grupo de IPI - [PUT /api/v3/tax-settings/ipi/{id}](https://cplug.redocly.app/openapi/ipigroup/put-tax-settings-ipi-id.md): Atualiza um grupo de IPI existente com novas configurações. 🔄 Limpeza de Campos: Se alterar o tipo do grupo de IPI (tributary_group_id), os campos do grupo anterior serão automaticamente limpos e apenas os campos específicos do novo grupo serão aceitos. Para informações detalhadas sobre grupos tributários, validações e configurações, consulte a seção 📋 Grupos de IPI na documentação principal. ### Apaga um grupo de IPI - [DELETE /api/v3/tax-settings/ipi/{id}](https://cplug.redocly.app/openapi/ipigroup/delete-tax-settings-ipi-id.md): Apaga um grupo de IPI específico. ### Define um grupo de IPI como padrão - [PUT /api/v3/tax-settings/ipi/{id}/set-default](https://cplug.redocly.app/openapi/ipigroup/post-tax-settings-ipi-id-set-default.md): Define o grupo de IPI especificado como o padrão para a empresa. Ao definir um grupo como padrão, todos os outros grupos de IPI serão marcados como não padrão. ### Lista os grupos tributários de IPI - [GET /api/v3/tax-settings/ipi/tributary-groups](https://cplug.redocly.app/openapi/ipigroup/get-tax-settings-ipi-tributary-groups.md): Retorna uma lista de grupos tributários de IPI. ### Lista as classificações legais de IPI - [GET /api/v3/tax-settings/ipi/legal-classifications](https://cplug.redocly.app/openapi/ipigroup/get-tax-settings-ipi-legal-classifications.md): Retorna uma lista de classificações legais de IPI. ## Grupo de PIS/COFINS Operações de grupos de PIS/COFINS. ### Lista os grupos de PIS/COFINS - [GET /api/v3/tax-settings/pis-cofins](https://cplug.redocly.app/openapi/piscofinsgroup/get-tax-settings-pis-cofins.md): Retorna uma lista de grupos de PIS/COFINS da Empresa. ### Cria um grupo de PIS/COFINS - [POST /api/v3/tax-settings/pis-cofins](https://cplug.redocly.app/openapi/piscofinsgroup/post-tax-settings-pis-cofins.md): Cria um novo grupo de PIS/COFINS com configurações específicas baseadas nas situações tributárias. Para informações detalhadas sobre situações tributárias, validações e configurações, consulte a seção 📋 Grupos de PIS/COFINS na documentação principal. ### Obtém um grupo de PIS/COFINS - [GET /api/v3/tax-settings/pis-cofins/{id}](https://cplug.redocly.app/openapi/piscofinsgroup/get-tax-settings-pis-cofins-id.md): Retorna os detalhes completos de um grupo de PIS/COFINS específico, incluindo situações tributárias e percentuais configurados. Para informações detalhadas sobre situações tributárias, validações e configurações, consulte a seção 📋 Grupos de PIS/COFINS na documentação principal. ### Atualiza um grupo de PIS/COFINS - [PUT /api/v3/tax-settings/pis-cofins/{id}](https://cplug.redocly.app/openapi/piscofinsgroup/put-tax-settings-pis-cofins-id.md): Atualiza um grupo de PIS/COFINS existente com novas configurações. 🔄 Limpeza de Campos: Se alterar as situações tributárias (pis_tributary_group_id ou cofins_tributary_group_id), os campos de percentual serão automaticamente ajustados conforme as novas situações. ### Apaga um grupo de PIS/COFINS - [DELETE /api/v3/tax-settings/pis-cofins/{id}](https://cplug.redocly.app/openapi/piscofinsgroup/delete-tax-settings-pis-cofins-id.md): Apaga um grupo de PIS/COFINS específico. ### Define um grupo de PIS/COFINS como padrão - [PUT /api/v3/tax-settings/pis-cofins/{id}/set-default](https://cplug.redocly.app/openapi/piscofinsgroup/post-tax-settings-pis-cofins-id-set-default.md): Define o grupo de PIS/COFINS especificado como o padrão para a empresa. Ao definir um grupo como padrão, todos os outros grupos de PIS/COFINS serão marcados como não padrão. ### Lista os grupos tributários de PIS/COFINS - [GET /api/v3/tax-settings/pis-cofins/tributary-groups](https://cplug.redocly.app/openapi/piscofinsgroup/get-tax-settings-pis-cofins-tributary-groups.md): Retorna uma lista de grupos tributários de PIS/COFINS. ## Grupo de ISSQN Operações de grupos de ISSQN. ### Lista os grupos de ISSQN - [GET /api/v3/tax-settings/issqns](https://cplug.redocly.app/openapi/issqngroup/get-tax-settings-issqns.md): Retorna uma lista de grupos de ISSQN da Empresa. ### Cria um grupo de ISSQN - [POST /api/v3/tax-settings/issqns](https://cplug.redocly.app/openapi/issqngroup/post-tax-settings-issqns.md): Cria um novo grupo de ISSQN com configurações específicas para ISS (Imposto Sobre Serviços). Para informações detalhadas sobre indicadores ISS, incentivos fiscais e configurações, consulte a seção 📋 Grupos de ISSQN na documentação principal. ### Obtém um grupo de ISSQN - [GET /api/v3/tax-settings/issqns/{id}](https://cplug.redocly.app/openapi/issqngroup/get-tax-settings-issqns-id.md): Retorna os detalhes completos de um grupo de ISSQN específico, incluindo indicadores ISS e de incentivo fiscal. Para informações detalhadas sobre indicadores ISS, incentivos fiscais e configurações, consulte a seção 📋 Grupos de ISSQN na documentação principal. ### Atualiza um grupo de ISSQN - [PUT /api/v3/tax-settings/issqns/{id}](https://cplug.redocly.app/openapi/issqngroup/put-tax-settings-issqns-id.md): Atualiza um grupo de ISSQN existente com novas configurações. Para informações detalhadas sobre indicadores ISS, incentivos fiscais e configurações, consulte a seção 📋 Grupos de ISSQN na documentação principal. ### Apaga um grupo de ISSQN - [DELETE /api/v3/tax-settings/issqns/{id}](https://cplug.redocly.app/openapi/issqngroup/delete-tax-settings-issqns-id.md): Apaga um grupo de ISSQN específico. ### Define um grupo de ISSQN como padrão - [PUT /api/v3/tax-settings/issqns/{id}/set-default](https://cplug.redocly.app/openapi/issqngroup/put-tax-settings-issqns-id-set-default.md): Define um grupo de ISSQN específico como o padrão da empresa. Quando um grupo é definido como padrão, todos os outros grupos de ISSQN da empresa perdem automaticamente o status de padrão. ## Informações Adicionais da NF-e Operações de informações adicionais da NF-e. ### Lista informações adicionais da NF-e - [GET /api/v3/tax-settings/nfe-additional-infos](https://cplug.redocly.app/openapi/nfeadditionalinfos/get-tax-settings-additional-info-nfe.md): Retorna uma lista de informações adicionais da NF-e da Empresa. ### Cria uma informação adicional da NF-e - [POST /api/v3/tax-settings/nfe-additional-infos](https://cplug.redocly.app/openapi/nfeadditionalinfos/post-tax-settings-additional-info-nfe.md): Cria uma nova informação adicional da NF-e. ### Obtém uma informação adicional da NF-e - [GET /api/v3/tax-settings/nfe-additional-infos/{id}](https://cplug.redocly.app/openapi/nfeadditionalinfos/get-tax-settings-additional-info-nfe-id.md): Retorna os detalhes de uma informação adicional da NF-e específica. ### Atualiza uma informação adicional da NF-e - [PUT /api/v3/tax-settings/nfe-additional-infos/{id}](https://cplug.redocly.app/openapi/nfeadditionalinfos/put-tax-settings-additional-info-nfe-id.md): Atualiza uma informação adicional da NF-e existente. ### Apaga uma informação adicional da NF-e - [DELETE /api/v3/tax-settings/nfe-additional-infos/{id}](https://cplug.redocly.app/openapi/nfeadditionalinfos/delete-tax-settings-additional-info-nfe-id.md): Apaga uma informação adicional da NF-e específica. ## Séries de Notas Fiscais Operações de séries de notas fiscais. ### Lista séries de notas fiscais - [GET /api/v3/tax-settings/invoice-series](https://cplug.redocly.app/openapi/invoiceseries/get-tax-settings-invoice-series.md): Retorna uma lista de séries de notas fiscais da Empresa. ### Cria uma série de nota fiscal - [POST /api/v3/tax-settings/invoice-series](https://cplug.redocly.app/openapi/invoiceseries/post-tax-settings-invoice-series.md): Cria uma nova série de nota fiscal. ### Obtém uma série de nota fiscal - [GET /api/v3/tax-settings/invoice-series/{id}](https://cplug.redocly.app/openapi/invoiceseries/get-tax-settings-invoice-series-id.md): Retorna os detalhes de uma série de nota fiscal específica. ### Atualiza uma série de nota fiscal - [PUT /api/v3/tax-settings/invoice-series/{id}](https://cplug.redocly.app/openapi/invoiceseries/put-tax-settings-invoice-series-id.md): Atualiza uma série de nota fiscal existente. ### Apaga uma série de nota fiscal - [DELETE /api/v3/tax-settings/invoice-series/{id}](https://cplug.redocly.app/openapi/invoiceseries/delete-tax-settings-invoice-series-id.md): Apaga uma série de nota fiscal específica. ## Tipo de Nota Emitida pelo PDV Operações de tipo de nota emitida pelo PDV. ### Obtém o tipo de nota emitida pelo PDV - [GET /api/v3/tax-settings/type-invoice-pdv](https://cplug.redocly.app/openapi/typeinvoicepdv/get-tax-settings-type-invoice-pdv.md): Retorna a configuração do tipo de nota emitida pelo PDV. ### Atualiza o tipo de nota emitida pelo PDV - [PUT /api/v3/tax-settings/type-invoice-pdv](https://cplug.redocly.app/openapi/typeinvoicepdv/put-tax-settings-type-invoice-pdv.md): Atualiza a configuração do tipo de nota emitida pelo PDV. ## Naturezas de Operações Operações de naturezas de operações fiscais. ### Lista naturezas de operações - [GET /api/v3/tax-settings/nature-operations](https://cplug.redocly.app/openapi/natureoperations/get-tax-settings-nature-operations.md): Retorna uma lista de naturezas de operações da Empresa. ### Cria uma natureza de operação - [POST /api/v3/tax-settings/nature-operations](https://cplug.redocly.app/openapi/natureoperations/post-tax-settings-nature-operations.md): Cria uma nova natureza de operação. ### Obtém uma natureza de operação - [GET /api/v3/tax-settings/nature-operations/{id}](https://cplug.redocly.app/openapi/natureoperations/get-tax-settings-nature-operations-id.md): Retorna os detalhes de uma natureza de operação específica. ### Atualiza uma natureza de operação - [PUT /api/v3/tax-settings/nature-operations/{id}](https://cplug.redocly.app/openapi/natureoperations/put-tax-settings-nature-operations-id.md): Atualiza uma natureza de operação existente. ### Apaga uma natureza de operação - [DELETE /api/v3/tax-settings/nature-operations/{id}](https://cplug.redocly.app/openapi/natureoperations/delete-tax-settings-nature-operations-id.md): Apaga uma natureza de operação específica. ## Configurações Fiscais Padrão Operações de configurações fiscais padrão. ### Obtém as configurações fiscais padrão - [GET /api/v3/tax-settings/defaults](https://cplug.redocly.app/openapi/taxsettingsdefaults/get-tax-settings-defaults.md): Retorna as configurações fiscais padrão da empresa, incluindo grupos de ICMS, IPI, PIS/COFINS, ISSQN e CFOP. ### Atualiza as configurações fiscais padrão - [PUT /api/v3/tax-settings/defaults](https://cplug.redocly.app/openapi/taxsettingsdefaults/put-tax-settings-defaults.md): Atualiza as configurações fiscais padrão da empresa. Os IDs dos grupos devem existir e pertencer à empresa. O código CFOP deve ser um dos valores permitidos no enum. ## Notas Fiscais Operações relacionadas a notas fiscais. ### Realiza a manifestação de um documento fiscal eletrônico recebido - [POST /api/v3/nfes/received-documents/manifest](https://cplug.redocly.app/openapi/nfe/post-nfe-received-documents-manifest.md): Transmite uma manifestação (ciência, confirmação, desconhecimento ou operação não realizada) para um documento fiscal eletrônico recebido através da SEFAZ. Tipos de manifestação: - 210200: Confirmação da Operação - 210210: Ciência da Operação - 210220: Desconhecimento da Operação - 210240: Operação não Realizada (requer justificativa) ### Importa documentos fiscais eletrônicos - [POST /api/v3/nfes/received-documents/import](https://cplug.redocly.app/openapi/nfe/import-nfe-documents.md): Executa a importação de documentos fiscais eletrônicos. Essa solicitação é limitada a uma solicitação por hora. ### Lista documentos fiscais eletrônicos emitidos - [GET /api/v3/nfes/emitted-documents](https://cplug.redocly.app/openapi/nfe/get-nfe-emitted-documents.md): Retorna uma lista paginada de documentos fiscais eletrônicos emitidos, com filtros opcionais por data, busca, ordenação e paginação. ### Envia NFe emitidas por e-mail - [POST /api/v3/nfes/emitted-documents/send-email](https://cplug.redocly.app/openapi/nfe/post-nfe-emitted-documents-send-email.md): Envia documentos fiscais eletrônicos emitidos por e-mail para o endereço especificado, filtrados pelo período informado. ### Lista histórico de envios de NFe por e-mail - [GET /api/v3/nfes/emitted-documents/sending-history](https://cplug.redocly.app/openapi/nfe/get-nfe-emitted-documents-sending-history.md): Obtém o histórico de envios de documentos fiscais eletrônicos emitidos por e-mail, com filtros opcionais por status, período das NFe e período de solicitação. ### Obtém estatísticas da importação - [GET /api/v3/nfes/received-documents/statistics](https://cplug.redocly.app/openapi/nfe/get-nfe.md): Solicita a importação de documentos fiscais eletrônicos e retorna a informações do último log de importação juntamente com os totais de documentos importados. Só realiza a importação se a ultima importação ocorreu há mais de 1 hora. ### Lista os documentos fiscais eletrônicos recebidos - [GET /api/v3/nfes/received-documents](https://cplug.redocly.app/openapi/nfe/get-nfe-received-documents.md): Retorna uma lista paginada de documentos fiscais eletrônicos recebidos, com filtros opcionais por data, busca, ordenação e paginação. ### Lista os eventos de um documento fiscal eletrônico recebido - [GET /api/v3/nfes/received-documents/{nfeInId}/events](https://cplug.redocly.app/openapi/nfe/get-nfe-received-documents-events.md): Retorna uma lista paginada de eventos de um documento fiscal eletrônico recebido. ## ↳ Envio de documentos fiscais Operações específicas de envio de documentos fiscais. ### Lista os envios automáticos - [GET /api/v3/nfes/emitted-documents/schedules](https://cplug.redocly.app/openapi/nfeemitteddocumentsschedules/get-emitted-documents-schedules.md): Obtém a lista de envios automáticos de notas fiscais eletrônicas. ### Cria um envio automático - [POST /api/v3/nfes/emitted-documents/schedules](https://cplug.redocly.app/openapi/nfeemitteddocumentsschedules/create-emitted-documents-schedules.md): Cria um novo registro de envio automático de notas fiscais. ### Apaga um registro - [DELETE /api/v3/nfes/emitted-documents/schedules/{id}](https://cplug.redocly.app/openapi/nfeemitteddocumentsschedules/delete-emitted-documents-schedules.md): Apaga um registro de envio automático de notas fiscais eletrônicas. ## Empresas Operações de cadastro de empresas. ### Lista de empresas - [GET /api/v3/companies](https://cplug.redocly.app/openapi/companies/get-companies.md): Retorna lista de empresas. ### Cria uma nova empresa - [POST /api/v3/companies](https://cplug.redocly.app/openapi/companies/post-companies.md): Cria uma nova empresa. ### Obtém uma empresa - [GET /api/v3/companies/{companyId}](https://cplug.redocly.app/openapi/companies/get-companies-id.md): Resgata uma empresa já existente. ### Atualiza uma empresa - [PUT /api/v3/companies/{companyId}](https://cplug.redocly.app/openapi/companies/put-companies.md): Atualiza uma empresa já existente. ### Apaga uma empresa - [DELETE /api/v3/companies/{companyId}](https://cplug.redocly.app/openapi/companies/delete-companies-id.md): Apaga uma empresa específica. Proibido deletar a empresa corrente ### Enviar logotipo da empresa - [POST /api/v3/companies/{companyId}/image](https://cplug.redocly.app/openapi/companies/post-companies-image.md): Faz o upload do logotipo da empresa. O arquivo deve ser enviado no formato base64. ### Upload de certificado - [POST /api/v3/companies/{companyId}/upload-certificate](https://cplug.redocly.app/openapi/companies/post-companies-upload-certificate.md): Upload de certificado de uma empresa. O tamanho máximo do arquivo é 1 MB. ### Revoga licença - [POST /api/v3/companies/{companyId}/revoke-api-token](https://cplug.redocly.app/openapi/companies/post-companies-revoke-api-token.md): Cancela o acesso de todos aplicativos à empresa. É necessário fornecer a senha para confirmar a operação. ### Obtém token de API - [POST /api/v3/companies/{companyId}/get-api-token](https://cplug.redocly.app/openapi/companies/post-companies-get-api-token.md): Obtém o token de API. É necessário fornecer a senha para confirmar a operação. ### Deleta empresas em massa - [POST /api/v3/companies/batch-delete](https://cplug.redocly.app/openapi/companies/batch-delete-companies.md): Apaga empresas em massa. Proibido deletar a empresa corrente ### Lista de CNAEs - [GET /api/v3/cnaes](https://cplug.redocly.app/openapi/companies/get-cnaes.md): Retorna uma lista de CNAEs. ## ↳ Dados de cobrança Operações de dados de cobrança de uma empresa. ### Obtém dados de cobrança da empresa - [GET /api/v3/companies/{companyId}/billing](https://cplug.redocly.app/openapi/companiesbilling/get-companies-billing.md): Resgata os dados de cobrança de uma empresa já existente. ### Atualiza dados de cobrança da empresa - [PUT /api/v3/companies/{companyId}/billing](https://cplug.redocly.app/openapi/companiesbilling/put-companies-billing.md): Atualiza os dados de cobrança de uma empresa já existente. ## ↳ Definições de uso Operações de definições de uso de uma empresa. ### Obtém definições de uso da empresa - [GET /api/v3/companies/{companyId}/use-definitions](https://cplug.redocly.app/openapi/companiesusedefinitions/get-companies-use-definitions.md): Resgata as definições de uso de uma empresa já existente. ### Atualiza definições de uso da empresa - [PUT /api/v3/companies/{companyId}/use-definitions](https://cplug.redocly.app/openapi/companiesusedefinitions/put-companies-use-definitions.md): Atualiza as definições de uso de uma empresa já existente. ## Usuários Operações de cadastro de usuários. ### Lista de usuários - [GET /api/v3/users](https://cplug.redocly.app/openapi/users/get-users.md): Retorna lista de usuários. ### Cria um novo usuário - [POST /api/v3/users](https://cplug.redocly.app/openapi/users/post-users.md): Cria um novo usuário. ### Obtém um usuário - [GET /api/v3/users/{userId}](https://cplug.redocly.app/openapi/users/get-users-id.md): Resgata um usuário já existente. ### Atualiza um usuário - [PUT /api/v3/users/{userId}](https://cplug.redocly.app/openapi/users/put-user.md): Atualiza um usuário já existente. ### Apaga um usuário - [DELETE /api/v3/users/{userId}](https://cplug.redocly.app/openapi/users/delete-user.md): Apaga um usuário. ### Restaura um usuário - [POST /api/v3/users/{userId}](https://cplug.redocly.app/openapi/users/restore-user.md): Restaura um usuário que foi previamente excluído. ##### ⚠️ Validações Importantes Conflito de Email: Se outro usuário foi criado com o mesmo email do usuário excluído, não será possível restaurar e um erro 400 Bad Request será retornado. ### Obtém o usuário autenticado - [GET /api/v3/users/me](https://cplug.redocly.app/openapi/users/get-users-me.md): Resgata o usuário autenticado baseado no Authorization: Bearer da requisição. ### Atualiza o usuário autenticado - [PUT /api/v3/users/me](https://cplug.redocly.app/openapi/users/put-users-me.md): Atualiza o usuário autenticado. ### Obtém as permissões do usuário autenticado - [GET /api/v3/users/me/permissions](https://cplug.redocly.app/openapi/users/get-me-permissions.md): Retorna as permissões vinculadas ao perfil do usuário autenticado. ### Obtém as sessões ativas dos usuários - [GET /api/v3/users/sessions](https://cplug.redocly.app/openapi/users/get-users-sessions.md): Retorna as sessões ativas dos usuários. ### Revogar uma sessão de acesso - [PUT /api/v3/users/sessions/{accessTokenId}](https://cplug.redocly.app/openapi/users/revoke-users-sessions-access-token.md): Revoga uma sessão de acesso. ## Perfil Operações do cadastro de perfil de usuário. ### Lista os perfis - [GET /api/v3/profiles](https://cplug.redocly.app/openapi/profiles/get-profiles.md): Retorna lista dos perfis. ### Cria um novo perfil - [POST /api/v3/profiles](https://cplug.redocly.app/openapi/profiles/post-profiles.md): Cria um novo perfil para relacionar ao usuário. ### Obtém um perfil - [GET /api/v3/profiles/{profileId}](https://cplug.redocly.app/openapi/profiles/get-profile-id.md): Resgata um perfil já existente. ### Atualiza um perfil - [PUT /api/v3/profiles/{profileId}](https://cplug.redocly.app/openapi/profiles/put-profile.md): Atualiza um perfil já existente. ### Apaga um perfil - [DELETE /api/v3/profiles/{profileId}](https://cplug.redocly.app/openapi/profiles/delete-profile.md): Apaga um perfil. ### Obtém as permissões do perfil - [GET /api/v3/profiles/{profileId}/permissions](https://cplug.redocly.app/openapi/profiles/get-profile-id-permissions.md): Resgata as permissões relacionadas ao perfil. ### Obtém as permissões de PDV do perfil - [GET /api/v3/profiles/{profileId}/pdv-permissions](https://cplug.redocly.app/openapi/profiles/get-profile-id-pdv-permissions.md): Resgata as permissões de PDV relacionadas ao perfil. ### Obtém os limites de desconto dos perfis - [GET /api/v3/profiles/discount-limits](https://cplug.redocly.app/openapi/profiles/get-profiles-discount-limits.md): Obtém os limites de desconto dos perfis. ### Sincroniza os limites de desconto dos perfis - [PUT /api/v3/profiles/discount-limits/sync](https://cplug.redocly.app/openapi/profiles/put-profiles-discount-limits.md): Sincroniza os limites de desconto dos perfis. ## Permissões Lista de Permissões. ### Lista as permissões - [GET /api/v3/permissions](https://cplug.redocly.app/openapi/permissions/get-permissions.md): Retorna uma lista de permissões disponíveis no sistema. ### Lista as permissões de PDV - [GET /api/v3/pdv-permissions](https://cplug.redocly.app/openapi/permissions/get-pdv-permissions.md): Retorna uma lista de permissões de PDV disponíveis no sistema. ## Estatísticas (Dashboard) Operações de estatísticas. ### Busca valores agregados - [GET /api/v3/statistics/aggregate](https://cplug.redocly.app/openapi/statistics/get-statistics-aggregate.md): Busca valores agregados baseados nos parâmetros fornecidos. ### Busca dados estatísticos - [GET /api/v3/statistics/series](https://cplug.redocly.app/openapi/statistics/get-statistics-series.md): Busca dados estatísticos baseados nos parâmetros fornecidos. ## Demonstrativo de Resultado do Exercício (DRE) Operações para geração do Demonstrativo de Resultado do Exercício (DRE) com informações sobre receitas e despesas organizadas por conta contábil. ### Demonstrativo de Resultado do Exercício (DRE) - [GET /api/v3/dre](https://cplug.redocly.app/openapi/dre/get-dre.md): Retorna o Demonstrativo de Resultado do Exercício (DRE) com informações sobre receitas e despesas organizadas por conta contábil. O DRE agrupa as movimentações financeiras por conta contábil (plano de contas) e calcula os totais de receitas e despesas para o período especificado. ### Exportar DRE em PDF - [GET /api/v3/dre/pdf](https://cplug.redocly.app/openapi/dre/get-dre-pdf.md): Exporta o Demonstrativo de Resultado do Exercício (DRE) em formato PDF para download. O arquivo PDF contém todas as informações do DRE organizadas por conta contábil, incluindo receitas, despesas e totalizações para o período especificado. O nome do arquivo gerado segue o padrão: Resultados_YYYYMMDDHHMM.pdf ### Exportar DRE em Excel - [GET /api/v3/dre/excel](https://cplug.redocly.app/openapi/dre/get-dre-excel.md): Exporta o Demonstrativo de Resultado do Exercício (DRE) em formato Excel (.xlsx) para download. O arquivo Excel contém todas as informações do DRE organizadas em planilha estruturada, incluindo receitas, despesas e totalizações para o período especificado. O nome do arquivo gerado segue o padrão: Resultados_YYYYMMDDHHMM.xlsx ## Cidades Lista de cidades. ### Lista de cidades - [GET /api/v3/cities](https://cplug.redocly.app/openapi/cities/get-cities.md): Retorna uma lista de cidades. ## Estados Lista de estados. ### Lista de estados - [GET /api/v3/states](https://cplug.redocly.app/openapi/states/get-states.md): Retorna uma lista de estados. ## Buscar Cep Operação de busca do endereço a partir de um cep informado. ### Obter informações de um CEP - [GET /api/v3/zip-codes/{zipCode}](https://cplug.redocly.app/openapi/zipcodes/get-zip-codes-single.md): Resgata um endereço de um CEP. ## Processamento em massa Operações de processamento em massa. ### Lista os lotes da empresa - [GET /api/v3/bulks](https://cplug.redocly.app/openapi/bulks/get-bulks.md): Retorna uma lista de todos os lotes da empresa. ### Obtém os dados de um lote da empresa - [GET /api/v3/bulks/{bulkId}](https://cplug.redocly.app/openapi/bulks/get-bulk-by-id.md): Retorna os detalhes de um lote específico. ### Lista todos os itens de todos os processos em massa - [GET /api/v3/bulks/{bulkId}/items](https://cplug.redocly.app/openapi/bulks/listbulkitems.md): Retorna uma lista paginada de itens de todos os processos em massa. ### Adiciona itens ao lote - [POST /api/v3/bulks/items-add](https://cplug.redocly.app/openapi/bulks/post-bulk-items-add.md): Adiciona itens a um lote existente. ### Adiciona itens ao lote por filtro - [POST /api/v3/bulks/items-add-by-filter](https://cplug.redocly.app/openapi/bulks/post-bulk-items-add-by-filter.md): Adiciona itens a um lote existente por filtro. ### Remove itens do lote - [POST /api/v3/bulks/items-remove](https://cplug.redocly.app/openapi/bulks/post-bulk-items-remove.md): Remove itens de um lote existente. ### Finaliza um lote - [POST /api/v3/bulks/finish](https://cplug.redocly.app/openapi/bulks/post-bulk-finish.md): Finaliza um lote e envia para ser processado. ### Obtém o status do lote - [GET /api/v3/bulks/{kind}/status](https://cplug.redocly.app/openapi/bulks/get-bulk-status.md): Retorna o status do último lote da empresa por tipo (kind), independente do status. ### Apaga um lote - [DELETE /api/v3/bulks/{kind}/destroy](https://cplug.redocly.app/openapi/bulks/delete-bulk-destroy.md): Remove completamente um lote e todos os seus itens. ## Filtros Endpoints para gerenciamento de filtros salvos. ### Lista de filtros - [GET /api/v3/filters](https://cplug.redocly.app/openapi/filters/get-filters.md): Retorna lista de filtros salvos de uma área específica do sistema. ### Cria um filtro - [POST /api/v3/filters](https://cplug.redocly.app/openapi/filters/post-filters.md): Cria um novo filtro salvo para uma área específica do sistema. ### Obtém um filtro - [GET /api/v3/filters/{filterId}](https://cplug.redocly.app/openapi/filters/get-filters-id.md): Resgata um filtro salvo já existente. ### Atualiza um filtro - [PUT /api/v3/filters/{filterId}](https://cplug.redocly.app/openapi/filters/put-filters.md): Atualiza um filtro salvo já existente. ### Apaga um filtro - [DELETE /api/v3/filters/{filterId}](https://cplug.redocly.app/openapi/filters/delete-filters.md): Apaga um filtro salvo do sistema. ## Integrações Operações de integrações disponíveis no sistema. ### Lista de integrações - [GET /api/v3/integrations](https://cplug.redocly.app/openapi/integrations/get-integrations.md): Retorna lista de integrações disponíveis no sistema e seu status para o usuário. O sistema suporta múltiplos tipos de integração (delivery, tapp, ERP, general) com dezenas de fornecedores diferentes. Cada integração pode ter status ativo ou inativo conforme a configuração do usuário. ### Obtém uma integração - [GET /api/v3/integrations/{integrationId}](https://cplug.redocly.app/openapi/integrations/get-integration-by-id.md): Retorna os detalhes completos de uma integração específica incluindo autenticação e configurações. O sistema suporta múltiplos tipos de integração com diferentes fornecedores. Os campos retornados variam conforme o tipo e fornecedor da integração. ### Atualiza uma integração - [PUT /api/v3/integrations/{integrationId}](https://cplug.redocly.app/openapi/integrations/put-integration-by-id.md): Atualiza uma integração existente incluindo suas credenciais de autenticação e configurações. O sistema suporta múltiplos tipos de integração (delivery, tapp, ERP, general) com diferentes fornecedores. Cada integração possui requisitos únicos de campos obrigatórios para autenticação e configuração. Tipos de integração suportados incluem (não exaustivo): - Delivery: Epadoca, Delivery Direto, iFood, Rappi, Aiqfome, Neemo, Onpedido, Quero Delivery, etc. - Tapp: EasyChopp, Beerpass, ITap, Enjoy, etc. - ERP: Tray, etc. - General: Fidelidade, CRM & Bonus, Todo Cartões, etc. ### Apaga uma integração - [DELETE /api/v3/integrations/{integrationId}](https://cplug.redocly.app/openapi/integrations/delete-integration-by-id.md): Apaga uma integração do sistema. ### Restaura uma integração - [POST /api/v3/integrations/{integrationId}/restore](https://cplug.redocly.app/openapi/integrations/post-integration-restore.md): Restaura uma integração que foi previamente apagada. Condições para restauração: - A integração deve existir no sistema - A integração deve estar "apagada" - O usuário deve ter permissão para restaurar integrações ## ↳ Tray Operações específicas da integração Tray. ### Lista produtos da integração Tray - [GET /api/v3/integrations/tray/products](https://cplug.redocly.app/openapi/tray/get-integrations-tray-products.md): Retorna a lista de produtos da integração Tray com informações de conciliação entre o sistema ERP e a loja. Esta integração permite sincronizar produtos entre o sistema ERP e a plataforma Tray, facilitando a gestão de catálogos e estoques. ### Conciliar produtos da integração Tray - [PUT /api/v3/integrations/tray/products/{productId}/conciliation](https://cplug.redocly.app/openapi/tray/put-integrations-tray-products-productid-conciliation.md): Executa a conciliação ou desconciliação de produtos da plataforma Tray com produtos do sistema ERP. ### Importar produtos da integração Tray - [POST /api/v3/integrations/tray/import-products](https://cplug.redocly.app/openapi/tray/post-integrations-tray-products-import.md): Inicia o processo de importação de produtos da plataforma Tray para o sistema ERP. ### Apagar importação de produtos - [DELETE /api/v3/integrations/tray/import-products](https://cplug.redocly.app/openapi/tray/delete-integrations-tray-products-import.md): Remove o processo de importação de produtos da plataforma Tray. ### Verifica situação da importação - [GET /api/v3/integrations/tray/import-products/status](https://cplug.redocly.app/openapi/tray/get-integrations-tray-products-import-status.md): Verifica o status atual do processo de importação de produtos da plataforma Tray. ### Exportar produtos da integração Tray - [POST /api/v3/integrations/tray/export-products](https://cplug.redocly.app/openapi/tray/post-integrations-tray-products-export.md): Inicia o processo de exportação de produtos do sistema ERP para a plataforma Tray. ### Apagar exportação de produtos - [DELETE /api/v3/integrations/tray/export-products](https://cplug.redocly.app/openapi/tray/delete-integrations-tray-products-export.md): Remove o processo de exportação de produtos para a plataforma Tray. ### Verifica situação da exportação - [GET /api/v3/integrations/tray/export-products/status](https://cplug.redocly.app/openapi/tray/get-integrations-tray-products-export-status.md): Verifica o status atual do processo de exportação de produtos para a plataforma Tray. ## Tipos de Negócio Operações de tipos de negócio disponíveis no sistema. ### Lista os tipos de negócio - [GET /api/v3/types-of-business](https://cplug.redocly.app/openapi/typebusiness/get-types-of-business.md): Retorna uma lista de tipos de negócio disponíveis no sistema. ## Arquivos Operações de arquivos. ### Download de Arquivo - [GET /api/v3/files/{hash}/download](https://cplug.redocly.app/openapi/files/get-files-download.md): Retorna o arquivo armazenado correspondente ao hash fornecido. Pode retornar arquivos XML, PDF, imagens ou outros tipos de arquivo diretamente.