XOMNI: Experience Omni-Channel

Item API Set

Adding a particular video to an item

HTTP POST /private/catalog/items/{itemId}/video?assetId={asset}&isDefault={isDefault}

The APIs can be used to create relationships between assets and items. Using this API, you can assign a video to an item.

Fetching a list of items

HTTP GET /private/catalog/items?skip={skip}&take={take}

The API provides a way to fetch a full list of items from the backend.

Group Items

HTTP POST /private/cataog/items/{itemId}/group

Group variant items under a sepecified default item.

Updating a relationship between a document and an item

HTTP PUT /private/catalog/items/{itemId}/document

The APIs can be used to update relationships between assets and brands. Using this API, you can update a relationship between a document and an item.

Updating dynamic attributes of a particular item

HTTP PUT /private/catalog/items/{itemId}/dynamicattributes

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

Adding a new item tag relation

HTTP POST /private/catalog/itemtagmapping

The item management systems provides APIs to create a new relationship between tags and items in backend. Using this API, you can create a new relationship between a tag and an item.

Removing a relationship between a tag and an item

HTTP DELETE /private/catalog/itemtagmapping?itemId={itemId}&tagId={tagId}

The APIs can be used to remove relationships between tags and items. Using this API, you can remove a relationship between a tag and an item.

Move items

HTTP POST /private/cataog/items/{itemId}/move

Moves variant items under a different default item.

Fetching related tags of a particular item

HTTP GET /private/catalog/itemtagmappings?itemId={itemId}

The item management systems provides APIs to fetch related tags of a particular item from backend. Using this API, you can get related tags of a particular item.

Adding a particular image to an item

HTTP POST /private/catalog/items/{itemId}/image?assetId={asset}&isDefault={isDefault}

The APIs can be used to create relationships between assets and items. Using this API, you can assign an image to an item.

Fetching an item by its item id

HTTP GET /private/catalog/item/{itemId}

The API provides to fetch an item by its item id from the backend.

Adding a particular image to an item

HTTP POST /private/catalog/imagerelation?itemId={itemId}

The APIs can be used to create relationships between assets and items. Using this API, you can assign an image to an item.

Fetching images of a particular item

HTTP GET /private/catalog/items/{itemId}/image

The APIs can be used to fetch relationships between assets and items. Using this API, you can get a list of images assigned to a particular item.

Adding a particular video to an item

HTTP POST /private/catalog/items/{itemId}/video

The APIs can be used to create relationships between assets and items. Using this API, you can assign a video to an item.

Removing a relationship between a video and an item

HTTP DELETE /private/catalog/items/{itemId}/video?assetId={assetId}

The APIs can be used to remove relationships between assets and items. Using this API, you can remove a relationship between a video and an item.

Removing a relationship between an image and an item

HTTP DELETE /private/catalog/items/{itemId}/image? assetId={assetId}

The APIs can be used to remove relationships between assets and items. Using this API, you can remove a relationship between an image and an item.

Updating an existing item

HTTP PUT /private/catalog/item

The API provides to update an existing item.

Creating a new item

HTTP POST /private/catalog/item

The API provides to create a new item.

Searching items

HTTP POST /private/catalog/items

The Item Search API helps the client application to find the exact list of items required by allowing a rich and flexible search backend. The search request object has multiple fields and options available that can be used separately or combined.

Adding a particular document to an item

HTTP POST /private/catalog/items/{itemId}/document

The APIs can be used to create relationships between assets and items. Using this API, you can assign a document to an item.

Updating a relationship between an image and an item

HTTP PUT /private/catalog/items/{itemId}/image

The APIs can be used to update relationships between assets and brands. Using this API, you can update a relationship between an image and an item.

Deleting an existing item

HTTP DELETE /private/catalog/item/{itemId}

The API provides to delete an item by its item id from the backend.

Fetching documents of a particular item

HTTP GET /private/catalog/items/{itemId}/document

The APIs can be used to fetch relationships between assets and items. Using this API, you can get a list of documents assigned to a particular item.

Fetching videos of a particular item

HTTP GET /private/catalog/items/{itemId}/video

The APIs can be used to create relationships between assets and items. Using this API, you can get a list of videos assigned to a particular item.

Removing a relationship between a document and an item

HTTP DELETE /private/catalog/items/{itemId}/document?assetId={assetId}

The APIs can be used to remove relationships between assets and items. Using this API, you can remove a relationship between a document and an item.

Searching Items

HTTP GET /private/catalog/items/search?categoryId={categoryId}&brandId={brandId}&defaultItemId={defaultItemId}&SKU={SKU}&UUID={UUID}&itemIds={itemIds}&includeOnlyMasterItems={includeOnlyMasterItems}&skip={skip}&take={take}&dynamicAttributeTypeId={dynamicAttributeTypeId}&dynamicAttributeTypeValueId={dynamicAttributeTypeValueId}

The API enables a client application to find the exact list of items required by allowing a rich and flexible search backend. The search request parameters has multiple fields and options available that can be used separately or combined.

Partially updating an existing item

HTTP PATCH /private/catalog/item

The API provides to partially update an existing item.

Updating prices of a particular item

HTTP PUT /private/catalog/items/{itemId}/prices

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

Updating a relationship between a video and an item

HTTP PUT /private/catalog/items/{itemId}/video

The APIs can be used to update relationships between assets and brands. Using this API, you can update a relationship between a video and an item.

Ungroup Items

HTTP POST /private/cataog/items/{itemId}/ungroup

Makes the variant items of the default item master; in other words, ugroups them.

Adding a particular document to an item

HTTP POST /private/catalog/items/{itemId}/document?assetId={assetId}&isDefault={isDefault}

The APIs can be used to create relationships between assets and items. Using this API, you can assign a document to an item.