XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API enables a client application to add a new item to an existing shopping cart.

Request

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

URI Parameters

Parameter Name Description Type Conditions
shoppingCartUniqueKey The unique key of the shopping cart. string

Request Body Description

Parameter Name Description Type Conditions
Quantity Quantity of the added item(s). Quantity
ItemId The unique ID of the item added to the shopping cart. ItemId
BluetoothId Bluetooth sensor ID. BluetoothId
Optional.
DateAdded The date when the item is added into the shopping cart. DateAdded
Optional.
UniqueKey The unique key of the shopping cart item. UniqueKey
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=
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*

PIIToken is optional.

Response

{
    "Data": {
        "ItemId": 2,
        "Quantity": 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.Quantity Quantity of the added item(s). Quantity
Data.ItemId The unique ID of the item added to the shopping cart. ItemId
Data.BluetoothId Bluetooth sensor ID. BluetoothId
Data.DateAdded The date when the item is added into the shopping cart. DateAdded
Data.UniqueKey The unique key of the shopping cart item. UniqueKey
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 shopping cart is private or not accessible to specified PII User.
404 (Not Found) The shopping cart you are trying to add an item is not found.