Skip to content

Latest commit

 

History

History
203 lines (107 loc) · 4.41 KB

product.schema.md

File metadata and controls

203 lines (107 loc) · 4.41 KB
Raw

Product Schema

https://ns.adobe.com/xdm/classes/product

This class is used to capture minimum set of properties that define a product.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted classes/product.schema.json

Schema Hierarchy

  • Product https://ns.adobe.com/xdm/classes/product
    • Record Schema https://ns.adobe.com/xdm/data/record
    • Currency https://ns.adobe.com/xdm/datatypes/currency

Product Example

{
  "xdm:productID": "59yigdug",
  "xdm:productName": "photoshop",
  "xdm:productDescription": "photo editing software"
}

Product Properties

Property Type Required Defined by
@id string Optional Record Schema
xdm:productDescription string Optional Product (this schema)
xdm:productID string Optional Product (this schema)
xdm:productLastModifiedDate string Optional Product (this schema)
xdm:productListPrice Currency Optional Product (this schema)
xdm:productManufacturedDate string Optional Product (this schema)
xdm:productName string Optional Product (this schema)
xdm:productRating number Optional Product (this schema)
* any Additional this schema allows additional properties

@id

Identifier

A unique identifier for the record.

@id

@id Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

xdm:productDescription

Product Description

Description of the product.

xdm:productDescription

  • is optional
  • type: string
  • defined in this schema

xdm:productDescription Type

string

xdm:productID

Product ID

Product unique identifer.

xdm:productID

  • is optional
  • type: string
  • defined in this schema

xdm:productID Type

string

xdm:productLastModifiedDate

Product last modified Date

The date when this product was last modified for any updates. The time using RFC3339 with a stated time zone offset such as "2001-07-04T12:08:56-07:00". An example formatting pattern is "yyyy-MM-dd'T'HH:mm:ssXXX".

xdm:productLastModifiedDate

  • is optional
  • type: string
  • defined in this schema

xdm:productLastModifiedDate Type

string

xdm:productListPrice

Product List price

Default price of the product before sales and discounting.

xdm:productListPrice

  • is optional
  • type: Currency
  • defined in this schema

xdm:productListPrice Type

  • Currency – https://ns.adobe.com/xdm/datatypes/currency

xdm:productManufacturedDate

Product Manufactured date

The date when this product was created. The time using RFC3339 with a stated time zone offset such as "2001-07-04T12:08:56-07:00". An example formatting pattern is "yyyy-MM-dd'T'HH:mm:ssXXX".

xdm:productManufacturedDate

  • is optional
  • type: string
  • defined in this schema

xdm:productManufacturedDate Type

string

xdm:productName

Product Name

Name of the product.

xdm:productName

  • is optional
  • type: string
  • defined in this schema

xdm:productName Type

string

xdm:productRating

Product Rating

Customer review rating of the product.

xdm:productRating

  • is optional
  • type: number
  • defined in this schema

xdm:productRating Type

number