XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API returns a full list of item static properties.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/catalog/itemstaticproperties?skip={skip}&take={take}

URI Parameters

Parameter Name Description Type Conditions
skip The number of items in the collection to skip before executing a select. Number
take The number of items that should be fetched from the collection. Number

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*

Response

{
   "Results":[
      {
         "Name":"Brand",
         "Options":11
      },
      {
         "Name":"Category",
         "Options":0
      },
      {
         "Name":"Dimensions",
         "Options":0
      },
      {
         "Name":"DocumentAssets",
         "Options":0
      },
      {
         "Name":"Id",
         "Options":0
      },
      {
         "Name":"ImageAssets",
         "Options":0
      },
      {
         "Name":"InStock",
         "Options":0
      },
      {
         "Name":"InStoreMetadata",
         "Options":0
      },
      {
         "Name":"LikeCount",
         "Options":0
      },
      {
         "Name":"LongDescription",
         "Options":0
      }
   ],
   "TotalCount":24
}

Response Body Description

Parameter Name Description Type
TotalCount Total count of items in the filtered collection without paging. Number
Results[0..N].Name Name of the item static property. String
Results[0..N].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.