VTEX · Example Payload

Vtex Alldocks Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Alldocks 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": "AllDocks",
  "method": "GET",
  "path": "/api/logistics/pvt/configuration/docks",
  "summary": "VTex List all docks",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json; charset=utf-8",
      "example": [
        {
          "id": "1a8bce3",
          "name": "Centro de Distribui\u00e7\u00e3o Principal",
          "priority": 0,
          "dockTimeFake": "1.00:00:00",
          "timeFakeOverhead": "00:00:00",
          "salesChannels": [
            "1",
            "2"
          ],
          "salesChannel": null,
          "freightTableIds": [
            "11cc4b6",
            "teste1",
            "186a2a6",
            "1962962",
            "173a63f"
          ],
          "wmsEndPoint": "",
          "pickupStoreInfo": {
            "isPickupStore": false,
            "storeId": null,
            "friendlyName": null,
            "address": null,
            "additionalInfo": null,
            "dockId": null
          }
        },
        {
          "id": "1_1_1",
          "name": "Doca A",
          "priority": 1,
          "dockTimeFake": "00:00:00",
          "timeFakeOverhead": "00:00:00",
          "salesChannels": [
            "1",
            "11",
            "4",
            "2",
            "12",
            "13",
            "14",
            "7",
            "16"
          ],
          "salesChannel": null,
          "freightTableIds": [
            "1962962",
            "teste1",
            "11cc4b6"
          ],
          "wmsEndPoint": "",
          "pickupStoreInfo": {
            "isPickupStore": false,
            "storeId": null,
            "friendlyName": null,
            "address": null,
            "additionalInfo": null,
            "dockId": null
          }
        },
        {
          "id": "139270d",
          "name": "Doca B",
          "priority": 0,
          "dockTimeFake": "1.00:00:00",
          "timeFakeOverhead": "1.00:00:00",
          "salesChannels": [
            "1"
          ],
          "salesChannel": null,
          "freightTableIds": [],
          "wmsEndPoint": "",
          "pickupStoreInfo": {
            "isPickupStore": false,
            "storeId": null,
            "friendlyName": null,
            "address": null,
            "additionalInfo": null,
            "dockId": null
          }
        },
        {
          "id": "18dd839",
          "name": "Doca C",
          "priority": 0,
          "dockTimeFake": "00:00:00",
          "timeFakeOverhead": "00:00:00",
          "salesChannels": [
            "1"
          ],
          "salesChannel": null,
          "freightTableIds": [],
          "wmsEndPoint": "http://recurrent-env-beta.elasticbeanstalk.com/recorrenciawms",
          "pickupStoreInfo": {
            "isPickupStore": false,
            "storeId": null,
            "friendlyName": null,
            "address": null,
            "additionalInfo": null,
            "dockId": null
          }
        },
        {
          "id": "avl",
          "name": "Doca InStore",
          "priority": 0,
          "dockTimeFake": "1.00:00:00",
          "timeFakeOverhead": "1.00:00:00",
          "salesChannels": [
            "18"
          ],
          "salesChannel": null,
          "freightTableIds": [],
          "wmsEndPoint": "",
          "pickupStoreInfo": {
            "isPickupStore": false,
            "storeId": null,
            "friendlyName": null,
            "address": null,
            "additionalInfo": null,
            "dockId": null
          }
        },
        {
          "id": "pickup_1",
          "name": "Pickup Point 1",
          "priority": 0,
          "dockTimeFake": "1.00:00:00",
          "timeFakeOverhead": "00:00:00",
          "salesChannels": [
            "1"
          ],
          "salesChannel": null,
          "freightTableIds": [],
          "wmsEndPoint": "",
          "pickupStoreInfo": {
            "isPickupStore": false,
            "storeId": null,
            "friendlyName": null,
            "address": null,
            "additionalInfo": null,
            "dockId": null
          }
        },
        {
          "id": "pickup_2",
          "name": "Pickup Point 2",
          "priority": 0,
          "dockTimeFake": "1.00:00:00",
          "timeFakeOverhead": "00:00:00",
          "salesChannels": [
            "1"
          ],
          "salesChannel": null,
          "freightTableIds": [],
          "wmsEndPoint": "",
          "pickupStoreInfo": {
            "isPickupStore": false,
            "storeId": null,
            "friendlyName": null,
            "address": null,
            "additionalInfo": null,
            "dockId": null
          }
        },
        {
          "id": "pickup_3",
          "name": "Pickup Point 3",
          "priority": 0,
          "dockTimeFake": "1.00:00:00",
          "timeFakeOverhead": "00:00:00",
          "salesChannels": [
            "1"
          ],
          "salesChannel": null,
          "freightTableIds": [],
          "wmsEndPoint": "",
          "pickupStoreInfo": {
            "isPickupStore": false,
            "storeId": null,
            "friendlyName": null,
            "address": null,
            "additionalInfo": null,
            "dockId": null
          }
        }
      ]
    }
  ]
}

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-alldocks-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.

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