Sign in

v1

latestOpenAPI 3.0.02026-07-141525155.4 KB
External Seller

Update tracking status

This request is sent by the external seller to the VTEX marketplace to update a given order's tracking status.

post/{marketplaceServicesEndpoint}/pvt/orders/{marketplaceOrderId}/invoice/{invoiceNumber}/tracking

Path parameters

marketplaceServicesEndpointstring required
Example:marketplaceservicesendpoint.myvtex.com

This is an endpoint sent from VTEX to the external seller in the Order placement request.

marketplaceOrderIdstring required
Example:1138342255777-01

Identifies the order in the marketplace.

invoiceNumberstring required
Example:NFe-00002

Invoice number.

Headers

Acceptstring required
Example:application/json

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

Content-Typestring required
Example:application/json

Describes the type of the content being sent.

Request body

isDeliveredboolean required

Indicates if order has been delivered. false if it is in transit.

Example request

{
  "events": [
    {
      "city": "Rio de Janeiro",
      "date": "2021-03-16",
      "description": "Order delivered.",
      "state": "Rio de Janeiro"
    }
  ],
  "isDelivered": true
}

Response

OK