VTEX · Example Payload

Vtex Retrychange Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Retrychange 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": "RetryChange",
  "method": "POST",
  "path": "/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/retry",
  "summary": "VTex Retry order change",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "reason": "The client wants to change a weighable product.",
        "replace": [
          {
            "from": {
              "items": [
                {
                  "id": "1",
                  "quantity": 1
                }
              ]
            },
            "to": {
              "items": [
                {
                  "id": "1",
                  "quantity": 1,
                  "measurementUnit": "kg",
                  "unitMultiplier": 1
                }
              ],
              "shippingData": {
                "logisticsInfo": [
                  {
                    "itemIndex": 0,
                    "slaId": "Normal",
                    "deliveryChannel": "delivery",
                    "addressId": "12334048475146857",
                    "price": 1000
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ],
  "responseExamples": []
}