Basic information

GET /{shopId}/products

Returns a list of products.

Authorisation

OAuth 2.0 Token required with scopes:

products_read

URI parameters

Name Type Description
shopId string

The unique identifier of the shop.

Required: true
Example: DemoShop

Query parameters

Name Type Description
locale string

Represents the language code according to ISO 639-1 and the country code according to ISO 3166-1. If not provided, the shop’s default language is used. We recommend to always send this parameter with your request. If the default language had been changed in the administration, it might take up to 1 day until this change affects the shop.

Required: false
Example: en_US
currency string

Represents the currency code according to ISO 4217.

Required: false
Example: EUR
page integer

Represents the current page.

Required: false
Default: 1
Minimum: 1
resultsPerPage integer

Specifies the maximum number of results per page.

Required: false
Default: 10
Maximum: 100
direction string

Specifies the sorting direction, which can be either ascending or descending.

Required: false
Enum: asc,desc
sort string

Sorts products by attribute.

Required: false
Example: name
Default: name
Enum: name,price
q string

Filters products by a query string that can be either

  1. a part of a string, e.g. q=myProd (would match “myProduct”)

    2. a single phrase string using quotes, e.g. q=”myProduct” (would match “myProduct”) or q=”new%20Product” where %20 is used to encode the whitespace

    or

    a list of elements of type 1 or 2, that have to appear (combined with +), e.g. q=myProd+new or q=”new”+product.
Required: false
categoryId string

Filters products by category ID.

Required: false
id string

The ID of the product.
The query parameter is repeatable up to 12 times, e.g. “?id=productId1&id=productId2&id=productId3”.
The response will return the product data in the same order as the IDs. Invisible, deleted or unknown products are removed from the list.
This parameter can only be used together with the locale and currency query parameters. Other query parameters, such as sort, categoryId, page etc, are not supported.

Required: false
Repeat: true
includeInvisible boolean

Includes invisible products. Only available with products_write authorisation.

Required: false

Response attributes

Name Type Description
results

integer

The number of products in total.

page

integer

The page number on which the products appears.

resultsPerPage

integer

The number of products returned per page.

items

array of product

The list of all products.

Response

HTTP 200

Media type application/json

