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

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

# Augmented warranties

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

Operation ID: `warrantyXList`

Lists warranties for a specific Cumulus number between two dates. The returned data is not just the raw data from the archived warranty but is augmented/extended by looking up the product in the M-API. If the product is not found in the M-API (for whatever reason) the original data is returned.

## 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
- `lang` (string, required) - Target language to use for article description.
- `storeType` (string, optional) - Show only warranties issued in a store of this type. SMVM is M or MM or MMM.

## Responses

- `200` - list of augmented 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/xlist/{cumulus}:
    get:
      description: >-
        Lists warranties for a specific Cumulus number between two dates.


        The returned data is not just the raw data from the archived warranty
        but is augmented/extended by looking up the product in the M-API. If the
        product is not found in the M-API (for whatever reason) the original
        data is returned.
      operationId: warrantyXList
      parameters:
        - $ref: "#/components/parameters/cumulus"
        - $ref: "#/components/parameters/from"
        - $ref: "#/components/parameters/to"
        - description: Target language to use for article description.
          in: query
          name: lang
          required: true
          schema:
            enum:
              - de
              - fr
              - it
            type: string
        - deprecated: true
          description: Show only warranties issued in a store of this type. SMVM is M or
            MM or MMM.
          in: query
          name: storeType
          schema:
            enum:
              - M
              - MM
              - MMM
              - SMVM
              - MEL
              - DG
              - MIC
              - SXX
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/XWarrantyListResponse"
          description: list of augmented warranties
      summary: Augmented 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
    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:
    XWarrantyListResponse:
      properties:
        articleDescription:
          description: Article description.
          example: MediaPadT5 10.1 WiFi s
          type: string
        articleImage:
          description: URL of image
          example: http://image.migros.ch/{stack}foo/bar.jpg
          type: string
        articleLink:
          description: URL of article in shop.
          example: https://produkte.migros.ch/bellcolor-kreidestift-3-stk
          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.95
          type: number
        buyDate:
          description: Buy-date as YYYYMMDD
          example: 20220124
          type: integer
        manuals:
          description: List of user manuals
          items:
            properties:
              type:
                description: Type of document
                example: application/pdf
                type: string
              url:
                description: URL of the manual
                example: https://cdn.migros.ch/documents/f0095e903b56bc975042be5d425ad10eccb444ad/bedienungsanleitung.pdf
                type: string
            type: object
          type: array
        serviceLink:
          description: URL to migros.service.
          example: https://migros-service.ch/foo/bar
          type: string
        storeId:
          description: Unique store identifier. Filial-ID.
          example: "0150475"
          type: string
        storeName:
          description: Name of store
          example: M Gränichen
          type: string
        storeType:
          description: Type of the store
          example: MEL
          type: string
        warrantyDuration:
          description: Complete length of the warranty duration in months.
          example: 24
          type: integer
        warrantyId:
          description: Warranty identifier.
          example: 20220124_174650_0045160_046_203_0
          type: string
        warrantyUntil:
          description: Exact date when the warranty will expire. Provided in YYYYMMDD.
          example: "20210927"
          type: string
      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
```