XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API returns a list of key/value in-store metadata pairs for a particular item.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/catalogs/items/{id}/storemetadata

URI Parameters

Parameter Name Description Type Conditions
id The unique ID of an item. Number

Request Headers

Header Field Name Description
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

[
   {
       "Key": "Key0",
       "Value": "e4404ea8-4803-4ace-80ed-6cf72617966a",
       "StoreId":2
   },
   {
       "Key": "Key1",
       "Value": "38e92c87-1ab4-47b4-85d2-b8dcfa1f8aa6",
       "StoreId":2
   }
]

Response Body Description

Parameter Name Description Type
[0..N].StoreId The unique ID of the related store. Number
[0..N].Key The key of the in-store metadata. String
[0..N].Value The value of the in-store metadata. 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 GET operations. Possible response status codes are as listed below:

Status Code Description
400 (Bad Request) Item or metadata could not be found.