{
  "results": 3,
  "page": 1,
  "resultsPerPage": 3,
  "items": [
    {
      "productId": "54EF2E41-FCA8-E0E5-9323-0A0C05E66C2E",
      "name": "Customised headphone",
      "visible": true,
      "productVariationType": "regular",
      "manufacturerProductNumber": "CU001",
      "productLength": null,
      "productWidth": null,
      "productHeight": null,
      "productVariationSelection": null,
      "shortDescription": null,
      "deliveryPeriod": "2-4",
      "description": "Customise your headphone in no time!",
      "title": "Customized headphone - Technic365",
      "productImage": "headphone3.jpg",
      "images": [
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54EF/2E41/FCA8/E0E5/9323/0A0C/05E6/6C2E/001-headphone_h.jpg",
          "classifier": "HotDeal"
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54EF/2E41/FCA8/E0E5/9323/0A0C/05E6/6C2E/001-headphone_m.jpg",
          "classifier": "Medium"
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54EF/2E41/FCA8/E0E5/9323/0A0C/05E6/6C2E/headphone3.jpg",
          "classifier": "Large"
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54EF/2E41/FCA8/E0E5/9323/0A0C/05E6/6C2E/001-headphone_s.jpg",
          "classifier": "Small"
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54EF/2E41/FCA8/E0E5/9323/0A0C/05E6/6C2E/001-headphone_xs.jpg",
          "classifier": "Thumbnail"
        }
      ],
      "priceInfo": {
        "quantity": {
          "amount": 1,
          "unit": "piece(s)"
        },
        "taxClass": {
          "taxClassId": "54B50D97-A277-9AF2-58A1-D5809AB32230",
          "name": "standard",
          "percentage": 19
        },
        "price": {
          "taxType": "NET",
          "formatted": "251.26 €",
          "amount": 251.26,
          "currency": "EUR"
        },
        "depositPrice": null,
        "ecoParticipationPrice": null,
        "priceWithDeposits": {
          "taxType": "NET",
          "formatted": "251.26 €",
          "amount": 251.26,
          "currency": "EUR"
        },
        "manufacturerPrice": null,
        "basePrice": null
      },
      "forSale": true,
      "specialOffer": false,
      "deliveryWeight": {
        "amount": 350,
        "unit": "g"
      },
      "availabilityText": "",
      "availability": null,
      "energyLabelsString": "B,D",
      "energyLabelsMaxEfficiencyString": "A+",
      "energyLabelSourceFile": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/Products/be_40401/label-1-9dee85f24e1.png",
      "productDataSheet": null,
      "sfUrl": "http://pm.epages.com/epages/apidocu.sf/?ObjectPath=/Shops/apidocu/Products/Cust001",
      "productNumber": "Cust001",
      "manufacturer": "Dr. Boom",
      "upc": null,
      "ean": null,
      "essentialFeatures": null,
      "searchKeywords": [],
      "stocklevel": null,
      "minStocklevel": null,
      "videos": [
        {
          "type": "YouTube",
          "source": "j-bj3nC7qss"
        },
        {
          "type": "Vimeo",
          "source": "https://vimeo.com/7265982"
        }
      ],
      "links": [
        {
          "rel": "self",
          "href": "https://pm.epages.com/rs/shops/apidocu/products/54EF2E41-FCA8-E0E5-9323-0A0C05E66C2E"
        },
        {
          "rel": "categories",
          "href": "https://pm.epages.com/rs/shops/apidocu/categories/?productId=54EF2E41-FCA8-E0E5-9323-0A0C05E66C2E"
        }
      ]
    },
    {
      "productId": "51E7F905-2E4C-78C2-30C2-AC14145FA4E5",
      "name": "Dr.Boom - Red Power",
      "visible": true,
      "productVariationType": "regular",
      "manufacturerProductNumber": "HP-003",
      "productLength": null,
      "productWidth": null,
      "productHeight": null,
      "productVariationSelection": null,
      "shortDescription": "<p>Red Resonator S&nbsp;headphones are the best-performing around-ear headphones from&nbsp;Dr.Boom. They give you fresh and&nbsp;powerful sound.&nbsp;These headphones definitely&nbsp;let you hear your music better!</p>",
      "deliveryPeriod": "3-5",
      "description": "<p><strong><em>Dr.Boom - HP001</em></strong>&nbsp;Red Resonator S&nbsp;headphones are the best-performing around-ear headphones from&nbsp;Dr.Boom. They give you fresh and&nbsp;powerful sound.&nbsp;These headphones definitely&nbsp;let you hear your music better!</p>\r\n\r\n<p>The noise cancelling technology monitors the noise around you and cancels it out, helping you focus on what you want to hear -&nbsp;whether it’s music, calls or simply peace and quiet. These headphones look as good as they sound. They’re comfy, durably made and easily to store, with earcups that&nbsp;fit in a small carrying box.</p>",
      "images": [
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F905/2E4C/78C2/30C2/AC14/145F/A4E5/013-headphone-red_h.jpg",
          "classifier": "HotDeal"
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F905/2E4C/78C2/30C2/AC14/145F/A4E5/013-headphone-red_m.jpg",
          "classifier": "Medium"
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F905/2E4C/78C2/30C2/AC14/145F/A4E5/013-headphone-red.jpg",
          "classifier": "Large"
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F905/2E4C/78C2/30C2/AC14/145F/A4E5/013-headphone-red_s.jpg",
          "classifier": "Small"
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F905/2E4C/78C2/30C2/AC14/145F/A4E5/013-headphone-red_xs.jpg",
          "classifier": "Thumbnail"
        }
      ],
      "priceInfo": {
        "quantity": {
          "amount": 1,
          "unit": "piece(s)"
        },
        "taxClass": {
          "taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF",
          "name": "standard",
          "percentage": 19
        },
        "price": {
          "taxType": "NET",
          "formatted": "54.62 €",
          "amount": 54.62,
          "currency": "EUR"
        },
        "depositPrice": null,
        "ecoParticipationPrice": null,
        "priceWithDeposits": {
          "taxType": "NET",
          "formatted": "54.62 €",
          "amount": 54.62,
          "currency": "EUR"
        },
        "manufacturerPrice": null,
        "basePrice": null
      },
      "forSale": true,
      "specialOffer": false,
      "deliveryWeight": {
        "amount": 260,
        "unit": "g"
      },
      "availabilityText": "In stock<br />can be shipped within 3-5 days",
      "availability": "OnStock",
      "energyLabelsString": null,
      "energyLabelSourceFile": null,
      "productDataSheet": null,
      "sfUrl": "http://pm.epages.com/epages/apidocu.sf/?ObjectPath=/Shops/apidocu/Products/HP-003",
      "productNumber": "HP-003",
      "manufacturer": "Bass by Dr.Boom",
      "upc": null,
      "ean": null,
      "essentialFeatures": "Surround Sound\r\nAcoustic Noise Cancelling\r\nCorrect fit",
      "searchKeywords": [
        "Surround Sound",
        "Acoustic Noise Cancelling",
        "Correct fit"
      ],
      "stocklevel": 100,
      "minStocklevel": 10,
      "videos": [
        {
          "type": "YouTube",
          "source": "j-bj3nC7qss"
        },
        {
          "type": "Vimeo",
          "source": "https://vimeo.com/7265982"
        }
      ],
      "links": [
        {
          "rel": "self",
          "href": "https://pm.epages.com/rs/shops/apidocu/products/51E7F905-2E4C-78C2-30C2-AC14145FA4E5"
        },
        {
          "rel": "categories",
          "href": "https://pm.epages.com/rs/shops/apidocu/categories/?productId=51E7F905-2E4C-78C2-30C2-AC14145FA4E5"
        }
      ]
    },
    {
      "productId": "51E7F913-5447-240E-77AE-AC14145FA477",
      "name": "Dr.Boom - True Voice",
      "visible": true,
      "productVariationType": "master",
      "manufacturerProductNumber": "HS-001",
      "productLength": null,
      "productWidth": null,
      "productHeight": null,
      "productVariationSelection": null,
      "shortDescription": null,
      "deliveryPeriod": "3-5",
      "description": "Professional headphones. Bass pipe emphasises low tones for a clear, realistic sound. Ergonomically shaped.",
       "productImage": "headset1.jpg",
      "images": [
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F913/5447/240E/77AE/AC14/145F/A477/headset1_h.jpg",
          "classifier": "HotDeal"
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F913/5447/240E/77AE/AC14/145F/A477/headset1_m.jpg",
          "classifier": "Medium"
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F913/5447/240E/77AE/AC14/145F/A477/headset1.jpg",
          "classifier": "Large"
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F913/5447/240E/77AE/AC14/145F/A477/headset1_s.jpg",
          "classifier": "Small"
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F913/5447/240E/77AE/AC14/145F/A477/headset1_xs.jpg",
          "classifier": "Thumbnail"
        }
      ],
      "priceInfo": {
        "quantity": {
          "amount": 1,
          "unit": "piece(s)"
        },
        "taxClass": {
          "taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF",
          "name": "standard",
          "percentage": 19
        },
        "price": {
          "taxType": "NET",
          "formatted": "126.04 €",
          "amount": 126.04,
          "currency": "EUR"
        },
        "depositPrice": null,
        "ecoParticipationPrice": null,
        "priceWithDeposits": {
          "taxType": "NET",
          "formatted": "42.02 €",
          "amount": 42.02,
          "currency": "EUR"
        },
        "lowestPrice": {
            "taxType": "GROSS",
            "formatted": "39.50 €",
            "amount": 39.50,
            "currency": "EUR"
        },
        "manufacturerPrice": null,
        "basePrice": null
      },
      "forSale": false,
      "specialOffer": true,
      "deliveryWeight": {
        "amount": 310,
        "unit": "g"
      },
      "availabilityText": "In stock<br />can be shipped within 3-5 days",
      "availability": "OnStock",
      "energyLabelsString": null,
      "energyLabelSourceFile": null,
      "productDataSheet": null,
      "sfUrl": "http://pm.epages.com/epages/apidocu.sf/?ObjectPath=/Shops/apidocu/Products/HS-001",
      "productNumber": "HS-001",
      "manufacturer": "Bass by Dr.Boom",
      "upc": null,
      "ean": null,
      "essentialFeatures": "Surround Sound\nBluetooth\nWireless",
      "searchKeywords": [
        "Surround Sound",
        "Bluetooth Wireless"
      ],
      "stocklevel": 100,
      "minStocklevel": 10,
      "videos": [
        {
          "type": "YouTube",
          "source": "j-bj3nC7qss"
        },
        {
          "type": "Vimeo",
          "source": "https://vimeo.com/7265982"
        }
      ],
      "links": [
        {
          "rel": "self",
          "href": "https://pm.epages.com/rs/shops/apidocu/products/51E7F913-5447-240E-77AE-AC14145FA477"
        },
        {
          "rel": "variations",
          "href": "https://pm.epages.com/rs/shops/apidocu/products/51E7F913-5447-240E-77AE-AC14145FA477/variations"
        },
        {
          "rel": "categories",
          "href": "https://pm.epages.com/rs/shops/apidocu/categories/?productId=51E7F913-5447-240E-77AE-AC14145FA477"
        }
      ]
    }
  ]
}