API para integração com o e-Millennium
Modelo de integração, contendo os detalhes sobre nossa API no padrão ODATA que permite conversar utilizando REST, JSON, utilizado no e-Millennium.
Neste documento trataremos do MILLENIUM_ECO na perspectiva de BackOffice, que foi desenvolvido para integrações onde o consumidor é um ERP externo ao MILLENNIUM.
A biblioteca Millenium_Eco foi desenvolvida especialmente para facilitar o uso por integradores com a plataforma Millennium. Esta biblioteca expõe apenas métodos especializados em tarefas comuns de integração como:
A biblioteca Millenium_Eco foi desenvolvida especialmente para facilitar o uso por integradores com a plataforma Millennium. Esta biblioteca expõe apenas métodos especializados em tarefas comuns de integração como:
- Leitura de faturamentos
- Gravação de produtos
- Gravação de preços
- Gravação de estoques
Para melhor desempenho em relação à integração, as APIs de gravação foram implementadas para receber lotes de registros como entrada, assim o Millennium processará vários registros de uma só vez a cada chamada, otimizando muito a velocidade do processo devido ao reaproveitamento de transações e consultas no banco de dados. A sugestão inicial é de 50 registros a cada lote, porém este número pode ser modificado para obter o melhor custo/benefício nas chamadas.
| Código | Descrição |
|---|---|
| COD_PRODUTO | Código do produto |
| DESCRICAO | Descrição do produto |
| NCM | O NCM é utilizado para classificar fiscalmente o produto |
| DESC_MARCA | Descrição da marca |
| DESC_COLECAO | Descrição da coleção |
| UNIDADE_USO | Unidade de venda do produto |
| UNIDADE_COMPRA | Unidade de compra do produto |
| ORIGEM_PROD | Origem do produto quanto à nacionalidade, conforme tabela do SEFAZ |
| SKUS | Lista de SKUs do produto (detalhada abaixo) |
| BARRA | Código de barras do SKU, utilizada posteriormente para identificar o SKU em outras chamadas |
| COD_COR | Código da cor. A cor será inserida automaticamente de o código não for encontrado. A descrição DESC_COR será usada no cadastro. |
| DESC_COR | Descrição da cor |
| COD_ESTAMPA | Código da estampa. A estampa será inserida automaticamente de o código não for encontrado. A descrição DESC_ESTAMPA será usada no cadastro. Se não informado, será considerado como “ÚNICA”. |
| TAMANHO | Código/Descrição do tamanho. O tamanho será inserido automaticamente de o código não for encontrado. Se não informado, será considerado como “U”. |
| ALTURA | Altura do SKU, usada para cálculo de frete |
| LARGURA | Largura do SKU, usada para cálculo de frete |
| COMPRIMENTO | Comprimento do SKU, usada para cálculo de frete |
| PESO | Peso do SKU, usada para cálculo de frete |
A atualização preços verifica se o preço “por” (PRECO1) ou o preço “de” (PRECO2) sofreram alterações e faz as mudanças necessárias no Millennium que depois serão transmitidas ao e-commerce. Os preços serão considerados assim que ficarem disponíveis aos clientes, sendo que os pedidos emitidos com os preços anteriores serão inseridos no Millennium com o preço vigente na emissão do pedido na plataforma. Por isto não há risco de mudanças de preço mesmo com o ambiente ativo.
POST :/api/millenium_eco/produtos/AtualizaPrecoDeTabela
Content-Type:Application/JSON
{“VITRINE”:0, “PRECOS”:[{“BARRA”:”789765765765”, ”PRECO1”:10, ”PRECO2”:9}]}
A atualização de estoques compara o saldo sendo enviado com o saldo atual no Millennium e faz um lançamento de ajuste de estoque quando o saldo difere. O saldo considerado no Millennium é o disponível+reserva, ou seja, o saldo físico. Assim, se houverem reservas pendentes no Millennium aguardando faturamento, estas não serão consideradas como baixas até que o faturamento seja concluído.
POST :/api/millenium_eco/produtos/AtualizaPrecoDeTabela
Content-Type:Application/JSON
{“VITRINE”:0, “PRECOS”:[{“BARRA”:”789765765765”, ”PRECO1”:10, ”PRECO2”:9}]}
A atualização de estoques compara o saldo sendo enviado com o saldo atual no Millennium e faz um lançamento de ajuste de estoque quando o saldo difere. O saldo considerado no Millennium é o disponível+reserva, ou seja, o saldo físico. Assim, se houverem reservas pendentes no Millennium aguardando faturamento, estas não serão consideradas como baixas até que o faturamento seja concluído.
POST :/api/millenium_eco/produtos/AtualizaSaldoDeEstoque
Content-Type:Application/JSON
{“VITRINE”:0, “PRECOS”:[{“BARRA”:”789765765765”, ”QUANTIDADE”:1000}]}
GET
:/api/millenium_eco/pedido_venda/ListaFaturamentos?DATA_ATUALIZACAO=YYYY-MM-DD
Content-Type:Application/JSON
O resultado da chamada possui os atributos a seguir:
:/api/millenium_eco/pedido_venda/ListaFaturamentos?DATA_ATUALIZACAO=YYYY-MM-DD
Content-Type:Application/JSON
O resultado da chamada possui os atributos a seguir:
| ROMANEIO | A | Número interno do faturamento no Millennium |
| NF | A | Número da nota referente ao documento |
| DATA | D | Data de emissão do faturamento |
| DATA_ATUALIZACAO | H | Data de atualização se houve (depois da emissão da nota não é possível alterar) |
| CANCELADO | B | Flag indicando se o faturamento foi cancelado |
| CLIENTE | Identificador do cliente | |
| PRODUTOS | Array de produtos | |
| PRODUTO * | N(8) | Id do produto no Millennium |
| COR | N(8) | Id da cor no Millennium |
| ESTAMPA | N(8) | Id da estampa no Millennium |
| TAMANHO | A | Código do tamanho no Millennium |
| QUANTIDADE * | N(15,7) | Quantidade do produto no faturamento |
| PRECO * | N(17,4) | Preço do SKU no faturamento |
| ITEM | A | Código de item do SKU no faturamento (opcional) |
| OBS_ITEM | A | Observação do item no faturamento |
| ALTURA | N(15,7) | Altura do produto faturado |
| COMPRIMENTO | N(15,7) | Comprimento do produto faturado |
| LARGURA | N(15,7) | Largura do produto faturado |
| SKU | A | SKU no formato produto_cor_estampa_tamanho |
| BARRA | A | Código de barras do SKU faturado |
| COD_PEDIDOV | A | Código do pedido faturado |
| CFOP | A | CFOP do SKU no faturamento |
| DATA_ENTREGA | D | Data de entrega do pedido faturado |
| LANCAMENTOS | Array de lançamentos/títulos a receber | |
| DATA_VENCIMENTO | D | Data de vencimento da parcela |
| VALOR_INICIAL | M | Valor da parcela |
| TIPO_PGTO/td> | N(8) | ‘0’=’Cartão de Crédito’,’1’=’Cartão de Débito’,’2’=’Boleto’,’3’=’Depósito’,’4’=’Pagamento Online’, ’6’=’Vale Presente’,’7’=’Vale Desconto’,’8’=’Outros’ |
| DOCUMENTO | A | Número do título a receber no Millennium |
| NSU | A | NSU do TEF (se houver) |
| AUTORIZACAO | A | Número da autorização |
| BANDEIRA | N(8) | ‘0’=’MasterCard’,’1’=’Visa’,’2’=’Sorocred’,’3’=’Amex’,’4’=’Diners’,’5’=’HiperCard’,’6’=’Elo’, ’7’=’Bradesco’,’8’=’ItauShopLine’,’9’=’BancoBrasil’,’10’=’HSBC’,’11’=’Outros’ |
| OPERADORA | N(8) | ‘0’=’Cielo’,’1’=’Rede’,’3’=’GetNet’,’4’=’Outros’ |
| NUMERO_CARTAO | A | Número do cartão mascarado (Nem sempre disponível, depende do setup e integração) |
| MES_VALIDADE_CARTAO | A | Nem sempre disponível, depende do setup e integração |
| ANO_VALIDADE_CARTAO | A | Nem sempre disponível, depende do setup e integração |
| COD_SEGURANCA_CARTAO | A | Nem sempre disponível, depende do setup e integração |
| NOME_PORTADOR_CARTAO | A | Nem sempre disponível, depende do setup e integração |
| CPF_PORTADOR_CARTAO | A | Nem sempre disponível, depende do setup e integração |
| COD_AUTORIZACAO_CARTAO | A | Cód. autorização retornado pela adm. cartão |
| DUPLICATA | A | Número do título no banco(nosso número) utilizado para baixa CNAB |
| QUANTIDADE | N(15,7) | Quantidade total do faturamento |
| TOTAL | N(15,7) | Valor total dos produtos faturamento |
| V_DESCONTO | N(15,7) | Valor do desconto total do faturamento |
| V_FRETE | N(15,7) | Valor do frete total do faturamento |
| VALOR_FINAL | N(15,7) | Valor total do faturamento |
| CHAVE_NF | A | Chave da NFe |
| SERIE_NF | A | Série da NFe |
| PROTOCOLO_NF | A | Número de protocolo da NFe |
| RECIBO_NF | A | Número do recibo da NFe |
| DATA_AUTORIZACAO_NF | D | Data de autorização da NFe |
Uma referência de todos os métodos disponíveis pode ser obtida on-line através da própria instância utilizada na integração. Para nossa instância de testes deve ser utilizada a seguinte url:
Usuário: OData
Senha: 0d@t@123
Usuário: OData
Senha: 0d@t@123
Baixe Documentação Completa
Servidor de Teste
Todos os nossos métodos para integração estão disponíveis e atualizados online em uma instância de integração que permite iniciar os testes de integração imediatamente.
Que tal uma coleção de exemplos prontos de nossa API?
Instale a extensão do Google Chrome – Postman:
Após instalar o Postman, importe a nossa Collection para ver os exemplos.
É bem simples, Copie e cole esse endereço https://www.getpostman.com/collections/f015d4034ca5ad30e01c na Opção “Import a Collection” disponível no Postman, conforme figura abaixo:
