XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

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.

Request

{
    "MailTemplateName": "Templat1",
    "UniqueKey": "63644db9-cfa5-41ae-b2c8-11b9c4de11fd",
    "To": "mycustomer@email.com",
    "ToDisplayName": "My Customer",
}
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/pii/wishlist/mail

Request Body Description

Parameter Name Description Type Conditions
MailTemplateName Name of the mail template. String
Optional.
UniqueKey The unique key of the shopping cart. String
To "To" e-mail address. String
Optional.
ToDisplayName "To" display name. String
Optional.

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
PIIToken
Includes the base64-encoded “Personally Identifiable Information” data.
Sample: dXNlcm5hbWU6SW5uQXBwc1VzZXI7cGFzc3dvcmQ6SW5uQXBwc1Bhc3M=
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da

Response

The response does not contain any response entity if the status is successful.

Response Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.

Status Codes

A successful operation returns status code 200 (OK) for POST operations. Possible response status codes are as listed below:

Status Code Description
202 (Accepted) Operation is successful. Your mail is added to queue.
400 (Bad Request) To email address required.
403 (Forbidden) Unable to access wishlist detail.
404 (Not Found) Unable to access wishlist detail.