Sends a tracking event to an order that already has a tracking number registered to its invoice.
This endpoint is not meant to send tracking number and URL to the invoice. If you wish to send tracking number and URL to an order, use the Update order's partial invoice API request. You can also learn more about Partial invoice scenarios.
The
Notify invoice
resource is needed to use this API request. This is included inOMS - Full access
andIntegrationProfile - Fulfillment Oms
, among other default roles available in the Admin. Learn more about the License manager roles and resources.
Do not use this request with orders that do not have a tracking number already added to their invoice. If you wish to send tracking number and URL to an order, use the Update order's partial invoice API request
Learn more about Transaction Details in VTEX Help
Important: the package is generated when an invoice is added to the order.
The last tracking's date is not the same as the delivery date.
Request object has the following properties:
Attribute | Type | Description |
---|---|---|
orderId | string | Order Id |
invoiceNumber | string | Order Invoice ID |
isDelivered | boolean | If the order package is delivered |
deliveredDate | string | the date when the package was delivered. It is not the same as the tracking date parameter. |
events | object | Events Details Object |
city | string | Event Tracking City |
state | string | Event Tracking State |
description | Event Tracking Description | This field is limited to 5000 characters |
date | string | Event Tracking Date in international format yyyy-mm-dd |
If
isDelivered
is true, the fieldfinished
changes to true. ThecourierStatus
field ofstatus
remains as unknown. This field can be found in the Order details of the.
Response object has the following properties:
Attribute | Type | Description |
---|---|---|
date | string | Tracking Update Date |
orderId | string | Order ID Update |
receipt | string | Tracking Update Receipt |
Request body example
curl --location --request PUT 'https://lojadosuporte.vtexcommercestable.com.br/api/oms/pvt/orders/v501245lspt-01/invoice/0102030405/tracking' \
--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 '{
"isDelivered": true,
"events": [
{
"city": "Rio de Janeiro",
"state": "RJ",
"description": "Coletado pela transportadora",
"date": "2015-06-23"
},
{
"city": "Sao Paulo",
"state": "SP",
"description": "A caminho de Curitiba",
"date": "2015-06-24"
}
]
}'
Response body example
{
"date": "2017-03-29T18:04:31.0521233+00:00",
"orderId": "v501245lspt-01",
"receipt": "f67d33a8029c42ce9a8f07fc17f54449"
}