VTEX · Example Payload

Vtex List Orders Example

CommerceE-CommerceRetailMarketplacePayments

Vtex List Orders Example is an example object payload from VTEX, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

titlerequestresponse

Example Payload

Raw ↑ 
{
  "title": "VTEX List Orders - Example Request and Response",
  "request": {
    "method": "GET",
    "url": "https://{accountName}.vtexcommercestable.com.br/api/oms/pvt/orders?f_status=ready-for-handling&orderBy=creationDate,desc&page=1&per_page=15",
    "headers": {
      "X-VTEX-API-AppKey": "{your-app-key}",
      "X-VTEX-API-AppToken": "{your-app-token}",
      "Accept": "application/json",
      "Content-Type": "application/json"
    }
  },
  "response": {
    "status": 200,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "list": [
        {
          "orderId": "v1234567890-01",
          "sequence": "500001",
          "origin": "Marketplace",
          "affiliateId": "",
          "salesChannel": "1",
          "merchantName": null,
          "status": "ready-for-handling",
          "statusDescription": "Ready for Handling",
          "value": 15990,
          "creationDate": "2026-05-01T14:32:00.0000000+00:00",
          "lastChange": "2026-05-01T14:45:00.0000000+00:00",
          "orderIsComplete": true,
          "listId": null,
          "listType": null,
          "authorizedDate": "2026-05-01T14:45:00.0000000+00:00",
          "callCenterOperatorName": null,
          "totalItems": 2,
          "currencyCode": "USD",
          "shippingEstimatedDate": "2026-05-05T23:59:59.0000000+00:00"
        }
      ],
      "facets": [],
      "paging": {
        "total": 1,
        "pages": 1,
        "currentPage": 1,
        "perPage": 15
      },
      "stats": {
        "stats": {
          "totalValue": {
            "Count": 1,
            "Max": 15990,
            "Mean": 15990.0,
            "Min": 15990,
            "Missing": 0,
            "StdDev": 0.0,
            "Sum": 15990,
            "SumOfSquares": 255680100.0,
            "Facets": {}
          }
        }
      }
    }
  }
}