Basic information

GET /{shopId}/watched-products

Returns a list of all watched products. Watched products refers to items currently out of stock and therefore can be watched by online shop customers.


OAuth 2.0 Token required with scopes:


URI parameters

Name Type Description
shopId string

The unique identifier of the shop.

Required: true
Example: DemoShop

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
page integer

Represents the current page.

Required: false
Default: 1
Minimum: 1
resultsPerPage integer

Specifies the maximum number of results per page.

Required: false
Default: 10
Maximum: 100

Response attributes

Name Type Description


The number of watched products in total.



The page number of the returned watched products.



The number of watched products returned per page.


array of watchedproduct

The list of all watched products.


HTTP 200

Media type application/json

  "results": 1,
  "page": 1,
  "resultsPerPage": 10,
  "items": [
      "productId": "51E7F905-2E4C-78C2-30C2-AC14145FA4E5",
      "name": "Dr.Boom - Red Power",
      "productNumber": "HP-003",
      "watchers": 1,
      "links": [
          "rel": "product",
          "href": ""