Create or Update an Item

The updateItem endpoint enables you to create or update an item in your inventory. If the item does not already exist, it is created. If the merged parameter is present and true, then only non-null fields are updated.

Details

Resource
  PUT /item-service/clients/{clientId}/items/{itemId}
Headers

-H 'Authorization: Basic ************************************ (Code supplied by Radial.)

-H 'Content-Type: application/json'

-H 'apiKey: ********************************' (API Key supplied by Radial.)
Sample Request URLs
https://tst04-epapi-na.gsipartners.com/item-service/clients/TMSNA/items/21-ALAN-022a 

https://tst04-epapi-na.gsipartners.com/item-service/clients/TMSNA/items/21-ALAN-022a?merge=true (optional)

Examples and Field Definitions

Copy this code sample. 
{
    "clientId": "TMSNA",
    "itemId": "21-ALAN-022a",
    "catalogId": "21",
    "clientItemId": "ALAN-022a",
    "gii": "700013002",
    "type": "MERCH",
    "status": "Active",
    "description": "Sourcing rule testing",
    "images": [
        {
            "url": "https://external-content.duckduckgo.com/iu/?u=https%3A%2F%2Ftse4.explicit.bing.net%2Fth%3Fid%3DOIP.1wts89vUK2DrKK_OHK1wOAHaHa%26pid%3DApi&f=1&ipt=6fee0ae28003ec162a1cb7e23f514a16572a38a15c676aa32233843322c45a42&ipo=images",
            "type": "prod_main",
            "view": "main",
            "height": 334,
            "width": 394
        }
    ],
    "freightClass": "ANY",
    "salesClass": "stock",
    "taxCode": "76800",
    "hierarchy": {
        "deptNumber": 992,
        "subDeptNumber": 998,
        "subDeptDescription": "CASUAL FOOTWEAR",
        "classNumber": 1,
        "classDescription": "MENS CASUAL FOOTWEAR",
        "subClassNumber": 1,
        "subClassDescription": "MN RUGGED CASUAL"
    },
    "displayMassDimensions": {
        "unit": "lb",
        "weight": 1.15
    },
    "displayPackagingDimensions": {
        "unit": "in",
        "width": 9,
        "length": 11.5,
        "height": 2.5
    },
    "shippingMassDimensions": {
        "unit": "lb",
        "weight": 1.15
    },
    "shippingPackagingDimensions": {
        "unit": "in",
        "width": 9,
        "length": 11.5,
        "height": 2.5
    },
    "cartonMassDimensions": {
        "unit": "lb",
        "weight": 1.15
    },
    "cartonPackagingDimensions": {
        "unit": "in",
        "width": 9,
        "length": 11.5,
        "height": 2.5
    },
    "hazardousMaterialCode": "0",
    "brand": {
        "name": "MGA Entertainment 1001165",
        "descriptions": [
            {
                "description": "MGA Entertainment 1001165"
            }
        ]
    },
    "dropShipSupplier": {
        "name": "Lumon Industries",
        "number": "290-28865",
        "partNumber": "0034741975"
    },
    "fulfillmentTypeEligibilities": [
        {
            "fulfillmentTypeId": "SHIP_TO_HOME",
            "eligibility": true
        },
        {
            "fulfillmentTypeId": "SHIP_TO_STORE",
            "eligibility": true
        },
        {
            "fulfillmentTypeId": "STORE_PICK_UP",
            "eligibility": true
        }
    ],
    "sfsEligible": true,
    "ispuEligible": true,
    "stsEligible": true,
    "ispuReserveEligible": true,
    "inventoryCheckEligible": true,
    "associateDeliveryEligible": false,
    "infiniteInventory": false,
    "dropShipped": true,
    "onPreOrder": false,
    "bundle": false,
    "eligibleToModify": true,
    "minShipmentProcessingDays": 0,
    "maxShipmentProcessingDays": 1,
    "customDynamicAttributes": [
        {
            "name": "HFR_ELIGIBLE",
            "value": "false"
        },
        {
            "name": "Shipping_Optimization_Eligible",
            "value": "true"
        }
    ],
    "upcs": [
        {
            "upc": "01234567981",
            "upcType": "UPC-A"
        },
        {
            "upc": "60034501",
            "upcType": "EAN"
        }
    ],
    "shipTogether": false
}

  • HTTP Status 204: No content; the item was successfully updated.

  • HTTP Status 400: The format of the update item request is invalid.

    Example
    {
    "date": "2015-04-24T13:12:34.123+05:00",
    "message": "Something went wrong."
    }

  • HTTP Status 500: An error occurred on the server attempting to update the item.

