Commerce Layer · JSON-LD Context

Commerce Layer Context

JSON-LD context defining the semantic vocabulary for Commerce Layer from Commerce Layer.

0 Classes 9 Properties 5 Namespaces
View Context View on GitHub

Namespaces

cl: https://commercelayer.io/vocab/
schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#
dcterms: http://purl.org/dc/terms/
hydra: http://www.w3.org/ns/hydra/core#

Properties

Property Type Container
Order
Sku
Customer
Market
PriceList
Price
Shipment
Promotion
Webhook

JSON-LD Document

Raw ↑
{
  "@context": {
    "@version": 1.1,
    "@vocab": "https://schema.org/",
    "cl": "https://commercelayer.io/vocab/",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "hydra": "http://www.w3.org/ns/hydra/core#",

    "Order": {
      "@id": "cl:Order",
      "@context": {
        "id": { "@id": "cl:Order/id", "@type": "xsd:string" },
        "number": { "@id": "cl:Order/number", "@type": "xsd:string" },
        "status": { "@id": "cl:Order/status", "@type": "xsd:string" },
        "payment_status": { "@id": "cl:Order/paymentStatus", "@type": "xsd:string" },
        "fulfillment_status": { "@id": "cl:Order/fulfillmentStatus", "@type": "xsd:string" },
        "customer_email": { "@id": "schema:email", "@type": "xsd:string" },
        "currency_code": { "@id": "schema:priceCurrency", "@type": "xsd:string" },
        "language_code": { "@id": "schema:inLanguage", "@type": "xsd:string" },
        "total_amount_cents": { "@id": "cl:Order/totalAmountCents", "@type": "xsd:integer" },
        "subtotal_amount_cents": { "@id": "cl:Order/subtotalAmountCents", "@type": "xsd:integer" },
        "shipping_amount_cents": { "@id": "cl:Order/shippingAmountCents", "@type": "xsd:integer" },
        "discount_amount_cents": { "@id": "cl:Order/discountAmountCents", "@type": "xsd:integer" },
        "total_tax_amount_cents": { "@id": "schema:taxAmount", "@type": "xsd:integer" },
        "line_items": { "@id": "schema:orderedItem", "@container": "@list" },
        "shipments": { "@id": "cl:Order/shipments", "@container": "@list" },
        "customer": { "@id": "schema:customer", "@type": "@id" },
        "market": { "@id": "cl:Order/market", "@type": "@id" },
        "billing_address": { "@id": "schema:billingAddress", "@type": "@id" },
        "shipping_address": { "@id": "schema:shippingAddress", "@type": "@id" },
        "created_at": { "@id": "dcterms:created", "@type": "xsd:dateTime" },
        "placed_at": { "@id": "schema:orderDate", "@type": "xsd:dateTime" }
      }
    },

    "Sku": {
      "@id": "cl:Sku",
      "@context": {
        "code": { "@id": "schema:sku", "@type": "xsd:string" },
        "name": { "@id": "schema:name", "@type": "xsd:string" },
        "description": { "@id": "schema:description", "@type": "xsd:string" },
        "image_url": { "@id": "schema:image", "@type": "xsd:anyURI" },
        "weight": { "@id": "schema:weight", "@type": "xsd:decimal" },
        "unit_of_weight": { "@id": "cl:Sku/unitOfWeight", "@type": "xsd:string" },
        "hs_tariff_number": { "@id": "cl:Sku/hsTariffNumber", "@type": "xsd:string" },
        "do_not_ship": { "@id": "cl:Sku/doNotShip", "@type": "xsd:boolean" },
        "do_not_track": { "@id": "cl:Sku/doNotTrack", "@type": "xsd:boolean" }
      }
    },

    "Customer": {
      "@id": "schema:Person",
      "@context": {
        "email": { "@id": "schema:email", "@type": "xsd:string" },
        "status": { "@id": "cl:Customer/status", "@type": "xsd:string" },
        "has_password": { "@id": "cl:Customer/hasPassword", "@type": "xsd:boolean" },
        "total_orders_count": { "@id": "cl:Customer/totalOrdersCount", "@type": "xsd:integer" }
      }
    },

    "Market": {
      "@id": "cl:Market",
      "@context": {
        "name": { "@id": "schema:name", "@type": "xsd:string" },
        "number": { "@id": "cl:Market/number", "@type": "xsd:integer" },
        "facebook_pixel_id": { "@id": "cl:Market/facebookPixelId", "@type": "xsd:string" },
        "external_prices_url": { "@id": "cl:Market/externalPricesUrl", "@type": "xsd:anyURI" },
        "external_order_validation_url": { "@id": "cl:Market/externalOrderValidationUrl", "@type": "xsd:anyURI" }
      }
    },

    "PriceList": {
      "@id": "cl:PriceList",
      "@context": {
        "name": { "@id": "schema:name", "@type": "xsd:string" },
        "currency_code": { "@id": "schema:priceCurrency", "@type": "xsd:string" },
        "tax_included": { "@id": "cl:PriceList/taxIncluded", "@type": "xsd:boolean" }
      }
    },

    "Price": {
      "@id": "schema:PriceSpecification",
      "@context": {
        "currency_code": { "@id": "schema:priceCurrency", "@type": "xsd:string" },
        "amount_cents": { "@id": "schema:price", "@type": "xsd:integer" },
        "compare_at_amount_cents": { "@id": "cl:Price/compareAtAmountCents", "@type": "xsd:integer" }
      }
    },

    "Shipment": {
      "@id": "schema:ParcelDelivery",
      "@context": {
        "number": { "@id": "schema:trackingNumber", "@type": "xsd:string" },
        "status": { "@id": "schema:deliveryStatus", "@type": "xsd:string" },
        "currency_code": { "@id": "schema:priceCurrency", "@type": "xsd:string" }
      }
    },

    "Promotion": {
      "@id": "cl:Promotion",
      "@context": {
        "name": { "@id": "schema:name", "@type": "xsd:string" },
        "starts_at": { "@id": "schema:validFrom", "@type": "xsd:dateTime" },
        "expires_at": { "@id": "schema:validThrough", "@type": "xsd:dateTime" },
        "total_usage_limit": { "@id": "cl:Promotion/totalUsageLimit", "@type": "xsd:integer" }
      }
    },

    "Webhook": {
      "@id": "cl:Webhook",
      "@context": {
        "name": { "@id": "schema:name", "@type": "xsd:string" },
        "topic": { "@id": "cl:Webhook/topic", "@type": "xsd:string" },
        "callback_url": { "@id": "cl:Webhook/callbackUrl", "@type": "xsd:anyURI" },
        "include_resources": { "@id": "cl:Webhook/includeResources", "@container": "@list" }
      }
    }
  }
}