CONTEÚDO

01. VISÃO GERAL

ERPs podem ser integrados ao TOTVS Omni totalmente através das APIs REST do TOTVS Omni. Desta forma o desenvolvimento da integração pode ser feita dentro dos sistemas ERPs e assim não é necessário o desenvolvimento de conectores específicos no Omni.

O TOTVS Omni disponibiliza APIs REST para realizar operações das duas entidades: Produtos e Pedidos.

02. CARGA DE PRODUTOS

De maneira geral para carga de produtos no Omni, é necessário que o ERP disponibilize em um servidor FTP (a ser configurado na integração do Omni) arquivos contendo informações relativas aos produtos.
Este processo é obrigatório.

Porém é possível realizar a carga destes arquivos diretamente executando a chamada de uma API REST conforme abaixo.

OBS: A carga de produtos pode conter informações sobre preço e/ou estoque, porém recomenda-se que sejam arquivos separados, pois a periodicidade de integração dos mesmos é diferente, permitindo assim configurar integrações especializadas para cada tipo de dado.

• ENDPOINT: http://adminco.modalia.com/integrador/session-less/integrations/<SITEID>/integration-exec-post
• METHOD: POST
• HEADERS: -
• PARAMETERS: 
  Os seguintes Form parameters devem ser enviados:
  - username: usuário do Omni com permissão de configurar e executar integrações.
  - password: Password do usuário
  - integrationType: Valor 1
  - integrationFile: Caminho no desktop onde está o arquivo de dados para ser processado pela integração.
• BODY: -

curl --location --request POST 'https://adminco.modalia.com/integrador/session-less/integrations/519/integration-exec-post' \
--form 'username="meusuario"' \
--form 'password="minhasenha"' \
--form 'integrationType="1"' \
--form 'integrationFile=@"/C:/TOTVS/Omni/PRODUTOS_DO_ERP.json"'

A variável SITEID na URL é o identificador único do cliente no Omni. Corresponde ao Site principal onde os produtos estarão associados.

A chamada à este endpoint automaticamente executa a integração ativa de produto que irá processar o arquivo enviado.

Veja Postman Collection (folder Produtos > Carga de Produtos) anexado ao final desta página.

Alternativamente é possível desenvolver um conector para integração de produtos e disponibilizar no TOTVS Omni. Este conector iria consumir APIs do ERP para gerar arquivos de produtos no servidor de FTP configurado na integração do Omni.

03. CARGA DE PREÇOS

De maneira geral para carga de preços de produtos no Omni, é necessário que o ERP disponibilize em um servidor FTP (a ser configurado na integração do Omni) arquivos contendo informações relativas aos preços.
Este processo é obrigatório.

Porém é possível realizar a carga destes arquivos diretamente executando a chamada de uma API REST conforme abaixo.

OBS: Importante ressaltar que o produto deve ser carregado antes e já integrado no Omni para que possa ser sincronizado os preços.

• ENDPOINT: http://adminco.modalia.com/integrador/session-less/integrations/<SITEID>/integration-exec-post
• METHOD: POST
• HEADERS: -
• PARAMETERS: 
  Os seguintes Form parameters devem ser enviados:
  - username: usuário do Omni com permissão de configurar e executar integrações.
  - password: Password do usuário
  - integrationType: Valor 7
  - integrationFile: Caminho no desktop onde está o arquivo de dados para ser processado pela integração.
• BODY: -

curl --location --request POST 'https://adminco.modalia.com/integrador/session-less/integrations/519/integration-exec-post' \
--form 'username="meusuario"' \
--form 'password="minhasenha"' \
--form 'integrationType="7"' \
--form 'integrationFile=@"/C:/TOTVS/Omni/PRECOS_DO_ERP.json"'

A variável SITEID na URL é o identificador único do cliente no Omni. Corresponde ao Site principal onde os produtos estarão associados.

A chamada à este endpoint automaticamente executa a integração ativa de preço que irá processar o arquivo enviado.

Veja Postman Collection (folder Produtos > Carga de Preços) anexado ao final desta página.

Alternativamente é possível desenvolver um conector para integração de preços e disponibilizar no TOTVS Omni. Este conector iria consumir APIs do ERP para gerar arquivos de preços no servidor de FTP configurado na integração do Omni.

04. CARGA DE ESTOQUE

