Connect REST API Developer Guide
jNewer Version Available
Order Summary Lookup Output
Order summary lookup output.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| adjustmentAggregates | Order Summary Adjustment Aggregates | Adjustment aggregates associated with the order summary. | Small, 58.0 | 58.0 |
| currencyIsoCode | String | Three-letter ISO 4217 currency code associated with the order summary. | Small, 58.0 | 58.0 |
| deliveryGroups | List<Order Delivery Group Summary Lookup Output> | Delivery groups associated with the order summary. | Small, 58.0 | 58.0 |
| fields | Map<String, Record Field> | Map of requested order summary fields. | Small, 58.0 | 58.0 |
| id | String | ID of the order summary. | Small, 58.0 | 58.0 |
| orderNumber | String | Reference number of the order summary. | Small, 58.0 | 58.0 |
| status | String | Status associated with the order summary. | Small, 58.0 | 58.0 |
Example
1{
2 "id":"1OsRO0000002DJ80AM",
3 "orderNumber":"GJA4C-MUVBN-6ZT4P-V6CSB",
4 "currencyIsoCode":"USD",
5 "status":"Created",
6 "fields":{
7 "AccountId":{
8 "label":"Account ID",
9 "text":"001RO000001npBoYAI",
10 "type":"reference"
11 },
12 "SalesStoreId":{
13 "label":"Sales Store ID",
14 "text":"0ZERO00000001Qa4AI",
15 "type":"reference"
16 },
17 "TotalAmount":{
18 "label":"Prextax Subtotal",
19 "text":"301.25",
20 "type":"currency"
21 },
22 "OwnerId":{
23 "label":"Owner ID",
24 "text":"005RO000000Hu7iYAC",
25 "type":"reference"
26 },
27 "OrderedDate":{
28 "label":"Ordered Date",
29 "text":"2022-09-28T12:26:22.000Z",
30 "type":"datetime"
31 }
32 },
33 "adjustmentAggregates":{
34 "available":true,
35 "status":null,
36 "totalDeliveryPromotionDistAmount":"0.0"
37 "totalDeliveryPromotionLineAmount":"0.0",
38 "totalDeliveryPromotionTotalAmount":"0.0",
39 "totalProductPromotionDistAmount":"-20.75",
40 "totalProductPromotionLineAmount":"-4.99",
41 "totalProductPromotionTotalAmount":"-25.74"
42 },
43 "deliveryGroups":[
44 {
45 "id":"0agRO0000002DbbYAE",
46 "currencyIsoCode":"USD",
47 "fields":{
48 "TotalTaxAmount":{
49 "label":"Tax",
50 "text":"0.96",
51 "type":"currency"
52 },
53 "GrandTotalAmount":{
54 "label":"Total with Tax",
55 "text":"12.95",
56 "type":"currency"
57 }
58 },
59 "deliveryMethod":{
60 "id":"2DmRO00000001ac0AA",
61 "fields":{
62 "Carrier":{
63 "label":"Carrier",
64 "text":"Test Carrier 1",
65 "type":"picklist"
66 },
67 "ClassOfService":{
68 "label":"Class of Service",
69 "text":"SNC9600",
70 "type":"picklist"
71 }
72 }
73 },
74 "lineItems":[
75 {
76 "id":"10uRO0000002krsYAA",
77 "currencyIsoCode":"USD",
78 "adjustmentAggregates":{
79 "available":true,
80 "status":null,
81 "totalLinePromotionAmount":"0.0",
82 "totalPromotionDistAmount":"-10.5"
83 },
84 "fields":{
85 "Quantity":{
86 "label":"Quantity",
87 "text":"1.0",
88 "type":"number"
89 },
90 "TotalLineAmount":{
91 "label":"Line Subtotal",
92 "text":"210.0",
93 "type":"currency"
94 },
95 "TotalLineTaxAmount":{
96 "label":"Line Subtotal Tax",
97 "text":"16.8",
98 "type":"currency"
99 },
100 "TotalLineAdjustmentAmount":{
101 "label":"Line Adjustments",
102 "text":"-4.99",
103 "type":"currency"
104 }
105 },
106 "product":{
107 "id":"01tRO000000FVNBYA4",
108 "canViewProduct":true,
109 "errorCode":null,
110 "errorMessage":null,
111 "fields":{
112 "Name":{
113 "label":"Name",
114 "text":"Grey T-shirt",
115 "type":"STRING"
116 },
117 "StockKeepingUnit":{
118 "label":"StockKeepingUnit",
119 "text":"00004",
120 "type":"STRING"
121 }
122 },
123 "media":{
124 "alternateText":null,
125 "contentVersionId":null,
126 "id":"2pmRO00000000x2YAA",
127 "mediaType":null,
128 "sortOrder":null,
129 "thumbnailUrl":null,
130 "title":"tshirt 5",
131 "url":"/cms/delivery/media/MC2KSOOFJGRZDDJGQG4QJHLKHTZQ?
132 recordId=01tRO000000FVNB&buyerId=001RO000001npBo"
133 },
134 "variationAttributes":null
135 },
136 "adjustments":[
137 {
138 "amount":"-27.9",
139 "basisReferenceDisplayName":null,
140 "currencyIsoCode":"USD",
141 "displayName":"10% Off On New Arrivals",
142 "targetType":null,
143 "type":"Promotion"
144 },
145 {
146 "amount":"-12.56",
147 "basisReferenceDisplayName":null,
148 "currencyIsoCode":"USD",
149 "displayName":"5%OFF On Order",
150 "targetType":"Header",
151 "type":"Promotion"
152 },
153 {
154 "amount":"-31.0",
155 "basisReferenceDisplayName":null,
156 "currencyIsoCode":"USD",
157 "displayName":"Other adjustments",
158 "targetType":null,
159 "type":"Other"
160 }
161 ]
162 },
163 {
164 "id":"10uRO0000002krtYAA",
165 "currencyIsoCode":"USD",
166 "adjustmentAggregates":{
167 "available":true,
168 "status":null,
169 "totalLinePromotionAmount":"-4.99",
170 "totalPromotionDistAmount":"-10.25"
171 },
172 "fields":{
173 "Quantity":{
174 "label":"Quantity",
175 "text":"1.0",
176 "type":"number"
177 },
178 "TotalLineAmount":{
179 "label":"Line Subtotal",
180 "text":"105.0",
181 "type":"currency"
182 },
183 "TotalLineTaxAmount":{
184 "label":"Line Subtotal Tax",
185 "text":"8.4",
186 "type":"currency"
187 },
188 "TotalLineAdjustmentAmount":{
189 "label":"Line Adjustments",
190 "text":"-4.99",
191 "type":"currency"
192 }
193 },
194 "product":{
195 "id":"01tRO000000FVN8YAO",
196 "canViewProduct":true,
197 "errorCode":null,
198 "errorMessage":null,
199 "fields":{
200 "Name":{
201 "label":"Name",
202 "text":"Purple T-shirt",
203 "type":"STRING"
204 },
205 "StockKeepingUnit":{
206 "label":"StockKeepingUnit",
207 "text":"00001",
208 "type":"STRING"
209 }
210 },
211 "media":{
212 "alternateText":null,
213 "contentVersionId":null,
214 "id":"2pmRO0000000C4VYAU",
215 "mediaType":null,
216 "sortOrder":null,
217 "thumbnailUrl":null,
218 "title":"purpleTshirt",
219 "url":"/cms/delivery/media/MCKCWEP4NIWBANRGO7DLBPPIEHBY?
220 recordId=01tRO000000FVN8&buyerId=001RO000001npBo"
221 },
222 "variationAttributes":{
223 "Color__c":{
224 "label":"Color",
225 "sequence":0,
226 "value":"purple"
227 },
228 "Size__c":{
229 "label":"Size",
230 "sequence":1,
231 "value":"L"
232 }
233 }
234 },
235 "adjustments":[
236 {
237 "amount":"-7.2",
238 "basisReferenceDisplayName":null,
239 "currencyIsoCode":"USD",
240 "displayName":"5%OFF On Order",
241 "targetType":"Header",
242 "type":"Promotion"
243 },
244 {
245 "amount":"-16.0",
246 "basisReferenceDisplayName":null,
247 "currencyIsoCode":"USD",
248 "displayName":"10% Off On New Arrivals",
249 "targetType":null,
250 "type":"Promotion"
251 }
252 ]
253 }
254 ]
255 }
256 ]
257}
258