Type Field Name Data Type Field Rules Is Required Description
Item item complex type Encapsulates the Item as is the root element of the payload
catalogId String Size (min = 1 to max = 4) required * The identifier is provided by Radial for an individual or organization.
clientId String Size (min = 1 to max = 32) required *

The identifier is provided by Radial for an individual or organization.
clientItemId String

Size (min = 1 to max = 16)

where is this showing up in e2e testing - code says 35

@NotNull

@Size(min = 1, max = 35)

private String clientItemId;

required * 		Advertised SKU number; The unique SKU-level identifier for the item. This is the retailer/client unique item ID or SKU. This is the primary key for the Item Master. Allowable Values: Text string Required: Yes Length: 35 Default Value: blank Restrictions: This item ID may not change or the new key is considered a new item.
countryOfOrigin Size (max = 2)
Follow the ISO 3166 two letter/alpha format.		 Required: No for domestic shipments but yes for international shipments.

A country in which goods were completely derived or manufactured. http://www.iso.org/iso/country_codes.htm
description String Size (max = 120) Short description of the item used in the OMS and WMS in the catalog’s base language. Stores having group sales must send a meaningful item description in the item master since the content feed is not loaded into OMS.
freightClass String Size (max = 20) Only used by Order modify. Dictates how (Scac and Service) and where (destination region) the product is eligible to ship.
fulfillmentOverride String Only used for sourcing. Control the fulfillment of an item. This allows clients to override the fulfillment sourcing for any given item. for e.g. "StoreOnly", "WarehouseOnly", "DC001Only." Allowable Values: Text string Required: No Length: 40 Default Value: blank Restrictions: Needs to be pre-agreed on the values before sending on item master. Aliases: N/A Offering: SOMS, Interfaces and Tools
giftCardTenderCode String

One of:

SD, SP, ST, SV, SX

 Only used for Gift cards (Physical and Virtual) Type of gift card to be used for activation.
SD TRU DIGITAL GIFT CARD
SP SVS Physical Gift Card
ST SmartClixx Gift Card Canada
SV SVS Virtual Gift Card
SX SmartClixx Gift Card
gii String leave blank Leave blank. Internal use only. Global Item ID
hazardousMaterialCode String Size (max = 4) Configurable. Work with Radial to configure hazardous material code(s) for the item.
itemId String Size (min = 1 to max = 40) required *

This identifier includes the catalog ID and the item's unique ID within that catalog. The syntax for this identifier is: <catalogId> + "-" + <clientItemId>.
productId String Size (max = 20) Product ID that is displayed on the product page on the client site and on the ROM UI on the Item Search screen.
productTitle String Size (max = 200) Product title that is displayed on the product page on the client site and on the ROM UI on the Item Search screen..
salesClass String Size (max = 25) advanceOrderOpen or stock Based on inventory availability, determines product display behavior for the item in the web store. Allowable Values: stock - Item is cartable if inventory is available and street date has passed. Either advanceOrderOpen / stock.
sourcingOverride String Only used in sourcing
sourcingPreference String Only used in sourcing
status String Size (max = 12) Active or Inactive Indicates an item's availability. Allowable Values: - Active - Inactive (item is not displayed in catalog) - Discontinued
styleDescription String

Size (max = 255)

A short description or title of the style for the item. Allowable Values: Text string Required: No Length: 255 Default Value: blank Restrictions: N/A Aliases: N/A Offering: SOMS, Interfaces and Tools
styleId String Size (max = 15) A code that identifies the specific appearance type or variety in which an item is available. Allowable Values: Text string Required: Yes Length: 15 Default Value: blank Restrictions: N/A Aliases: N/A Offering: SOMS, Interfaces and Tools
taxCode String Size (max = 5) required The Radial Inc-assigned tax group to which the item belongs. Allowable Values: Text string Required: No (BUT - This field is mandatory for ROM) Length: 5 Default Value: blank Restrictions: N/A Aliases: N/A Offering: SOMS, Interfaces and Tools
type String

One of:

GIFT WRAP
CUSTOM
REFUNDOGC
W
VGC
DONATION
PF
GiftMessage
MERCH
GC
BUNDLE
OGC

 required

Specifies the type of item. Not restricted by the schema. Allowable Values:

