VTEX · Schema

Create/UpdateDockRequest

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
address object
View JSON Schema on GitHub

JSON Schema

vtex-createupdatedockrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateUpdateDockRequest",
  "title": "Create/UpdateDockRequest",
  "required": [
    "id",
    "name",
    "priority",
    "dockTimeFake",
    "timeFakeOverhead",
    "salesChannels",
    "salesChannel",
    "freightTableIds",
    "wmsEndPoint",
    "pickupStoreInfo",
    "address"
  ],
  "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": "PickupStoreInfo",
      "required": [
        "isPickupStore",
        "storeId",
        "friendlyName",
        "address",
        "additionalInfo",
        "dockId"
      ],
      "type": "object",
      "properties": {
        "isPickupStore": {
          "type": "boolean"
        },
        "storeId": {
          "type": "string",
          "nullable": true
        },
        "friendlyName": {
          "type": "string",
          "nullable": true
        },
        "address": {
          "title": "Address",
          "required": [
            "postalCode",
            "country",
            "city",
            "state",
            "neighborhood",
            "street",
            "number",
            "complement",
            "coordinates"
          ],
          "type": "object",
          "properties": {
            "postalCode": {
              "type": "string"
            },
            "country": {
              "title": "Country",
              "required": [
                "acronym",
                "name"
              ],
              "type": "object",
              "properties": {
                "acronym": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                }
              },
              "example": {
                "acronym": "BRA",
                "name": "Brazil"
              }
            },
            "city": {
              "type": "string"
            },
            "state": {
              "type": "string"
            },
            "neighborhood": {
              "type": "string"
            },
            "street": {
              "type": "string"
            },
            "number": {
              "type": "string"
            },
            "complement": {
              "type": "string"
            },
            "coordinates": {
              "type": "string",
              "nullable": true
            }
          },
          "example": {
            "postalCode": "22220070",
            "country": {
              "acronym": "BRA",
              "name": "Brazil"
            },
            "city": "Rio de Janeiro",
            "state": "RJ",
            "neighborhood": "Catete",
            "street": "Artur Bernardes Street",
            "number": "100",
            "complement": "",
            "coordinates": null
          }
        },
        "additionalInfo": {
          "type": "string",
          "nullable": true
        },
        "dockId": {
          "type": "string",
          "nullable": true
        }
      },
      "example": {
        "isPickupStore": false,
        "storeId": null,
        "friendlyName": null,
        "address": {
          "postalCode": "22220070",
          "country": {
            "acronym": "BRA",
            "name": "Brazil"
          },
          "city": "Rio de Janeiro",
          "state": "RJ",
          "neighborhood": "Catete",
          "street": "Artur Bernardes Street",
          "number": "100",
          "complement": "",
          "coordinates": null
        },
        "additionalInfo": null,
        "dockId": null
      }
    },
    "address": {
      "title": "Address1",
      "required": [
        "postalCode",
        "country",
        "city",
        "state",
        "neighborhood",
        "street",
        "number",
        "complement",
        "coordinates"
      ],
      "type": "object",
      "properties": {
        "postalCode": {
          "type": "string"
        },
        "country": {
          "title": "Country",
          "required": [
            "acronym",
            "name"
          ],
          "type": "object",
          "properties": {
            "acronym": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          },
          "example": {
            "acronym": "BRA",
            "name": "Brazil"
          }
        },
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "neighborhood": {
          "type": "string"
        },
        "street": {
          "type": "string"
        },
        "number": {
          "type": "string"
        },
        "complement": {
          "type": "string"
        },
        "coordinates": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "type": "number"
            }
          }
        }
      },
      "example": {
        "postalCode": "22220070",
        "country": {
          "acronym": "BRA",
          "name": "Brazil"
        },
        "city": "Rio de Janeiro",
        "state": "RJ",
        "neighborhood": "Catete",
        "street": "Artur Bernardes Street",
        "number": "100",
        "complement": "",
        "coordinates": [
          [
            -43.18228090000002,
            -22.9460398
          ]
        ]
      }
    }
  },
  "example": {
    "id": "catete",
    "name": "Loja Catete",
    "priority": 0,
    "dockTimeFake": "00:00:00",
    "timeFakeOverhead": "00:00:00",
    "salesChannels": [
      "1"
    ],
    "salesChannel": null,
    "freightTableIds": [],
    "wmsEndPoint": "",
    "pickupStoreInfo": {
      "isPickupStore": false,
      "storeId": null,
      "friendlyName": null,
      "address": {
        "postalCode": "22220070",
        "country": {
          "acronym": "BRA",
          "name": "Brazil"
        },
        "city": "Rio de Janeiro",
        "state": "RJ",
        "neighborhood": "Catete",
        "street": "Artur Bernardes Street",
        "number": "100",
        "complement": "",
        "coordinates": null
      },
      "additionalInfo": null,
      "dockId": null
    },
    "address": {
      "postalCode": "22220070",
      "country": {
        "acronym": "BRA",
        "name": "Brazil"
      },
      "city": "Rio de Janeiro",
      "state": "RJ",
      "neighborhood": "Catete",
      "street": "Artur Bernardes Street",
      "number": "100",
      "complement": "",
      "coordinates": [
        [
          -43.18228090000002,
          -22.9460398
        ]
      ]
    }
  }
}