Skip to content

Latest commit

 

History

History
172 lines (100 loc) · 3.35 KB

order.schema.md

File metadata and controls

172 lines (100 loc) · 3.35 KB

Order Schema

https://ns.adobe.com/xdm/data/order

The order placed for a product list.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental No Forbidden Permitted data/order.schema.json

Order Example

{
  "xdm:purchaseID": "a8g784hjq1mnp3",
  "xdm:purchaseOrderNumber": "123456",
  "xdm:payments": [
    {
      "xdm:transactionID": "transactid-a111",
      "xdm:paymentAmount": 899.99,
      "xdm:paymentType": "credit_card",
      "xdm:currencyCode": "USD"
    },
    {
      "xdm:transactionID": "transactid-a222",
      "xdm:paymentAmount": 99.99,
      "xdm:paymentType": "gift_card",
      "xdm:currencyCode": "USD"
    }
  ],
  "xdm:currencyCode": "USD",
  "xdm:priceTotal": 999.98
}

Order Properties

Property Type Required Defined by
xdm:currencyCode string Optional Order (this schema)
xdm:payments Payment Item Optional Order (this schema)
xdm:priceTotal number Optional Order (this schema)
xdm:purchaseID string Optional Order (this schema)
xdm:purchaseOrderNumber string Optional Order (this schema)
* any Additional this schema allows additional properties

xdm:currencyCode

Currency

The ISO 4217 currency code used for the order totals.

xdm:currencyCode

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

xdm:currencyCode Type

string

All instances must conform to this regular expression

^[A-Z]{3}$
  • test example: USD
  • test example: EUR

xdm:currencyCode Examples

"USD"
"EUR"

xdm:payments

Payment List

The list of payments for this order.

xdm:payments

  • is optional

  • type: Payment Item

  • defined in this schema

xdm:payments Type

Array type: Payment Item

All items must be of the type:

  • Payment Item – https://ns.adobe.com/xdm/data/paymentitem

xdm:priceTotal

Price Total

The total price of this order after all discounts and taxes have been applied.

xdm:priceTotal

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

xdm:priceTotal Type

number

xdm:purchaseID

Purchase ID

Unique identifier assigned by the seller for this purchase or contract. There is no guarantee that the ID is unique.

xdm:purchaseID

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

xdm:purchaseID Type

string

xdm:purchaseOrderNumber

Purchase Order Number

Unique identifier assigned by the purchaser for this purchase or contract.

xdm:purchaseOrderNumber

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

xdm:purchaseOrderNumber Type

string