API docs by Redocly

API - Alterdata modaUP - PRODUÇÃO

Download OpenAPI specification:

modaUP API é uma plataforma que permite aos clientes da Alterdata, integrar diversos recursos de sistemas de terceiros ao modaUP através de funcionalidades disponibilizadas por um conjunto de APIs RestFul/JSON.

Primeiros passos

Veja como é simples começar a desenvolver com a nossa API:

1 - Registre-se!

Para obter acesso às APIs, é necessário entrar em contato com nosso canal de atendimento no karoo e verificar a viabilidade de disponibilização para sua empresa.

Após isto, cadastraremos sua aplicação e lhe passaremos seus Tokens de acesso.

Leia o tópico de autenticação para entender como funcionam os Tokens.

2 - Conhecendo as APIs

Antes de iniciar o desenvolvimento, leia sobre os padrões de modelagem das APIs no tópico APIs.

Depois, navegue pela documentação para conhecer as funcionalidades disponíveis.

3 - Desenvolva sua aplicação

Agora que você já possui seu cadastro, os Tokens de acesso e já conhece melhor a API, comece a desenvolver sua aplicação.

APIs

Esta API fornece aos desenvolvedores que a consomem a possibilidade de integração com diversas funcionalidades do modaUP.

Modelagem das API's

Todos os serviços disponibilizados através da API utilizam a tecnologia REST (Representational State Transfer), uma arquitetura que permite interações com serviços web RestFul que disponibiliza recursos através de sistemas distribuídos, popularmente utilizados via HTTP.

Onde:

  • Hostname: Endereço principal do serviço

  • Versão da API: Versão do serviço que está sendo consumido

  • Recurso Raiz: Nome do serviço

Por exemplo: https://seuservidordaAPI.com.br/api/clientes

No Recurso Raiz, podemos acessar as principais operações do serviço (CRUD), através dos métodos do padrão HTTP, conforme tabela abaixo:

CRUD Métodos HTTP
Create POST
Read GET
Update PUT
Delete DELETE

Ou seja, no serviço /clientes, do exemplo acima, se fizermos uma operação POST, salvaremos um novo cliente.

A tabela abaixo mostra algumas das operações que conseguimos executar sobre determinados serviços:

Recurso GET POST
/clientes * Cria um novo cliente
/produtos Lista com todos os produtos cadastrados *
/produtos/00A0000001 Lista detalhes do produto com identificador 00A0000001 *
  • O '*' representa que o método não está disponível, então espera-se o retorno com ERRO 405 - method not allowed

HTTP 1.1

O protocolo padrão para comunicação com as APIs é o HTTP versão 1.1.

Para mais informações sobre esse protocolo, consulte:

http://www.w3.org/Protocols/rfc2616/rfc2616.html

http://www.ietf.org/rfc/rfc2616.txt

UTF-8

O Charset padrão para chamadas às APIs é o UTF-8. Para mais informações sobre essa codificação, consulte:

https://tools.ietf.org/html/rfc3629

JSON

JSON (JavaScript Object Notation) é um padrão para descrição de dados para intercâmbio entre sistemas e é mais simples e mais leve que o XML.

Por padrão, toda a API trafega JSON, tanto para receber informações (métodos POST e PUT) quanto no retorno (método GET)

Devido a essa padronização, para as chamadas POST e PUT é necessário informar o HTTP Header content-type:application/json. Do contrário, você receberá um erro HTTP 415: Unsupported Media Type

Requisitos

Para poder utilizar a api é necessário se atentar aos seguintes requisitos:

  • Verificar se a api atende suas necessidades através de uma exploração maior da documentação a fim de verificar se as funcionalidades disponibilizadas irão atender às pretendidas.

  • IIS 7.5 ou superior instalado no servidor;

  • Net Framework 4.7.2 ou superior instalado no servidor;

  • Acesso ao banco de dados SQL onde está a base do Interface Net;

    • Para a criação de um login para ser utilizado pelo Interface Net

  • Versão corrente da documentação ou superior do Alterdata Interface Net

    • Caso não esteja na versão informada, solicite a atualização via suporte

  • Acesso ao módulo Cadastro de Usuário do Interface Net.

  • Versão do Windows em período de suporte da Microsoft (A instalação pode ser realizada em uma versão fora do suporte, mas não há garantia de funcionamento)

  • Base de homologação do Interface Net (Não é um requisito, mas é altamente recomendado)

    • Base de dados que é uma cópia da base de produção voltada para os testes.

Dúvidas e Sugestões

Gostaria de sugerir um novo recurso? Acesse a Central do cliente em https://www.alterdata.com.br e crie um registro em Minhas sugestões.

Caso continue com problemas você também pode entrar em contato com nosso time de suporte, estamos sempre felizes em ajudar!

Atenção: A modaUP API pode funcionar tanto em HTTP quanto em HTTPs e irá depender da infraestrutura onde a mesma foi instalada.

Erros comuns

