---
title: "Get sales"
method: GET
path: "/api/v2/host/sales"
tags: ["host"]
---

# Get sales

`GET /api/v2/host/sales`

**Note:** This is an experimental feature, please contact support if you want to utilize this endpoint. 
 
This endpoint returns a list of host sales. 
The default sorting mode is DESC (newest sales first), but you can also specify ASC (oldest sales first). 
For session and appointment sales, additional meta data is returned in the response.

## Query parameters

- `page` integer, required
- `pageSize` integer, required
- `sortOrder` 'ASC' | 'DESC'
- `sortBy` string

## Response `200`

- object
  - `pagination` PaginatedResponseDataDto, required
    - `page` integer, required
    - `pageSize` integer, required
    - `totalCount` integer, required
    - `sortBy` string
    - `sortOrder` 'ASC' | 'DESC'
  - `payload` HostSaleDto[], required
    - `id` integer, required
    - `saleDate` string, date-time, required
    - `items` HostSaleItemDto[], required
      - `id` integer, required
      - `saleItemId` integer, required
      - `itemType` 'membership' | 'session' | 'appointment' | 'product' | 'video' | 'course' | 'gift-card' | 'monthly-subscription' | 'custom-member-payment-plan-installment' | 'money-credit' | 'event-credit' | 'auto-attendance-penalty' | 'auto-attendance-penalty-retry-fee' | 'stripe-refund' | 'refund' | 'tips' | 'appointment-deposit' | 'tuition-installment' | 'tuition-registration-fee' | 'appointment-addon' | 'open-area-visit' | 'membership-freeze-fee' | 'membership-renewal-retry-fee' | 'membership-cancellation-fee' | 'membership-transfer-fee' | 'membership-joining-fee' | 'session-addon', required
      - `itemName` string, required
      - `descriptiveItemName` string, required
      - `payingMember` HostSaleMemberDto, required
        - `id` integer, required
        - `firstName` string, required
        - `lastName` string, required
      - `targetMember` HostSaleMemberDto, required
        - `id` integer, required
        - `firstName` string, required
        - `lastName` string, required
      - `session` HostSaleSessionDto
        - `id` integer, required
        - `name` string, required
        - `startsAt` string, date-time, required
        - `endsAt` string, date-time, required
      - `appointment` HostSaleAppointmentDto
        - `id` integer, required
        - `name` string, required
      - `product` HostSaleProductDto
        - `id` integer, required
        - `name` string, required
      - `productVariant` HostSaleProductVariantDto
        - `id` integer, required
        - `name` string, required
      - `openArea` HostSaleOpenAreaDto
        - `id` integer, required
        - `name` string, required
      - `quantity` number, required
      - `unitPriceExcludingTaxInCurrency` string, required
      - `unitTaxAmountInCurrency` string, required
    - `paymentTransaction` HostSalePaymentTransactionDto, required
      - `items` HostSalePaymentTransactionItemDto[], required
        - `id` integer, required
        - `paymentMethodType` 'stripe' | 'stripe-becs' | 'stripe-nz-becs' | 'stripe-revolut-pay' | 'stripe-ideal' | 'stripe-ideal-sepa-direct-debit' | 'stripe-bancontact' | 'stripe-bancontact-sepa-direct-debit' | 'stripe-sepa-direct-debit' | 'stripe-ach-direct-debit' | 'stripe-acss-debit' | 'stripe-bacs-direct-debit' | 'stripe-refund' | 'membership' | 'cash' | 'free' | 'imported' | 'custom' | 'scheduled-stripe' | 'paypal' | 'xendit' | 'classpass' | 'gympass' | 'gift-card' | 'stripe-reader' | 'pay-later' | 'pay-at-start' | 'money-credit-correction' | 'money-credit-refund' | 'event-credit-correction' | 'event-credit-refund' | 'tuition' | 'urban-sports-club' | 'my-clubs' | 'referral-reward' | 'referral-gift' | 'campaign-sequence-action' | 'reward-points-corrections' | 'reward-points-earned' | 'reward-points-spent' | 'multiple-payment-methods' | 'yappy' | 'odin-card' | 'odin-ach' | 'odin-reader', required
        - `paymentMethodName` string — Additional name for the payment method used - for CUSTOM, it's custom payment method name, for MEMBERSHIP it's the membership name
        - `amountInCurrencyWithoutTax` string, required
        - `taxAmountInCurrency` string, required

---

[API](https://skmtc.net/momence/apis/momence-public.md) · [All operations](https://skmtc.net/momence/apis/momence-public/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/momence/momence-public/revisions/5e27e54ff467/schema)