XOMNI: Experience Omni-Channel

Wishlist API Set

Changing wish list access information

HTTP POST /pii/wishlistaccess?wishlistUniqueKey={wishlistUniqueKey}&isPublic={isPublic}

This API enables a client application to change the visibility of the wish list.

Fetching all wish lists

HTTP GET /pii/wishlists

This API allows you to retrieve specified PIIUser’s wish lists.

Fetching a wish list with a unique key

HTTP GET /pii/wishlist?wishlistUniqueKey={wishlistUniqueKey}&longitude={longitude} &latitude={latitude}&includeItemStaticProperties={includeItemStaticProperties}&includeItemDynamicProperties={includeItemDynamicProperties}&includeCategoryMetadata={includeCategoryMetadata}&imageAssetDetail={imageAssetDetail}&videoAssetDetail={videoAssetDetail}&documentAssetDetail={documentAssetDetail}&metadataKey={metadataKey}&metadataValue={metadataValue}

This API enables a client application to fetch all of the wish list items based on the unique key of the wish list. Wish list items may be used by client applications to display wish list of a particular user. This is especially useful when an application needs to fetch close-by wish lists and fetch the wish list of a PII whose token is not available client side.

Clearing all wish lists

HTTP DELETE /pii/wishlists

This API enables a client application to clear current PII’s all the wish lists. This operation does not delete the wish lists; it only removes wish list items.

Changing wish list name

HTTP PUT /pii/wishlist

This API helps a client application to change the name of a particular wish list.

Creating a wish list

HTTP POST /pii/wishlist

This API helps a client application to create new wish list for the PII User based on the PIIToken value received through the PIIToken HTTP header.

Deleting a wish list

HTTP DELETE /pii/wishlist?wishlistUniqueKey={wishlistUniqueKey}

This API enables a client application to delete a wish list.

Emailing a wish list

HTTP POST /pii/wishlist/mail

The API enables a client application to email specified wish list content. The API provides 3 different scenarios as listed below; 1- If the client app does not send a PIIToken through the request header, ‘To’ field is required. 2- If client app sends an Anonymous PIIToken through the request header, ‘To’ field is required. 3- If client app sends a Loyalty PIIToken through the request header, ‘To’ field is optional. By default, the API sends the e-mail to the e-mail address of the loyalty user. Based on the “MailTemplateName” parameter in request body, the client app can decide which email template should be used.