Update order's partial invoice (send tracking number)

Update a given order, adding its tracking number to its invoice.

After using this call to add a tracking number to an order, you can use the Update order tracking status API request to add tracking events.

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.

Learn more about Order Invoice Notifications in VTEX Help.

Request object has the following properties:

AttributeTypeDescription
orderIdstringOrder Id
invoiceNumberstringInvoice Number
trackingNumberstringPackage Tracking Number
trackingUrlstringPackage Tracking URL
courierstringSelected Courier
dispatchedDatestringDate when package was dispatched, nullable variable. Datetime format

Response object has the following properties:

AttributeTypeDescription
datestringInvoice Date
orderIdstringOrder Id
receiptstringInvoice receipt confirmation ID

Request body example

curl --location --request PATCH 'https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/v5195004lux-01/invoice/7999972' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}' \
--header 'X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}' \
--data-raw '{
    "trackingNumber":"9997LUX",
    "trackingUrl":"http://www.trackingu.rl",
    "courier":"Todos os CEPS"
  "dispatchedDate":null
}'

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!