XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The related item APIs provide to create a relationship between two items. You can create item relationships one way or two way.

Request

[
    1,
    2,
    6
]
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/private/catalog/relatedItem?itemId={itemId}&direction={direction}

URI Parameters

Parameter Name Description Type Conditions
itemId The unique ID of an item. Number
direction Direction of relationship. Possible values: OneWay, TwoWay. String

Request Body Description

Array of item IDs related for the given item ID.

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

The response does not contain any response entity if the status is successful.

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) Given item or related item could not be found.