VTEX · Example Payload

Vtex Dockbyid Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Dockbyid 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": "DockById",
  "method": "GET",
  "path": "/api/logistics/pvt/configuration/docks/{dockId}",
  "summary": "VTex List dock by ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json; charset=utf-8",
      "example": {
        "id": "1a8bce3",
        "name": "Centro de Distribui\u251c\u00ba\u251c\u00fao 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
        }
      }
    }
  ]
}