Catalog

listProducts - List products from your Mirakl Connect catalog

Changed on
<div class="extension-title">Description</div>

Use this API to retrieve products imported in your Mirakl Connect catalog. Items are sorted by product identifiers.

<div class="api-description-extension"> <div class="extension-title">Call Frequency</div> <div class="recommended-call-frequency">Recommended usage: Synchronous: every 5 minutes</div> <div class="max-call-frequency">Maximum usage: Synchronous: once per minute</div> <div class="extension-title">Pagination</div> <p>This resource supports seek pagination (<a href="#section/Seek-pagination-and-sort">see documentation</a>)</p> </div>
get/products

Request

Query parameters

page_tokenstring

Token to access the next or previous page

limitinteger

Maximum number of listed products

Response

List of products

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.

Example response

{
  "data": [
    {
      "attributes": [
        {
          "type": "STRING"
        }
      ],
      "brand": "My awesome brand",
      "category": {
        "id": "123654789",
        "labels": [
          {
            "locale": "en_US",
            "value": "Fridge"
          }
        ]
      },
      "descriptions": [
        {
          "locale": "en_US",
          "value": "My awesome product's description"
        }
      ],
      "discount_prices": [
        {
          "end_date": "2025-02-19T16:46:00Z",
          "price": {
            "currency": "EUR"
          },
          "start_date": "2025-02-19T16:46:00Z"
        }
      ],
      "gtins": [
        {
          "value": "9780050666319"
        }
      ],
      "images": [
        {
          "url": "http://my_image.png"
        }
      ],
      "standard_prices": [
        {
          "price": {
            "currency": "EUR"
          }
        }
      ],
      "titles": [
        {
          "locale": "en_US",
          "value": "My awesome product"
        }
      ]
    }
  ]
}

Changes

    • warning

      added the new BOOLEAN enum value to the ///////// response property for the response status

    • warning

      added the new NUMERIC enum value to the ///////// response property for the response status

    • warning

      added the new STRING enum value to the ///////// response property for the response status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      removed the required property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      added subschema #2 to the // response property allOf list for the response status