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

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

# List warranties

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

Operation ID: `warrantyList`

Lists the available warranties for a specific Cumulus number between two dates. The returned data is a shortened version of the detail of each warranty.

## Path parameters

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

## Query parameters

- `from` (string, date, optional) - start date If omited it defaults to "3 years and 2 months ago".
- `to` (string, date, optional) - end date of list; if omited or empty the current date is used

## Responses

- `200` - list of warranties

## 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/warranties/v1/list/{cumulus}:
    get:
      description: Lists the available warranties for a specific Cumulus number
        between two dates. The returned data is a shortened version of the
        detail of each warranty.
      operationId: warrantyList
      parameters:
        - $ref: "#/components/parameters/cumulus"
        - $ref: "#/components/parameters/from3a"
        - $ref: "#/components/parameters/to"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WarrantyListResponse"
          description: list of warranties
      summary: List warranties
      tags:
        - Warranty
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
    from3a:
      description: |-
        start date
        If omited it defaults to "3 years and 2 months ago".
      example: 2019-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:
    WarrantyListResponse:
      properties:
        articleDescription:
          description: Article description.
          example: MediaPadT5 10.1 WiFi s
          type: string
        articleNumber:
          description: Unique article identifer. Product-ID
          example: "798458800000"
          type: string
        articlePrice:
          description: Full article price in CHF without reductions in CHF.
          example: 274.5
          type: number
        storeId:
          description: Unique store identifier. Filial-ID
          example: "0150475"
          type: string
        warrantyDuration:
          description: Complete length of the warranty duration in months.
          example: 24
          type: integer
        warrantyId:
          description: Warranty identifier.
          type: number
        warrantyUntil:
          description: Exact date when the warranty will expire. Provided in YYYYMMDD.
          example: 20210927
          type: integer
      required:
        - articleDescription
        - articleNumber
        - articlePrice
        - storeId
        - warrantyDuration
        - warrantyId
        - warrantyUntil
      type: object
  securitySchemes:
    Kong-Api-Key:
      description: Kong key-auth authentication
      in: header
      name: X-Api-Key
      type: apiKey
```