Linha Datasul

Árvore de páginas

Documentação complementar das APIs Públicas do Módulo de Administração de Vendas.


Requisitos: Datasul na Release 12.1.29 ou posterior.

Documentação dos campos, verbos e filtros: A documentação completa das APIs está disponível no diretório de programas do produto padrão, nos caminhos:

  • Cadastros Gerais: \ems2\<release>\cdp\api\v1\apipubliccdp.json
  • Pedido de Venda: \ems2\<release>\pdp\api\v1\apipublicpdp.json 
  • Cotação de Venda: \ems2\<release>\qop\api\v1\apipublicqop.json


Para o consumo das APIs por parte de serviços externos ao Datasul (Connector, TOTVS CRM), é necessário realizar a configuração do proxy reverso no ambiente, para que seja possível acessar o Datasul fora da rede na qual ele está hospedado.

Configuração de Proxy Reverso Datasul For THF: https://centraldeatendimento.totvs.com/hc/pt-br/articles/1500003165101-Framework-Linha-Datasul-TEC-Configura%C3%A7%C3%A3o-de-Proxy-Reverso-para-os-Portais-do-Datasul-for-THF-utilizando-IIS

Configuração de Proxy Reverso Datasul Jboss: https://centraldeatendimento.totvs.com/hc/pt-br/articles/234966387-Framework-Linha-Datasul-TEC-Como-configurar-Proxy-Reverso-para-os-Portais-Datasul

Para o funcionamento do filtro lastUpdate é utilizado um grupo de tabelas auxiliares no produto, nestas tabelas são registradas as chaves primárias dos registros de algumas entidades, para ativar o armazenamento destas informações, é necessário realizar a ativação do aplicativo Minhas Vendas, na tela de Configurador de Aplicações (Configuração de Aplicações - App Minhas Vendas), não sendo necessário a configuração total do Aplicativo Minhas Vendas, apenas sua ativação.

Obs: Os registros auxiliares serão gerados A PARTIR da ativação do aplicativo, ou seja, os registros já existentes no Datasul, não terão um equivalente nas tabelas auxiliares, a não ser que, sofram alguma alteração.


Regras Específicas:

Nesta seção são apresentados os campos que tem comportamentos específicos no caso do não envio de informações no momento da criação dos registros (POST)


Endpoint: customerPublic

Método: POST

CampoRegra

representativeCode

Caso não seja enviado o código do representante, será considerado o código do representante atrelado ao grupo de cliente informado no campo customerGroup, caso não seja enviado o código de grupo do cliente, o erro 'Grupo de Cliente inválido' será retornado.

city

Caso o nome da cidade não seja enviado ou não coincida com o nome da cidade cadastrada no Datasul, as informações de Cidade serão buscadas com base no campo ibgeCode.

billingCity

Caso o nome da cidade de cobrança não seja enviado ou não coincida com o nome da cidade cadastrada no Datasul, as informações de Cidade serão buscadas com base no campo billingIbgeCode.


Endpoint: customerPublic/ecommerce

Método: POST

CampoRegra
representativeCodeCaso não seja enviado o código do representante, será considerado o código do representante atrelado ao grupo de cliente informado no campo customerGroup, caso não seja enviado o código de grupo do cliente, o erro 'Grupo de Cliente inválido' será retornado.

city

Caso o nome da cidade não seja enviado ou não coincida com o nome da cidade cadastrada no Datasul, as informações de Cidade serão buscadas com base no campo ibgeCode.

billingCity

Caso o nome da cidade de cobrança não seja enviado ou não coincida com o nome da cidade cadastrada no Datasul, as informações de Cidade serão buscadas com base no campo billingIbgeCode.

customerGroupCaso não seja enviado o grupo de cliente ou seu valor seja 0 (zero), o código de grupo que será considerado é o grupo parametrizado na integração com a loja.

Documentos Complementares