Order Summary Collection

Collection of order summaries.

JSON example

1{
2  "count": 2,
3  "currentPageToken": null,
4  "currentPageUrl": "/services/data/v67.0/commerce/webstores/0ZEOK00000008vK/order-summaries?effectiveAccountId=001OK000001o5Ft&fields=AccountId&includeAdjustmentDetails=false&includeProducts=true&ownerScoped=false&pageSize=25&sortOrder=OrderedDateDesc",
5  "nextPageToken": null,
6  "nextPageUrl": null,
7  "orderSummaries": [
8    {
9      "adjustmentAggregates": null,
10      "createdDate": "2024-03-08T07:28:32.000Z",
11      "currencyIsoCode": "USD",
12      "fields": {
13        "AccountId": {
14          "label": "Account ID",
15          "text": "001OK000001o5FtYAI",
16          "type": "reference"
17        }
18      },
19      "orderNumber": "00000110",
20      "orderSummaryId": "1OsOK00000006Sh0AI",
21      "orderedDate": "2023-10-02T11:03:27.000Z",
22      "ownerId": "005OK000000JZklYAG",
23      "products": [
24        {
25          "canViewProduct": true,
26          "errorCode": null,
27          "errorMessage": null,
28          "fields": {},
29          "id": "01tOK000000EUprYAG",
30          "media": {
31            "alternateText": "Default Image",
32            "contentVersionId": null,
33            "id": null,
34            "mediaType": null,
35            "sortOrder": null,
36            "thumbnailUrl": "/img/b2b/default-product-image.svg",
37            "title": null,
38            "url": null
39          },
40          "variationAttributes": {}
41        }
42      ],
43      "status": "Created",
44      "totalAmount": "26.98"
45    },
46    {
47      "adjustmentAggregates": null,
48      "createdDate": "2024-03-08T07:28:32.000Z",
49      "currencyIsoCode": "USD",
50      "fields": {
51        "AccountId": {
52          "label": "Account ID",
53          "text": "001OK000001o5FtYAI",
54          "type": "reference"
55        }
56      },
57      "orderNumber": "00000109",
58      "orderSummaryId": "1OsOK00000006Sg0AI",
59      "orderedDate": "2023-10-02T11:02:06.000Z",
60      "ownerId": "005OK000000JZklYAG",
61      "products": [
62        {
63          "canViewProduct": true,
64          "errorCode": null,
65          "errorMessage": null,
66          "fields": {},
67          "id": "01tOK000000EUpmYAG",
68          "media": {
69            "alternateText": "Default Image",
70            "contentVersionId": null,
71            "id": null,
72            "mediaType": null,
73            "sortOrder": null,
74            "thumbnailUrl": "/img/b2b/default-product-image.svg",
75            "title": null,
76            "url": null
77          },
78          "variationAttributes": {}
79        }
80      ],
81      "status": "Created",
82      "totalAmount": "561.98"
83    }
84  ],
85  "previousPageToken": null,
86  "previousPageUrl": null,
87  "sortOrder": "OrderedDateDesc"
88}

Property Name	Type	Description	Filter Group and Version	Available Version
`count`	Integer	Total count of order summaries returned on the current page.	Small, 51.0	51.0
`currentPageToken`	String	Token identifying the current page.	Small, 51.0	51.0
`currentPageUrl`	String	Connect REST API URL identifying the current page.	Small, 51.0	51.0
`nextPageToken`	String	Token identifying the next page, or `null` if there isn’t a next page.	Small, 51.0	51.0
`nextPageUrl`	String	Connect REST API URL identifying the next page, or `null` if there isn’t a next page.	Small, 51.0	51.0
`orderSummaries`	Order Summary[]	Collection of order summaries.	Small, 51.0	51.0
`previousPageToken`	String	Token identifying the previous page, or `null` if there isn’t a previous page.	Small, 51.0	51.0
`previousPageUrl`	String	Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page.	Small, 51.0	51.0
`sortOrder`	String	Sort order for order summaries. Values are: `CreatedDateAsc`—Sorts by the oldest created date. `CreatedDateDesc`—Sorts by the most recent created date. `OrderedDateAsc`—Sorts by the oldest ordered date. `OrderedDateDesc`—Sorts by the most recent ordered date.	Small, 51.0	51.0

Connect REST API Developer Guide

Order Summary Collection