Basic information

POST /{shopId}/products/find

Returns a list of products that match a specified SKU.

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

Request attributes

Name Type Description
productNumber

string

The product SKU to search for

Request body

Media type application/json

{
    "productNumber": "1008"
}

Response attributes

Name Type Description
results

integer

The number of products found in total.

page

integer

The page number on which the found products appear.

resultsPerPage

integer

The number of found products returned per page.

items

array of product

The list of all products found.

Response

HTTP 200

Media type application/json

{
  "results": 3,
  "page": 1,
  "resultsPerPage": 3,
  "items": [
    {
      "productId": "54EF2E41-FCA8-E0E5-9323-0A0C05E66C2E",
      "name": "Boom - Customized headphone",
      "visible": true,
      "productVariationType": "regular",
      "productVariationMasterName": null,
      "productVariationMasterId": null,
      "manufacturerProductNumber": "CU001",
      "productLength": null,
      "productWidth": null,
      "productHeight": null,
      "productVariationSelection": null,
      "shortDescription": null,
      "deliveryPeriod": "2-4",
      "description": "Customize your headphone in no time!",
      "title": "Boom - 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",
          "isZoomEnabled": true,
          "width": 149,
          "height": 84,
          "fileSize": 5168
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54EF/2E41/FCA8/E0E5/9323/0A0C/05E6/6C2E/001-headphone_m.jpg",
          "classifier": "Medium",
          "isZoomEnabled": true,
          "width": 500,
          "height": 281,
          "fileSize": 47289
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54EF/2E41/FCA8/E0E5/9323/0A0C/05E6/6C2E/headphone3.jpg",
          "classifier": "Large",
          "isZoomEnabled": true,
          "width": 1920,
          "height": 1080,
          "fileSize": 636262
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54EF/2E41/FCA8/E0E5/9323/0A0C/05E6/6C2E/001-headphone_s.jpg",
          "classifier": "Small",
          "isZoomEnabled": true,
          "width": 100,
          "height": 56,
          "fileSize": 2498
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54EF/2E41/FCA8/E0E5/9323/0A0C/05E6/6C2E/001-headphone_xs.jpg",
          "classifier": "Thumbnail",
          "isZoomEnabled": true,
          "width": 50,
          "height": 28,
          "fileSize": 1031
        }
      ],
      "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"
        },
        "lowestPrice": null,
        "lowestRefPriceFormatted": null,
        "highestPrice": null,
        "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",
      "isProductNumberVisible": true,
      "newnessDate": "2023-08-08T00:00:00Z",
      "refAmount": 1,
      "refUnit": "piece",
      "refContentAmount": 1,
      "priceQuantity": 1,
      "orderUnit": "piece(s)",
      "minOrder": 1,
      "intervalOrder": 1,
      "productCode": null,
      "manufacturer": "Dr. Boom",
      "upc": null,
      "ean": null,
      "essentialFeatures": null,
      "searchKeywords": [],
      "stocklevel": null,
      "minStocklevel": null,
      "isInWishlist": false,
      "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"
        },
        {
          "rel": "producttype",
          "href": "https://pm.epages.com/rs/shops/apidocu/producttypes/6489A241-7B85-54B0-0B69-C0A8020205ED"
        }
      ]
    },
    {
      "productId": "51E7F905-2E4C-78C2-30C2-AC14145FA4E5",
      "name": "Dr.Boom - Red Power",
      "visible": true,
      "productVariationType": "regular",
      "productVariationMasterName": null,
      "productVariationMasterId": null,
      "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 canceling 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",
          "isZoomEnabled": true,
          "width": 1920,
          "height": 1080,
          "fileSize": 636262
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F905/2E4C/78C2/30C2/AC14/145F/A4E5/013-headphone-red_m.jpg",
          "classifier": "Medium",
          "isZoomEnabled": true,
          "width": 500,
          "height": 281,
          "fileSize": 47289
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F905/2E4C/78C2/30C2/AC14/145F/A4E5/013-headphone-red.jpg",
          "classifier": "Large",
          "isZoomEnabled": true,
          "width": 1920,
          "height": 1080,
          "fileSize": 636262
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F905/2E4C/78C2/30C2/AC14/145F/A4E5/013-headphone-red_s.jpg",
          "classifier": "Small",
          "isZoomEnabled": true,
          "width": 100,
          "height": 56,
          "fileSize": 2498
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F905/2E4C/78C2/30C2/AC14/145F/A4E5/013-headphone-red_xs.jpg",
          "classifier": "Thumbnail",
          "isZoomEnabled": true,
          "width": 50,
          "height": 28,
          "fileSize": 1031
        }
      ],
      "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"
        },
        "lowestPrice": null,
        "lowestRefPriceFormatted": null,
        "highestPrice": null,
        "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",
      "isProductNumberVisible": true,
      "newnessDate": "2023-08-08T00:00:00Z",
      "refAmount": 1,
      "refUnit": "piece",
      "refContentAmount": 1,
      "priceQuantity": 1,
      "orderUnit": "piece(s)",
      "minOrder": 1,
      "intervalOrder": 1,
      "productCode": null,
      "manufacturer": "Bass by Dr.Boom",
      "upc": null,
      "ean": null,
      "essentialFeatures": "Surround Sound\r\nAcoustic Noise Canceling\r\nCorrect fit",
      "searchKeywords": [
        "Surround Sound",
        "Acoustic Noise Canceling",
        "Correct fit"
      ],
      "stocklevel": 100,
      "minStocklevel": 10,
      "isInWishlist": false,
      "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"
        },
        {
          "rel": "producttype",
          "href": "https://pm.epages.com/rs/shops/apidocu/producttypes/6489A241-7B85-54B0-0B69-C0A8020205ED"
        }
      ]
    },
    {
      "productId": "51E7F913-5447-240E-77AE-AC14145FA477",
      "name": "Dr.Boom - True Voice",
      "visible": true,
      "productVariationType": "master",
      "productVariationMasterName": null,
      "productVariationMasterId": null,
      "manufacturerProductNumber": "HS-001",
      "productLength": null,
      "productWidth": null,
      "productHeight": null,
      "productVariationSelection": null,
      "shortDescription": null,
      "deliveryPeriod": "3-5",
      "description": "Professional headphones. Bass pipe emphasizes 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",
          "isZoomEnabled": true,
          "width": 149,
          "height": 84,
          "fileSize": 5168
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F913/5447/240E/77AE/AC14/145F/A477/headset1_m.jpg",
          "classifier": "Medium",
          "isZoomEnabled": true,
          "width": 500,
          "height": 281,
          "fileSize": 47289
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F913/5447/240E/77AE/AC14/145F/A477/headset1.jpg",
          "classifier": "Large",
          "isZoomEnabled": true,
          "width": 1920,
          "height": 1080,
          "fileSize": 636262
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F913/5447/240E/77AE/AC14/145F/A477/headset1_s.jpg",
          "classifier": "Small",
          "isZoomEnabled": true,
          "width": 100,
          "height": 56,
          "fileSize": 2498
        },
        {
          "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F913/5447/240E/77AE/AC14/145F/A477/headset1_xs.jpg",
          "classifier": "Thumbnail",
          "isZoomEnabled": true,
          "width": 50,
          "height": 28,
          "fileSize": 1031
        }
      ],
      "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": "NET",
            "formatted": "39.50 €",
            "amount": 39.5,
            "currency": "EUR"
        },
        "lowestRefPriceFormatted": "1 piece(s) = 39.50 €",
        "highestPrice": {
          "taxType": "NET",
          "formatted": "131.70 €",
          "amount": 131.7,
          "currency": "EUR"
        },
        "manufacturerPrice": null,
        "basePrice": null
      },
      "bulkPriceInfo": [
        {
          "quantity": {
            "amount": 2,
            "unit":"piece(s)"
          },
          "price": {
            "taxType": "NET",
            "formatted": "90.00 €",
            "amount": 90,
            "currency": "EUR"
          },
          "basePrice": null,
          "priceSavings": {
            "percent": {
              "formatted": "10 %",
              "percentage": 10.0
            },
            "regularBulkPrice": {
              "taxType": "NET",
              "formatted": "100.00 €",
              "amount": 100,
              "currency": "EUR"
            }
          }
        },
        {
          "quantity": {
            "amount": 1,
            "unit":"piece(s)"
          },
          "price": {
            "taxType": "NET",
            "formatted": "108.00 €",
            "amount": 108,
            "currency": "EUR"
          },
          "basePrice": null,
          "priceSavings": {
            "percent": {
              "formatted": "10 %",
              "percentage": 10.0
            },
            "regularBulkPrice": {
              "taxType": "NET",
              "formatted": "120.00 €",
              "amount": 120,
              "currency": "EUR"
            }
          }
        }
      ],
      "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",
      "isProductNumberVisible": true,
      "newnessDate": "2023-08-08T00:00:00Z",
      "refAmount": 1,
      "refUnit": "piece",
      "refContentAmount": 1,
      "priceQuantity": 1,
      "orderUnit": "piece(s)",
      "minOrder": 1,
      "intervalOrder": 1,
      "productCode": null,
      "manufacturer": "Bass by Dr.Boom",
      "upc": null,
      "ean": null,
      "essentialFeatures": "Surround Sound\nBluetooth\nWireless",
      "searchKeywords": [
        "Surround Sound",
        "Bluetooth Wireless"
      ],
      "stocklevel": 100,
      "minStocklevel": 10,
      "isInWishlist": false,
      "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"
        },
        {
          "rel": "producttype",
          "href": "https://pm.epages.com/rs/shops/apidocu/producttypes/6489A241-7B85-54B0-0B69-C0A8020205ED"
        }
      ]
    }
  ]
}