Existem alguns erros comuns que podem acontecer ao utilizar a api, dentre eles estão:

  • Erro 405 - The requested resource does not support http method '...'.

    1. Pode ser causado pela utilização de uma versão mais antiga da api.

  • Erro 400 - Não foi possível hidratar a entidade '...' com identificador 00000.

    1. Pode ser causado por um identificador incorreto. Lembre-se que os identificadores do modaUP são compostos de 10 caracteres alfanuméricos.
    2. Pode ser causado pelo identificador não existir no banco de dados. Isso pode ser causado pela remoção indevida do registro do banco. Por favor entre em contato com o suporte.

  • Erro 401 - Authorization has been denied for this request.

    1. O token de autenticação utilizado expirou ou é inválido

  • Erro 403 - Forbidden

    1. O usuário atual não possui acesso a essa rota. Libere o acesso no módulo cadastro de usuários.

Código do Cliente e Guardian

Obter código de cliente

path Parameters
marca
required
string
Example: MARCA

Marca

Responses

Response samples

Content type
application/json
{}

Autenticação

Criar token para utilização no serviço

Cria o token que será utilizado para realizar todas as requisições para a API. Esse token deve ser utilizado no header de todas as requisições para a api com a key Authorization e o value "bearer + token" A validade deste token é de 12 horas. Após isto será necessário utilizar o refresh token para receber um novo token de autenticação.

  • É recomendado que o tráfego de informações sempre seja feito através de protocolo HTTPS (SSL), sendo que para chamadas a recursos que não sejam feitas por intermédio deste protocolo, o conteúdo trafegado fica sob responsabilidade do Desenvolvedor. Contudo sem esta abordagem os tokens de segurança ficam visíveis e podem gerar problemas de segurança para seu sistema.
Request Body schema: application/x-www-form-urlencoded
Array
grant_type
string

Utilize o valor padrão "client_credentials".

scope
string

Escopo de acesso aos módulos da API. Inserir quais módulos serão utilizados, separando-os por um espaço.

client_id
string

Email do usuário de acesso aos serviços Moda.

client_secret
string

Senha de acesso aos serviços Moda

Responses

Response samples

Content type
application/json
{
  • "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyb2xlI",
  • "token_type": "bearer",
  • "expires_in": 899,
  • "refresh_token": "df11fb7117264120a71b65311c943789",
  • "client_id": "aplicação.js",
  • "userName": "usuário",
  • ".issued": "Thu, 01 Oct 2015 18:27:26 GMT",
  • ".expires": "Thu, 01 Oct 2015 18:42:26 GMT"
}

Reautenticar o token para utilização no serviço

O Refresh Token, tem sempre uma validade de 30 minutos, caso o tempo da sessão tenha expirado será necessário realizar os passos de autenticação novamente.

Request Body schema: application/x-www-form-urlencoded
Array
client_id
string

Este valor será passado pela Alterdata com o nome da sua aplicação que será liberada para acesso a api.

grant_type
string

No caso de reautenticação será sempre fixo "refresh_token".

refresh_token
string

Hash de refresh token recebido no retorno da autenticação.

Responses

Response samples

Content type
application/json
{
  • "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyb2xlI",
  • "token_type": "bearer",
  • "expires_in": 899,
  • "refresh_token": "df11fb7117264120a71b65311c943789",
  • "client_id": "aplicação.js",
  • "userName": "usuário",
  • ".issued": "Thu, 01 Oct 2015 18:27:26 GMT",
  • ".expires": "Thu, 01 Oct 2015 18:42:26 GMT"
}

Fake

Consulta Fake

Descrição do endpoint (para que ele serve)

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Usuario

Obter usuário por email

Obtém usuário por email

path Parameters
email
required
string
Example: email@email.com

Email do Usuário

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "begin": "2023-11-07T18:19:34.403Z",
  • "end": "2023-11-07T18:19:34.403Z",
  • "success": true,
  • "data": {
    },
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": [
    ],
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

Obter usuário por matricula

Obtém usuário por matricula

path Parameters
matricula
required
string
Example: 000111

Matricula do Usuário

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "begin": "2023-11-07T18:19:34.403Z",
  • "end": "2023-11-07T18:19:34.403Z",
  • "success": true,
  • "data": {
    },
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": [
    ],
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

Obter usuários realizando filtros

Obtém usuários podendo filtrar por Rede, Filial, e Ativo/Inativo. Também pode ser escolhido o tamanho da página e a quantidade de itens por página

path Parameters
rede
required
string
Example: 01

Rede a ser filtrada

filial
required
string
Example: 01

Filial a ser filtrada

inativo
required
number
Example: 0

Filtro para ativo/inativo. Valor "0" para ativo. Valor "1" para inativo

page
required
number
Example: 1

Página a ser filtrada. Caso não seja utilizado, possui valor 1 como padrão

pageSize
required
number
Example: 5

Quantidade de itens por página. Caso não seja utilizado, possui valor 5 como padrão

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "begin": "2023-11-07T18:19:34.403Z",
  • "end": "2023-11-07T18:19:34.403Z",
  • "success": true,
  • "data": {
    },
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": [
    ],
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

Cadastro de Usuário

Realiza o Cadastro de um usuário

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
matricula
required
string

