magento · JSON-LD Context
Magento Context
JSON-LD context defining the semantic vocabulary for Magento from magento.
0 Classes
8 Properties
6 Namespaces
Namespaces
magento:
https://developer.adobe.com/commerce/webapi/rest/vocabulary#
schema:
https://schema.org/
xsd:
http://www.w3.org/2001/XMLSchema#
dcterms:
http://purl.org/dc/terms/
gr:
http://purl.org/goodrelations/v1#
s:
https://schema.org/
Properties
| Property | Type | Container |
|---|---|---|
| Order | ||
| OrderItem | ||
| Product | ||
| Category | ||
| Customer | ||
| Address | ||
| InventorySource | ||
| StoreConfig |
JSON-LD Document
{
"@context": {
"@version": 1.1,
"magento": "https://developer.adobe.com/commerce/webapi/rest/vocabulary#",
"schema": "https://schema.org/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"dcterms": "http://purl.org/dc/terms/",
"gr": "http://purl.org/goodrelations/v1#",
"s": "https://schema.org/",
"Order": {
"@id": "schema:Order",
"@context": {
"entity_id": {
"@id": "schema:orderNumber",
"@type": "xsd:integer"
},
"increment_id": {
"@id": "schema:orderNumber",
"@type": "xsd:string"
},
"status": {
"@id": "schema:orderStatus",
"@type": "xsd:string"
},
"state": {
"@id": "magento:orderState",
"@type": "xsd:string"
},
"customer_id": {
"@id": "schema:customer",
"@type": "xsd:integer"
},
"customer_email": {
"@id": "schema:email",
"@type": "xsd:string"
},
"customer_firstname": {
"@id": "schema:givenName",
"@type": "xsd:string"
},
"customer_lastname": {
"@id": "schema:familyName",
"@type": "xsd:string"
},
"customer_is_guest": {
"@id": "magento:isGuestOrder",
"@type": "xsd:boolean"
},
"created_at": {
"@id": "schema:orderDate",
"@type": "xsd:dateTime"
},
"updated_at": {
"@id": "dcterms:modified",
"@type": "xsd:dateTime"
},
"grand_total": {
"@id": "schema:price",
"@type": "xsd:decimal"
},
"subtotal": {
"@id": "magento:subtotal",
"@type": "xsd:decimal"
},
"tax_amount": {
"@id": "magento:taxAmount",
"@type": "xsd:decimal"
},
"shipping_amount": {
"@id": "magento:shippingAmount",
"@type": "xsd:decimal"
},
"discount_amount": {
"@id": "magento:discountAmount",
"@type": "xsd:decimal"
},
"base_currency_code": {
"@id": "schema:priceCurrency",
"@type": "xsd:string"
},
"order_currency_code": {
"@id": "magento:orderCurrencyCode",
"@type": "xsd:string"
},
"coupon_code": {
"@id": "schema:discount",
"@type": "xsd:string"
},
"shipping_method": {
"@id": "schema:deliveryMethod",
"@type": "xsd:string"
},
"billing_address": {
"@id": "schema:billingAddress",
"@type": "@id"
},
"items": {
"@id": "schema:orderedItem",
"@container": "@set"
},
"payment": {
"@id": "schema:paymentMethod",
"@type": "@id"
}
}
},
"OrderItem": {
"@id": "schema:OrderItem",
"@context": {
"item_id": {
"@id": "magento:orderItemId",
"@type": "xsd:integer"
},
"sku": {
"@id": "gr:hasStockKeepingUnit",
"@type": "xsd:string"
},
"name": {
"@id": "schema:name",
"@type": "xsd:string"
},
"product_id": {
"@id": "schema:product",
"@type": "xsd:integer"
},
"product_type": {
"@id": "magento:productType",
"@type": "xsd:string"
},
"qty_ordered": {
"@id": "schema:orderQuantity",
"@type": "xsd:decimal"
},
"qty_shipped": {
"@id": "magento:qtyShipped",
"@type": "xsd:decimal"
},
"qty_invoiced": {
"@id": "magento:qtyInvoiced",
"@type": "xsd:decimal"
},
"price": {
"@id": "schema:price",
"@type": "xsd:decimal"
},
"row_total": {
"@id": "magento:rowTotal",
"@type": "xsd:decimal"
},
"tax_amount": {
"@id": "magento:taxAmount",
"@type": "xsd:decimal"
},
"tax_percent": {
"@id": "magento:taxPercent",
"@type": "xsd:decimal"
},
"discount_amount": {
"@id": "magento:discountAmount",
"@type": "xsd:decimal"
}
}
},
"Product": {
"@id": "schema:Product",
"@context": {
"id": {
"@id": "magento:productEntityId",
"@type": "xsd:integer"
},
"sku": {
"@id": "gr:hasStockKeepingUnit",
"@type": "xsd:string"
},
"name": {
"@id": "schema:name",
"@type": "xsd:string"
},
"price": {
"@id": "schema:price",
"@type": "xsd:decimal"
},
"status": {
"@id": "magento:productStatus",
"@type": "xsd:integer"
},
"visibility": {
"@id": "magento:productVisibility",
"@type": "xsd:integer"
},
"type_id": {
"@id": "magento:productType",
"@type": "xsd:string"
},
"attribute_set_id": {
"@id": "magento:attributeSetId",
"@type": "xsd:integer"
},
"weight": {
"@id": "schema:weight",
"@type": "xsd:decimal"
},
"created_at": {
"@id": "dcterms:created",
"@type": "xsd:dateTime"
},
"updated_at": {
"@id": "dcterms:modified",
"@type": "xsd:dateTime"
},
"product_links": {
"@id": "schema:isRelatedTo",
"@container": "@set"
},
"media_gallery_entries": {
"@id": "schema:image",
"@container": "@set"
},
"tier_prices": {
"@id": "gr:hasPriceSpecification",
"@container": "@set"
},
"custom_attributes": {
"@id": "magento:customAttributes",
"@container": "@set"
}
}
},
"Category": {
"@id": "schema:CategoryCode",
"@context": {
"id": {
"@id": "magento:categoryEntityId",
"@type": "xsd:integer"
},
"parent_id": {
"@id": "schema:broader",
"@type": "xsd:integer"
},
"name": {
"@id": "schema:name",
"@type": "xsd:string"
},
"is_active": {
"@id": "magento:isActive",
"@type": "xsd:boolean"
},
"position": {
"@id": "schema:position",
"@type": "xsd:integer"
},
"level": {
"@id": "magento:treeLevel",
"@type": "xsd:integer"
},
"path": {
"@id": "magento:categoryPath",
"@type": "xsd:string"
},
"created_at": {
"@id": "dcterms:created",
"@type": "xsd:dateTime"
},
"updated_at": {
"@id": "dcterms:modified",
"@type": "xsd:dateTime"
},
"include_in_menu": {
"@id": "magento:includeInMenu",
"@type": "xsd:boolean"
},
"children_data": {
"@id": "schema:hasPart",
"@container": "@set"
}
}
},
"Customer": {
"@id": "schema:Person",
"@context": {
"id": {
"@id": "magento:customerEntityId",
"@type": "xsd:integer"
},
"group_id": {
"@id": "magento:customerGroupId",
"@type": "xsd:integer"
},
"email": {
"@id": "schema:email",
"@type": "xsd:string"
},
"firstname": {
"@id": "schema:givenName",
"@type": "xsd:string"
},
"lastname": {
"@id": "schema:familyName",
"@type": "xsd:string"
},
"store_id": {
"@id": "magento:storeId",
"@type": "xsd:integer"
},
"website_id": {
"@id": "magento:websiteId",
"@type": "xsd:integer"
},
"created_at": {
"@id": "schema:startDate",
"@type": "xsd:dateTime"
},
"updated_at": {
"@id": "dcterms:modified",
"@type": "xsd:dateTime"
},
"addresses": {
"@id": "schema:address",
"@container": "@set"
}
}
},
"Address": {
"@id": "schema:PostalAddress",
"@context": {
"firstname": {
"@id": "schema:givenName",
"@type": "xsd:string"
},
"lastname": {
"@id": "schema:familyName",
"@type": "xsd:string"
},
"company": {
"@id": "schema:name",
"@type": "xsd:string"
},
"email": {
"@id": "schema:email",
"@type": "xsd:string"
},
"street": {
"@id": "schema:streetAddress",
"@container": "@set"
},
"city": {
"@id": "schema:addressLocality",
"@type": "xsd:string"
},
"region": {
"@id": "schema:addressRegion",
"@type": "xsd:string"
},
"region_code": {
"@id": "magento:regionCode",
"@type": "xsd:string"
},
"country_id": {
"@id": "schema:addressCountry",
"@type": "xsd:string"
},
"postcode": {
"@id": "schema:postalCode",
"@type": "xsd:string"
},
"telephone": {
"@id": "schema:telephone",
"@type": "xsd:string"
}
}
},
"InventorySource": {
"@id": "schema:Place",
"@context": {
"source_code": {
"@id": "magento:sourceCode",
"@type": "xsd:string"
},
"name": {
"@id": "schema:name",
"@type": "xsd:string"
},
"enabled": {
"@id": "schema:isAccessibleForFree",
"@type": "xsd:boolean"
},
"description": {
"@id": "schema:description",
"@type": "xsd:string"
},
"latitude": {
"@id": "schema:latitude",
"@type": "xsd:decimal"
},
"longitude": {
"@id": "schema:longitude",
"@type": "xsd:decimal"
},
"country_id": {
"@id": "schema:addressCountry",
"@type": "xsd:string"
},
"region": {
"@id": "schema:addressRegion",
"@type": "xsd:string"
},
"city": {
"@id": "schema:addressLocality",
"@type": "xsd:string"
},
"street": {
"@id": "schema:streetAddress",
"@type": "xsd:string"
},
"postcode": {
"@id": "schema:postalCode",
"@type": "xsd:string"
}
}
},
"StoreConfig": {
"@id": "schema:WebSite",
"@context": {
"id": {
"@id": "magento:storeId",
"@type": "xsd:integer"
},
"code": {
"@id": "magento:storeCode",
"@type": "xsd:string"
},
"website_id": {
"@id": "magento:websiteId",
"@type": "xsd:integer"
},
"locale": {
"@id": "schema:inLanguage",
"@type": "xsd:string"
},
"base_currency_code": {
"@id": "schema:priceCurrency",
"@type": "xsd:string"
},
"timezone": {
"@id": "magento:timezone",
"@type": "xsd:string"
},
"base_url": {
"@id": "schema:url",
"@type": "@id"
},
"secure_base_url": {
"@id": "magento:secureBaseUrl",
"@type": "@id"
}
}
}
}
}