XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API provides to create a new item.

Request

{
    "RFID":"7407c7c3-9464-4e51-bb29-069fee2e03f3",
    "UUID":"76ef6dbc-23bb-49b5-85a0-a704a32e7f69",
    "SKU":"85996",
    "Name":"57eda292-c1ce-4340-9f68-f47bf43fa0f3",
    "Model":"66e7caff-15b6-426a-87f4-fcf3194aad40",
    "Title":"d35bc9fc-94da-45bd-b577-f2f4ad728672",
    "ShortDescription":"b9806598-9fb1-4a4a-83a5-f3e787936e73",
    "LongDescription":"d11bcca4-73a1-4a84-848b-2e1043cd14e0",
    "Rating":4.0,
    "LikeCount":30,
    "CategoryId":1,
    "InStock":true,
    "PublicWebLink":"2ed4f32b-4867-4c6e-ab93-722cddb84fc4",
    "DefaultItemId":null,
    "BrandId":35,
    "UnitTypeId":null,
    "DynamicAttributes":[
       {
           "TypeId":1,
           "TypeValueId":1,
           "Value":"Red",
           "TypeName":"Color"
       },
       {
           "TypeId":2,
           "TypeValueId":20,
           "Value":"XXXXXXXXL",
           "TypeName":"Size"
       },
       {
           "TypeId":3,
           "TypeValueId":21,
           "Value":"A Style",
           "TypeName":"Style"
       }
    ],
    "Prices":[
       {
           "PriceId":26,
           "ItemId":31,
           "NormalPrice":50.0,
           "DiscountPrice":null,
           "CurrencySymbol":"$",
           "CurrencyId":1
       },
       {
           "PriceId":27,
           "ItemId":31,
           "NormalPrice":30.0,
           "DiscountPrice":null,
           "CurrencySymbol":"€",
           "CurrencyId":2
       }
    ],
    "Tags":[
       {
           "Id":1,
           "Name":"Sample Tag 0",
           "Description":"693aaa60-8dad-4236-96d1-99f3ca0f175a",
           "TagMetadata":[
 
           ]
       },
       {
           "Id":2,
           "Name":"Sample Tag 1",
           "Description":"fbf64b85-215e-4ce1-a3c4-b8f8bca23c91",
           "TagMetadata":[
 
           ]
       },
       {
           "Id":3,
           "Name":"Sample Tag 2",
           "Description":"4a379ed8-a714-41ba-8709-22c41623257b",
           "TagMetadata":[
 
           ]
       }
    ],
    "Weights":[
       {
           "ItemId":0,
           "WeightId":5,
           "WeightTypeId":1,
           "WeightTypeDescription":"Kg",
           "Value":15.0
       },
       {
           "ItemId":0,
           "WeightId":6,
           "WeightTypeId":2,
           "WeightTypeDescription":"LBS",
           "Value":25.0
       }
    ],
    "Dimensions":[
       {
           "ItemId":0,
           "DimensionId":9,
           "DimensionTypeId":1,
           "DimensionDescription":"Meter",
           "Width":60.0,
           "Height":70.0,
           "Depth":50.0
       },
       {
           "ItemId":0,
           "DimensionId":10,
           "DimensionTypeId":2,
           "DimensionDescription":"Inch",
           "Width":30.0,
           "Height":40.0,
           "Depth":20.0
       }
    ]
}
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/private/catalog/item

Request Body Description

