Radial Data Value Conventions

Before working with Radial's APIs, it's important to understand some conventions used by the platform.

Item Identifiers

The platform supports multiple catalogs of sellable items per e-commerce site. To ensure that items are uniquely identified, the API employs two part item identifiers that include the catalog which the item belongs to and the item’s unique identity in that catalog.

The syntax of this two part item identifier is:

<catalogId> + "-" + <clientItemId>

where

catalogId: is the //Item/@catalog_id value sent in the item master
clientItemId: is the //Item/ItemId/ClientItemId value sent in the item master

For example, consider an item whose identity is expressed in the item master as follows:

   <Item operation_type="Change" gsi_client_id="TMSNA" catalog_id="21">
      <ItemId>
         <ClientItemId>843953242895</ClientItemId>
      </ItemId>
      ...
   </Item>

The item’s identity is communicated to the ROM API as:

itemId="21-843953242895"

All of the ROM APIs expect item ID values to be expressed in this format.