VTEX · Schema

Create/UpdateWarehouseRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string
name string
warehouseDocks array
View JSON Schema on GitHub

JSON Schema

vtex-createupdatewarehouserequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateUpdateWarehouseRequest",
  "title": "Create/UpdateWarehouseRequest",
  "required": [
    "id",
    "name",
    "warehouseDocks"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "warehouseDocks": {
      "type": "array",
      "items": {
        "title": "WarehouseDock",
        "required": [
          "dockId",
          "name",
          "time",
          "cost",
          "translateDays",
          "costToDisplay"
        ],
        "type": "object",
        "properties": {
          "dockId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "time": {
            "type": "string"
          },
          "cost": {
            "type": "string"
          },
          "translateDays": {
            "type": "string"
          },
          "costToDisplay": {
            "type": "string"
          }
        },
        "example": {
          "dockId": "1a8bce3",
          "name": "Centro de Distribui\u251c\u00ba\u251c\u00fao Principal",
          "time": "3.00:00:00",
          "cost": "5.00",
          "translateDays": "dias",
          "costToDisplay": "5,00"
        }
      },
      "description": ""
    }
  },
  "example": {
    "id": "15bfc76",
    "name": "Estoque Principal",
    "warehouseDocks": [
      {
        "dockId": "1a8bce3",
        "name": "Centro de Distribui\u251c\u00ba\u251c\u00fao Principal",
        "time": "3.00:00:00",
        "cost": "5.00",
        "translateDays": "dias",
        "costToDisplay": "5,00"
      }
    ]
  }
}