Código da matricula do usuário

nome
string

Nome do Usuário. Campo não-obrigatório, mas por motivos de compatibilidade, é recomendado que seja utilizado.

senha
string

Senha do Usuário

acesso
required
string

Depreciado. Recomendado enviar uma string vazia

abreviado
required
string

Nome do Usuário

cadastro
string

12-31T14:41:26.112Z (string) - Data de Cadastro do Usuário

filial
required
string

Código da filial do usuário

status
required
string

Define se o usuário está ativo ou não. Valor "N" para ativo. Valor "S" para inativo

zoom
number

Zoom inicial que será utilizado ao visualizar algum relatório no Desktop. Número de 0 a 200

atualizacao
string

12-31T14:41:26.112Z (string) - Data de Atualização do Usuário

depto
string

Departamento do Usuário

geral2
required
number

Define se o usuário terá acesso geral ao sistema. Valor "0" para Acesso Parcial. Valor "1" para Acesso Completo

acesso2
string

Armazena as permissões de acesso as telas do sistema de forma criptografada. Os valores abaixo estão organizados por ordem, na seguinte forma: SISTEMA | TELA(Desktop) | TIPO | CÓDIGO | SUBCÓDIGO(Se existir)

grupo
string

Código do Perfil de Usuário vinculado.

acessoRede
string

Código da rede a qual o Usuário terá acesso. Códigos devem ser separados por ","

representante
string

Código do Representante vinculado

acessoDataCaixaStatus
string

VERIFICAR

email
string

E-mail de cadastro do Usuário

vendedor
string

Define o código do Vendedor selecionado no cadastro do sistema.

acessoFilial
string

Código das filiais em que o usuário terá permissão. São separadas por vírgula e aspas simples.

Responses

Request samples

Content type
application/json
{
  • "matricula": "010101",
  • "nome": "Nome Usuario",
  • "senha": "123123",
  • "acesso": "\"\"",
  • "abreviado": "Nome Usuario",
  • "cadastro": "2023",
  • "filial": "01",
  • "status": "N",
  • "zoom": 0,
  • "atualizacao": "2023",
  • "depto": "Departamento",
  • "geral2": 1,
  • "acesso2": "1111111111111111111111111111111111111111111111111101101000011111111011111011111111111001111111100111111111111110111111111111111111111111111111111111111111111111111111111111111111111110000011111110100111111110111111111111111111111111000000000000000000",
  • "grupo": "01010101",
  • "acessoRede": "01,02,03",
  • "representante": "representante",
  • "acessoDataCaixaStatus": "acessoDataCaixaStatus",
  • "email": "email",
  • "vendedor": "010101",
  • "acessoFilial": "'01','02','03'"
}

Response samples

Content type
application/json
{
  • "begin": "2023-11-07T18:19:34.403Z",
  • "end": "2023-11-07T18:19:34.403Z",
  • "success": true,
  • "data": {
    },
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": [
    ],
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

Atualizar Usuário

Atualiza o Cadastro de um usuário

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
matricula
required
string

Código da matricula do usuário

nome
string

Nome do Usuário. Campo não-obrigatório, mas por motivos de compatibilidade, é recomendado que seja utilizado.

senha
string

Senha do Usuário

acesso
required
string

Depreciado. Recomendado enviar uma string vazia

abreviado
required
string

Nome do Usuário

cadastro
string

12-31T14:41:26.112Z (string) - Data de Cadastro do Usuário

filial
required
string

Código da filial do usuário

status
required
string

Define se o usuário está ativo ou não. Valor "N" para ativo. Valor "S" para inativo

zoom
number

Zoom inicial que será utilizado ao visualizar algum relatório no Desktop. Número de 0 a 200

atualizacao
string

12-31T14:41:26.112Z (string) - Data de Atualização do Usuário

depto
string

Departamento do Usuário

geral2
required
number

Define se o usuário terá acesso geral ao sistema. Valor "0" para Acesso Parcial. Valor "1" para Acesso Completo

acesso2
string

Armazena as permissões de acesso as telas do sistema de forma criptografada. Os valores abaixo estão organizados por ordem, na seguinte forma: SISTEMA | TELA(Desktop) | TIPO | CÓDIGO | SUBCÓDIGO(Se existir)

grupo
string

Código do Perfil de Usuário vinculado.

acessoRede
string

Código da rede a qual o Usuário terá acesso. Códigos devem ser separados por ","

representante
string

Código do Representante vinculado

acessoDataCaixaStatus
string

VERIFICAR

email
string

E-mail de cadastro do Usuário

vendedor
string

Define o código do Vendedor selecionado no cadastro do sistema.

acessoFilial
string

Código das filiais em que o usuário terá permissão. São separadas por vírgula e aspas simples.

Responses

Request samples

