Newer Version Available

This content describes an older version of this product. View Latest

Order Summary

Order summary information.
JSON example
1[
2  {
3    "adjustmentAggregates": null,
4    "createdDate": "2024-03-08T07:28:32.000Z",
5    "currencyIsoCode": "USD",
6    "fields": {
7      "AccountId": {
8        "label": "Account ID",
9        "text": "001OK000001o5FtYAI",
10        "type": "reference"
11      }
12    },
13    "orderNumber": "00000110",
14    "orderProductTopLevelLineCount": 1,
15    "orderSummaryId": "1OsOK00000006Sh0AI",
16    "orderedDate": "2023-10-02T11:03:27.000Z",
17    "ownerId": "005OK000000JZklYAG",
18    "products": [
19      {
20        "canViewProduct": true,
21        "errorCode": null,
22        "errorMessage": null,
23        "fields": {},
24        "id": "01tOK000000EUprYAG",
25        "media": {
26          "alternateText": "Default Image",
27          "contentVersionId": null,
28          "id": null,
29          "mediaType": null,
30          "sortOrder": null,
31          "thumbnailUrl": null,
32          "title": "/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/alpine-blends-gobrew-coffee-wholebean-frenchroast.jpg",
33          "url": "https://s3.amazonaws.com/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/alpine-blends-gobrew-coffee-wholebean-frenchroast.jpg"
34        },
35        "variationAttributes": {}
36      }
37    ],
38    "status": "Created",
39    "totalAmount": "26.98"
40  },
41  {
42    "adjustmentAggregates": null,
43    "createdDate": "2024-03-08T07:28:32.000Z",
44    "currencyIsoCode": "USD",
45    "fields": {
46      "AccountId": {
47        "label": "Account ID",
48        "text": "001OK000001o5FtYAI",
49        "type": "reference"
50      }
51    },
52    "orderNumber": "00000109",
53    "orderProductTopLevelLineCount": 1,
54    "orderSummaryId": "1OsOK00000006Sg0AI",
55    "orderedDate": "2023-10-02T11:02:06.000Z",
56    "ownerId": "005OK000000JZklYAG",
57    "products": [
58      {
59        "canViewProduct": true,
60        "errorCode": null,
61        "errorMessage": null,
62        "fields": {},
63        "id": "01tOK000000EUpmYAG",
64        "media": {
65          "alternateText": "Default Image",
66          "contentVersionId": null,
67          "id": null,
68          "mediaType": null,
69          "sortOrder": null,
70          "thumbnailUrl": "/img/b2b/default-product-image.svg",
71          "title": null,
72          "url": null
73        },
74        "variationAttributes": {}
75      }
76    ],
77    "status": "Created",
78    "totalAmount": "561.98"
79  }
80]
Property Name Type Description Filter Group and Version Available Version
adjustment​Aggregates Order Summary ​Adjustment Aggregates Adjustment aggregates associated with the order summary. Small, 55.0 55.0
createdDate String Created date of the order summary. Small, 51.0 51.0
currencyIsoCode String Three-letter ISO 4217 currency code associated with the order summary record. Small, 57.0 57.0
fields Map<String, ​Record Field> Map of requested order summary fields. Small, 51.0 51.0
orderNumber String Order number of the order summary. Small, 51.0 51.0
orderProductTop​LevelLineCount Integer Count of top level order product line summaries. Small, 62.0 62.0
orderSummaryId String ID of the order summary. Small, 51.0 51.0
orderedDate String Ordered date of the order summary. Small, 51.0 51.0
ownerId String ID of the owner of the order summary. Small, 51.0 51.0
products Order Summary ​Product Lookup[] Order summary product lookup details. Small, 61.0 61.0
status String Status of the order summary. Small, 51.0 51.0
totalAmount String Total amount of the order summary. Small, 51.0 51.0