Histórico da Página
A versão 2 da API TOTVS MODA O Hub de Integração TOTVS Moda é um passo importante para a inovação a ponto de facilitar a sua integração aos diversos segmentos.
...
Todas as URLs e documentações estão disponíveis no swagger de cada API disponível para acesso através dos host Base oficial ou Base treino.
Segurança
O Token Authentication de Autorização tem a responsabilidade de autenticar os usuários nas diversas API's,
utilizamos para geração e validação de tokens no padrão Jason Json Web Token (JWT), criptografados, que serão utilizados durante as requisições às API's,
...
Outro ponto importante para verificar a integridade dos dados é a chave de acesso única ou conhecido como "x-api-key",
onde este é gerado exclusivamente para cada cliente e está é obrigatório ser informando em todas as as requisições.
Trabalhando juntas e aumentando a segurança e a integridade dos seus dados.
Estrutura
A grande maioria das requisições que retornam uma coleção possuem as seguintes opções:
- page: Controle de pagina.
- page size: Controle de quantidade de coleções a serem retornadas por paginas.
- expand: Controle de quais coleções realmente precisam ser retornadas, eliminando dados desnecessários.
- limit: Indica a quantidade de recursos a serem retornados, indo de 1 e no máximo 1000 registros por páginas.
- order: Indica por qual atributo a consulta deve ser ordenada.
- max change date: Indica qual a maior data de alteração referente ao filtro realizado.
Lista
Abaixo a lista contendo as API's e o link de sua documentação com suas funcionalidades disponíveis para utilização.
Abaixo temos um exemplo de como gerar o Token de Autorização pelo Postman, importando através de uma cURL.
curl --location --request POST 'https://moda.api.varejo.totvs.com.br/api/totvsmoda/authorization/v2/token' \ --header 'x-api-key;' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'grant_type=password' \ --data-urlencode 'client_id=' \ --data-urlencode 'client_secret=' \ --data-urlencode 'username=' \ --data-urlencode 'password=' |
---|
Na aba Headers temos o campo x-api-key, onde deve ser inserida a chave de acesso única.
Na aba Body temos os campos onde devem ser inseridas as credenciais do cliente.
Lista
Abaixo a lista contendo as API's e o link de sua documentação com suas funcionalidades disponíveis para utilização.
Authorization - Obter token de autorização | Documentação |
---|---|
Gerar token | Produção: https://moda.api.varejo.totvs.com.br/#/Authorization/post_api_totvsmoda_authorization_v2_token |
Accounts-receivable - Contas a receber | Documentação |
---|---|
Obter valor de limite do cliente | |
Obter dados de documentos de constas a receber | |
Obter dados de boletos já impressos | |
Liquidar faturas de contas a receber |
Analytics - Dados de movimentações fiscais | Documentação |
---|---|
Obter empresas da movimentação fiscal | |
Obter dados de comprador da movimentação fiscal | |
Obter movimentação fiscal | |
Obter dados de operação de movimentação fiscal | |
Obter dados de condição de pagamento da movimentação fiscal | |
Obter dados de pessoa da movimentação fiscal | |
Obter dados de produto da movimentação fiscal | |
Obter dados de representante da movimentação fiscal | |
Obter dados de vendedor da movimentação fiscal | |
Obter dados de tipo de saldo da movimentação fiscal |
Data-package - Pacote de dados | Documentação |
---|---|
Obter o conteúdo de um pacote de dados | |
Incluir um pacote de dados | Produção: https://moda.api.varejo.totvs.com.br/#/DataPackage/post_api_totvsmoda_data_package_v2_input_packages |
Obter lista de pacotes de dados | Produção: https://moda.api.varejo.totvs.com.br/#/DataPackage/get_api_totvsmoda_data_package_v2_output_packages |
Alterar situação de um pacote de dados para "Recebido" | |
Obter as informações de um pacote de dados |
Fiscal | Documentação |
---|---|
Obter detalhe de uma item da nota fiscal | |
Obter saldo de produto em condicional por empresa e pessoa | |
Obter lista de notas fiscais e seus dados por filtro geral | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Fiscal/post_api_totvsmoda_fiscal_v2_invoices_search Produção: https://moda.api.varejo.totvs.com.br/#/Fiscal/post_api_totvsmoda_fiscal_v2_invoices_search |
Obter XML(s) de uma nota fiscal eletrônica | Produção: https://moda.api.varejo.totvs.com.br/#/Fiscal/get_api_totvsmoda_fiscal_v2_xml_contents__accessKey_ |
Location - Dados de localização | Documentação |
---|---|
Obter os dados de endereço de um CEP | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Location/get_api_totvsmoda_location_v2_ceps__cep_ Produção: https://moda.api.varejo.totvs.com.br/#/Location/get_api_totvsmoda_location_v2_ceps__cep_ |
Obter cidade | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Location/get_api_totvsmoda_location_v2_city Produção: https://moda.api.varejo.totvs.com.br/#/Location/get_api_totvsmoda_location_v2_city |
Obter país | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Location/get_api_totvsmoda_location_v2_country Produção: https://moda.api.varejo.totvs.com.br/#/Location/get_api_totvsmoda_location_v2_country |
Obter estado | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Location/get_api_totvsmoda_location_v2_state Produção: https://moda.api.varejo.totvs.com.br/#/Location/get_api_totvsmoda_location_v2_state |
Image - Imagem de produto | Documentação |
---|---|
Importar imagem de produto | Treino: https://moda.api.varejo.totvs.com.br/treino/#/ProductImage/post_api_totvsmoda_image_v2_product Produção: https://moda.api.varejo.totvs.com.br/#/ProductImage/post_api_totvsmoda_image_v2_product |
Consultar imagem de produto | Produção: https://moda.api.varejo.totvs.com.br/#/ProductImage/post_api_totvsmoda_image_v2_product_search |
Management - Administração | Documentação |
---|---|
Obter parâmetros por empresa | Produção: https://moda.api.varejo.totvs.com.br/#/Management/get_api_totvsmoda_management_v2_branch_parameter |
Obter parâmetros corporativos | Produção: https://moda.api.varejo.totvs.com.br/#/Management/get_api_totvsmoda_management_v2_global_parameter |
Obter lista de usuários | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Management/get_api_totvsmoda_management_v2_users Produção: https://moda.api.varejo.totvs.com.br/#/Management/get_api_totvsmoda_management_v2_users |
Production-order - Ordem de produção | Documentação |
---|---|
Consultar ordem de produção | Produção: https://moda.api.varejo.totvs.com.br/#/Order/post_api_totvsmoda_production_order_v2_orders_search |
Purchase-order - Pedido de compra | Documentação |
---|---|
Incluir um pedido de compra | Treino: |
_api_totvsmoda_purchase_order_v2_orders Produção: |
Cancelar pedido de compra |
_api_totvsmoda_purchase_order_v2_orders_cancel Produção: https://moda.api.varejo.totvs.com.br |
Alterar a situação de um pedido de compra |
_api_totvsmoda_purchase_order_v2_orders_change_status Produção: https://moda.api.varejo.totvs.com.br/ |
Alterar a quantidade solicitada de um pedido de compra |
api_totvsmoda_purchase_order_v2_quantity_items Produção: https://moda.api.varejo.totvs.com.br/ |
PurchaseOrder/post_api_totvsmoda_purchase_order_v2_quantity_items | |
Consulta pedido de compra |
Produção: https://moda.api.varejo.totvs.com.br |
Sales-order - Pedido de venda | Documentação |
---|---|
Alterar dados adicionais de um pedido de venda |
api_totvsmoda_sales_order_v2_additional_order Produção: |
Incluir um pedido de venda | Treino: |
Produção: |
Consultar sugestão de faturamento |
Produção: https://moda.api.varejo.totvs.com.br/ |
Consultar tipos de desconto |
_api_totvsmoda_sales_order_v2_discount_type Produção: |
Obter lista das notas fiscais vinculadas a um pedido | Treino: |
Produção: https://moda.api.varejo.totvs.com.br/ |
Cancelar um pedido de venda | Treino: |
SalesOrder/post_api_totvsmoda_sales_order_v2_orders_cancel Produção: https://moda.api.varejo.totvs.com.br/#/ |
Alterar a situação de um pedido de venda | Treino: |
SalesOrder/post_api_totvsmoda_sales_order_v2_orders_change_status Produção: |
SalesOrder/post_api_totvsmoda_sales_order_v2_orders_change_status | |
Obter lista de pedidos de venda e seus dados por filtro geral |
SalesOrder/post_api_totvsmoda_sales_order_v2_orders_search Produção: https://moda.api.varejo.totvs.com.br/ |
Gravar dados de transação TOTVS Moda PDV |
api_totvsmoda_sales_order_v2_pdv_transactions Produção: |
Obter lista dos itens pendentes de um pedido | Treino: |
_api_totvsmoda_sales_order_v2_pending_items Produção: https://moda.api.varejo.totvs.com.br/ |
Gravar relacionamento entre contagem e pedido de venda |
SalesOrder/post_api_totvsmoda_sales_order_v2_relationship_counts Produção: |
Seller - Vendedor | Documentação |
---|---|
Obter lista de região de atuação de vendedores |
Seller/get_api_totvsmoda_seller_v2_operational_area Produção: https://moda.api.varejo.totvs.com.br/ |
Obter lista de região de atuação de vendedores por CEP |
Seller/get_api_totvsmoda_seller_v2_operational_area_cep Produção: https://moda.api.varejo.totvs.com.br |
Obter lista de região de atuação de vendedores por cidade | Treino: |
api_totvsmoda_seller_v2_operational_area_city Produção: |
Obter lista de região de atuação de vendedores por estado |
totvsmoda_seller_v2_operational_area_state Produção: |
Obter lista de vendedores, empresas e clientes |
Produção: https://moda.api.varejo.totvs.com.br/ |
Voucher | Documentação |
---|---|
Incluir um voucher | Treino: |
Produção: https://moda.api.varejo.totvs.com.br/ |
Incluir voucher para uma lista de clientes baseado em um voucher pai |
api_totvsmoda_voucher_v2_customer_create Produção: https://moda.api.varejo.totvs.com.br |
Consultar voucher |
Produção: https://moda.api.varejo.totvs.com.br/ |
Alterar um voucher | Treino: |
Produção: |
HTML |
---|
<!-- esconder o menu --> <style> div.theme-default .ia-splitter #main { margin-left: 0px; } .ia-fixed-sidebar, .ia-splitter-left { display: none; } #main { padding-left: 10px; padding-right: 10px; overflow-x: hidden; } .aui-header-primary .aui-nav, .aui-page-panel { margin-left: 0px !important; } .aui-header-primary .aui-nav { margin-left: 0px !important; } </style> |