Content type
application/json
{
  • "matricula": "010101",
  • "nome": "Nome Usuario",
  • "senha": "123123",
  • "acesso": "\"\"",
  • "abreviado": "Nome Usuario",
  • "cadastro": "2023",
  • "filial": "01",
  • "status": "N",
  • "zoom": 0,
  • "atualizacao": "2023",
  • "depto": "Departamento",
  • "geral2": 1,
  • "acesso2": "1111111111111111111111111111111111111111111111111101101000011111111011111011111111111001111111100111111111111110111111111111111111111111111111111111111111111111111111111111111111111110000011111110100111111110111111111111111111111111000000000000000000",
  • "grupo": "01010101",
  • "acessoRede": "01,02,03",
  • "representante": "representante",
  • "acessoDataCaixaStatus": "acessoDataCaixaStatus",
  • "email": "email",
  • "vendedor": "010101",
  • "acessoFilial": "'01','02','03'"
}

Response samples

Content type
application/json
{
  • "begin": "2023-11-07T18:19:34.403Z",
  • "end": "2023-11-07T18:19:34.403Z",
  • "success": true,
  • "data": {
    },
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": [
    ],
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

CartaoCredenciadora

Consulta cartão credenciadora por versão

path Parameters
versao
required
number
Example: 2

Versão da credenciadora

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consulta cartão credenciadora

Descrição do endpoint (para que ele serve)

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

CartaoMalote

Consulta cartão credenciadora

Descrição do endpoint (para que ele serve)

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

NFEConfig

Cadastrar Configuração de Nota Fiscal Eletronica

Cadastra Configuração de Nota Fiscal Eletronica

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
codigo
number

Código sequncial identificador

filial
string

Código da loja a qual a configuração se destina

filialc
string

Código da filial que está realizando o cadastro dessa configuração

serie
number

Código da Série Retaguarda

descricao
string

Descricao da configuação

tipo
string

Tipo de nota fiscal cadastrado no sistema pelo usuário.

natureza
string

Código da Natureza do CFOP para Produtos de Produção Própria

marca
string

Descrição da Marca

especie
string

Descrição da Espécie

tFrete
string

Tipo de frete.

Valor 1 + valor abaixo: Tipos de frete existentes: 0 - Contratação do Frete por conta do Remetente (CIF) 1 - Contratação do Frete por conta do Destinatário (FOB) 2 - Contratação do Frete por conta de Terceiros 3 - Transporte Próprio por conta do Remetente 4 - Transporte Próprio por conta do Destinatário 9 - Sem Ocorrência de Transporte

transportadora
string

Código da transportadora

via
string

Descrição do Transporte

pisTributacao
number

Código da Tributação do PIS

pisAliquota
number

Alíquota da Tributação de PIS

cofinsTributacao
number

Código da Tributação de COFINS

cofinsAliquota
number

Alíquota da Tributação de COFINS

inativo
number

Valor '0' para Ativo. Valor '1' para Inativo

cadastro
string

12-14T12:55:46 (string) - Data de Cadastro

atualizacao
string

12-14T12:55:46 (string) - Data de Atualização

matricula
string

Código do login do usuário

funcao
string

Definição de tipo de emissão fiscal para qual essa configuração automatizada poderá ser utilizada

Texto de 13 posições com valores 0 ou 1. Identificação da posições: 1 - Romaneiro de distribuição 2 - Pedido de venda 3 - Separação de pedido 4 - Avulso 5 - Boleta s/ ECF 6 - Venda c/ ECF 7 - Romaneio de transferência 8 - Matéria prima 9 - Boleta de troca 10 - Consignação saída 11 - Consignação devolução 12 - NFC-e 13 - Simples Remessa

serieLoja
number

Código da Série Loja

cadastraPlaca
number

Valor '0' para Não. Valor '1' para Sim

tributacao
number

Identificação da tabela de tributação a ser utilizada para destaque tributário

naturezaSubstituicao
string

Código da Natureza do CFOP para Substituição Tributaria para Produtos de Produção Própria

cstPadrao
number

Código do CST Padrão

tipoNf
number

Valor '55' para NF-e. Valor '65' para NFC-e

csosnPadrao
number

Código do CSOSN Padrão

naturezaTerceiro
string

Código da Natureza do CFOP para Produtos de Produção de Terceiros

naturezaTerceiroSubstituicao
string

Código da Natureza do CFOP para Substituição Tributaria para Produtos de Produção de Terceiros

desoneracaoICMS
string

Indica se essa configuração terá algum tipo de cálculo de desoneração de ICMS. Valor '0' para não. Valor '1' para Sim

naturezaConsignado
string

Código da Natureza do CFOP para Produtos em Consignação

naturezaConsignadoSubstituicao
string

Código da Natureza do CFOP para Substituição Tributaria para Produtos em Consignação

filiaDescricao
string

Campo ainda não utilizado

Responses

Request samples