Parameter Name Description Type Conditions
Id The unique ID of the item Number
RFID The radio frequency id of the item String
Max Length: 128
UUID The universally unique ID of the item String
Max Length: 128
SKU Stock keeping unit of the item String
Max Length: 32
Name Name of the item String
Max Length: 512
Model Model of the item String
Max Length: 512
Title Title of the item String
Max Length: 512
ShortDescription Short description of the item String
Max Length: 1024
LongDescription Long description of the item String
Rating Rating of the item Number
LikeCount Like count of the item Number
DateAdded Item added date Date
DateModified Item last modification date Date
ItemStatusId Status id of the item. Number
CategoryId The unique Id of a category assigned to the item. Number
InStock The boolean field indicating if the item is in stock or not. Unknown
PublicWebLink Public web link of the item String
DefaultItemId The Id of the default item in the associated variant list. If the DefaultItemID is equal to the Id the current item is a default item in its variant list. Number
BrandId The unique Id of a brand assigned to the item. Number
UnitTypeId Id of item’s unit type Number
Dimensions[0..N].DimensionId The unique ID of the dimension. Number
Dimensions[0..N].DimensionTypeId The unique ID of the dimension type to define the dimension. Number
Dimensions[0..N].DimensionDescription The description of the dimension type to define the dimension. String
Dimensions[0..N].Width The width value of the item. Number
Dimensions[0..N].Height The hight value of the item. Number
Dimensions[0..N].Depth The depth value of the item. Number
Weights[0..N].WeightId The unique ID of the weight. Number
Weights[0..N].WeightTypeId The unique ID of the weight type to define the weight. Number
Weights[0..N].WeightTypeDescription The description of the weight type used to define the weight. String
Weights[0..N].Value The weight value of the item. Number
Tags[0..N].Id The unique ID of the tag. Number
Tags[0..N].Name The name of the tag. String
Tags[0..N].Description The description of the tag. String
Tags[0..N].TagMetadata[0..N].Key The key for the metadata. String
Tags[0..N].TagMetadata[0..N].Value The value of the metadata. String
Prices[0..N].PriceId Unique id of the price. Number
Prices[0..N].ItemId Unique id of the item. Number
Prices[0..N].NormalPrice The regular price of the item. Number
Prices[0..N].DiscountPrice The discounted price of the item. Number
Prices[0..N].PriceTypeSymbol The code of the price type used to define the price. String
Prices[0..N].PriceTypeId The unique Id of the price type used to define the price. Number
DynamicAttributes[0..N].TypeId Unique ID of a dynamic field. Number
DynamicAttributes[0..N].TypeValueId Unique ID of a dynamic field value. Number
DynamicAttributes[0..N].Value Value of a dynamic field. String
DynamicAttributes[0..N].TypeName Unique name of a dynamic field. String

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

{
    "RFID":"7407c7c3-9464-4e51-bb29-069fee2e03f3",
    "UUID":"76ef6dbc-23bb-49b5-85a0-a704a32e7f69",
    "SKU":"85996",
    "Name":"57eda292-c1ce-4340-9f68-f47bf43fa0f3",
    "Model":"66e7caff-15b6-426a-87f4-fcf3194aad40",
    "Title":"d35bc9fc-94da-45bd-b577-f2f4ad728672",
    "ShortDescription":"b9806598-9fb1-4a4a-83a5-f3e787936e73",
    "LongDescription":"d11bcca4-73a1-4a84-848b-2e1043cd14e0",
    "Rating":4.0,
    "LikeCount":30,
    "CategoryId":1,
    "InStock":true,
    "PublicWebLink":"2ed4f32b-4867-4c6e-ab93-722cddb84fc4",
    "DefaultItemId":null,
    "BrandId":35,
    "UnitTypeId":null,
    "DynamicAttributes":[
       {
           "TypeId":1,
           "TypeValueId":1,
           "Value":"Red",
           "TypeName":"Color"
       },
       {
           "TypeId":2,
           "TypeValueId":20,
           "Value":"XXXXXXXXL",
           "TypeName":"Size"
       },
       {
           "TypeId":3,
           "TypeValueId":21,
           "Value":"A Style",
           "TypeName":"Style"
       }
    ],
    "Prices":[
       {
           "PriceId":26,
           "ItemId":31,
           "NormalPrice":50.0,
           "DiscountPrice":null,
           "PriceTypeSymbol":"$",
           "PriceTypeId":1
       },
       {
           "PriceId":27,
           "ItemId":31,
           "NormalPrice":30.0,
           "DiscountPrice":null,
           "PriceTypeSymbol":"€",
           "PriceTypeId":2
       }
    ],
    "Tags":[
       {
           "Id":1,
           "Name":"Sample Tag 0",
           "Description":"693aaa60-8dad-4236-96d1-99f3ca0f175a",
           "TagMetadata":[
 
           ]
       },
       {
           "Id":2,
           "Name":"Sample Tag 1",
           "Description":"fbf64b85-215e-4ce1-a3c4-b8f8bca23c91",
           "TagMetadata":[
 
           ]
       },
       {
           "Id":3,
           "Name":"Sample Tag 2",
           "Description":"4a379ed8-a714-41ba-8709-22c41623257b",
           "TagMetadata":[
 
           ]
       }
    ],
    "Weights":[
       {
           "ItemId":0,
           "WeightId":5,
           "WeightTypeId":1,
           "WeightTypeDescription":"Kg",
           "Value":15.0
       },
       {
           "ItemId":0,
           "WeightId":6,
           "WeightTypeId":2,
           "WeightTypeDescription":"LBS",
           "Value":25.0
       }
    ],
    "Dimensions":[
       {
           "ItemId":0,
           "DimensionId":9,
           "DimensionTypeId":1,
           "DimensionDescription":"Meter",
           "Width":60.0,
           "Height":70.0,
           "Depth":50.0
       },
       {
           "ItemId":0,
           "DimensionId":10,
           "DimensionTypeId":2,
           "DimensionDescription":"Inch",
           "Width":30.0,
           "Height":40.0,
           "Depth":20.0
       }
    ]
}

