VTEX · Example Payload

Vtex Registerchange Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Registerchange 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": "RegisterChange",
  "method": "POST",
  "path": "/api/oms/pvt/orders/{orderId}/changes",
  "summary": "VTex Register change on order",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "date": "2024-02-08T13:54:33.6868469+00:00",
        "orderId": "v502538llux-01",
        "receipt": "535d4581-a2a2-4fd2-a206-1c61eae91b1e"
      }
    }
  ]
}