Content type
application/json
{
  • "codigo": 9,
  • "filial": "01",
  • "filialc": "01",
  • "serie": 555,
  • "descricao": "Configuação de Teste",
  • "tipo": "10",
  • "natureza": "000001",
  • "marca": "CX",
  • "especie": "Especie",
  • "tFrete": "10",
  • "transportadora": "000003",
  • "via": "Rodoviario",
  • "pisTributacao": 99,
  • "pisAliquota": 0,
  • "cofinsTributacao": 99,
  • "cofinsAliquota": 0,
  • "inativo": 0,
  • "cadastro": "2020",
  • "atualizacao": "2020",
  • "matricula": "00000001",
  • "funcao": "0101010101010",
  • "serieLoja": 854,
  • "cadastraPlaca": 0,
  • "tributacao": 1,
  • "naturezaSubstituicao": "000001",
  • "cstPadrao": 11,
  • "tipoNf": 55,
  • "csosnPadrao": 90,
  • "naturezaTerceiro": "000001",
  • "naturezaTerceiroSubstituicao": "000001",
  • "desoneracaoICMS": "0",
  • "naturezaConsignado": "000001",
  • "naturezaConsignadoSubstituicao": "000001",
  • "filiaDescricao": "null"
}

Response samples

Content type
application/json
{
  • "begin": "2023-11-07T18:19:34.403Z",
  • "end": "2023-11-07T18:19:34.403Z",
  • "success": true,
  • "data": {
    },
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": [
    ],
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

Fornecedor

Obtém a listagem de Fornecedores

Endpoint de consulta para a listagem de Fornecedoores. As ordenações e quantidade de itens por Página são passados no Header da requisição. Outros filtros são passados como parametros na query. Ao filtrar, é possivel escolher qual será a ordenação da listagem no Header. Siga a tabela abaixo para utilizar o valor correto para a ordenação.

VALOR DESCRIÇÃO
codigo Código do Fornecedor
nome Nome do Fornecedor
fantasia Nome Fantasia do Fornecedor
endereco Endereço do Fornecedor
bairro Bairro do Fornecedor
telefone Telefone do Fornecedor
contato Contato do Fornecedor
inativo Fornecedor Inativo

Também é possivel escolher o Tipo de Produto utilizando o parametro "tipoProduto" na query. Siga a tabela abaixo para utilizar o valor correto de cada Tipo.

VALOR DESCRIÇÃO
A Produtos Administrativos
M Matéria Prima
V Produto Loja
S Prestador de Serviços
F Facção
path Parameters
codigo
required
string
Example: 0001

Código do Fornecedor

tipoCliente
required
string
Example: A

Tipo de Cliente. Valor "J" prara Juridica. Valor "F" para Física. Valor "I" para Importadora.

tipoProduto
required
string
Example: 2024

12-31T23:59:59.000Z (string) - Tipo do do Produto. Verificar a tabela na descrição do Endpoint

termo
required
string
Example: 2024

12-31T23:59:59.000Z (string) - Procura por Nome, Nome fantasia, Código, CPF e/ou CNPJ.

inativo
required
boolean
Example: false

Booleano para filtrar por fornecedor ativo ou inativo.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

ordenadoPor
string
Example: status (string) - Item que será ordenado. Verificar a tabela na descrição do Endpoint

e.g. status (string) - Item que será ordenado. Verificar a tabela na descrição do Endpoint

direcao
string
Example: DESC (string) - Direção da Ordenação. "ASC" para direção ascendente. "DESC" para ordenação descendente.

e.g. DESC (string) - Direção da Ordenação. "ASC" para direção ascendente. "DESC" para ordenação descendente.

pagina
string
Example: 1 (number) - Página da busca. Valor "1" como padrão.

e.g. 1 (number) - Página da busca. Valor "1" como padrão.

itensPorPagina
string
Example: 20 (number) - Página da busca. Valor "20" como padrão.

e.g. 20 (number) - Página da busca. Valor "20" como padrão.

Responses

Response samples

Content type
application/json
{
  • "begin": "2023",
  • "end": "2023",
  • "success": true,
  • "data": {
    },
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": [
    ],
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

PedidoMalote

Obtém a listagem de Pedido de Compras

Endpoint de consulta para a listagem de Pedido de Compras. As ordenações e quantidade de itens por Página são passados no Header da requisição. Outros filtros são passados como parametros na query. Ao filtrar, é possivel escolher qual será a ordenação da listagem no Header. Siga a tabela abaixo para utilizar o valor correto para a ordenação.

VALOR DESCRIÇÃO
pedidoId Código do Pedido
fornecedorNome Nome do Fornecedor
filialNome Nome da Loja
status Status do Pedido
totalPedido Total do Pedido
totalEntregue Total Entrege do Pedido
valorPedido Valor Total do Pedido
data Data de Emissão do Pedido
inicioEntrega Data de Inicio da Entrega
fimEntrega Data do Fim da Entrega

Também é possivel escolher o status do Pedido de Compra utilizando o parametro "status" na query. Siga a tabela abaixo para utilizar o valor correto de cada status.

VALOR DESCRIÇÃO
A Aberto
P Pendente
T Totalmente Recebido
F Finalizado
E Excluido
B Baixado
path Parameters
pedido
required
string
Example: 0001

Código do Pedido

status
required
string
Example: A

Status do Pedido. Verificar a tabela na descrição do Endpoint

dataEmissao
required
string
Example: 2024-12-31T23:59:59.000Z

Data de Emissão do Pedido

