Basic information

GET /{shopId}/products/{productId}/crossselling

Returns information on the cross-selling assignments of a single product.

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
includeInvisible boolean

Includes invisible products. Only available with products_write authorisation.

Required: false

Response attributes

Name Type Description

object of crossselling

Response

HTTP 200

Media type application/json

{
  "manualCrossSellingTitle": "cross-selling headline",
  "embedded": {
    "results": 2,
    "page": 1,
    "resultsPerPage": 4,
    "items" : [
      {
        "productId": "54EF2E41-FCA8-E0E5-9323-0A0C05E66C2E",
        "name": "Customized headphone",
        "visible": true,
        "shortDescription": null,
        "deliveryPeriod": "5",
        "description": "Customize your headphone in no time!",
        "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": false,
            "width": 0,
            "height": 0,
            "fileSize": 0
          },
          {
            "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54EF/2E41/FCA8/E0E5/9323/0A0C/05E6/6C2E/001-headphone_m.jpg",
            "classifier": "Medium",
            "isZoomEnabled": false,
            "width": 0,
            "height": 0,
            "fileSize": 0
          },
          {
            "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54EF/2E41/FCA8/E0E5/9323/0A0C/05E6/6C2E/headphone3.jpg",
            "classifier": "Large",
            "isZoomEnabled": false,
            "width": 0,
            "height": 0,
            "fileSize": 0
          },
          {
            "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54EF/2E41/FCA8/E0E5/9323/0A0C/05E6/6C2E/001-headphone_s.jpg",
            "classifier": "Small",
            "isZoomEnabled": false,
            "width": 0,
            "height": 0,
            "fileSize": 0
          },
          {
            "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54EF/2E41/FCA8/E0E5/9323/0A0C/05E6/6C2E/001-headphone_xs.jpg",
            "classifier": "Thumbnail",
            "isZoomEnabled": false,
            "width": 0,
            "height": 0,
            "fileSize": 0
          }
        ],
        "priceInfo": {
          "quantity": {
            "amount": 1,
            "unit": "piece(s)"
          },
          "taxClass": {
            "taxClassId": "574BD82D-7DE3-46C6-FE2C-AC1532076195",
            "name": "Combined tax rate",
            "percentage": 0
          },
          "price": {
            "taxType": "GROSS",
            "formatted": "299.00 €",
            "amount": 299,
            "currency": "EUR"
          },
          "depositPrice": null,
          "ecoParticipationPrice": null,
          "priceWithDeposits": {
            "taxType": "GROSS",
            "formatted": "299.00 €",
            "amount": 299,
            "currency": "EUR"
          },
          "lowestPrice": {
            "taxType": "GROSS",
            "formatted": "270.50 €",
            "amount": 270.5,
            "currency": "EUR"
          },
          "lowestRefPriceFormatted": "1 piece(s) = 270.50 €",
          "highestPrice": {
          "taxType": "GROSS",
          "formatted": "310.50 €",
          "amount": 310.5,
          "currency": "EUR"
          },
          "manufacturerPrice": null,
          "basePrice": null
        },
        "bulkPriceInfo": [
          {
            "quantity": {
              "amount": 2,
              "unit":"piece(s)"
            },
            "price": {
              "taxType": "GROSS",
              "formatted": "245.00 €",
              "amount": 245,
              "currency": "EUR"
            },
            "basePrice": null,
            "priceSavings": {
              "percent": {
                "formatted": "0 %",
                "percentage": 0.0
              },
              "regularBulkPrice": {
                "taxType": "GROSS",
                "formatted": "245.00 €",
                "amount": 245,
                "currency": "EUR"
              }
            }
          },
          {
            "quantity": {
              "amount": 1,
              "unit":"piece(s)"
            },
            "price": {
              "taxType": "GROSS",
              "formatted": "250.00 €",
              "amount": 250,
              "currency": "EUR"
            },
            "basePrice": null,
            "priceSavings": {
              "percent": {
                "formatted": "0 %",
                "percentage": 0.0
              },
              "regularBulkPrice": {
                "taxType": "GROSS",
                "formatted": "250.00 €",
                "amount": 250,
                "currency": "EUR"
              }
            }
          }
        ],
        "customerSpecificPriceInfo": [
          {
            "customerGroup" : "KG1",
            "customerGroupId": "63E4F781-CDA5-327F-B72B-C0A802027724",
            "priceInfo": [
              {
                "quantity": {
                  "amount": 1,
                  "unit":"piece(s)"
                },
                "price": {
                  "taxType": "GROSS",
                  "formatted": "245.45 €",
                  "amount": 245.45,
                  "currency": "EUR"
                },
                "basePrice": null,
                "priceSavings": {
                  "percent": {
                    "formatted": "10 %",
                    "percentage": 10.0
                  },
                  "regularBulkPrice": {
                    "taxType": "GROSS",
                    "formatted": "270.00 €",
                    "amount": 270,
                    "currency": "EUR"
                  }
                }
              },
              {
                "quantity": {
                    "amount": 5,
                    "unit": "piece(s)"
                },
                "price": {
                    "taxType": "GROSS",
                    "formatted": "230.00 €",
                    "amount": 230,
                    "currency": "EUR"
                },
                "basePrice": null,
                "priceSavings": {
                    "percent": {
                        "formatted": "0 %",
                        "percentage": 0.0
                    },
                    "regularBulkPrice": {
                        "taxType": "GROSS",
                        "formatted": "230.00 €",
                        "amount": 230,
                        "currency": "EUR"
                    }
                }
              }
            ]
          }
        ],
        "forSale": true,
        "specialOffer": false,
        "deliveryWeight": {
          "amount": 350,
          "unit": "g"
        },
        "shippingMethodsRestrictedTo": null,
        "availabilityText": "",
        "availability": null,
        "energyLabelsString": null,
        "energyLabelSourceFile": null,
        "productDataSheet": null,
        "sfUrl": "http://pm.epages.com/epages/apidocu.sf/?ObjectPath=/Shops/apidocu/Products/Cust001",
        "productNumber": "Cust001",
        "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,
        "productCode": null,
        "manufacturer": "Dr. Boom",
        "upc": null,
        "ean": null,
        "essentialFeatures" : "Customized headphones",
        "searchKeywords" : [
            "headphones"
        ],
        "links": [
          {
            "rel": "self",
            "href": "https://pm.epages.com/rs/shops/apidocu/products/54EF2E41-FCA8-E0E5-9323-0A0C05E66C2E"
          },
          {
            "rel": "custom-attributes",
            "href": "https://pm.epages.com/rs/shops/apidocu/products/54EF2E41-FCA8-E0E5-9323-0A0C05E66C2E/custom-attributes"
          },
          {
            "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,
        "shortDescription": null,
        "description": "<ul>\n\t<li>Surround Sound</li>\n\t<li>Acoustic Noise Cancelling</li>\n\t<li>Correct fit",
        "deliveryPeriod": null,
        "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": false,
            "width": 0,
            "height": 0,
            "fileSize": 0
          },
          {
            "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": false,
            "width": 0,
            "height": 0,
            "fileSize": 0
          },
          {
            "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F905/2E4C/78C2/30C2/AC14/145F/A4E5/013-headphone-red.jpg",
            "classifier": "Large",
            "isZoomEnabled": false,
            "width": 0,
            "height": 0,
            "fileSize": 0
          },
          {
            "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": false,
            "width": 0,
            "height": 0,
            "fileSize": 0
          },
          {
            "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": false,
            "width": 0,
            "height": 0,
            "fileSize": 0
          }
        ],
        "priceInfo": {
          "quantity": {
            "amount": 1,
            "unit": "piece(s)"
          },
          "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": {
              "taxType": "GROSS",
              "formatted": "59.50 €",
              "amount": 59.50,
              "currency": "EUR"
          },
          "highestPrice": {
            "taxType": "GROSS",
            "formatted": "70.50 €",
            "amount": 70.50,
            "currency": "EUR"
          },
          "manufacturerPrice": null,
          "basePrice": null
        },
        "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": null,
        "energyLabelSourceFile": null,
        "productDataSheet": null,
        "sfUrl": "http://pm.epages.com/epages/apidocu.sf/?ObjectPath=/Shops/apidocu/Products/HP-003",
        "productNumber": "HP-003",
        "isProductNumberVisible": true,
        "isManufacturerPriceRRP": true,
        "isShippingLinkVisible": true,
        "isNew": false,
        "isCustomizable": true,
        "customizableTextLength": 50,
        "customizableHeadlineText": "Customize your product",
        "newnessDate": "2023-08-08T00:00:00Z",
        "refAmount": 1,
        "refUnit": "piece",
        "refContentAmount": 1,
        "productCode": null,
        "manufacturer": "Bass by Dr.Boom",
        "upc": null,
        "ean": null,
        "essentialFeatures" : null,
        "searchKeywords" : null,
        "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/categories/?productId=51E7F905-2E4C-78C2-30C2-AC14145FA4E5"
          },
          {
            "rel": "producttype",
            "href": "https://pm.epages.com/rs/shops/apidocu/producttypes/6489A241-7B85-54B0-0B69-C0A8020205ED"
          }
        ]
      }
    ]
  },
  "links": [
    {
      "rel": "self",
      "href": "https://pm.epages.com/rs/shops/apidocu/products/51E7F905-2E4C-78C2-30C2-AC14145FA4E5/crossselling/"
    },
    {
      "rel": "product",
      "href": "https://pm.epages.com/rs/shops/apidocu/products/51E7F905-2E4C-78C2-30C2-AC14145FA4E5"
    }
  ]
}