VTEX · Schema

PickupStoreInfoV2

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
isPickupStore boolean This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated.
friendlyName string Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.
address string Address of the loading dock converted to pickup point. This field has been deprecated.
additionalInfo string Additional information about the loading dock converted to pickup point. This field has been deprecated.
dockId string ID of the loading dock converted to pickup point. This field has been deprecated.
View JSON Schema on GitHub

JSON Schema

vtex-pickupstoreinfov2-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PickupStoreInfoV2",
  "title": "PickupStoreInfoV2",
  "required": [
    "isPickupStore",
    "friendlyName",
    "address",
    "additionalInfo",
    "dockId"
  ],
  "type": "object",
  "properties": {
    "isPickupStore": {
      "type": "boolean",
      "description": "This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated.",
      "example": false,
      "nullable": true,
      "deprecated": true
    },
    "friendlyName": {
      "type": "string",
      "description": "Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.",
      "example": null,
      "nullable": true,
      "deprecated": true
    },
    "address": {
      "type": "string",
      "nullable": true,
      "description": "Address of the loading dock converted to pickup point. This field has been deprecated.",
      "example": null,
      "deprecated": true
    },
    "additionalInfo": {
      "type": "string",
      "nullable": true,
      "description": "Additional information about the loading dock converted to pickup point. This field has been deprecated.",
      "example": null,
      "deprecated": true
    },
    "dockId": {
      "type": "string",
      "nullable": true,
      "description": "ID of the loading dock converted to pickup point. This field has been deprecated.",
      "example": null,
      "deprecated": true
    }
  },
  "deprecated": true,
  "example": {
    "isPickupStore": false,
    "friendlyName": null,
    "address": null,
    "additionalInfo": null,
    "dockId": "dockAjs28"
  }
}