inicioEntrega
required
string
Example: 2024-12-31T23:59:59.000Z

Data de Inicio da Entrega

fimEntrega
required
string
Example: 2024-12-31T23:59:59.000Z

Data de Fim da Entrega

fornecedor
required
string
Example: 0001

Código do Fornecedor da Entrega

localEntrega
required
string
Example: 0001

Código da Filial do Local de Entrega

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

ordenadoPor
string
Example: status (string) - Item que será ordenado. Verificar a tabela na descrição do Endpoint

e.g. status (string) - Item que será ordenado. Verificar a tabela na descrição do Endpoint

direcao
string
Example: DESC (string) - Direção da Ordenação. "ASC" para direção ascendente. "DESC" para ordenação descendente.

e.g. DESC (string) - Direção da Ordenação. "ASC" para direção ascendente. "DESC" para ordenação descendente.

pagina
string
Example: 1 (number) - Página da busca. Valor "1" como padrão.

e.g. 1 (number) - Página da busca. Valor "1" como padrão.

itensPorPagina
string
Example: 20 (number) - Página da busca. Valor "20" como padrão.

e.g. 20 (number) - Página da busca. Valor "20" como padrão.

Responses

Response samples

Content type
application/json
{
  • "begin": "2024-12-31T23:00:00.000Z",
  • "end": "2024-12-31T23:00:00.000Z",
  • "success": true,
  • "data": [
    ],
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "notification": "notification",
  • "businessViolations": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

Inclusão de Pedido de Compras

path Parameters
filial
required
number
Example: 0001

Código da filial do Pedido a ser criado

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
pedidoId
string

Código do Pedido

fornecedor
string
data
string

31-12T12:18:11.813Z (string)

status
string
observacao
string

Observação do Pedido

cadastro
string

31-12T12:18:11.813Z (string)

inicioEntrega
string

31-12T12:18:11.813Z (string)

fimEntrega
string

31-12T12:18:11.813Z (string)

minimo
number
condicao
string
tecnicas
string
baixa
string

31-12T12:18:11.813Z (string)

matricula
string
atualizacao
string

31-12T12:18:11.813Z (string)

previsaoOriginal
string

31-12T12:18:11.813Z (string)

atacado
number
tabela
number
frete
number
filialEntrega
string
fabril
number
Array of objects (PedidoMalotePOSTPedidoItens)
object (PedidoMalotePOSTFilialEntity)
object (PedidoMalotePOSTFornecedorEntity)
object (PedidoMalotePOSTTabelaPrecoEntity)

Responses

Request samples

Content type
application/json
{
  • "pedidoId": "0001",
  • "fornecedor": "0001",
  • "data": "2024",
  • "status": "status",
  • "observacao": "observacao",
  • "cadastro": "2024",
  • "inicioEntrega": "2024",
  • "fimEntrega": "2024",
  • "minimo": 0,
  • "condicao": "condicao",
  • "tecnicas": "tecnicas",
  • "baixa": "2024",
  • "matricula": "matricula",
  • "atualizacao": "2024",
  • "previsaoOriginal": "2024",
  • "atacado": 0,
  • "tabela": 0,
  • "frete": 0,
  • "filialEntrega": "filial",
  • "fabril": 0,
  • "pedidoItens": [
    ],
  • "filialEntity": {
    },
  • "fornecedorEntity": {
    },
  • "tabelaPrecoEntity": {
    }
}

Response samples

Content type
application/json
{
  • "begin": "2023-11-07T18:19:34.403Z",
  • "end": "2023-11-07T18:19:34.403Z",
  • "success": true,
  • "data": true,
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": [
    ],
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

Certificado

Inclusão de Certificado

O endpoint tem a finalidade de inclusão de um certificado digital no sistema é um recurso que possibilita o registro e integração de certificados digitais dentro da plataforma. Esse processo é essencial para estabelecer a autenticidade e a validade de informações e transações, garantindo a segurança e confiabilidade de operações realizadas no ambiente digital. Por meio desse endpoint, os certificados digitais podem ser devidamente incorporados ao sistema, assegurando a integridade e a identificação segura dos usuários e entidades envolvidas nas interações digitais.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
object (certificado)
object (certificadoFilial)

Responses

Request samples

Content type
application/json
{
  • "certificado": {
    },
  • "certificadoFilial": {
    }
}

Response samples

Content type
application/json
{
  • "begin": "2023",
  • "end": "2023",
  • "success": true,
  • "data": true,
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": [
    ],
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

PedidoVendaMalote

Consulta a Pedidos de Venda

Endpoint para consultar Pedidos de Venda As ordenações e quantidade de itens por Página são passados no Header da requisição. Outros filtros são passados como parametros na query. Ao filtrar, é possivel escolher qual será a ordenação da listagem no Header. Siga a tabela abaixo para utilizar o valor correto para a ordenação.

VALOR DESCRIÇÃO
serie Número de Série
nota Número da Nota
cadastro Data de Cadastro
valor Valor Total
fornecedor Fornecedor
filial Filial
tipo Tipo
excluida Status

Também é possivel escolher o Status ao filtrar utilizando o parametro "status" na query. Siga a tabela abaixo para utilizar o valor correto de cada Status.

VALOR DESCRIÇÃO
A Abertos
B Baixados
E Excluido
F Finalizado
P Entregue Parcial
T Entregue Total
path Parameters
pedido
required
string
Example: 0001

Código do Pedido

dataInicial
required
string
Example: 2024

12-31 (string) - Data Inicial do Periodo para Consulta

dataFinal
required
string
Example: 2024

12-31Z (string) - Data Final do Periodo para Consulta

codigon
required
string
Example: 0001

Codigo do Cliente

representante
required
string
Example: 0001

Código do Representante

status
required
string
Example: A

Status do Pedido. Verificar a tabela na descrição do Endpoint.

cota
required
string
Example: 0001

Código da Cota

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

ordenadoPor
string
Example: status (string) - Item que será ordenado. Verificar a tabela na descrição do Endpoint

e.g. status (string) - Item que será ordenado. Verificar a tabela na descrição do Endpoint

direcao
string
Example: DESC (string) - Direção da Ordenação. "ASC" para direção ascendente. "DESC" para ordenação descendente.

e.g. DESC (string) - Direção da Ordenação. "ASC" para direção ascendente. "DESC" para ordenação descendente.

pagina
string
Example: 1 (number) - Página da busca. Valor "1" como padrão.

e.g. 1 (number) - Página da busca. Valor "1" como padrão.

itensPorPagina
string
Example: 20 (number) - Página da busca. Valor "20" como padrão.

e.g. 20 (number) - Página da busca. Valor "20" como padrão.

Responses

Response samples

Content type
application/json
{
  • "begin": "2023",
  • "end": "2023",
  • "success": true,
  • "data": {
    },
  • "isBusinessViolation": true,
  • "businessViolations": [
    ],
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

NotaEntradaMalote

Consulta a Notas de Entrada

Endpoint para adicionar uma nota de entrada As ordenações e quantidade de itens por Página são passados no Header da requisição. Outros filtros são passados como parametros na query. Ao filtrar, é possivel escolher qual será a ordenação da listagem no Header. Siga a tabela abaixo para utilizar o valor correto para a ordenação.

VALOR DESCRIÇÃO
serie Número de Série
nota Número da Nota
cadastro Data de Cadastro
valor Valor Total
fornecedor Fornecedor
filial Filial
tipo Tipo
excluida Status
path Parameters
tipo
required
number
Example: 1

Tipo da Nota. Valor "1" para Entrada. Valor "2" para Saída

serie
required
string
Example: 55

Número de Série da Nota

notaDe
required
string
Example: 0001

Número da Nota Inicial

notaAte
required
string
Example: 0001

Número da Nota Final

periodoInicio
required
string
Example: 2024

12-31T23:59:59.000Z (string) - Data Inicial do Periodo para Consulta

periodoFim
required
string
Example: 2024

12-31T23:59:59.000Z (string) - Data Final do Periodo para Consulta

tipoPeriodo
required
number
Example: 1

Tipo do filtro de Período. Valor "1" para Cadastro. Valor "2" para Emissão. Valor "3" para Entrada

excluida
required
boolean
Example: true

Valor "true" para retornar as notas excluidas. Valor "false" para não retornar as notas excluidas.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

ordenadoPor
string
Example: status (string) - Item que será ordenado. Verificar a tabela na descrição do Endpoint

e.g. status (string) - Item que será ordenado. Verificar a tabela na descrição do Endpoint

direcao
string
Example: DESC (string) - Direção da Ordenação. "ASC" para direção ascendente. "DESC" para ordenação descendente.

e.g. DESC (string) - Direção da Ordenação. "ASC" para direção ascendente. "DESC" para ordenação descendente.

pagina
string
Example: 1 (number) - Página da busca. Valor "1" como padrão.

e.g. 1 (number) - Página da busca. Valor "1" como padrão.

itensPorPagina
string
Example: 20 (number) - Página da busca. Valor "20" como padrão.

e.g. 20 (number) - Página da busca. Valor "20" como padrão.

Responses

Response samples

Content type
application/json
{
  • "begin": "2023",
  • "end": "2023",
  • "success": true,
  • "data": {
    },
  • "isBusinessViolation": true,
  • "businessViolations": [
    ],
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

Inclusão de Nota de Entrada

Endpoint para adicionar uma nota de entrada

path Parameters
rede
required
string
Example: rede

Rede

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
object (NotaEntradaMalotePOSTAdicionarNotaEntrada)

Responses

Request samples

Content type
application/json
{
  • "NotaEntrada": {
    }
}

Response samples

Content type
application/json
{
  • "begin": "2023",
  • "end": "2023",
  • "success": true,
  • "data": {
    },
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": [
    ],
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

Consulta Notas de Entrada por Chave de Acesso

Endpoint para consultar uma nota fiscal de entrada por meio da chave de acesso. A chave da Nota Fiscal de entrada deve ser incluída diretamente no endpoint.

VALOR DESCRIÇÃO
chave Chave de Acesso da NF-e
path Parameters
chave
required
number
Example: 99999999999999999999999999999999999999999999

Numero composto por 44 digitos.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "begin": "2023",
  • "end": "2023",
  • "success": true,
  • "data": [
    ],
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": [
    ],
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

Inclusão de Conferencia de Notas de Entrada

Endpoint para enviar a conferencia de uma NFE de entrada. A chave da Nota Fiscal de entrada deve ser incluída diretamente no endpoint.

VALOR DESCRIÇÃO
chaveAcesso Chave de Acesso da NF-e
path Parameters
chaveAcesso
required
number
Example: 99999999999999999999999999999999999999999999

Numero composto por 44 digitos.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Array
Produto
string

Código do Produto

QuantidadeConferida
number

Quantidade Conferida

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "begin": "2023",
  • "end": "2023",
  • "success": true,
  • "data": true,
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": false,
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": "null"
}

CFOP

Inclusão de CFOP

O endpoint retorna os cadastros de cfop no sistema.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "begin": "2023",
  • "end": "2023",
  • "success": true,
  • "data": {
    },
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": [
    ],
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