Response Body Description

Parameter Name Description Type
Id The unique ID of the item Number
RFID The radio frequency id of the item String
UUID The universally unique ID of the item String
SKU Stock keeping unit of the item String
Name Name of the item String
Model Model of the item String
Title Title of the item String
ShortDescription Short description of the item String
LongDescription Long description of the item String
Rating Rating of the item Number
LikeCount Like count of the item Number
DateAdded Item added date Date
DateModified Item last modification date Date
ItemStatusId Status id of the item. Number
CategoryId The unique Id of a category assigned to the item. Number
InStock The boolean field indicating if the item is in stock or not. Unknown
PublicWebLink Public web link of the item String
DefaultItemId The Id of the default item in the associated variant list. If the DefaultItemID is equal to the Id the current item is a default item in its variant list. Number
BrandId The unique Id of a brand assigned to the item. Number
UnitTypeId Id of item’s unit type Number
Dimensions[0..N].DimensionId The unique ID of the dimension. Number
Dimensions[0..N].DimensionTypeId The unique ID of the dimension type to define the dimension. Number
Dimensions[0..N].DimensionDescription The description of the dimension type to define the dimension. String
Dimensions[0..N].Width The width value of the item. Number
Dimensions[0..N].Height The hight value of the item. Number
Dimensions[0..N].Depth The depth value of the item. Number
Weights[0..N].WeightId The unique ID of the weight. Number
Weights[0..N].WeightTypeId The unique ID of the weight type to define the weight. Number
Weights[0..N].WeightTypeDescription The description of the weight type used to define the weight. String
Weights[0..N].Value The weight value of the item. Number
Tags[0..N].Id The unique ID of the tag. Number
Tags[0..N].Name The name of the tag. String
Tags[0..N].Description The description of the tag. String
Tags[0..N].TagMetadata[0..N].Key The key for the metadata. String
Tags[0..N].TagMetadata[0..N].Value The value of the metadata. String
Prices[0..N].PriceId Unique id of the price. Number
Prices[0..N].ItemId Unique id of the item. Number
Prices[0..N].NormalPrice The regular price of the item. Number
Prices[0..N].DiscountPrice The discounted price of the item. Number
Prices[0..N].PriceTypeSymbol The code of the price type used to define the price. String
Prices[0..N].PriceTypeId The unique Id of the price type used to define the price. Number
DynamicAttributes[0..N].TypeId Unique ID of a dynamic field. Number
DynamicAttributes[0..N].TypeValueId Unique ID of a dynamic field value. Number
DynamicAttributes[0..N].Value Value of a dynamic field. String
DynamicAttributes[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 POST operations. Possible response status codes are as listed below:

Status Code Description
400 (Bad Request) Specified brand not found.
400 (Bad Request) Specified category not found.
400 (Bad Request) Specified default item not found.
400 (Bad Request) Specified unit type not found.
400 (Bad Request) Specified currency not found.
400 (Bad Request) Specified weight type not found
400 (Bad Request) Specified dimension type not found
400 (Bad Request) Specified tag not found