commerce/instocknotifications

Use the Customer In-Stock Notification Subscription resource to manage the subscriptions customer accounts use to send product notifications. This resource can send a notification when a product in a catalog returns to a site's active inventory after it is out of stock, or when a new product becomes available for the first time.

Note: In-Stock Notifications are not supported for bundled products.

JSON Example

InStockNotificationSubscription Properties

Property Description
customerId

type: int

Unique identifier of the customer in Kibo eCommerce, used to associate customers with data, orders, returns, and in-store credit.

email

type: string

The email address for the customer account and contact. This email may be used for login to the storefront, receiving in-stock product notifications, and subscription mailing lists.

locationCode

type: string

The unique, user-defined code that identifies a location. This location can be the location where the order was entered, location for newly in-stock products, and where products are returned.

productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

Operations

Operation Name Request URI Description
AddInStockNotificationSubscription POST %3fresponseFields%3d%7bresponseFields%7d

Creates a new subscription that notifies the customer when the product specified in the request is available in the active inventory of the defined location.

DeleteInStockNotificationSubscription DELETE %7bid%7d

Deletes a subscription for a customer in-stock notification.

GetInStockNotificationSubscription GET %7bid%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of a subscription that sends a push notification when a product is available in a site's active stock.

GetInStockNotificationSubscriptions GET %3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of in-stock notification subscriptions.