Inclusão de CFOP com parametros

O endpoint retorna os cadastros de cfop no sistema.

path Parameters
codigoFiscal
required
string
Example: "001"

Código Fiscal

inativo
required
boolean
Example: true

Ativo ou Inativo

ordenadoPor
required
string
Example: "ordenadoPor"

Item a ser ordenado

direcao
required
string
Example: "direcao"

A DOCUMENTAR

pagina
required
number
Example: 1

Página a ser acessada

itensPorPagina
required
number
Example: 20

Quantidade de Itens por Página

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "begin": "2023",
  • "end": "2023",
  • "success": true,
  • "data": {
    },
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": [
    ],
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

TransferenciaMalote

Obter Transferencias

O endpoint retorna as transferencias do sistema As ordenações e quantidade de itens por Página são passados no Header da requisição. Outros filtros são passados como parametros na query. Ao filtrar, é possivel escolher qual será a ordenação da listagem no Header. Siga a tabela abaixo para utilizar o valor correto para a ordenação.

VALOR DESCRIÇÃO
codigo Código da Transferênia
origem Loja de Origem
destino Loja de Destino
tipo Tipo da Nota
cadastro Data de Cadastro
quantidade Quantidade de Itens

Também é possivel escolher o Status ao filtrar utilizando o parametro "status" na query. Siga a tabela abaixo para utilizar o valor correto de cada Status.

