-
Notifications
You must be signed in to change notification settings - Fork 315
/
order.schema.json
134 lines (134 loc) · 5.61 KB
/
order.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
{
"meta:license": [
"Copyright 2017 Adobe Systems Incorporated. All rights reserved.",
"This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
"you may not use this file except in compliance with the License. You may obtain a copy",
"of the License at https://creativecommons.org/licenses/by/4.0/"
],
"$id": "https://ns.adobe.com/xdm/data/order",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Order",
"type": "object",
"description": "The order placed for a product list.",
"definitions": {
"order": {
"properties": {
"xdm:purchaseID": {
"title": "Purchase ID",
"type": "string",
"description": "Unique identifier assigned by the seller for this purchase or contract. There is no guarantee that the ID is unique.",
"meta:titleId": "order##xdm:purchaseID##title##55591",
"meta:descriptionId": "order##xdm:purchaseID##description##70271"
},
"xdm:purchaseOrderNumber": {
"title": "Purchase Order Number",
"type": "string",
"description": "Unique identifier assigned by the purchaser for this purchase or contract.",
"meta:titleId": "order##xdm:purchaseOrderNumber##title##23251",
"meta:descriptionId": "order##xdm:purchaseOrderNumber##description##51741"
},
"xdm:payments": {
"title": "Payment List",
"type": "array",
"description": "The list of payments for this order.",
"items": {
"$ref": "https://ns.adobe.com/xdm/data/paymentitem"
},
"meta:titleId": "order##xdm:payments##title##70501",
"meta:descriptionId": "order##xdm:payments##description##67541"
},
"xdm:refunds": {
"title": "Refunds List",
"type": "array",
"description": "The list of refunds for this order.",
"items": {
"$ref": "https://ns.adobe.com/xdm/data/refunditem"
}
},
"xdm:returns": {
"title": "Return Info",
"$ref": "https://ns.adobe.com/xdm/datatypes/return",
"description": "The RMA (Return Merchandise Authorization) issued."
},
"xdm:currencyCode": {
"title": "Currency",
"type": "string",
"examples": ["USD", "EUR"],
"pattern": "^[A-Z]{3}$",
"description": "The ISO 4217 currency code used for the order totals.",
"meta:titleId": "order##xdm:currencyCode##title##81771",
"meta:descriptionId": "order##xdm:currencyCode##description##51121"
},
"xdm:taxAmount": {
"title": "Tax Amount",
"type": "number",
"description": "The tax amount paid by the buyer as part of the final payment.",
"meta:titleId": "order##xdm:taxAmount##title##81954",
"meta:descriptionId": "order##xdm:taxAmount##description##51205"
},
"xdm:discountAmount": {
"title": "Discount Amount",
"type": "number",
"description": "The difference between the regular price and the special price - applied to the entire order, rather than to individual products."
},
"xdm:priceTotal": {
"title": "Price Total",
"type": "number",
"description": "The total price of this order after all discounts and taxes have been applied.",
"meta:titleId": "order##xdm:priceTotal##title##86151",
"meta:descriptionId": "order##xdm:priceTotal##description##47781"
},
"xdm:orderType": {
"title": "Order Type",
"type": "string",
"description": "The type order that has been placed.",
"enum": ["checkout", "instant_purchase"],
"meta:enum": {
"checkout": "checkout",
"instant_purchase": "Instant Purchase"
},
"meta:titleId": "order##xdm:orderType##title##56861",
"meta:descriptionId": "order##xdm:orderType##description##62731"
},
"xdm:lastUpdatedDate": {
"title": "Last Updated Date",
"type": "string",
"format": "date-time",
"description": "The time when a particular order record is last updated in the commerce system.",
"meta:titleId": "order##xdm:lastUpdatedDate##title##86152",
"meta:descriptionId": "order##xdm:lastUpdatedDate##description##47783"
},
"xdm:createdDate": {
"title": "Created Date",
"type": "string",
"format": "date-time",
"description": "The time/date when a new order is created in the commerce system.",
"meta:titleId": "order##xdm:createdDate##title##86153",
"meta:descriptionId": "order##xdm:createdDate##description##47783"
},
"xdm:cancelDate": {
"title": "Cancel Date",
"type": "string",
"format": "date-time",
"description": "The date/time when an order cancellation is initiated by the shopper.",
"meta:titleId": "order##xdm:cancelDate##title##86156",
"meta:descriptionId": "order##xdm:cancelDate##description##47786"
},
"xdm:refundTotal": {
"title": "Total Amount Refunded",
"type": "number",
"description": "The total amount provided in this refund on the order, combining all refunded items and after any discounts etc. have been applied."
}
}
}
},
"allOf": [
{
"$ref": "#/definitions/order"
}
],
"meta:status": "stable",
"meta:createdDate": "2020-08-10",
"meta:titleId": "order##title##821",
"meta:descriptionId": "order##description##62901"
}