VTEX · Schema

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string
name string
priority integer
dockTimeFake string
timeFakeOverhead string
salesChannels array
salesChannel string
freightTableIds array
wmsEndPoint string
pickupStoreInfo object
View JSON Schema on GitHub

JSON Schema

vtex-listalldocks-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListAllDocks",
  "title": "",
  "required": [
    "id",
    "name",
    "priority",
    "dockTimeFake",
    "timeFakeOverhead",
    "salesChannels",
    "salesChannel",
    "freightTableIds",
    "wmsEndPoint",
    "pickupStoreInfo"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "priority": {
      "type": "integer",
      "format": "int32"
    },
    "dockTimeFake": {
      "type": "string"
    },
    "timeFakeOverhead": {
      "type": "string"
    },
    "salesChannels": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "salesChannel": {
      "type": "string",
      "nullable": true
    },
    "freightTableIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "wmsEndPoint": {
      "type": "string"
    },
    "pickupStoreInfo": {
      "title": "PickupStoreInfo1",
      "required": [
        "isPickupStore",
        "storeId",
        "friendlyName",
        "address",
        "additionalInfo",
        "dockId"
      ],
      "type": "object",
      "properties": {
        "isPickupStore": {
          "type": "boolean"
        },
        "storeId": {
          "type": "string",
          "nullable": true
        },
        "friendlyName": {
          "type": "string",
          "nullable": true
        },
        "address": {
          "type": "string",
          "nullable": true
        },
        "additionalInfo": {
          "type": "string",
          "nullable": true
        },
        "dockId": {
          "type": "string",
          "nullable": true
        }
      },
      "example": {
        "isPickupStore": false,
        "storeId": null,
        "friendlyName": null,
        "address": null,
        "additionalInfo": null,
        "dockId": null
      }
    }
  },
  "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
    }
  }
}