VTEX · Example Payload

Vtex Reservationbyid Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Reservationbyid 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

{
  "operationId": "ReservationById",
  "method": "GET",
  "path": "/api/logistics/pvt/inventory/reservations/{reservationId}",
  "summary": "VTex List reservation by ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json; charset=utf-8",
      "example": {
        "LastUpdateDateUtc": "2016-04-15T19:59:40.9832533+00:00",
        "SalesChannel": "2",
        "LockId": "621a9121-06c9-4731-96d1-edf8c5c23877",
        "ReservationDateUtc": "2016-04-15T19:59:40.9832533+00:00",
        "MaximumConfirmationDateUtc": "2016-04-15T20:09:40.9832533+00:00",
        "Status": 1,
        "SlaRequest": [
          {
            "item": {
              "id": "2390059",
              "groupItemId": null,
              "quantity": 1,
              "price": 0,
              "modal": null,
              "additionalHandlingTime": "00:00:00",
              "dimension": {
                "weight": 800,
                "height": 10,
                "width": 12,
                "length": 35,
                "maxSumDimension": 0
              },
              "kitItem": [],
              "unlimitedQuantity": false
            },
            "slaType": "Normal",
            "slaTypeName": "Normal",
            "freightTableName": "Correios PAC",
            "freightTableId": "11cc4b6",
            "listPrice": 10.5,
            "promotionalPrice": 10.5,
            "transitTime": "2.00:00:00",
            "dockTime": "00:00:00",
            "timeToDockPlusDockTime": "1.00:00:00",
            "totalTime": "3.00:00:00",
            "deliveryWindows": null,
            "wareHouseId": "1937054",
            "dockId": "1_1_1",
            "wmsEndPoint": "",
            "location": {
              "zipCode": "22220070",
              "country": "BRA",
              "deliveryPointId": null,
              "point": null,
              "inStore": {
                "IsCheckedIn": false,
                "StoreId": "180082"
              }
            },
            "pickupStoreInfo": null
          }
        ],
        "PickupPointItemOptions": "PUP 1",
        "CanceledDateUtc": "0001-01-01T00:00:00+00:00",
        "AuthorizedDateUtc": "2016-04-15T19:59:40.9832533+00:00",
        "ConfirmedDateUtc": "0001-01-01T00:00:00+00:00",
        "Errors": [],
        "IsSucess": true
      }
    }
  ]
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this

find_examplesBrowse and filter every example in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools

Call it yourself

curl for this page

This example

curl "https://apis.io/api/v1/examples/vtex-reservationbyid-example"

All examples

curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.