Skip to content

Latest commit

 

History

History
215 lines (120 loc) · 4.54 KB

experienceevent-order-details.schema.md

File metadata and controls

215 lines (120 loc) · 4.54 KB
Raw

Order Details Schema

https://ns.adobe.com/xdm/context/experienceevent-order-details

Order data such as product information (SKU, name, quantity), and related information like shipping, billing, payments etc.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental No Forbidden Permitted fieldgroups/experience-event/experienceevent-order-details.schema.json

Schema Hierarchy

  • Order Details https://ns.adobe.com/xdm/context/experienceevent-order-details

Order Details Example

{
  "xdm:productListItems": [
    {
      "xdm:_id": "1002352692",
      "xdm:currencyCode": "USD",
      "xdm:quantity": 1,
      "xdm:priceTotal": 159,
      "xdm:SKU": "1234566"
    }
  ],
  "xdm:order": {
    "xdm:orderID": "a8g784hjq1mnp3",
    "xdm:orderDate": "2017-09-26T15:52:25+00:00",
    "xdm:payment": {
      "xdm:transactionID": "transactid-a111",
      "xdm:paymentAmount": 899.99,
      "xdm:paymentType": "credit",
      "xdm:currencyCode": "USD"
    },
    "xdm:priceTotal": 999.98
  },
  "xdm:shipping": {
    "xdm:shippingAmount": 20,
    "xdm:shippingMethod": "standard",
    "xdm:shippingDestination": "home"
  }
}

Order Details Properties

Property Type Required Defined by
xdm:billing object Optional Order Details (this schema)
xdm:order Store and Web Order Optional Order Details (this schema)
xdm:productListItems Product list item Optional Order Details (this schema)
xdm:shipping Shipping Optional Order Details (this schema)
xdm:store object Optional Order Details (this schema)
* any Additional this schema allows additional properties

xdm:billing

Billing Details

Billing related information.

xdm:billing

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

xdm:billing Type

object with following properties:

Property Type Required
xdm:address Optional

xdm:address

Billing Address

Billing Address.

xdm:address

  • is optional
  • type: reference
xdm:address Type
  • – https://ns.adobe.com/xdm/common/address

xdm:order

Order

Product Orders and realted information like payments.

xdm:order

  • is optional
  • type: Store and Web Order
  • defined in this schema

xdm:order Type

xdm:productListItems

Product list items

A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record.

xdm:productListItems

  • is optional

  • type: Product list item

  • defined in this schema

xdm:productListItems Type

Array type: Product list item

All items must be of the type:

xdm:shipping

Shipping

Shipping related informnation for the order.

xdm:shipping

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

xdm:shipping Type

  • Shipping – https://ns.adobe.com/xdm/datatypes/shipping

xdm:store

Store Details

Store related information.

xdm:store

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

xdm:store Type

object with following properties:

Property Type Required
xdm:storeID string Optional

xdm:storeID

Store ID

Unique identifier for the store.

xdm:storeID

  • is optional
  • type: string
xdm:storeID Type

string