GIFT WRAP: Physical Gift Wrap.
CUSTOM: Customization SKUs. A virtual item that represents a charge to the consumer to customize an item as well as a description of the customization options selected by the customer.
REFUNDOGC: Refund Online Gift Certificate. 'Refund' used for accounting purposes to differentiate Refunds from the original tender.
W: Product warranty. A virtual item representing a warranty purchased for another physical item on the order.
VGC: Functionally similar to OGC’s except they are processed by a 3rd-party gift-card provider (ex: SVS or ValueLink).
DONATION: Donation SKU. A virtual item that represents a consumer's donation to a charitable cause.
PF: Pre Fulfill example : Donation
GC: Physical Gift Cards.
GiftMessage: This item is a Gift Message.
MERCH: A typical physically-fulfilled item.
GC: Gift Card, physical GC
BUNDLE: Bundle parent SKU
OGC: Online Gift Certificates that are hosted/processed by Radial Inc. They are our in-house product for gift certificates that don’t have a physical card associated with them (only a payment account number and PIN).
bundle true/false Test needed Determines items included if this is a bundle product.
dropShipped true/false

Specifies if this item can be fulfilled using a drop shipper. Allowable Values: false - item cannot be fulfilled using a drop shipper true - item can be fulfilled using a drop shipper Required: Yes, Length: TBD Default Value: false
eligibleToModify true/false Test needed Product ID that is displayed on the product page on the client site and on the ROM UI on the Item Search screen.
infiniteInventory true/false Ability to set the infinite inventory for any particular item, this is mainly used for items like warranties, virtual items, gift cards , customizations or any other service items. Default false.
inventoryCheckEligible true/false Default false
isFeedItem true/false not persisted **
onPreOrder true/false Presell functionality. Item can be sold before on the market
shipTogether true/false Ship Together program eligibility
splitToOne true/false Used for Virtual Gift Card at Activation. Splits the order into multiple lines with Qty of 1 for each line

maxGCAmount

numeric

Size Digits(integer = 15 fraction = 2)

MaxGCAmount which is mandatory if the Item is Gift Item. Used in refund order.

maxOrderableQuantity numeric Maximum quantity that may be purchased of this item in a single order.
maxShipmentProcessingDays numeric Maximum ship days rounded up to nearest day
minOrderableQuantity numeric Minimum quantity that must be purchased of this item in a single order.
minShipmentProcessingDays numeric Minimum ship days rounded down to nearest day
brand Brand

Encapsulates the selling name and description used to identify a product for advertising purposes.
color Color Color
streetDate Date

Presell functionality. Earliest date the OMS will allocate the product. Default Value: blank. The ISODate format is "2023-12-15T10:00:00Z".
dropShipSupplier DropShipSupplier Required with "is drop ship flag" is is true
hierarchy Hierarchy Used by WMS to classify items.
customDynamicAttributes List of Attribute Random key value pairs
bundleItems List of BundleItem A list of Bundled Items
images List of Image
sizes List of Size
upcs List of UPC
manufacturer Manufacturer
cartonMassDimensions MassDimensions
dimensionalWeight MassDimensions The “weight” used to calculate the shipping cost of bulky, lightweight packages.
displayMassDimensions MassDimensions
shippingMassDimensions MassDimensions
cartonPackagingDimensions PackagingDimensions
displayPackagingDimensions PackagingDimensions
shippingPackagingDimensions PackagingDimensions
unitCost Price
shipAlone String Yes/No
supplier Supplier
Brand brand complex type
name String Size (max = 50)

The selling and promotional name used to identify a product for advertising and name recognition purposes. Allowable Values: Text string Required: No Length: 50 Default Value: blank Restrictions: N/A Aliases: N/A Offering: SOMS, Interfaces and Tools
description List of BrandDescription

Short Description of the selling and promotional name used to identify a product for advertising and name recognition purposes. Allowable Values: Text string Required: No Length: 100 Default Value: blank Restrictions: N/A Aliases: N/A Offering: Interfaces and Tools
BrandDescription brandDescription complex type
locale String Size (max = 5) A locale represents a specific geographical, political, or cultural region. It is used to define language, date/time formatting, numerical formatting, currency symbols, and other regional-specific settings in software applications. For example, the code "en_US" represents the English language in the United States.
description String Size (max = 100)
Color color complex type
code String Size (min = 1, max = 40) required *
descriptions List of ColorDescription Size (min = 1) required *
ColorDescription colorDescription complex type
locale String Size (max = 5) A locale represents a specific geographical, political, or cultural region. Example: "en_US"
description String Size (min = 1, max = 4000) required *
Date date type The ISODate formats are "2023-12-15T10:00:00Z".
DropShipSupplier dropShipSupplier complex type If this item is fulfilled by a Drop Shipper then Supplier Number, Supplier Name, and Supplier Part Number are required. Without the three values, the FILE will be rejected.
name String Size (min = 1, max = 120) required * Name of the Drop Ship Supplier fulfilling the item. Default Value: blank
number String Size (min = 1, max = 15) required *

Unique Radial Inc-assigned code for this supplier. Default Value: blank
partNumber String Size (min = 1, max = 15) required *

