---
title: "List receipts"
url: "https://developer-qual.migros.ch/apis/layout-api-1/versions/fcc71337-b27c-4bc7-8aea-a50107bf562d/operations/receiptList"
---

> Full API specification: https://developer-qual.migros.ch/apis/layout-api-1/versions/fcc71337-b27c-4bc7-8aea-a50107bf562d.md

# List receipts

`GET` `/migros/customers/receipts/v1/list/{cumulus}`

Operation ID: `receiptList`

Lists receipts and received Cumulus points for a specific Cumulus number between two dates. The returned data contains only summary data of the receipt and omits articles, payments and other variable size details. If a record has `hasDetail` == 1 this record represents a real receipt and the `transactionId` can be used to retrieve the rendered receipts via the .../v1/details/... endpoint. If a record has `hasDetail` == 0 this record represents only the credit entry of Cumulus-Points, typically from a Migros-Partner or Mitarbeiterpunkte. In this case you cannot access the receipts details as there are no details.

## Path parameters

- `cumulus` (integer, required) - Cumulus Number

## Query parameters

- `from` (string, date, optional) - start date If omited it defaults to "yesterday one year ago", i.e. one whole year of data is returned or analyzed.
- `to` (string, date, optional) - end date of list; if omited or empty the current date is used
- `sort` (string, optional) - Sort list by date of purchase or total CHF.

## Responses

- `200` - list of transactions

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Layout-API
  version: 1.3.0
servers:
  - description: URL of upstream
    url: https://api-qual.migros.ch
paths:
  /migros/customers/receipts/v1/list/{cumulus}:
    get:
      description: >-
        Lists receipts and received Cumulus points for a specific Cumulus number
        between two dates. The returned data contains only summary data of the
        receipt and omits articles, payments and other variable size details.

        If a record has `hasDetail` == 1 this record represents a real receipt
        and the `transactionId` can be used to retrieve the rendered receipts
        via the .../v1/details/... endpoint.

        If a record has `hasDetail` == 0 this record represents only the credit
        entry of Cumulus-Points, typically from a Migros-Partner or
        Mitarbeiterpunkte. In this case you cannot access the receipts details
        as there are no details.
      operationId: receiptList
      parameters:
        - $ref: "#/components/parameters/cumulus"
        - $ref: "#/components/parameters/from"
        - $ref: "#/components/parameters/to"
        - description: Sort list by date of purchase or total CHF.
          example: total
          in: query
          name: sort
          schema:
            default: date
            enum:
              - date
              - total
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ReceiptListResponse"
          description: list of transactions
      summary: List receipts
      tags:
        - Receipt
security:
  - Kong-Api-Key: []
components:
  parameters:
    cumulus:
      description: Cumulus Number
      example: 2099123456789
      in: path
      name: cumulus
      required: true
      schema:
        maximum: 2099999999999
        minimum: 2098000000000
        type: integer
    from:
      description: >-
        start date

        If omited it defaults to "yesterday one year ago", i.e. one whole year
        of data is returned or analyzed.
      example: 2021-03-17
      in: query
      name: from
      required: false
      schema:
        format: date
        type: string
    to:
      description: end date of list; if omited or empty the current date is used
      in: query
      name: to
      required: false
      schema:
        format: date
        type: string
  schemas:
    ReceiptListResponse:
      items:
        $ref: "#/components/schemas/ReceiptHeadShort"
      type: array
    ReceiptHeadShort:
      properties:
        cumulusPunkte:
          description: Rewarded Cumulus points.
          example: 319.7
          type: number
        hasDetail:
          description: >-
            0: This is a syntetic pseudo-transaction that just list Partner- or
            Mitarbeiter-Punkte. Trying to retrieve details will fail always in
            this case.


            1: Actual receipt available via detail/{cumulus}/{transactionId}.
          example: 1
          type: number
        storeid:
          description: Filial-ID
          example: "0090390"
          type: string
        storename:
          description: Filialname
          example: M Wittenbach
          type: string
        total:
          description: Total purchase value in CHF.
          example: 159.85
          type: number
        transactionId:
          description: >-
            ID to retrieve actual receipt if hasDetail==1 If `hasDetail` = 0
            this ID is just a dummy and cannot be used to retrieve the
            (non-existing) details.


            Note: if `hasDetail` = 0 the `transactionId` might be empty (i.e.
            "").
          example: 20220611_092739_0090390_003_9
          type: string
        trxDate:
          description: Date of purchase in the form YYYYMMDD.
          example: "20220611"
          type: string
        trxTime:
          description: Time of purchase (local time of store) in the form hhmmss.
          example: "092739"
          type: string
        version:
          description: Kept for backwards compatibility. You are not supposed to use or
            interpret this field.
          type: string
      required:
        - cumulusPunkte
        - hasDetail
        - storeid
        - storename
        - total
        - transactionId
        - trxDate
        - trxTime
        - version
      type: object
  securitySchemes:
    Kong-Api-Key:
      description: Kong key-auth authentication
      in: header
      name: X-Api-Key
      type: apiKey
```