De maneira geral para carga de produtos no Omni, é necessário que o ERP disponibilize em um servidor FTP (a ser configurado na integração do Omni) arquivos contendo informações relativas aos produtos.
Este processo é obrigatório.

Porém é possível realizar a carga destes arquivos diretamente executando a chamada de uma API REST conforme abaixo.

OBS: Importante ressaltar que o produto deve ser carregado antes e já integrado no Omni para que possa ser sincronizado os estoques. Também é importante que as lojas estejam previamente cadastradas no Omni, utilizando o mesmo código Identificador externo.

• ENDPOINT: http://adminco.modalia.com/integrador/session-less/integrations/<SITEID>/integration-exec-post
• METHOD: POST
• HEADERS: -
• PARAMETERS: 
  Os seguintes Form parameters devem ser enviados:
  - username: usuário do Omni com permissão de configurar e executar integrações.
  - password: Password do usuário
  - integrationType: Valor 2
  - integrationFile: Caminho no desktop onde está o arquivo de dados para ser processado pela integração.
• BODY: -

curl --location --request POST 'https://adminco.modalia.com/integrador/session-less/integrations/519/integration-exec-post' \
--form 'username="meusuario"' \
--form 'password="minhasenha"' \
--form 'integrationType="2"' \
--form 'integrationFile=@"/C:/TOTVS/Omni/ESTOQUE_DO_ERP.json"'

A variável SITEID na URL é o identificador único do cliente no Omni. Corresponde ao Site principal onde os produtos estarão associados.

A chamada à este endpoint automaticamente executa a integração ativa de estoque que irá processar o arquivo enviado.

Veja Postman Collection (folder Produtos > Carga de Estoque) anexado ao final desta página.

Alternativamente é possível desenvolver um conector para integração de estoque e disponibilizar no TOTVS Omni. Este conector iria consumir APIs do ERP para gerar arquivos de estoque no servidor de FTP configurado na integração do Omni.

05. INTEGRAÇÃO DE PEDIDOS PAGOS

Os pedidos são criados no TOTVS Omni através da integração com os canais de venda. Estes pedidos baixados ou enviados pelos canais de venda contém informações sobre meio de pagamento efetuados e ficam em um status de pendente de confirmação no Omni.

O Fluxo a seguir exemplifica o ciclo de vida de um pedido pago e o consumo de APIs do Omni que os ERPs podem fazer para prosseguir com este pedido pelo fluxo (veja Ciclo de Vida de Pedido).

Fluxo de Criação de Pedido

* No caso de rejeição parcial de um pedido, a API verifica se os itens rejeitados fazem parte de um mesmo kit. Caso algum item do kit não tenha sido rejeitado junto, a API irá recusar a rejeição informando os itens que fazem parte do kit.

Alternativamente é possível desenvolver um conector para integração de pedido e disponibilizar no TOTVS Omni. Este conector iria consumir APIs do ERP para criar e atualizar pedidos no ERP, porém é necessário também desenvolver chamadas à API do Omni a partir do ERP para
completar o ciclo de funcionamento todo.

06. INTEGRAÇÃO DE PEDIDOS PRATELEIRA INFINITA

Os pedidos provenientes da prateleira infinita (módulo do Omni - veja Arquitetura TOTVS OMNI) são criados no TOTVS Omni pendentes de pagamento. Um sistema de pagamento externo ou mesmo PDVs podem consultar a API do OMNI para listar pedidos deste tipo, realizar o pagamento correspondente, e atualizar o Omni com informações deste pagamento.

Após este processo o OMNI seguirá as etapas do ciclo de vida de pedido pago, conforme descrito em Ciclo de Vida de Pedido. Veja também o fluxo de Integração de Pedidos Pagos nesta página.

Fluxo de Confirmação de Pagamento de Pedido

07. ANEXO 1 - TABELA DE TIPOS DE INTEGRAÇÕES SUPORTADAS

Outras Ações / Ações relacionadas

07. ANEXO 2 - POSTMAN COLLECTION

Abaixo uma postman collection contendo as chamadas relacionadas neste documento:

Consumo de APIs REST para ERPs e PDVs.postman_collection.json

08. ANEXO 3 - EXEMPLO DE ARQUIVOS DE CARGA

Abaixo exemplos de arquivos de carga:

• Produtos: PRODUTOS_DO_ERP.json
• Preços: PRECOS_DO_ERP.json
• Estoque: ESTOQUE_DO_ERP.json