VTEX · JSON-LD Context

Vtex Context

JSON-LD context defining the semantic vocabulary for Vtex from VTEX.

36 Classes 11 Properties 3 Namespaces

View Context View on GitHub

Namespaces

schema: https://schema.org/

vtex: https://developers.vtex.com/vocab/

xsd: http://www.w3.org/2001/XMLSchema#

Classes

Order orderId status Product productId productName BrandId CategoryId Description IsActive RefId SKU skuId ClientProfile email firstName lastName phone isCorporate Address street city state country postalCode OrderItem quantity Warehouse warehouseId Promotion promotionId Coupon couponCode Transaction transactionId paymentSystem

Properties

Property	Type	Container
value	integer
creationDate	dateTime
invoicedDate	dateTime
BrandName	schema:Brand
price	integer
listPrice	integer
sellingPrice	integer
discountValue	integer
vtex:accountName	string
vtex:tradePolicy	string
vtex:logisticsInfo	reference

JSON-LD Document

{
  "@context": {
    "@version": 1.1,
    "schema": "https://schema.org/",
    "vtex": "https://developers.vtex.com/vocab/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",

    "Order": "schema:Order",
    "orderId": "schema:orderNumber",
    "status": "schema:orderStatus",
    "value": {
      "@id": "schema:price",
      "@type": "xsd:integer"
    },
    "creationDate": {
      "@id": "schema:orderDate",
      "@type": "xsd:dateTime"
    },
    "invoicedDate": {
      "@id": "schema:orderDelivery",
      "@type": "xsd:dateTime"
    },

    "Product": "schema:Product",
    "productId": "schema:productID",
    "productName": "schema:name",
    "BrandId": "schema:brand",
    "BrandName": {
      "@id": "schema:brand",
      "@type": "schema:Brand"
    },
    "CategoryId": "schema:category",
    "Description": "schema:description",
    "IsActive": "schema:isAccessibleForFree",
    "RefId": "schema:identifier",

    "SKU": "schema:Offer",
    "skuId": "schema:sku",
    "price": {
      "@id": "schema:price",
      "@type": "xsd:integer"
    },
    "listPrice": {
      "@id": "schema:highPrice",
      "@type": "xsd:integer"
    },
    "sellingPrice": {
      "@id": "schema:lowPrice",
      "@type": "xsd:integer"
    },

    "ClientProfile": "schema:Person",
    "email": "schema:email",
    "firstName": "schema:givenName",
    "lastName": "schema:familyName",
    "phone": "schema:telephone",
    "isCorporate": "schema:isicV4",

    "Address": "schema:PostalAddress",
    "street": "schema:streetAddress",
    "city": "schema:addressLocality",
    "state": "schema:addressRegion",
    "country": "schema:addressCountry",
    "postalCode": "schema:postalCode",

    "OrderItem": "schema:OrderItem",
    "quantity": "schema:orderQuantity",

    "Warehouse": "schema:Warehouse",
    "warehouseId": "schema:identifier",

    "Promotion": "schema:Offer",
    "promotionId": "schema:identifier",
    "discountValue": {
      "@id": "schema:discount",
      "@type": "xsd:integer"
    },

    "Coupon": "schema:DiscountCode",
    "couponCode": "schema:code",

    "Transaction": "schema:PaymentStatusType",
    "transactionId": "schema:identifier",
    "paymentSystem": "schema:paymentMethod",

    "vtex:accountName": {
      "@id": "vtex:accountName",
      "@type": "xsd:string"
    },
    "vtex:tradePolicy": {
      "@id": "vtex:tradePolicy",
      "@type": "xsd:string"
    },
    "vtex:logisticsInfo": {
      "@id": "vtex:logisticsInfo",
      "@type": "@id"
    }
  }
}