XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

This API allows a client application to get a compared item matrix. The API allows a maximum of 5 items to be compared in a request.

Request

[
   1,
   2,
   3
]
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/catalog/itemcomparematrix

Request Body Description

A list of unique Ids of items to compare.

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
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

{
    "Data": {
        "TableRows": [
            {
                "Cells": [
                    {
                        "Value": "Name"
                    },
                    {
                        "Value": "Default Item 1 Red-S-A Style"
                    },
                    {
                        "Value": "Master Item 1 Red-S-B Style"
                    },
                    {
                        "Value": "Master Item 1 Red-M-A Style"
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "RFID"
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "UUID"
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "SKU"
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "Model"
                    },
                    {
                        "Value": "Model Name"
                    },
                    {
                        "Value": "Model Name"
                    },
                    {
                        "Value": "Model Name"
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "Title"
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "ShortDescription"
                    },
                    {
                        "Value": "Master Item 1 Short Description"
                    },
                    {
                        "Value": "Master Item 1 Variant 1 Short Description"
                    },
                    {
                        "Value": "Master Item 1 Variant 1 Short Description"
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "LongDescription"
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "Width"
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "Height"
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "Weight"
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "InStock"
                    },
                    {
                        "Value": "True"
                    },
                    {
                        "Value": "True"
                    },
                    {
                        "Value": "True"
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "Rating"
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "LikeCount"
                    },
                    {
                        "Value": "80"
                    },
                    {
                        "Value": "80"
                    },
                    {
                        "Value": "80"
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "UnitTypeName"
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "Category"
                    },
                    {
                        "Value": "Category 1 Sub 1 Sub 1"
                    },
                    {
                        "Value": "Category 1 Sub 1 Sub 1"
                    },
                    {
                        "Value": "Category 1 Sub 1 Sub 1"
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "Brand"
                    },
                    {
                        "Value": "Brand 1"
                    },
                    {
                        "Value": "Brand 1"
                    },
                    {
                        "Value": "Brand 1"
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "Normal Price - €"
                    },
                    {
                        "Value": "100,55"
                    },
                    {
                        "Value": "100,55"
                    },
                    {
                        "Value": "100,55"
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "Discount Price - €"
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "Normal Price - $"
                    },
                    {
                        "Value": "140,55"
                    },
                    {
                        "Value": "140,55"
                    },
                    {
                        "Value": "140,55"
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "Discount Price - $"
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    },
                    {
                        "Value": ""
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "Color"
                    },
                    {
                        "Value": "Red"
                    },
                    {
                        "Value": "Red"
                    },
                    {
                        "Value": "Red"
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "Style"
                    },
                    {
                        "Value": "A"
                    },
                    {
                        "Value": "B"
                    },
                    {
                        "Value": "A"
                    }
                ]
            },
            {
                "Cells": [
                    {
                        "Value": "Size"
                    },
                    {
                        "Value": "S"
                    },
                    {
                        "Value": "S"
                    },
                    {
                        "Value": "M"
                    }
                ]
            }
        ]
    }
}

Response Body Description

Parameter Name Description Type
Data.TableRows[0..N].Cells[0..N].Value Value of the compared items properties (N = Compared item count. N =< 5). String

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
400 (Bad Request) Invalid DelimitedItemIds parameter.
404 (Not Found) No item found to compare.