Pedido Faturado ou Despachado
Nesta seção explicamos sobre os recursos relacionados a integração do status de faturamento e despacho dos pedidos
Este endpoint será utilizado pelo Seller para atualizar as informações de faturamento (NF-e) e rastreamento da entrega de um pedido. É possível realizar o faturamento parcial do pedido, sendo obrigatório o envio do valor e dos itens faturados inicialmente. Os demais produtos poderão ser faturados em uma requisição posterior. Porém o status faturado do pedido só será atingido após o faturamento de todos os itens e do valor total da compra.
O Marketplace irá receber na solicitação o ID do pedido enviado no request no campo "marketplaceOrderId” para acionar o processo decorrente do pedido correspondente.
No corpo da resposta contém a informação: o “orderId”, que identifica o pedido no Seller, data e hora do recebimento da notificação e um código de protocolo que confirma seu recebimento.
Faturamento do pedido
Quando a nota fiscal é emitida pelo Seller, os dados serão enviados para o Marketplace através deste endpoint, com as informações de rastreio sem preenchimento, identificando o cenário de "Faturamento".
O pedido irá constar com o status "Faturado".
Dados de rastreamento do pedido
Quando o pedido for despachado pelo Seller, ou seja, entregue a transportadora, os dados de rastreamento serão atualizados utilizando este endpoint, com todas as informações de faturamento e rastreio do pedido, identificando o cenário de "Expedição".
O pedido irá constar com o status "Despachado".
Endpoint
Order Invoice Notification
POST https://{environmentMarketplace}/api/oms/pub/orders/{marketplaceOrderId}/invoice
Path Parameters
{environmentMarketplace}*
string
URL da API do Marketplace
{marketplaceOrderId}*
string
ID do pedido do Marketplace
Headers
X-VTEX-API-AppKey*
string
{{appKey}}
X-VTEX-API-AppToken*
string
{{appToken}}
Accept*
string
application/json
Content-Type*
string
application/json
Faturamento do pedido
Descrição dos campos:
Request
type * (
string) : tipo da nota. São possíveis dois valores: Output e Input. O primeiro (Output) é referente a notas de venda, e o segundo (Input) a notas de devolução.issuanceDate * (
string) : data de emissão da nota fiscal.invoiceNumber * (
string) : número da nota fiscal.invoiceValue * (
integer) : valor total faturado na nota fiscal, sem separador de casas decimais, considere apenas 2 dígitos.invoiceKey (
string) : Chave da NF-e (Nota Fiscal Eletrônica).invoiceUrl (
string) : URL da NF-e.embeddedInvoice (
string): Texto com o conteúdo do arquivo XML da NF-e.courier (
string) : Nome da Transportadora de envio. Quando o request for para envio de notas fiscais, o valor deverá ser vazio ("").trackingNumber (
string) : Número de rastreio na transportadora. Quando o request for para envio de notas fiscais, o valor deverá ser vazio ("").trackingUrl (
string) : URL de rastreio. Quando o request for para envio de notas fiscais, o valor deverá ser vazio ("").dispatchedDate (
string): Data de envio. Quando o request for para envio de notas fiscais, o valor deverá ser vazio ("").items *** (
array de objetos) : itens que estão sendo faturados na nota fiscal em questão.id * (
string) : ID do SKU do item faturado.quantity * (
integer) : quantidade deste item faturada.price * (
integer) : preço total deste item faturado, sem separador de casas decimais, considere apenas 2 dígitos.
Response
date * (
string) : data e horário de recebimento da notificaçãoorderId * (
string) : identificador do pedido no Seller.receipt (
string) : protocolo gerado confirmando o recebimento da atualização, pode ser null.
* Campos obrigatórios *** Lista que irá conter pelo menos 1 objeto.
Exemplo do Request
Exemplo do Response (200 - OK)
Dados de rastreamento do pedido
Descrição dos campos:
Request
type * (
string) : tipo da nota. São possíveis dois valores: Output e Input. O primeiro (Output) é referente a notas de venda, e o segundo (Input) a notas de devolução.issuanceDate * (
string) : data de emissão da nota fiscal.invoiceNumber * (
string) : é o número da nota fiscal.invoiceValue * (
string) : valor total faturado na nota fiscal.invoiceKey (
string) : Chave da NF-e (Nota Fiscal Eletrônica).invoiceUrl (
string) : URL da NF-e.embeddedInvoice (
string): Texto com o conteúdo do arquivo XML da NF-e.courier (
string): nome da transportadora responsável pela entrega do pedido.trackingNumber (
string): identificador de rastreio do pedido na transportadora.trackingUrl (
string): url para o usuário consultar o rastreamento na transportadora.dispatchedDate (
string): Data de envio do pedido. Pode ser nulo.items *** (
array de objetos) : itens que estão sendo faturados na nota fiscal em questão.id * (
string) : ID do SKU do item faturado.quantity * (
integer) : quantidade deste item faturada.price * (
integer) : preço total deste item faturado.
Response
date * (
string) : data e horário de recebimento da notificaçãoorderId * (
string) : identificador do pedido no Seller.receipt (
string) : protocolo gerado confirmando o recebimento da atualização, pode ser null.
* Campos obrigatórios *** Lista que irá conter pelo menos 1 objeto.
Exemplo do Request
Exemplo do Response
Last updated
Was this helpful?