XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The API returns a spesific item static property.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/catalog/itemstaticproperties/{propertyName}

URI Parameters

Parameter Name Description Type Conditions
propertyName Name of the item static property. String

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

{
   "Name":"Rating",
   "Options":0
}

Response Body Description

Parameter Name Description Type
Name Name of the item static property. String
Options Seach options for the item static property. See details for possible values. Number

Possible Values For "Options"

Value Description
0 Default Value – Not Initalized.
1 Retrievable.
2 Filterable.
4 Searchable.
8 Facetable.
16 Sortable.

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 GET operations. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) Item static property not found.