Skip to content

List of product alternative products

Request

Returns list of alternative products related to product defined by guid, list is ordered by priority parameter.

If Pair reciprocally option (Settings > Product > Related and Alternative products) is enabled, list of

items will be enriched by items that has called product in own alternative table.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
guidstringrequired

Product guid

Example:93bc0dbe-7481-11e8-8216-002590dad85e
Query
visibleboolean

If set to true, only visible products are returned (those, which does not have visibility: hidden)

Example:visible=true
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/products/93bc0dbe-7481-11e8-8216-002590dad85e/alternativeProducts?visible=true' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "items": [ … ]
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}