Informações sobre o endpoint de notas

INFO

/

O endpoint de notas fiscais permite gerenciar as notas para os pedidos realizados na plataforma.

Dependências

Pedidos - endpoint /orders - É necessário que já existam os pedidos cadastrados na API para que seja possível realizar o envio das notas fiscais

Campos

Campo	Tipo	Obrigatório	Descrição
type	enum	Sim	Tipo da nota fiscal, os tipos aceitos hoje são de venda e de entrega, deve ser enviado "SALE" para notas de vendas e "SHIPPING" para notas de entrega.
distribution_center_code	varchar	Sim	Código externo do centro de distribuição, esta informação pode ser consultada no admin da loja no menu Fretes > CDs .
number	varchar	Sim	Número da nota fiscal.
serie	varchar	Sim	Serie da nota fiscal.
key	varchar	Sim	Chave da nota fiscal.
invoice_date	date	Sim	Data da nota.
tracking_code	varchar	Não	Código para rastreio do envio.
tracking_url	varchar	Não	Url do rastreio.
transport_code	varchar	Não	Código da transportadora.
transport_name	varchar	Não	Nome da transportadora.
delivery_date	date	Sim	Data da entrega.
billing_type	varchar	Não	Tipo de cobrança, os tipos aceitos nesse campo são (CREDIT CARD, MONEY).
code	varchar	Sim	Código unico da nota fiscal na API, esta informação é utilizada em caso de atualização dos dados da nota fiscal.
issued	date	Não	Data da emissão.
base64_file	longtext	Não	Arquivo da nota fiscal convertido em base64.
order_external_id	varchar	Não	Código do pedido, este campo é utilizado quando o mesmo pedido possuí mais de um código, então devem ser informados todos os códigos desse pedido.
bankbills	array	Não	Conjunto com as informações de boletos relacionados a nota fiscal.
items	array	Não	Conjunto com as informações dos itens do pedido.

Campos node bankbills

Campo	Tipo	Obrigatório	Descrição
number	varchar	Sim	Número do boleto.
value	varchar	Sim	Valor do boleto.
situation	varchar	Sim	Situação atual do boleto.
due_date	varchar	Sim	Data de vencimento do boleto.
url	varchar	Sim	Url para acesso ao boleto.
base64_file	longtext	Não	Boleto convertido em base64.

Campos node items

Campo	Tipo	Obrigatório	Descrição
product_code	varchar	Sim	Código do produto.
attended_quantity	varchar	Sim	Quantidade atendida do produto na nota fiscal.

Response Example

{}

Requisição

Nenhum

Respostas

🟢200Success

application/json

Body

Modificado em 2025-06-23 20:17:41

Página anterior

atualizar pedido com cancelamento parcial de itens

Próxima página

cadastrar notas