Módulo: Arquivos do Pedido
Pedido
Deve retornar os arquivos de um pedido.
| API | Descrição | Obrigatório |
|---|---|---|
| GET api/v1/arquivospedido?pedidoErpId={pedidoErpId}&revendaId={revendaId} |
A partir do id do pedido no Erp, deve retornar as referências dos arquivos. |
Sim |
Módulo: Busca de endereço
CEP
Deve retornar os dados de endereço dado um CEP.
| API | Descrição | Obrigatório |
|---|---|---|
| GET api/v1/cep?cep={cep} |
A partir do cep informado, deve retornar os dados do endereço. |
Sim |
Módulo: Checkout novo
Checkout
Deve retornar as informações do checkout atualizadas
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/checkout |
Nenhuma documentação disponível. |
Sim |
Módulo: Comissões
Comissão
Deve retornar os dados de comissão.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/comissao |
A partir dos dados do produto, do preço de venda e do usuário logado, deve retornar o valor da comissão. |
Sim |
| POST api/v1/comissao/solicita |
Envia para o ERP uma solicitação de comissões |
Sim |
| POST api/v1/comissao/pesquisaComissoes |
Deve pesquisar os dados de comissão através dos dados de busca informados. Essa chamada ou retorna o filtro (De, Ate, Status) ou o Id do Pedido no request, e o código deve tratar ambos os casos de forma distinta. |
Sim |
| POST api/v1/comissao/consulta |
Deve pesquisar os dados de comissão através dos dados de busca informados. Essa chamada ou retorna o filtro (De, Ate, Status) ou o Id do Pedido no request, e o código deve tratar ambos os casos de forma distinta. |
Sim |
Módulo: Estoque
Estoque
Deve retornar os dados de estoque de um Part Number.
| API | Descrição | Obrigatório |
|---|---|---|
| GET api/v1/estoque?partNumber={partNumber}&revendaId={revendaId}&clienteFinalId={clienteFinalId} |
A partir do Part Number do produto, deve retornar o estoque para cada Centro de Distribuição disponível. |
Sim |
Módulo: Pedido
Integração de Carrinho
[OPCIONAL] Notifica o ERP se um item é inserido no carrinho de compras. Para ativar a chamada para essa API é necessário entrar em contato com o suporte Atma.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/carrinho |
Recebe qual produto foi adicionado no carrinho pelo usuário |
Sim |
Tracking
Deve devolver uma lista de pedidos com o tracking.
| API | Descrição | Obrigatório |
|---|---|---|
| GET api/v1/pedidotracking?inicioUtc={inicioUtc}&fimUtc={fimUtc}&incluirPedidosAbertos={incluirPedidosAbertos} |
A partir de uma faixa de data deve retornar o tracking dos pedidos daquele período. |
Sim |
Frete
A partir de um carrinho de compras e das informações de quem é o destinatário do pedido, deve retornar os dados de prazo de entrega e frete. É necessário enviar também os dados de valor de frete separados por Centro de Distribuição (Filial).
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/frete |
A partir dos dados do carrinho de compras do cliente, deve retornar quais são as opções disponíveis de frete, bem como seus valores. Cada opção de frete deve ter um identificador único que será enviado de lta no método CriarPedido. É possível também fornecer os dados de frete quebrados por filial. |
Sim |
| POST api/v1/frete/rastreio |
Nenhuma documentação disponível. |
Sim |
pagamento
Insere pagamentos no ERP.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/pagamento |
Insere pagamentos no ERP. |
Sim |
Integração de Pedido
Deve receber um pedido do site e integrá-lo aos sistemas internos do cliente. É necessário fornecer um código de protocolo único para confirmar a integração com sucesso do pedido.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/pedido/pesquisaPedidos |
Pesquisa por pedidos no ERP. |
Sim |
| POST api/v1/pedido/IncluirIDEcommerce |
Pesquisa por pedidos no ERP. |
Sim |
| POST api/v1/pedido/itensPedido |
Nenhuma documentação disponível. |
Sim |
| POST api/v1/pedido/arquivo |
Envia um arquivo enviado pelo usuário para o ERP |
Sim |
| POST api/v1/pedido/desintegraPedidos |
Pesquisa por pedidos no ERP. |
Sim |
| POST api/v1/pedido/pagamento/status |
OPCIONAL: recebe uma atualização sobre o pagamento do pedido (Confirmado ou Erro) É utilizado quando o plugin de pagamento envia o TipoStatusPagamentoPedido como Pendente. |
Sim |
| POST api/v1/pedido/efetivarPedidoErp |
Nenhuma documentação disponível. |
Sim |
Prazo de Pagamento
A partir dos dados do carrinho do cliente final, deve retornar quais são as opções de pagamento no modelo Pagamento Faturado.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/prazoDePagamento |
A partir do carrinho de compras deve retornar quais são as opções para a forma de pagamento Faturado. |
Sim |
Boleto
Deve retornar se existe ou não boletos para um pedido.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/boleto/consultar |
A partir do cnpj e da nota fiscal verifica se o pedido contém boletos. |
Sim |
Módulo: Preços
Preço (múltiplos em um request)
[OPCIONAL] Pode ser usado para fornecer num único request múltiplos preços para o site. O conjunto de preços retornado contempla todos os Centros de Distribuição (Filiais) que possuam o produto para venda.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/precos |
A partir dos Part Numbers e dos dados do usuário logado, deve retornar os preços dos produtos. |
Sim |
Preço
Deve fornecer os preços para os produtos do site. O conjunto de preços retornado contempla todos os Centros de Distribuição (Filiais) que possuam o produto para venda.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/preco |
A partir do Part Number e dos dados do usuário logado, deve retornar os preços do produto. |
Sim |
| POST api/v1/preco/pricelist |
Solicitacao d. |
Sim |
Módulo: Relatórios
Relatórios de Produção
[OPCIONAL] Ativa relatórios de pedido com dados do ERP.
| API | Descrição | Obrigatório |
|---|---|---|
| GET api/v1/relatorios/orders/vendor?inicioUtc={inicioUtc}&fimUtc={fimUtc}&vendorErpId={vendorErpId} |
[OPCIONAL] Fornece os dados necessários para extração de um relatório de pedidos do ERP. |
Não |
Módulo: Retorno de Mercadoria Avariada
RMA
[OPCIONAL] Módulo de retorno de mercadoria avariada.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/rma/pedido |
[OPCIONAL] Envia para o ERP o pedido de RMA. |
Não |
| GET api/v1/rma/detalhes/{srmId} |
[OPCIONAL] Retorna os dados sobre o RMA solicitado. |
Não |
Módulo: Revendas e Clientes
Revendas
Fornece as informações sobre as revendas cadastradas no ERP.
| API | Descrição | Obrigatório |
|---|---|---|
| GET api/v1/revenda?cnpj={cnpj} |
Retorna os dados da revenda a partir do CNPJ |
Sim |
| GET api/v1/revenda?cpf={cpf} |
Retorna os dados da revenda a partir do CPF |
Sim |
| GET api/v1/revenda?id={id} |
Retorna os dados da revenda a partir do Id |
Sim |
| GET api/v1/revenda?cnpj={cnpj}&totalPedido={totalPedido}&operacao={operacao}&faturamentoDireto={faturamentoDireto} |
Retorna os prazos de pagamento disponiveis para a revenda, de acordo com valor do pedidoJ |
Sim |
| POST api/v1/revenda/PrazosCarrinho |
Retorna os prazos de pagamento disponiveis para a revenda, de acordo com valor do pedidoJ |
Sim |
| POST api/v1/revenda |
Recebe os dados de cadastro de uma nova revenda a partir dos dados do site. ATENÇÃO: no ERP, o endereço que é enviado nesse método deve ser armazenado inicialmente como o endereço de cobrança e entrega. Caso a revenda opte por um endereço de entrega diferenciado, ele será enviado posteriormente através do método PostAddress. |
Sim |
| PUT api/v1/revenda/AtualizaRevenda |
Recebe os dados de cadastro de uma nova revenda a partir dos dados do site. ATENÇÃO: no ERP, o endereço que é enviado nesse método deve ser armazenado inicialmente como o endereço de cobrança e entrega. Caso a revenda opte por um endereço de entrega diferenciado, ele será enviado posteriormente através do método PostAddress. |
Sim |
| PUT api/v1/revenda/AtualizaLogin |
Recebe os dados de cadastro de uma nova revenda a partir dos dados do site. ATENÇÃO: no ERP, o endereço que é enviado nesse método deve ser armazenado inicialmente como o endereço de cobrança e entrega. Caso a revenda opte por um endereço de entrega diferenciado, ele será enviado posteriormente através do método PostAddress. |
Sim |
| PUT api/v1/revenda?cnpj={cnpj} |
Cancela o pré-cadastro casjo o mesmo ainda não esteja confirmado |
Sim |
| GET api/v1/revenda/{revendaId}/contatos |
Retorna os contatos da revenda. |
Sim |
| GET api/v1/revenda/{revendaId}/vendedores |
Retorna os vendedores da revenda. |
Sim |
| GET api/v1/revenda/{revendaID}/enderecos |
Retorna os endereços da revenda |
Sim |
| POST api/v1/revenda/{revendaId}/enderecos |
Adiciona um novo endereço vinculado à revenda |
Sim |
| POST api/v1/revenda/{revendaId}/ativacao |
Solicita a ativação de uma revenda. Esse método deve notificar o ERP de que o usuário do site deseja ativar o cadastro de uma revenda que existe no ERP mas ainda não foi integrado no site, com o e-mail e senha informados. |
Sim |
| GET api/v1/revenda/{revendaID}/limitecredito |
[OPCIONAL] Retorna o limite de crédito da revenda |
Não |
| GET api/v1/revenda/{revendaId}/pendencia |
[SALES SET] Indica se a revenda possui ou não pendências financeiras |
Sim |
| GET api/v1/revenda/{revendaId}/infoCredito |
[SALES SET] Indica se a revenda possui Infomacao de credito |
Sim |
| GET api/v1/revenda/{revendaId}/infoTitulos |
[SALES SET] Indica se a revenda possui Titulos |
Sim |
Cliente Final
Fornece as informações sobre os clientes finais no ERP.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/clienteFinal |
Nenhuma documentação disponível. |
Sim |
| GET api/v1/clienteFinal/{clienteFinalId}/enderecos |
Retorna os endereços da cliente final |
Sim |
| POST api/v1/clienteFinal/pessoaFisica |
Cadastra um novo cliente final pessoa física a partir dos dados fornecidos no site |
Sim |
| POST api/v1/clienteFinal/pessoaJuridica |
Cadastra um novo cliente final pessoa física a partir dos dados fornecidos no site |
Sim |
| POST api/v1/clienteFinal/{clienteFinalId}/enderecos |
Adiciona um novo endereço vinculado ao cliente final |
Sim |
Módulo: Sales Set
Serial Number
[SALES SET] Busca por SerialNumber. Recebe o termo de busca e o tipo de dado e deve retornar o SerialNumber e PartNumber.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/serialnumber |
Nenhuma documentação disponível. |
Sim |
Preços (múltiplos em um request)
[SALES SET] [OPCIONAL] Pode ser usado para fornecer num único request múltiplos preços para o site (Sales Set). O conjunto de preços retornado contempla todos os Centros de Distribuição (Filiais) que possuam o produto para venda.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/salesset/precos |
A partir dos Part Numbers e dos dados do usuário logado, deve retornar os preços dos produtos. |
Sim |
Pedido
[SALES SET] Deve receber um pedido do site (SALES SET) e integrá-lo aos sistemas internos do cliente. É necessário fornecer um código de protocolo único para confirmar a integração com sucesso do pedido.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/salesset/pedido |
A partir dos dados do pedido do cliente, deve integrar o pedido para o sistema interno e retornar um protocolo. |
Sim |
Transportadora
[SALES SET] Deve fornecer a lista de transportadoras (SALES SET).
| API | Descrição | Obrigatório |
|---|---|---|
| GET api/v1/salesset/transportadora/{id} |
Retorna a transportadora pelo Id. |
Sim |
| POST api/v1/salesset/transportadora |
Através do termo de busca informado, deve retornar as opções de transportadora disponíveis. |
Sim |
| GET api/v1/salesset/transportadora/retornarTransportadoras |
Nenhuma documentação disponível. |
Sim |
Opções de Pagamento
[SALES SET] Opções de pagamento no checkout do Sales Set.
| API | Descrição | Obrigatório |
|---|---|---|
| GET api/v1/salesset/opcaopagamento |
Retorna todas as opções disponíveis de pagamento no Sales Set. |
Sim |
| POST api/v1/salesset/opcaopagamento/cart |
Nenhuma documentação disponível. |
Sim |
Preço
[SALES SET] Deve fornecer os preços para os produtos do site (Sales Set). O conjunto de preços retornado contempla todos os Centros de Distribuição (Filiais) que possuam o produto para venda.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/salesset/preco |
A partir do Part Number, dos dados do usuário logado e da forma de pagamento, deve retornar os preços do produto. Diferente do método padrão de preço, esse aqui pode ser influenciado pela forma de pagamento selecionada no processo do Sales Set, retornando o preço adequado para cada ocasião. |
Sim |
Margens
[SALES SET] Deve fornecer os preços de margem do produto no site (Sales Set).
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/salesset/margem |
A partir dos dados do checkout junto com preco comissionado, retorna o valor de margem disponivel para determinado item. |
Sim |
Banco
[SALES SET] Busca de registros de banco para uso no checkout do Sales Set.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/salesset/banco |
A partir do termo de busca digitado, o ERP deve retornar os registros correspondentes dos bancos relacionados. |
Sim |
| GET api/v1/salesset/banco/{id} |
Retorna o banco através do ID |
Sim |
Endereços
[SALES SET] Deve buscar os endereços dos terceiros (Sales Set). O método irá retornar o id do Terceiro (revenda ou cliente final) e o sistema irá usar o endereço relacionado a esse id pro fechamento do pedido Sales Set.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/salesset/endereco/search |
Busca de endereço de acordo com o termo de busca utilizado. |
Sim |
Frete
[SALES SET] Cálculo de frete do Sales Set. Recebe o carrinho do cliente e deve retornar as opções disponíveis de frete.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/salesset/frete |
Nenhuma documentação disponível. |
Sim |
Módulo: Simulador de preços
Preço
[OPCIONAL] Simulador de preços.
| API | Descrição | Obrigatório |
|---|---|---|
| POST api/v1/preco/simulador |
[OPCIONAL] A partir dos dados do simulador de compras, deve retornar os preços para o Part Number específico. |
Não |
| POST api/v1/precos/simulador |
[OPCIONAL] A partir dos dados do simulador de compras, deve retornar os preços para os Part Numbers específicos. |
Não |