Sign in

v1

latestOpenAPI 3.0.02026-07-141525155.4 KB
External Seller

Send tracking information

This request is sent by the external seller to the VTEX marketplace to add tracking information to a given order's invoice, in case it is necessary to do so after the invoice has been sent.

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

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

courierstring

Courier.

dispatchedDatestring

Date of order dispatch.

trackingNumberstring

Tracking number.

trackingUrlstring

Tracking URL.

Example request

{
  "courier": "courier-example",
  "dispatchedDate": "2021-06-09",
  "trackingNumber": "12345678abc",
  "trackingUrl": "https://courier-example.com/tracking"
}

Response

OK