VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Pedidos e conta do cliente

Nota fiscal (NF-e)

Dados, XML e DANFE da nota fiscal eletrônica do pedido.

Quando o seller emite a NF-e (nota fiscal eletrônica) do pedido, o cliente tem direito de recebê-la. Estas três rotas entregam os dados da nota, o arquivo XML assinado pela SEFAZ e o DANFE em PDF (a versão impressa da nota). Dependem do módulo focusnfe; com o módulo desligado a resposta é 403 module_disabled.

Só existe resposta de sucesso para nota autorizada pela SEFAZ. Enquanto a nota não foi emitida (pedido ainda não faturado), foi rejeitada ou cancelada, as três rotas respondem 404 NF-e not available for this order: trate como "ainda não disponível".

GET/api/v1/storefront/orders/{id}/nfeCliente

Dados da NF-e do pedido

Parâmetros de caminho

iduuidobrigatório
Id do pedido.
bash
curl "$BASE_URL/api/v1/storefront/orders/$ORDER_ID/nfe" \
  -H "Authorization: Bearer $TOKEN"
200NF-e autorizada
json
{
  "status": "authorized",
  "chave_nfe": "35261012345678000190550010000001231000001234",
  "numero": "123",
  "serie": "1",
  "issued_at": "2026-10-12T14:03:10Z"
}

Campos da resposta

statusstring
Sempre authorized nesta rota.
chave_nfestring
Chave de acesso da NF-e, 44 dígitos. O cliente a usa para consultar a nota no portal da Receita.
numerostring
Número da nota.
seriestring
Série da nota.
issued_atstring
Data de emissão, RFC 3339. Pode ser nulo.
GET/api/v1/storefront/orders/{id}/nfe/xmlCliente

Baixa o XML da NF-e

Devolve o XML assinado como download (Content-Disposition: attachment; filename=nfe_<número>.xml). O Content-Type é o que o emissor devolve (normalmente application/xml). Guarde o arquivo: ele é o documento fiscal válido.

Parâmetros de caminho

iduuidobrigatório
Id do pedido.
bash
curl "$BASE_URL/api/v1/storefront/orders/$ORDER_ID/nfe/xml" \
  -H "Authorization: Bearer $TOKEN"
GET/api/v1/storefront/orders/{id}/nfe/danfeCliente

Baixa o DANFE (PDF) da NF-e

Devolve o DANFE em PDF como download (Content-Disposition: attachment; filename=danfe_<número>.pdf). É a versão para imprimir ou mostrar junto da mercadoria.

Parâmetros de caminho

iduuidobrigatório
Id do pedido.
bash
curl "$BASE_URL/api/v1/storefront/orders/$ORDER_ID/nfe/danfe" \
  -H "Authorization: Bearer $TOKEN"

Erros

StatusQuandoCorpo
401Sem token, ou token inválido ou expirado{"error":"missing authorization header"} / {"error":"invalid or expired token"}
403Módulo focusnfe desligado na loja{"error":"module_disabled","module":"focusnfe"}
404Pedido que não é seu, ou nota ainda não autorizada{"error":"order not found"} / {"error":"NF-e not available for this order"}
500Falha ao ler a nota ou ao baixar o XML/DANFE do emissor{"error":"failed to download DANFE PDF","detail":"..."}
503Serviço de pedidos indisponível{"error":"order service unavailable"}
Quando mostrar o botão

Chame GET .../nfe ao abrir o pedido. Se vier 200, mostre "Baixar NF-e" (XML) e "Baixar DANFE". Se vier 404, esconda os botões e, se quiser, mostre "A nota fiscal ainda será emitida". Recarregue quando o status do pedido mudar para enviado.

Fatura não é nota fiscal

A fatura é um comprovante da plataforma e existe para todo pedido. A NF-e é um documento fiscal do seller e só existe depois que ele a emite.

Veja também

  • Fatura do pedido
  • Acompanhar o envio
Anterior
Fatura do pedido
Próxima
Acompanhar o envio
Nesta página
  • Erros
  • Veja também