> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# GetSummary

# Package: ticketing

# Namespace: OrderManagement

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/events/registration/ticketing/orders/get-order-summary.md

## Permission Scopes:
Read Basic Events Order Info: SCOPE.DC-EVENTS.READ-BASIC-ORDERS

## Introduction

Retrieves a summary of total ticket sales.

---

## REST API

### Schema

```
 Method: getSummary
 Description: Retrieves a summary of total ticket sales.
 URL: https://www.wixapis.com/events/v1/orders/summary
 Method: GET
 Method parameters:
   query param name: eventId | type: eventId | description: Event GUID to which the order belongs. 
 Return type: GetSummaryResponse
  - name: sales | type: array<TicketSales> | description: Ticket sales grouped by currency. 
     - name: total | type: Money | description: Total balance of confirmed transactions. 
        - name: currency | type: string | description: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`. 
        - name: value | type: string | description: Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative. 
     - name: totalOrders | type: integer | description: Total number of confirmed orders. 
     - name: totalTickets | type: integer | description: Total number of tickets purchased. 
     - name: revenue | type: Money | description: Total revenue, excluding fees (taxes and payment provider fees are not deducted). 


```

### Examples

### GetSummary
```curl
~~~cURL
curl -X GET 'https://api.wix.com/events/v1/orders/summary?eventId=619d52c0-c93b-4155-a55c-108048f20b3f' \
-H 'Authorization: <AUTH TOKEN>'
~~~
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.ticketing.OrderManagement.getSummary(options)
 Description: Retrieves a summary of total ticket sales.
 Method parameters:
   param name: options | type: GetSummaryOptions  none 
        - name: eventId | type: string | description: Event GUID to which the order belongs. 
 Return type: PROMISE<GetSummaryResponse>
  - name: sales | type: array<TicketSales> | description: Ticket sales grouped by currency. 
     - name: total | type: Money | description: Total balance of confirmed transactions. 
        - name: currency | type: string | description: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`. 
        - name: value | type: string | description: Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative. 
     - name: totalOrders | type: integer | description: Total number of confirmed orders. 
     - name: totalTickets | type: integer | description: Total number of tickets purchased. 
     - name: revenue | type: Money | description: Total revenue, excluding fees (taxes and payment provider fees are not deducted). 


```

### Examples

### getSummary
```javascript
import { orders } from '@wix/events';

async function getSummary(options) {
  const response = await orders.getSummary(options);
};
```

### getSummary (with elevated permissions)
```javascript
import { orders } from '@wix/events';
import { auth } from '@wix/essentials';

async function myGetSummaryMethod(options) {
  const elevatedGetSummary = auth.elevate(orders.getSummary);
  const response = await elevatedGetSummary(options);
}
```

### getSummary (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { orders } from '@wix/events';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { orders },
  // Include the auth strategy and host as relevant
});


async function getSummary(options) {
  const response = await myWixClient.orders.getSummary(options);
};
```

---