Basic information

GET /{shopId}/products/{productId}

Returns information on a single product. For product variations, a link to the respective product variations resource (rel=”variations”) is added. Note that the attribute minStocklevel is only available with the products_write authorisation.

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
productId string

The unique identifier of the product.

Required: true
Example: 52F221E0-36F6-DC4E-384A-AC1504050C04

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

Response attributes

Name Type Description

object of product

Response

HTTP 200

Media type application/json

{
  "productId": "51E7F905-2E4C-78C2-30C2-AC14145FA4E5",
  "name": "Dr.Boom - Red Power",
  "visible": true,
  "productVariationType": "variation",
  "productVariationMasterName": "Dr.Boom - True Voice",
  "productVariationMasterId": "51E7F913-5447-240E-77AE-AC14145FA477",
  "manufacturerProductNumber": "HP-003",
  "productLength": null,
  "productWidth": null,
  "productHeight": null,
  "productVariationSelection": [
    {
      "name": "Color",
      "displayName": "Headphone color",
      "value": "red",
      "displayValue": "Ravishing red"
    }
  ],
  "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>",
  "title": "Dr.Boom - Red Power - Technic365",
  "productImage": "013-headphone-red.jpg",
  "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": 149,
      "height": 84,
      "fileSize": 5168
    },
    {
      "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": "GROSS",
      "formatted": "65.00 €",
      "amount": 65,
      "currency": "EUR"
    },
    "depositPrice": null,
    "ecoParticipationPrice": null,
    "priceWithDeposits": {
      "taxType": "GROSS",
      "formatted": "65.00 €",
      "amount": 65,
      "currency": "EUR"
    },
    "lowestPrice": null,
    "lowestRefPriceFormatted": null,
    "highestPrice": null,
    "manufacturerPrice": null,
    "basePrice": null
  },
  "bulkPriceInfo": [
    {
      "quantity": {
        "amount": 2,
        "unit":"piece(s)"
      },
      "price": {
        "taxType": "GROSS",
        "formatted": "117.00 €",
        "amount": 117,
        "currency": "EUR"
      },
      "basePrice": null,
      "priceSavings": {
        "percent": {
          "formatted": "10 %",
          "percentage": 10.0
        },
        "regularBulkPrice": {
          "taxType": "GROSS",
          "formatted": "130.00 €",
          "amount": 130,
          "currency": "EUR"
        }
      }
    },
    {
      "quantity": {
        "amount": 1,
        "unit":"piece(s)"
      },
      "price": {
        "taxType": "GROSS",
        "formatted": "135.00 €",
        "amount": 135,
        "currency": "EUR"
      },
      "basePrice": null,
      "priceSavings": {
        "percent": {
          "formatted": "10 %",
          "percentage": 10.0
        },
        "regularBulkPrice": {
          "taxType": "GROSS",
          "formatted": "150.00 €",
          "amount": 150,
          "currency": "EUR"
        }
      }
    }
  ],
  "customerSpecificPriceInfo": [
    {
      "customerGroup" : "KG1",
      "customerGroupId": "63E4F781-CDA5-327F-B72B-C0A802027724",
      "priceInfo": [
        {
          "quantity": {
            "amount": 5,
            "unit": "piece(s)"
          },
          "price": {
            "taxType": "GROSS",
            "formatted": "61.75 €",
            "amount": 61.75,
            "currency": "EUR"
          },
          "basePrice": null,
          "priceSavings": {
            "percent": {
              "formatted": "5 %",
              "percentage": 5.0
            },
            "regularBulkPrice": {
              "taxType": "GROSS",
              "formatted": "65.00 €",
              "amount": 65,
              "currency": "EUR"
            }
          }
        },
        {
          "quantity": {
            "amount": 10,
            "unit": "piece(s)"
          },
          "price": {
            "taxType": "GROSS",
            "formatted": "50.00 €",
            "amount": 50,
            "currency": "EUR"
          },
          "basePrice": null,
          "priceSavings": {
            "percent": {
              "formatted": "0 %",
              "percentage": 0.0
            },
            "regularBulkPrice": {
              "taxType": "GROSS",
              "formatted": "50.00 €",
              "amount": 50,
              "currency": "EUR"
            }
          }
        }
      ]
    }
  ],
  "forSale": true,
  "specialOffer": false,
  "deliveryWeight": {
    "amount": 260,
    "unit": "g"
  },
  "shippingMethodsRestrictedTo": null,
  "availabilityText": "In stock<br />can be shipped within 3-5 days",
  "availability": "OnStock",
  "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/HP-003",
  "productNumber": "HP-003",
  "isProductNumberVisible": true,
  "isNew": false,
  "isManufacturerPriceRRP": true,
  "isShippingLinkVisible": true,
  "isCustomizable": true,
  "customizableTextLength": 50,
  "customizableHeadlineText": "Customize your product",
  "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": "custom-attributes",
      "href": "https://pm.epages.com/rs/shops/apidocu/products/51E7F905-2E4C-78C2-30C2-AC14145FA4E5/custom-attributes"
    },
    {
      "rel": "categories",
      "href": "https://pm.epages.com/rs/shops/apidocu/products/51E7F905-2E4C-78C2-30C2-AC14145FA4E5/categories"
    },
    {
      "rel": "main-category",
      "href": "https://pm.epages.com/rs/shops/apidocu/categories/546E02D6-3469-4610-54A1-0A0C05E63C68",
      "title": "On-Ear"
    },
    {
      "rel": "producttype",
      "href": "https://pm.epages.com/rs/shops/apidocu/producttypes/6489A241-7B85-54B0-0B69-C0A8020205ED"
    }
  ]
}