VTEX · Example Payload

Vtex Updateorderstatus Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Updateorderstatus 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": "UpdateOrderStatus",
  "method": "PUT",
  "path": "/api/order-integration/orders/status",
  "summary": "VTex Update Order Status",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "marketplaceOrderId": "{{$guid}}",
        "marketplaceOrderStatus": "APPROVED",
        "connectorName": "Skyhub",
        "connectorEndpoint": "https://connector-endpoint.com/api/vtex"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "marketplaceOrderId": "7e62fcd3-827b-400d-be8a-f050a79c4976",
        "accountName": null,
        "code": "SOI003",
        "flow": "ApproveOrder",
        "success": true,
        "operationId": null,
        "errors": null,
        "fields": null,
        "message": "Order successfully enqueued"
      }
    }
  ]
}