Referência da API · Pedidos · Gestão loja
Upload de XML da Nota Fiscal - Loja
- Método
- PUT
- Rota
-
/partnerOrders/:id/invoice - URL base
https://ws.autorei.net- Parâmetros de rota
:id- Token
- Exige token Bearer
Abre esta requisição na documentação pública da API, a fonte oficial da referência.
Descrição
Anexa o XML da nota fiscal ao pedido. O corpo da requisição é o próprio arquivo, enviado como conteúdo binário, o stream cru dos bytes do .xml. Não é multipart/form-data, não há campo de formulário e o XML não vai dentro de um JSON.
A nota precisa ser uma NF-e real e válida: a plataforma lê o arquivo e extrai dele os dados da nota. Veja O que é lido do arquivo.
Parâmetros de Rota
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id |
integer | Sim | Id do pedido do parceiro (partnerOrderId). |
Corpo da Requisição
Os bytes do arquivo .xml da NF-e, sem envelope. Envie Content-Type: application/xml.
Regras de negócio
O que é lido do arquivo
A plataforma faz o parse do XML e extrai a chave de acesso, o número, a série, a data de emissão e o valor total da nota. É por isso que o arquivo precisa ser uma NF-e de verdade: um XML bem formado mas que não seja uma nota não traz esses dados. O arquivo é guardado com o nome da chave de acesso.
São aceitos os dois formatos usuais, o XML processado, com o envelope da nota, e o XML só com o bloco da nota.
Arquivo vazio ou que não é XML válido é recusado, e nada é gravado.
O pedido precisa ter o pagamento aprovado
Só aceita nota em pedido que já passou da aprovação de pagamento. Antes disso a requisição é recusada e nada é gravado.
Uma nota ou várias
Por padrão o pedido guarda um arquivo, e cada envio substitui o anterior. Lojas configuradas para múltiplas notas acumulam os arquivos: cada envio acrescenta mais um. A configuração é da loja e é feita pela CWS.
Resposta · 200
Os dados da nota anexada ao pedido.
Erros
| Código | Quando |
|---|---|
| 422 | Corpo vazio, arquivo que não é XML válido, ou pedido ainda sem pagamento aprovado. O motivo vem em message. |
| 404 | O pedido não existe ou não está no seu escopo. |
| 401 | Token ausente, malformado ou expirado. |
Exemplo de requisição
curl --request PUT 'https://ws.autorei.net/partnerOrders/:id/invoice' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/xml' \
--data '<?xml version="1.0" encoding="UTF-8"?>
<nfeProc versao="4.00">
<NFe>
<infNFe Id="NFe35260930424972000174550010000012341000012349">
<ide><nNF>1234</nNF><serie>1</serie></ide>
</infNFe>
</NFe>
</nfeProc>'Respostas de exemplo
422Recusa: pedido sem pagamento aprovado
{
"status": "UNPROCESSABLE_ENTITY",
"message": "Envio de XML de NFe permitido somente para pedido com pagamento aprovado"
}Usado em
- Casos de usoIntegração ERP: o caminho típico pela API
- Casos de usoPortal B2B próprio: o caminho típico pela API
- Casos de usoMarketplace B2B: o caminho típico pela API
- Casos de usoVarejo complexo e B2B2C: o caminho típico pela API
- Casos de usoCompras B2B e suprimentos: o caminho típico pela API
- Casos de usoVenda assistida e balcão: o caminho típico pela API
- Webhooks e eventosWebhook de pedidos
- Webhooks e eventosWebhook de pedidos, payload completo
Endpoints relacionados
Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.