VALOR DESCRIÇÃO
0 Batimento para Ambos
1 Batimento para Origem
2 Batimento para Destino
3 Com Batimento
4 Sem Batimento
5 Recebido com Divergências
6 Sem Batimento com Divergências
7 Saída sem Entrada
path Parameters
romaneio
required
string
Example: 001

Código do Romaneio

origem
required
string
Example: 001

Código da Loja de Origem

destino
required
string
Example: 001

Código da Loja de Destino

tipo
required
string
Example: E

Tipo da Nota. Valor "E" para Entrada. Valor "S" para Saída.

status
required
number
Example: 0

Status da Nota. Verificar tabela na descrição do endpoint para todos os valores.

periodoInicio
required
string
Example: 2024-12-31T23:59:59.000Z

Data do Inicio do Periodo de Busca.

periodoFim
required
string
Example: 2024-12-31T23:59:59.000Z

Data do Fim do Periodo de Busca.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

ordenadoPor
string
Example: status (string) - Item que será ordenado. Verificar a tabela na descrição do Endpoint

e.g. status (string) - Item que será ordenado. Verificar a tabela na descrição do Endpoint

direcao
string
Example: DESC (string) - Direção da Ordenação. "ASC" para direção ascendente. "DESC" para ordenação descendente.

e.g. DESC (string) - Direção da Ordenação. "ASC" para direção ascendente. "DESC" para ordenação descendente.

pagina
string
Example: 1 (number) - Página da busca. Valor "1" como padrão.

e.g. 1 (number) - Página da busca. Valor "1" como padrão.

itensPorPagina
string
Example: 20 (number) - Página da busca. Valor "20" como padrão.

e.g. 20 (number) - Página da busca. Valor "20" como padrão.

Responses

Response samples

Content type
application/json
{
  • "begin": "2023",
  • "end": "2023",
  • "success": true,
  • "data": {
    },
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": {
    },
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}

Obter Transferencia

O endpoint retorna as transferencias do sistema (Endpoint antigo, possui menos filtros e opções comparado ao endpoint acima)

path Parameters
romaneio
required
string
Example: 001

Código do Romaneio

origem
required
string
Example: 001

Código da Loja de Origem

destino
required
string
Example: 001

Código da Loja de Destino

tipo
required
number
Example: 1

A DOCUMENTAR

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "begin": "2023",
  • "end": "2023",
  • "success": true,
  • "data": {
    },
  • "isObsolete": false,
  • "isBusinessViolation": true,
  • "businessViolations": {
    },
  • "notification": [
    ],
  • "pagination": {
    },
  • "error": [
    ]
}