v60

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01361201.5 MB

Tracking

Update order tracking status

This endpoint sends a tracking event to an order that already has a tracking number registered to its invoice.

This request is not meant to send a tracking number and URL to the invoice. If you wish to send a tracking number and URL to an order, use the Update order's partial invoice endpoint. For more information, see Partial invoice scenarios.

This endpoint applies to orders with any shipping type, whether delivery or pickup.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

Product	Category	Resource
OMS	OMS access	Notify invoice

You can create a custom role with that resource or use one of the following predefined roles:

Role	Resource
OMS - Full access	Notify invoice
IntegrationProfile - Fulfillment Oms	Notify invoice

❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys. To learn more about machine authentication at VTEX, see Authentication overview.

put/api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}/tracking

Path parameters

orderIdstring required

Example:1172452900788-01

Order ID is a unique code that identifies an order.

invoiceNumberstring required

Example:000030711

Number that identifies the invoice.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

isDeliveredboolean required

When set as true, it means the order got to its final shipping address, whether by delivery or pickup shipping type. When set as false, the order is still in transit to its shipping address.

deliveredDatestring nullable required

Date and time of when the package was delivered. Note that it is different from the tracking date parameter. The deliveredDate format is yyyy-mm-dd hh:mm.

Example request

{
  "deliveredDate": "2022-10-01 21:15",
  "events": [
    {
      "city": "Rio de Janeiro",
      "state": "RJ",
      "description": "Coletado pela transportadora",
      "date": "2015-06-23"
    }
  ]
}

v60