XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The API provides to update dynamic attributes of an item with a single API call.

Request

[
   {
       "TypeId": 12,
       "TypeValueId": 13,
       "Value": "sampleValue",
       "TypeName": "sampleAttributeName"
   },
   {
       "TypeId": 0,
       "TypeValueId": 0,
       "Value": "sampleAttribute2",
       "TypeName": "sampleAttribute3"
   }
]
HTTP Method Resource URI
PUT https://{tenantName}.api.xomni.com/private/catalog/items/{itemId}/dynamicattributes

URI Parameters

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

Request Body Description

Parameter Name Description Type Conditions
Item[0..N].TypeId Unique ID of a dynamic field. Number
Item[0..N].TypeValueId Unique ID of a dynamic field value. Number
Item[0..N].Value Value of a dynamic field. String
Item[0..N].TypeName Unique name of a dynamic field. String

It's compulsory to supply both the DynamicAttributeTypeID and TypeValueID parameters inside the request body. However, if the DynamicAttributeTypeID and TypeValueID are unknown, both dynamic attribute name and dynamic attribute value should be passed inside the request body.

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

[
   {
       "TypeId": 12,
       "TypeValueId": 13,
       "Value": "sampleValue",
       "TypeName": "sampleAttributeName"
   },
   {
       "TypeId": 13,
       "TypeValueId": 15,
       "Value": "sampleAttribute2",
       "TypeName": "sampleAttributeValue3"
   }
]

Response Body Description

Parameter Name Description Type
Item[0..N].TypeId Unique ID of a dynamic field. Number
Item[0..N].TypeValueId Unique ID of a dynamic field value. Number
Item[0..N].Value Value of a dynamic field. String
Item[0..N].TypeName Unique name of a dynamic field. 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 PUT operations. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) Given item could not be found.
409 (Conflict) Given dynamic attribute type or value already exists. There should be a concurrency issue. Please send the request again.