VTEX · Schema

ListRegistry

ListRegistry information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
name string List name defined by the store.
deliveryToOwner boolean Defines if the order will be delivered to list creator (`true`) or not (`false`).
View JSON Schema on GitHub

JSON Schema

vtex-listregistry-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListRegistry",
  "title": "ListRegistry",
  "description": "ListRegistry information.",
  "required": [
    "name",
    "deliveryToOwner"
  ],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "List name defined by the store.",
      "example": "My gift list."
    },
    "deliveryToOwner": {
      "type": "boolean",
      "description": "Defines if the order will be delivered to list creator (`true`) or not (`false`).",
      "example": false
    }
  }
}