XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

This API enables a client application to add a new item to an existing wish list.

Request

{
   "ItemId":2,
   "BluetoothId":"BluetoothId",
   "LastSeenLocation":{
      "Longitude":-122.335197,
      "Latitude":47.646711
   },
}
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/pii/wishlistitem?wishlistUniqueKey={wishlistUniqueKey}

URI Parameters

Parameter Name Description Type Conditions
wishlistUniqueKey The unique key of the wish list. string

Request Body Description

Parameter Name Description Type Conditions
ItemId The unique ID of the item to be added to the wish list. Number
BluetoothId Bluetooth sensor ID. String
LastSeenLocation.Longitude Longitude value of the location. Number
LastSeenLocation.Latitude Latitude value of the location. Number

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

PIIToken is optional.

Response

{
    "Data": {
        "ItemId": 2,
        "BluetoothId": "BluetoothId",
        "LastSeenLocation": {
            "Longitude": -122.335197,
            "Latitude": 47.646711
        },
        "DateAdded": "2013-03-12T14:13:07.7543788+02:00",
        "UniqueKey": "942653b2-88e9-43fc-a336-c720d0c1ee76"
    }
}

Response Body Description

Parameter Name Description Type
Data.ItemId The unique ID of the item to be added to the wish list. Number
Data.BluetoothId Bluetooth sensor ID. String
Data.DateAdded The date when the item is added into the wish list. Date
Data.UniqueKey The unique key of the wish list item. String
Data.LastSeenLocation.Longitude Longitude value of the location. Number
Data.LastSeenLocation.Latitude Latitude value of the location. Number

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
403 (Forbidden) This wish list is private or not accessible to specified PII User.