v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Product

List cross sellings

Returns a list of product's cross-selling products

get/api/v1/products/{id}/crossSelling

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Query parameters

numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

field'productId' | 'productName' | 'productNumber' | 'type' | 'salesChannelId' | 'sort'
dir'asc' | 'desc'

Response

Success

Example response

{
  "data": [
    {
      "id": "17",
      "active": true,
      "type": 1,
      "salesChannel": {
        "id": "sales-channel-56789"
      },
      "sort": 1,
      "note": "Handle with care during shipping.",
      "product": {
        "id": "123456",
        "name": "Sample Name",
        "number": "SKU-001"
      }
    }
  ],
  "extra": {
    "page": {
      "number": 1,
      "size": 10
    }
  }
}