Order invoice notification

Entering the invoice in the order is a required step for its status to change to Invoiced - a sign that the order has been successfully completed. Remember that once an order is read as invoiced by the system, this status cannot be changed.

The total value of the order will be updated after the insertion of the invoice, even when there's a Partial invoice scenario. The updated value is settled by VTEX's Payment Gateway. The reimbursement for the shopper is automatic.

We strongly recommend that you always send the object of the invoiced items. With this practice, rounding errors will be avoided.

When returning items, an input invoice must be sent through this call. For that, the type field should be filled in with input.

It is not allowed to use the same invoiceNumber in more than one request to the Order Invoice Notification endpoint.

For marketplace integrations: once the order is invoiced, the seller should use this request to send the invoice information to the marketplace. Be aware that this endpoint is also used by the seller to send the order tracking information. This, however, should be done in a separate moment, once the seller has the tracking information.

The Notify invoice resource is needed to use this API request. This is included in OMS - Full access and IntegrationProfile - Fulfillment Oms, among other default roles available in the Admin. Learn more about the License manager roles and resources.

📘

Onboarding guide

Check the new Orders onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey.

Request body example

{
   "type": "Output",
   "invoiceNumber": "NFe-00001",
   "courier": "",
   "trackingNumber": "",
   "trackingUrl": "",
   "items": [
      {
         "id": "345117",
         "quantity": 1,
         "price": 9003
      }
   ],
   "issuanceDate": "2013-11-21T00:00:00",
   "invoiceValue": 9508
}

Response body fields

FieldTypeDescription
datestringInvoice Date
orderIdstringOrder Id
receiptstringInvoice receipt confirmation ID

Response body example

{
  "date": "2019-02-08T13:16:13.4617653+00:00",
  "orderId": "00-v5195004lux-01",
  "receipt": "527b1ae251264ef1b7a9b597cd8f16b9"
}
Language
Authentication
URL
Click Try It! to start a request and see the response here!