VTEX · Schema

Address metadata

Address metadata.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
version string Unique identifier of the address version.
author string Unique identifier of the user who created the address.
creationDate string Date when the address was created in ISO 8601 format.
lastUpdateDate string Date when the address was last updated in ISO 8601 format.
View JSON Schema on GitHub

JSON Schema

vtex-addressmeta-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AddressMeta",
  "title": "Address metadata",
  "type": "object",
  "description": "Address metadata.",
  "required": [
    "version",
    "author",
    "creationDate",
    "lastUpdateDate"
  ],
  "properties": {
    "version": {
      "type": "string",
      "description": "Unique identifier of the address version.",
      "example": "27112371-a71b-45d6-b3bc-93436a3a0b4f"
    },
    "author": {
      "type": "string",
      "description": "Unique identifier of the user who created the address.",
      "example": "82a2b53d-39be-4f49-bb7c-8971b58cb7dc"
    },
    "creationDate": {
      "type": "string",
      "description": "Date when the address was created in ISO 8601 format.",
      "example": "2022-01-05T15:41:37.5009471+00:00"
    },
    "lastUpdateDate": {
      "type": "string",
      "description": "Date when the address was last updated in ISO 8601 format.",
      "example": "2022-01-05T15:41:37.5009471+00:00"
    }
  }
}