VTEX · Example Payload

Vtex Send Tracking Information Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Send Tracking Information Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "send-tracking-information",
  "method": "POST",
  "path": "/pvt/orders/{marketplaceOrderId}/invoice/{invoiceNumber}",
  "summary": "VTex Send tracking information",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "courier": "courier-example",
        "trackingNumber": "12345678abc",
        "trackingUrl": "https://courier-example.com/tracking",
        "dispatchedDate": "2021-06-09"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "date": "2021-06-09T15:22:56.7612218-02:00",
        "orderId": "1138342255777-01",
        "receipt": "527b1ae251264ef1b7a9b597cd8f16b9"
      }
    }
  ]
}