VTEX · Example Payload

Vtex Updatepartialinvoicesendtrackingnumber Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Updatepartialinvoicesendtrackingnumber 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": "Updatepartialinvoice.SendTrackingNumber",
  "method": "PATCH",
  "path": "/api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}",
  "summary": "VTex Update order's partial invoice (send tracking number)",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "trackingNumber": "87658",
        "trackingUrl": "https://www.tracking.com/url",
        "courier": "carrierOne",
        "dispatchedDate": "2022-02-08T13:16:13.4617653+00:00"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "date": "2019-02-08T13:16:13.4617653+00:00",
        "orderId": "00-v5195004lux-01",
        "receipt": "527b1ae251264ef1b7a9b597cd8f16b9"
      }
    }
  ]
}