v60

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

Invoice

Update order's partial invoice (send tracking number)

Update a given order, adding its tracking number to its Partial 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.

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.

patch/api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}

Path parameters

orderIdstring required

Example:1172452900788-01

Unique code that identifies the order whose invoice is being sent.

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

trackingNumberstring required

The number code that identifies the order tracking.

trackingUrlstring nullable required

Package tracking URL.

dispatchedDatestring nullable required

Date when the package was dispatched. For example, 2023-01-08T13:16:13.4617653+00:00.

courierstring nullable required

The name of the carrier responsible for delivering the order.

Response

datestring required

orderIdstring required

receiptstring required

Example response

{
  "date": "2019-02-08T13:16:13.4617653+00:00",
  "orderId": "00-v5195004lux-01",
  "receipt": "527b1ae251264ef1b7a9b597cd8f16b9"
}