VTEX · Example Payload

Vtex Mkp Order Cancellation Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Mkp Order Cancellation 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": "mkp-order-cancellation",
  "method": "POST",
  "path": "/pvt/orders/{orderId}/cancel",
  "summary": "VTex Marketplace order cancellation",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "marketplaceOrderId": "1138342255777-01",
        "marketplaceOrderGroup": "group-123",
        "cancellationRequestId": "85835ab408514b52aa139e4236ce0c33",
        "cancellationRequestDate": "2024-03-04T15:45:02.1306363+00:00",
        "reason": "Out of stock",
        "requestedByUser": true
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "date": "2019-05-09 15:31:23",
        "marketplaceOrderId": "959311095",
        "orderId": "1138342255777-01",
        "receipt": "e39d05f9-0c54-4469-a626-8bb5cff169f8"
      }
    }
  ]
}