API de Nota Fiscal
O intuito desta API é dar a possiblidade ao lojista, de forma integrada, conseguir consultar e baixar o XML da Nota Fiscal de venda gerado para um determinado pedido. Abaixo mostraremos o passo a passo de como deve ser desenvolvida:
URL Endpoint: Cada lojista terá uma URL para ser utilizada nas chamadas da API
AUTENTICAÇÃO DE USUÁRIO
Descrição: Este serviço é responsável por gerar a API KEY que será utilizada nos demais endpoits da API para baixar o XML da NF. Ela fica ativa por 6 horas, sendo necessário gerar uma nova após expiração por conta do prazo.
POST https://worker.rockitbaby.com.br/bff-api/login.php
Header:
- Content-Type:application/json
- Accept:application/json
Body request:
{
"email": "admin@exemplo.com",
"password": "admin"
}
Body response:
{
"body": {
"id": 123
"email": "usuario@exemplo.com.br",
"UserName": "USUARIO EXEMPLO",
"CompanyList": [
{
"Role": "Seller",
"IDCompany": 456,
"AccountName": "lojistafulfillment",
"CompanyCpfCnpj": "12345678000101",
"CompanyNameCorporateName": "LOJISTA EXEMPLO LTDA"
}
],
"token": "eyJ0eXAiOiJKV1QiLCssdferfggyhhyyjjuuybhh.efggb2ffj1LCJBY2NvdW50TmFtZSI6eyJSb2xlIjoiU2VsbGVyIiwiSURDb21wYW55Ijo0MzksIkFjY291bn",
"success": true
}
“Token”: Acesso que utilizara nas demais chamadas da API.
CONSULTA DE DADOS DO LOJISTA
Após sucesso na autenticação e obtenção do token, o próximo passo é consultar os dados da empresa cadastrada. O retorno dessa chamada fornecerá informações que serão utilizadas em chamadas subsequentes, como o ID da empresa (IDCompany).
GET https://worker.rockitbaby.com.br/company/getcompany.php
Autenticação da chamada
Header:
- Content-Type:application/json
- Accept:application/json
Params:
-
CompanyCpfCnpj:Confira no response do POST de AUTENTICAÇÃO DE USUÁRIO.
CONSULTAR PEDIDOS
A consulta de pedidos deve ser realizado no endpoint da API de pedidos do Marketplace:
GET https://api-mktplace.viavarejo.com.br/api/v2/orders/{orderId} Confira mais detalhes clicando aqui.
Quando o status do pedido for "Nota Fiscal emitida", o próximo passo será identificar o IDOrder, que é o número do pedido gerado em nosso ERP Rock.IT. Guarde esse ID, pois será necessário no endpoint de download da Nota Fiscal XML.
Endpoint de consulta do IDOrder:
GET https://worker.rockitbaby.com.br/order/orderdetails.php
Autenticação da chamada
Header:
- IDCompany:000
- Content-Type:application/json
- Accept:application/json
O próximo passo é fazer buscas dos pedidos para obter o “IDOrder” da Rock.it, necessário para baixar o XML da Nota Fiscal de venda.
Filtros disponíveis (Params):
- OrderFrom: Número do pedido na Casas Bahia Marketplace;
- Order: Número do pedido recebido do canal
- NfeNumber: Número da Nota Fiscal de venda.
- ChaveNfe: Chave de 44 caracteres da NF de venda.
- ConsumerCpfCnpj: Apenas números do CPF ou CNPJ.
- IDOrder: Número do pedido gerado automaticamente na Rock.IT
- DateFrom: Data inicial sempre no padrão “Ano-mês-dia”;
- DateTo: Data final, sempre no padrão “Ano-mês-dia”;
- offset: Parâmetro de paginação, limite fixo de 3000 registros, começa com 0, 1, 2;
DOWNLOAD XML DA NOTA FISCAL
Descrição: Este endpoint é responsável por baixar a NF de venda gerada pelo ERP Rock.IT para que a loja possa obtê-la de forma integrada.
POST https://worker.rockitbaby.com.br/order/xml/downloadV2.php
Autenticação da chamada
Header:
- IDCompany:000
- Content-Type:application/json
- Accept:application/json
Body Request
{
"IDOrder": [
"1234567"
]
}
Para consulta massiva, precisa inserir os IDOrders no Array, exemplo:
{
"IDOrder": [
1234567,8765432
]
}
Body Response
[
{
"IDOrder": "1234567",
"response": "xxxx"
}
]
Documentação (collection POSTMAN)
Link: Collection Postman