Retrieve back-in-stock subscriptions

post

https://{instance}.wshop.cloud/api/v1/back-in-stock-subscriptions/get

Returns back-in-stock subscriptions. The response is a bare array ([] when nothing matches).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

begin

date

Start date of the subscription period (inclusive, YYYY-MM-DD). Invalid date: CUS0021.

end

date

End date of the subscription period (inclusive, YYYY-MM-DD). Invalid date: CUS0022.

string

Customer email address to filter on. Must be a known customer or newsletter email, otherwise CUS0023 - Email is not found.

ean

string

Product EAN (barcode) to filter on

status

string

enum

Notification status filter (case-insensitive). Any other value is ignored.

Allowed:

page

integer

≥ 1

Defaults to 1

Page number

limit

integer

0 to 1000

Defaults to 100

Number of items per page, capped to 1000. 0 = no limit (all results).

site

integer

Site identifier to scope results to

exclude_anonymized_customer

boolean

Defaults to false

If true (JSON boolean), excludes subscriptions of anonymized customers (GDPR)

Responses

200Array of subscriptions, or {"success": false, "error": {"message": ...}} on error (CUS0021, CUS0022, CUS0023, or Critical error).