ID or SKU used by Supplier to identify this item. Default Value: blank Restrictions:
Hierarchy

hierarchy complex type Encapsulates the merchandise structure for the item. Primarily used for reporting. The hierarchy is client-defined. One example of use, by an apparel company might be as follows: Department = client name SubDepartment = Male, Female Class = If the SubDepartment is "Femaile", possible classes might be "blouses", "pants", "shoes" "accessories", etc.
deptNumber numeric required * Product Hierarchy Level 1 (Dept). Default Value: blank .
deptDescription String Size (max = 25)

Product Hierarchy Level 1 description. Default Value: blank Offering: Interfaces and Tools
subDeptNumber numeric required *

Product Hierarchy Level 2 (Sub-Dept). Default Value: blank Restrictions: N/A Aliases: N/A Offering: SOMS, Interfaces and Tools
subDeptDescription String Size (max = 25)

Product Hierarchy Level 2 description. Default Value: blank Restrictions: N/A Aliases: N/A Offering: Interfaces and Tools
classNumber numeric required * Product Hierarchy Level 3 (Class). Default Value: blank Restrictions: N/A Aliases: N/A Offering: SOMS, Interfaces and Tools
classDescription String Size (max = 25)

Product Hierarchy Level 3 description. Default Value: blank Restrictions: N/A Aliases: N/A Offering: SOMS, Interfaces and Tools
subClassNumber numeric required *

SubClass code. Allowable Values: Default Value: blank Restrictions: N/A Aliases: N/A Offering: SOMS, Interfaces and Tools
subClassDescription String Size (max = 25)

SubClass description. Allowable Values: Default Value: blank Restrictions: N/A Aliases: N/A Offering: Interfaces and Tools
Attribute attribute complex type

Attributes are name/value pairs.
name String Size (max = 50) required *
value String Size (max = 255)
BundleItem bundleItem complex type

When bundle is true, items listed are a bundle product.
item Item

Each items element contains an itemID and an action used to modify a bundle. There is one BundleItem occurrence for each product in a bundle.
itemId String

The client or vendor ID for the item to be included in the bundle. Allowable Values: Text string Required: Yes Length: 35 Default Value: blank Restrictions: N/A Aliases: N/A Offering: SOMS, Interfaces and Tools
operationType String Add or delete
pricePercentage numeric Percentage value of each child item in the bundle.
quantity numeric
FulfillmentTypeId fulfillmentTypeId enumeration SHIP_TO_HOME, SHIP_TO_STORE, STORE_PICK_UP Limited the choices: SHIP_TO_HOME, SHIP_TO_STORE, or STORE_PICK_UP
Image image complex type Meta information necessary to link to the product image
url String Size (min = 1, max = 255) required *
type String Size (min = 1, max = 32) required *
view String Size (max = 32)
height numeric required *
width numeric required *
Size size complex type
locale String Size (max = 5) A locale represents a specific geographical, political, or cultural region. Example: "en_US"
code String Size (min = 1, max = 40) required *
description String Size (min = 1, max = 255) required *
UPC upc complex type Universal Product Code
upcType String required *
upc String required *
operationType String
Manufacturer manufacturer complex type Manufacturer
name String Size (max = 50) Company Name of the Manufacturer.
id String Size (max = 50) The code assigned to the item by the manufacturer to uniquely identify the item.
manufacturingDate Date The date which the item was built/assembled by the manufacturer. Allowable Values: ISO 8601 standard with offset from UTC. The ISODate format is "2023-12-15T10:00:00Z".
MassDimensions massDimensions complex type MassDimensions
unit String Lower case required * units must be lower cased (e.g. in, ft, lb)
weight numeric Size Digits(integer=14, fraction=4) required *
PackagingDimensions packagingDimensions complex type PackagingDimensions
unit String required *
width numeric SIze Digits(integer = 14, fraction = 4) required *
length numeric SIze Digits(integer = 14, fraction = 4) required *
height numeric SIze Digits(integer = 14, fraction = 4) required *
Price price complex type Price
currency String Size (min = 1, max = 3) required *
value numeric Size Digits(integer = 19, fraction = 2) required *
Supplier supplier complex type Encapsulates the information related to the agency providing the goods or materials.
name String Size (max = 50) The name of the individual/organization responsible for providing/supplying the merchandise identified within the purchase order. Default Value: blank
id String Size (max = 50) Specifies the individual/organization that acts as a source for merchandise and services offered for sale, or for supplies and services consumed by the buyer and/or client. Default Value: blank
partNumber String Size (max = 15) Specifies Buyer and/or Client assigned SupplierPartNumber Default Value: blank