Items

The following services are included in this functional area:

• Item Definition

  • Item Download Service

    • Get Item Details

    • Get Item Details for All or Provided Items

    • Get Item Details for Provided Item

    • Get Item Location Details

    • Get Item VAT Details

    • Get Item VAT Details by Item Number

  • Item ELC Upload Service

    • Create Item Conditional Tariff Treatments

    • Create Item Expenses

    • Create Item HTS

    • Create Item HTS Assessments

    • Delete Item Conditional Tariff Treatments

    • Delete Item Expenses

    • Delete Item HTS

    • Delete Item HTS Assessments

    • Update Item Expenses

    • Update Item HTS

    • Update Item HTS Assessments

  • Item Location Upload Service

    • Create Item Locations

    • Manage Item Location Status Update Requests

    • Update Item Locations

  • Item Number Reservation Upload Service

    • Generate and Reserve Item Numbers

  • Item Placeholder Upload Service

    • Create Placeholder Items

  • Item Sourcing Upload Service

    • Create Item Supplier Countries

    • Create Item Supplier Countries of Manufacture

    • Create Item Supplier Country Dimensions

    • Create Item Supplier Country Locations

    • Create Item Supplier Translations

    • Create Item Suppliers

    • Delete Item Supplier Countries

    • Delete Item Supplier Countries of Manufacture

    • Delete Item Supplier Country Dimensions

    • Delete Item Supplier Country Locations

    • Delete Item Supplier Translations

    • Delete Item Suppliers

    • Update Item Supplier Countries

    • Update Item Supplier Countries of Manufacture

    • Update Item Supplier Country Dimensions

    • Update Item Supplier Country Locations

    • Update Item Supplier Translations

    • Update Item Suppliers

  • Item Taxes Upload Service

    • Create Item Taxes

    • Delete Item Taxes

  • Item Up Charge Download Service

    • Get Item Up Charges for Future Date

  • Item Upload Service

    • Create Item Description Translations

    • Create Item Image Translations

    • Create Item Images

    • Create Item Seasons

    • Create Item Tickets

    • Create Item UDAs

    • Create Item Up Charges

    • Create Items

    • Delete Item Description Translations

    • Delete Item Image Translations

    • Delete Item Images

    • Delete Item Seasons

    • Delete Item Tickets

    • Delete Item UDAs

    • Delete Item Up Charges

    • Delete Items

    • Update Item Description Translations

    • Update Item Image Translations

    • Update Item Images

    • Update Item Tickets

    • Update Item UDAs

    • Update Item Up Charge Details

    • Update Items

• Item Foundation

  • Brand Download Service

    • Get Brands

  • Brand Upload Service

    • Manage Brands

  • Differentiator Download Service

    • Get Differentiator Details

    • Get Differentiator Details for Provided Differentiator

    • Get Differentiator Details for Single Differentiator

  • Differentiator Group Download Service

    • Get Differentiator Groups

    • Get Differentiators for Provided Group

  • Differentiator Group Upload Service

    • Create Differentiator Group Details

    • Create Differentiator Groups

    • Delete Differentiator Group Details

    • Delete Differentiator Groups

    • Update Differentiator Group Details

    • Update Differentiator Groups

  • Differentiator Type Download Service

    • Get Differentiator Type Details for Provided Type

    • Get Differentiator Types

  • Differentiator Upload Service

    • Create Differentiators

    • Delete Differentiators

    • Update Differentiators

  • Seasons and Phases Download Service

    • Get Seasons and Phases Service

  • User Defined Attribute (UDA) Download Service

    • REST Endpoint for UDA details

    • REST Endpoint to Fetch UDA by UDA ID

Item Definition

The following services are included in this functional area:

• Item Download Service

  • Get Item Details

  • Get Item Details for All or Provided Items

  • Get Item Details for Provided Item

  • Get Item Location Details

  • Get Item VAT Details

  • Get Item VAT Details by Item Number

• Item ELC Upload Service

  • Create Item Conditional Tariff Treatments

  • Create Item Expenses

  • Create Item HTS

  • Create Item HTS Assessments

  • Delete Item Conditional Tariff Treatments

  • Delete Item Expenses

  • Delete Item HTS

  • Delete Item HTS Assessments

  • Update Item Expenses

  • Update Item HTS

  • Update Item HTS Assessments

• Item Location Upload Service

  • Create Item Locations

  • Manage Item Location Status Update Requests

  • Update Item Locations

• Item Number Reservation Upload Service

  • Generate and Reserve Item Numbers

• Item Placeholder Upload Service

  • Create Placeholder Items

• Item Sourcing Upload Service

  • Create Item Supplier Countries

  • Create Item Supplier Countries of Manufacture

  • Create Item Supplier Country Dimensions

  • Create Item Supplier Country Locations

  • Create Item Supplier Translations

  • Create Item Suppliers

  • Delete Item Supplier Countries

  • Delete Item Supplier Countries of Manufacture

  • Delete Item Supplier Country Dimensions

  • Delete Item Supplier Country Locations

  • Delete Item Supplier Translations

  • Delete Item Suppliers

  • Update Item Supplier Countries

  • Update Item Supplier Countries of Manufacture

  • Update Item Supplier Country Dimensions

  • Update Item Supplier Country Locations

  • Update Item Supplier Translations

  • Update Item Suppliers

• Item Taxes Upload Service

  • Create Item Taxes

  • Delete Item Taxes

• Item Up Charge Download Service

  • Get Item Up Charges for Future Date

• Item Upload Service

  • Create Item Description Translations

  • Create Item Image Translations

  • Create Item Images

  • Create Item Seasons

  • Create Item Tickets

  • Create Item UDAs

  • Create Item Up Charges

  • Create Items

  • Delete Item Description Translations

  • Delete Item Image Translations

  • Delete Item Images

  • Delete Item Seasons

  • Delete Item Tickets

  • Delete Item UDAs

  • Delete Item Up Charges

  • Delete Items

  • Update Item Description Translations

  • Update Item Image Translations

  • Update Item Images

  • Update Item Tickets

  • Update Item UDAs

  • Update Item Up Charge Details

  • Update Items

Item Download Service

The following services are included in this functional area:

• Get Item Details

• Get Item Details for All or Provided Items

• Get Item Details for Provided Item

• Get Item Location Details

• Get Item VAT Details

• Get Item VAT Details by Item Number

Get Item Details

This section describes the Item Detail service.

Business Overview

Item Detail service allows user to retrieve Item information for a selected item.

Service Type

Get

ReST URL

Item/itemDetail?item={itemNumber}

Input Parameters

Parameter Name	Required	Description
Item	Yes	Item number

Output

RestItemRecRDO

Parameter Name	Data Type
itemGrandparent	String
itemParent	String
item	String
itemDesc	String
shortDesc	String
packInd	String
status	String
itemLevel	BigDecimal
tranLevel	BigDecimal
dept	BigDecimal
classAttribute	BigDecimal
subclass	BigDecimal
diff1	String
diff2	String
diff3	String
diff4	String
primaryRefItemInd	String
originalRetail	BigDecimal
sellableInd	String
orderableInd	String
inventoryInd	String
packitemBreakout	List<RestPackitemBreakoutRecRDO>
itemSupplier	List<RestItemSupplierRecRDO>
itemSupplierCountry	List<RestItemSupplierCountryRecRDO>
vatItem	List<RestVatItemRecRDO>
longDesc	String

RestPackitemBreakoutRecRDO

Parameter Name	Data Type
item	String
seqNo	BigDecimal
packItemQty	BigDecimal

RestItemSupplierRecRDO

Parameter Name	Data Type
supplier	BigDecimal
vpn	String
primarySuppInd	String
directShipInd	String

RestItemSupplierCountryRecRDO

Parameter Name	Data Type
originCountryId	String
primaryCountryInd	String
unitCost	BigDecimal
suppPackSize	BigDecimal
innerPackSize	BigDecimal
leadTime	BigDecimal
pickupLeadTime	BigDecimal

RestVatItemRecRDO

Parameter Name	Data Type
vatRegion	BigDecimal
vatType	String
vatCode	String
vatRate	BigDecimal
activeDate	Timestamp

JSON Structure

{
  "itemGrandparent": null,
  "itemParent": null,
  "item": null,
  "itemDesc": null,
  "shortDesc": null,
  "packInd": null,
  "status": null,
  "itemLevel": null,
  "tranLevel": null,
  "dept": null,
  "classAttribute": null,
  "subclass": null,
  "diff1": null,
  "diff2": null,
  "diff3": null,
  "diff4": null,
  "primaryRefItemInd": null,
  "originalRetail": null,
  "sellableInd": null,
  "orderableInd": null,
  "inventoryInd": null,
  "packitemBreakout": [],
  "itemSupplier": [
    {
      "primarySuppInd": null,
      "itemSupplierCountry": [
        {
          "unitCost": null,
          "leadTime": null,
          "suppPackSize": null,
          "originCountryId": null,
          "primaryCountryInd": null,
          "pickupLeadTime": null,
          "innerPackSize": null,
          "links": [],
          "hyperMediaContent": {
            "linkRDO": []
          }
        }
      ],
      "supplier": null,
      "vpn": null,
      "directShipInd": null,
      "links": [],
      "hyperMediaContent": {
        "linkRDO": []
      }
    }
  ],
  "vatItem": [
    {
      "vatRegion": null,
      "activeDate": null,
      "vatType": null,
      "vatCode": null,
      "vatRate": null,
      "links": [],
      "hyperMediaContent": {
        "linkRDO": []
      }
    }
  ],
  "longDesc": null,
  "links": [],
  "hyperMediaContent": {
    "linkRDO": []
  }
}

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_ITEM_MASTER	Yes	No	No	No
PACKITEM_BREAKOUT	Yes	No	No	No
ITEM_SUPPLIER	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
VAT_ITEM	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Get Item Details for All or Provided Items

Endpoints

MerchIntegrations/services/foundation/item

MerchIntegrations/services/foundation/item/{itemId}

Functional Area

Items

Business Overview

This service can be used by external applications to get all or selected items and its details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/item?itemLevel={itemlevel}&tranLevel={tranLevel}& deptId={deptId}&classId={classId}&subclassId={subclassId}&status={status}&itemType={itemType}&inventoryInd={inventoryInd}&supplier={supplier}&referenceItem={referenceItem}&offsetkey={offsetkey}&limit={limit}&since={since}&before={before}

/MerchIntegrations/services/foundation/item/{itemId}

Input Parameters

Table 5-311 /MerchIntegrations/services/foundation/item

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
itemLevel	No	String	Item’s Level. Valid values are 1, 2 and 3.
tranLevel	No	String	Item’s Transaction Level. Valid Values are 1,2 and 3.
deptId	No	String	Department ID.
classId	No	String	Class ID.
subclassId	No	String	Subclass ID.
status	No	String	Status of the item. At this time, will always contain ‘A’ as only approved items are interfaced.
itemType	No	String	Item Type. Valid values are S - Simple Pack, C - Complex Pack, A - Deposit Container, E - Deposit Contents, T - Deposit Returned Item, Z - Deposit Crate, O - Transformed Orderable, L - Transformed Sellable, R - Regular Item.
inventoryInd	No	String	Inventoried must be 'Y' or 'N'.
supplier	No	String	Supplier ID.
referenceItem	No	String	Reference Item.
offsetkey	No	String	Offset Key. Valid Value is an Item Id.
limit	No	String	Pagination limit. Default Value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Table 5-312 /MerchIntegrations/services/foundation/item/{itemId}

Parameter Name	Required	Data Type	Description
itemId	Yes	Number	Item Number.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Output

Name	Data Type					Description
action			String		Action for Item details. Valid Values are INSERT, UPDATE and DELETE.
item			String		This field specifies unique alphanumeric value that identifies the item.
itemNumberType			String		Indicates the type of the item ID, for example UPC-12. The valid values for this column are maintained in code type UPCT.
status			String		This field specifies status of the item.
itemLevel		Number		This field specifies Number indicating which of the three levels the item resides. The item level determines if the item stands alone or if it is part of a family of related items. The item level also determines how the item may be used throughout the system.
tranLevel		Number		This field specifies Number indicating which of the three levels transactions occur for the item's group. The transaction level is the level at which the item's inventory is tracked in the system. The transaction level item will be counted, transferred, shipped, etc. The transaction level may be at the current item or up to 2 levels above or below the current item. Only one level of the hierarchy of an item family may contain transaction level items.
itemDescription			String		This field specifies long description of the item. This description is used throughout the system to help online users identify the item. For items that have parents, this description will default to the parent’s description plus any differentiators. For items without parents this description will default to null.
shortDescription			String		This field specifies shortened description of the item. This description is the default for downloading to the POS. For items that have parents, this description will default to the parent's short description. For items without parents, this description will default to null.
itemDescriptionUppercase			String		This field specifies all upper-case description of the item (same as upper(itemDescription). This field is not displayed in the on-line item maintenance dialog but is used in item list of value search processing throughout the system.
itemDescriptionSecondary			String		This field specifies secondary descriptions of the item. This field can only be populated when secondary_desc_ind on the system options is Y.
longDescription			String		This field specifies long description of the item. This is a more descriptive writeup about the item targeted largely for platforms like Ecommerce platforms, Marketplaces, Order Management Systems etc.
itemParent			String		This field specifies alphanumeric value that uniquely identifies the item/group at the level above the item.
itemGrandparent			String		This field specifies alphanumeric value that uniquely identifies the item/group at two levels above the item.
sellableInd			String		This field indicates if the item can be sold.
orderableInd			String		This field indicates if the item can be ordered.
inventoryInd			String		This field indicates whether the retailer intends to maintain inventory of the item. Non-inventory items cannot be put on any transactions except sales.
packInd			String		This field indicates if the item is a pack. A pack item is a collection of items that may be either ordered or sold as a unit. Packs require details (i.e., component items and quantities, etc.) that other items do not. This field is required by the database.
simplePackInd			String		This field indicates if pack item is a simple pack or not. This field will only be available if the item is a pack item. A simple pack is an item whose components are all the same item (i.e., a six pack of cola, etc). Valid values are - Yes, this item is a simple pack; N - No if this is not a simple pack.
containsInnerInd			String		This field indicates if pack item contains inner packs. Vendor packs will never contain inner packs and this field will be defaulted to 'N'. This field will only be available if the item is a pack item. Valid values are Y - Yes, this pack contains inner packs; N - No, this pack does not contain inner packs.
dept			Number		This field specifies number identifying the department to which the item is attached. The item's department will be the same as that of its parent (and, by transitivity, to that of its grandparent).
deptName			String		This field contains the name of the department.
class			Number		Number identifying the class to which the item is attached.
className			String		This field contains the name of the class.
uniqueClassId			Number		This field uniquely identify the class which the item belongs to. Class is not unique ID the merchandise hierarchy. The combination of Dept/Class is unique but requires use of a composite key. The composite key is generally used in user interfaces. The unique ID can be used in back-end processing or in systems that cannot have a composite key in the merchandise hierarchy.
subclass			Number		This field specifies number identifying the subclass to which the item is attached. The item's subclass will be the same as that of its parent (and, by transitivity, to that of its grandparent). Valid values for this field are located on the subclass table.
subclassName			String		This field contains the name of the subclass.
uniqueSubclassId			Number		This field uniquely identifies the subclass which the item belongs to. Subclass is not unique ID the merchandise hierarchy. The combination of Dept/Class/Subclass is unique but requires use of a composite key. The unique ID can be used in back-end processing or in systems that cannot have a composite key in the merchandise hierarchy.
unitRetail			Number		This field holds the unit retail in the standard unit of measure for the item/zone combination. This field is stored in the local currency.
variableUpcFormatId			String		This field will hold the format ID that corresponds to the item's variable UPC. This value is only used for items with variable UPCs.
variableWeightUpcPrefix			Number		This field holds the prefix for variable weight UPCs. The prefix determines the format of the eventual UPC and will be used to decode variable weight UPCs that are uploaded from the POS. It is the client’s responsibility to download this value to their POS system.
diff1			String		This field contains diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e., Men's pant sizes) or a value (6 oz). For an item that is not a parent, this field may contain a value (34X34, Red, etc.). Valid values are found on the diff_group and diff_id tables.
diff1Type			String		This field will hold a value of all possible differential types. (for example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). The valid values for this column are maintained in code type 'DIFF' and on the diff_type table.
diff2			String		This field contains diff_group or diff_id that differentiates the current item from its itemParent.
diff2Type			String		This field will hold a value of all possible differential types. (for example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). The valid values for this column are maintained in code type 'DIFF' and on the diff_type table.
diff3			String		This field contains diff_group or diff_id that differentiates the current item from its itemParent.
diff3Type			String		This field will hold a value of all possible differential types. (For example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). The valid values for this column are maintained in code type 'DIFF' and on the diff_type table.
diff4			String		This field contains diff_group or diff_id that differentiates the current item from its itemParent.
diff4Type			String		This field will hold a value of all possible differential types. (For example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). The valid values for this column are maintained in code type 'DIFF' and on the diff_type table.
costZoneGroupId			Number		This field contains cost zone group associated with the item. This field is only required when elc_ind (landed cost indicator) is set to 'Y' on the system_options table.
standardUom			String		This field contains unit of measure in which stock of the item is tracked at a corporate level.
uomConversionFactor			Number		This field contains Conversion factor between an 'Each' and the standard_uom when the standard_uom is not in the quantity class.
packageSize			Number		This field holds the size of the product printed on any packaging.
packageUom			String		This field holds the unit of measure associated with the package size. This field is used for reporting purposes and by Retek Price Management to determine same sized and different sized items.
merchandiseInd			String		This field indicates if the item is a merchandise item (Y, N).
storeOrderMultiple			String		This field indicates Merchandise shipped from the warehouses to the stores must be specified in this unit type. Valid values are C - Cases; I - Inner; E - Eaches.
forecastInd			String		This field indicates if this item will be interfaced to an external forecasting system (Y, N).
manufacturerRecommendedRetail			Number		This field contains manufacturer's recommended retail price for the item. Used for informational purposes only. This field is stored in the primary currency.
manufacturerRetailCurrencyCode			String		The field indicates the currency code of the Manufacturer's retail price.
originalRetail			Number		The field indicated the original retail price of the item per unit. This field is stored in the primary currency.
originalRetailCurrencyCode			String		The field indicates the currency code of the original retail price.
retailLabelType			String		This field indicates any special label type associated with an item (i.e., pre-priced or cents off).
retailLabelTypeDescription			String		Contains the retail label type description corresponding to the retailLabelType value.
retailLabelValue			Number		This field represents the value associated with the retail label type.
handlingTemperature			String		Holds the temperature information associated with the item. The valid values for this column are maintained in code type 'HTMP'.
handlingTemperatureDescription			String		Contains the Handling temperature description corresponding to the handlingTemperature value.
handlingSensitivity			String		Holds the handling sensitivity information associated with the item. The valid values for this column are maintained in code type 'HSEN'.
handlingSensitivityDescription			String		Contains the Handling sensitivity description corresponding to the handlingSensitivity value.
catchWeightInd			String		Indicates whether the item should be weighed when it arrives at a location. Valid values for this field are 'Y' and 'N'.
catchWeightType			String		The field will hold catch weight type for a simple pack catch weight item. The value is based on the component items orderType and saleType: 2 - orderType - Variable Weight, saleType - Loose Weight 4 - orderType - Variable Weight, saleType - Variable Weight Each.
catchWeightUom			String		The field indicates the UOM for Catchweight Items.
orderType			String		The field determines how catch weight items are ordered. Valid values are F - fixed weight V - Variable weight. The valid values for this column are maintained in code type ORDT.
saleType			String		The field indicates the method of how catch weight items are sold in store locations. Valid values are V - variable weight each L - Loose weight. The valid values for this column are maintained in code type STPE.
wasteType			String		The field identifies the wastage type as either sales or spoilage wastage. Valid values are SP - spoilage; and SL - Sales.
wasteTypeDescription			String		The field contains the Waste Type description corresponding to the wasteType value.
averageWastePercentage			Number		The field indicates average percent of wastage for the item over its shelf life. Used in inflating the retail price for wastage items.
defaultWastePercentage			Number		The field indicates default daily wastage percent for spoilage type wastage items. This value will default to all item locations and represents the average amount of wastage that occurs on a daily basis.
constantDimensionInd			String		The field indicates that the dimensions of the product are always the same, regardless of the supplier. If this field is Y, the dimensions for all suppliers will be defaulted to the primary supplier/primary country dimensions. Editing of dimensions for the item will only be allowed for the primary supplier/primary country.
packType			String		The field indicates if pack item is a vendor pack or a buyer pack. Valid values are V - Vendor; B - Buyer.
orderAsType			String		This field indicates if pack item is receivable at the component level or at the pack level (for a buyer pack only). Valid Values are E - Eaches (component level) P - Pack (buyer pack only).
comments			String		The field holds any comments associated with the item.
itemServiceLevel			String		The field Holds a value that restricts the type of shipment methods that RCOM can select for an item.
giftWrapInd			String		This field will contain a value of 'Y' if the item is eligible to be gift wrapped.
shipAloneInd			String		This field will contain a value of 'Y' if the item should be shipped to the customer is a separate package versus being grouped together in a box.
brandName			String		This field contains the brand associated to an item.
brandDescription			String		The field contains the brand description associated to an item.
perishableInd			String		A grocery item attribute used to indicate whether an item is perishable or not.
itemTransformInd			String		The field show that an item is associated with an item transformation. The item will be either the sellable item or orderable item in the transformation process.
depositItemType			String		The field contains deposit item component type. A NULL value in this field indicates that this item is not part of a deposit item relationship. The possible values are - E - Contents A - Container Z - Crate T - Returned Item (Empty bottle) P - Complex pack (with deposit items) The Returned item is flagged only to enable these items to be mapped to a separate GL account if required.
containerItem			String		The field holds the container item number for a contents item. This field is only populated and required if the depositItemType - E.
depositInPricePerUom			String		This field indicates if the deposit amount is included in the price per UOM calculation for a contents item ticket. This value is only required if the depositItemType - E. Valid values are I - Include deposit amount E - Exclude deposit amount.
notionalPackInd			String		The field indicates to the Store Inventory System if a sellable simple pack needs to be broken down to its component item.
sohInquiryAtPackInd			String		The field indicates to the Store Inventory System if a notional simple pack item's inventory should be displayed in packs.
purchaseType			String		The field indicates if an item is a normal, consignment or concession item - 'N' for normal, 'S' for consignment, 'C' for concession.
productClassification			String		The field contains item combinability codes (The valid values for this column are maintained in code type 'PCLA') which provide a way to define which items can be combined (packed or boxed) together.
productClassificationDescription			String		This field will hold the description of the product classification.
itemAggregateInd			String		This field holds indicator to aggregate inventory and sales for the item. Currently, this indicator is used by allocation and MFP to aggregate inventory for items. For staple items this indictor should be N.
diff1AggregateInd			String		This field holds indicator for the corresponding diff. Indicator to aggregate inventory and sales for an item at Parent/Diff level (e.g., Style/Color or Style/Size.
diff2AggregateInd			String		This field holds indicator for the corresponding diff. Indicator to aggregate inventory and sales for an item at Parent/Diff level (e.g., Style/Color or Style/Size.
diff3AggregateInd			String		This field holds indicator for the corresponding diff. Indicator to aggregate inventory and sales for an item at Parent/Diff level (e.g., Style/Color or Style/Size.
diff4AggregateInd			String		This field holds indicator for the corresponding diff. Indicator to aggregate inventory and sales for an item at Parent/Diff level (e.g., Style/Color or Style/Size.
diff1Level			String		This field will contain either ID or GROUP, based on whether the diff1 is a group diff or a diff id.
diff1Description			String		This field will hold the description of differentiator.
diff2Level			String		This field will contain either ID or GROUP, based on whether the diff1 is a group diff or a diff id.
diff2Description			String		This field will hold the description of differentiator.
diff3Level			String		This field will contain either ID or GROUP, based on whether the diff1 is a group diff or a diff id.
diff3Description			String		This field will hold the description of differentiator.
diff4Level			String		This field will contain either ID or GROUP, based on whether the diff1 is a group diff or a diff id.
diff4Description			String		This field will hold the description of differentiator.
primaryImageUrl			String		This field will hold the primary item image URL.
createDateTime			String		This field holds the record creation date.
updateDateTime			String		This field holds the date when the record was last updated.
customFlexAttribute					This list holds custom flex attributes for the item.
itemTranslation					This list holds translation attributes for the item.
itemSupplier					This list holds supplier's attributes for the item.
itemUda					This list holds uda attributes for the item.
itemImage					This list holds image attributes for the item.
referenceItem					This list holds the attributes of the reference item.
itemBOM					This list holds pack attributes for the item.
itemTicket					This list holds ticket attributes for the item.
relatedItem					This list holds related item's attributes for the item.
cacheTimestamp			String		This field specifies date and time when the item record was last maintained.

Table 5-313 customFlexAttribute

Name	Data Type	Description
name	String	This field will hold the custom flex attribute name.
value	String	This field will hold the numeric or string value of the custom flex attribute.
valueDate	String	This field will hold the date value of the custom flex attribute.
createDateTime	String	This field will hold the date time when the custom flex attribute was inserted.
updateDateTime	String	This field will hold the date time when the custom flex attribute was last updated.

Table 5-314 itemTranslation

Name	Data Type	Description
languageCode	Number	This field contains the language in which the translated text is maintained
languageName	String	This field contains description of language code in which the translated text is maintained
isoCode	String	This field will hold the ISO code associated with the given language.
itemDescription	String	This field will hold the ISO code associated with the given language.
itemDescriptionSecondary	String	This field holds long description of the item.
shortDescription	String	This field holds shortened description of the item. This description is the default for downloading to the POS. For items that have parents, this description will default to the parents short description. For items without parents, this description will default to null
longDescription	String	This field specifies long description of the item. This is a more descriptive writeup about the item targeted largely for platforms like Ecommerce platforms, Marketplaces, Order Management Systems etc.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-315 itemSupplier

Name	Data Type	Description
supplier	Number	This field specifies unique identifier for the supplier.
primarySupplierInd	String	This field indicates whether this supplier is the primary supplier for the item. An item can have one and only one primary supplier.
vpn	String	This field contains the Vendor Product Number for the Item/Supplier.
supplierLabel	String	This field contains the supplier label. It will only be populated if item is a parent item.
supplierDiff1	String	This field contains the first supplier differentiator and/or description. This field may only contain a value for items with an item parent.
supplierDiff2	String	This field contains the second supplier differentiator and/or description. This field may only contain a value for items with an item parent.
supplierDiff3	String	This field contains the third supplier differentiator and/or description. This field may only contain a value for items with an item parent.
supplierDiff4	String	This field contains the fourth supplier differentiator and/or description. This field may only contain a value for items with an item parent.
palletName	String	This field specifies code referencing the name used to refer to the pallet.
caseName	String	This field specifies code referencing the name used to refer to the case.
innerName	String	This field specifies code referencing the name used to refer to the inner.
supplierDiscontinueDate	String	This field specifies the date when the supplier discontinues an item.
directShipInd	String	This field indicates that any item associated with this supplier is eligible for a direct shipment from the supplier to the customer.
primaryCaseSize	String	This field indicates the primary case size for the item supplier when an orderable item is configured for informal case types.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
customFlexAttribute		This list holds custom flex attributes for the item's supplier record.
itemSupplierCountry		This list holds attributes for the item supplier's country record.
itemSupplierCountryOfManufacture		This list holds attributes for the item supplier's country of manufacturing record
itemSupplierUom		This list holds attributes for the item supplier’s UOM record.

Table 5-316 itemSupplierCountry

Name	Data Type	Description
originCountry	String	This field specifies country where the item was manufactured or significantly altered.
primarySupplierInd	String	This field indicates whether this supplier is the primary supplier for the item. Each item can have one and only one primary supplier.
primaryCountryInd	String	This field indicates whether this country is the primary country for the item/supplier. Each item/supplier combination can have one and only one primary country.
unitCost	Number	This field contains the current corporate unit cost for the item from the supplier /origin country.
leadTime	Number	This field contains the number of days that will elapse between the date an order is written and the delivery to the store or warehouse from the supplier.
pickupLeadTime	Number	This field contains the time that will be taken to get the item from the supplier to the initial receiving location.
supplierPackSize	Number	This field contains the quantity that orders must be placed in multiples of for the supplier for the item.
innerPackSize	Number	This field contains the break pack size for this item from the supplier.
roundLevel	String	This field is used to determine how order quantities will be rounded to case, layer and pallet.
minimumOrderQuantity	Number	This field contains the minimum quantity that can be ordered at once from the supplier for the item.
maximumOrderQuantity	Number	This field contains the maximum quantity that can be ordered at once from the supplier for the item.
packingMethod	String	This field indicates whether the packing method for the item in the container is flat or hanging.
defaultUop	String	This field contains the default unit of purchase for the item/supplier/country. Valid values include 'C' - Case and 'P' – Pallet.
ti	Number	This field contains number of shipping units (cases) that make up one tier of the pallet. Multiply TI x HI to get total number of units (cases) in a Pallet.
hi	Number	This field contains number of tiers that make up a complete pallet. Multiply TI x HI to get total number of units (cases) in a Pallet.
costUom	String	This field contains cost UOM is held to allow costs to be managed in a separate UOM to the standard UOM.
toleranceType	String	The unit of tolerance for catch weight simple packs. Valid values are: 'A' - actual 'P' - percent.
maximumTolerance	Number	The maximum tolerance value for the catch weight simple pack.
minimumTolerance	Number	The minimum tolerance value for the catch weight simple pack.
roundToInnerPercentage	Number	This field will hold the Inner Rounding Threshold value. During rounding, this value is used to determine whether to round partial Inner quantities up or down. If the Inner-fraction in question is less than the Threshold proportion, it is rounded down; if not, it is rounded up.
roundToCasePercentage	Number	This field will hold the Case Rounding Threshold value. During rounding, this value is used to determine whether to round partial Case quantities up or down. If the Case-fraction in question is less than the Threshold proportion, it is rounded down; if not, it is rounded up.
roundToLayerPercentage	Number	This field will hold the Layer Rounding Threshold value. During rounding, this value is used to determine whether to round partial Layer quantities up or down. If the Layer-fraction in question is less than the Threshold proportion, it is rounded down; if not, it is rounded up.
roundToPalletPercentage	Number	This field will hold the Pallet Rounding Threshold value. During rounding, this value is used to determine whether to round partial Pallet quantities up or down. If the Pallet -fraction in question is less than the Threshold proportion, it is rounded down; if not, it is rounded up.
supplierHierarchyType1	String	This field identifies partner type of supplier hierarchy level 1. This field will always have the partner type S1 which indicates manufacturer.
supplierHierarchyLevel1	String	This field contains highest level of supplier hierarchy which is there to indicate a partner, such as a manufacturer, in the supply chain that gives rebates to the retailer.
supplierHierarchyType2	String	This field identifies partner type of supplier hierarchy level 2. This field will always have the partner type S2 which indicates distributor.
supplierHierarchyLevel2	String	This field contains second highest level of supplier hierarchy which is there to indicate a partner, such as a distributor, in the supply chain that gives rebates to the retailer.
supplierHierarchyType3	String	This field identifies partner type of supplier hierarchy level 3. This field will always have the partner type S3 which indicates wholesaler.
supplierHierarchyLevel3	String	Third highest level of supplier hierarchy which is there to indicate a partner, such as a wholesaler, in the supply chain that gives rebates to the retailer.
negotiatedItemCost	Number	This field will hold the supplier negotiated item cost for the primary delivery country of the item. Once a location is associated with the item, the primary locations negotiated item cost will be stored in this field.
extendedBaseCost	Number	This field will hold the extended base cost for the primary delivery country of the item. Once a location is associated with the item, the primary locations extended base cost will be stored in this field. Extended base cost is the cost inclusive of all the taxes that affect the WAC. In case of GTAX, Extended Base Cost = Base Cost + Non-recoverable taxes. In case of VAT, Extended Base Cost = Base Cost.
inclusiveCost	Number	This field will hold the inclusive cost for the primary delivery country of the item. Once a location is associated with the item, the primary locations inclusive cost will be stored in this field. This cost will have both the recoverable and non-recoverable taxes included. In case of GTAX, Inclusive Cost = Base Cost + Non-recoverable taxes + Recoverable Taxes. In case of VAT, Inclusive Cost = Base Cost + VAT.
baseCost	Number	This field will hold the tax exclusive cost of the item.
purchaseType	Number	This field contains a code to indicate whether the item is normal merchandise (i.e., owned by the retailer), consignment stock or a concession item. Valid values are 0 - Owned, 1 - Consignment, 2 - Concession.
calculationBasis	String	This field indicates if the cost for the consignment/concession item will be managed either based on cost per unit or as a percentage of retail. Valid values are C - Cost per Unit, P - Purchase Rate.
purchaseRate	Number	This field contains the percentage of the retail price which will determine the cost paid to the supplier for a consignment or concession item.
pricingControl	String	Indicates the default value of the pricing control attribute at the supplier site level when supplier-controlled pricing for Consignment/Concession ownership model is used within the Merchandising suite of solutions. Valid values are: • R – Retailer • S – Supplier For owned items, the value is always NULL.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
customFlexAttribute		This list holds custom flex attributes for the item supplier's country record.
itemSupplierCountryDimension		This list holds dimension attributes for the item supplier's country record.

Table 5-317 itemSupplierCountryOfManufacture

Name	Data Type	Description
countryId	String	This field holds country ID of manufacturer.
primaryInd	String	This field indicates primary country of manufacturer indicator.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-318 ItemSupplierCountryDimension

Name	Data Type	Description
dimensionObject	String	This field Specific object whose dimensions are specified in this record (e.g. case, pallet, each). The valid values for this column are maintained in code type DIMO.
dimensionObjectDescription	String	This field contains description of the dimension object.
presentationMethod	String	This field describes the packaging (if any) being taken into consideration in the specified dimensions. The valid values for this column are maintained in code type PCKT.
presentationMethodDescription	String	This field contains description of the presentation method.
length	Number	This field contains length of dimension object measured in units specified in terms of the LWH Unit of Measure.
width	Number	This field contains width of dimension object measured in units specified in terms of the LWH Unit of Measure.
height	Number	This field contains height of dimension object measured in units specified in terms of the LWH Unit of Measure.
lwhUom	String	This field contains measurement for length, width, and height.
weight	Number	This field contains weight of dimension object measured in units specified in terms of the Weight Unit of Measure.
netWeight	Number	This field contains net weight of the dimension object (weight without packaging) measured in units specified in terms of the Weight Unit of Measure.
weightUom	String	This field contains unit of measurement for Weight and Net Weight.
liquidVolume	Number	This field contains unit of measurement for volume.
liquidVolumeUom	String	This field contains unit of measurement for liquid volume. Liquid volumes are only convertible to other liquid volumes.
statisticalCube	Number	This field contains statistical value of the dimension object's dimensions to be used for loading purposes.
tareWeight	Number	This field contains amount of weight to be subtracted for packaging materials. Used to calculate the true net weight of the dimension object.
tareType	String	This field indicates whether the tare weight for the dimension object is wet or dry.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-319 ItemSupplierUom

Name	Data Type	Description
uom	String	This field holds unit of measure that the item is being measured in.
value	Number	This field holds value of measure.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-320 itemImage

Name	Data Type	Description
imageName	String	This field specifies name of the image.
imageAddress	String	This field specifies path where the image file is stored.
imageType	String	This field contains the type of the image of the item. The valid values for this column are maintained in code type IITD.
primaryImageInd	String	This field indicates whether this record is the primary image of the item or not. Valid values are Y - Yes and N - No.
displayPriority	Number	This field specifies display sequence order of images associated to the item per priority.
imageDescription	String	This field contains the description associated with the image of the item.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-321 itemSeason

Name	Data Type	Description
seasonId	Number	This field contains the season identifier.
phaseId	Number	This field contains the phase identifier.
sequenceNo	Number	This field contains a sequence number that combined with the item number will make each record unique.
diffId	String	This field holds a value for group/differentiator combination records only.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-322 referenceItem

Name	Data Type	Description
referenceItem	String	This field holds the unique identifier for the item.
primaryInd	String	This field indicates if the sub-transaction level item is designated as the primary sub-transaction level item.
formatId	String	This field will hold the format id that corresponds to the item's variable UPC. This value is only used for items with variable UPCs.
prefix	Number	This field holds the prefix for variable weight UPCs. The prefix determines the format of the eventual UPC and will be used to decode variable weight UPCs that are uploaded from the POS.
itemNoType	String	This field holds code specifying what type of the item is. The valid values for this column are maintained in code type UPCT.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-323 itemUDA

Name	Data Type	Description
udaLOV		This list will hold attributes for the item's uda list of values.
udaFreeform		This list will hold attributes for the item's uda free form.
udaDate		This list will hold attributes for the item's uda date.

Table 5-324 udaLOV

Name	Data Type	Description
udaId	Number	This field contains a number identifying the user-defined attribute.
udaDescription	String	This field contains description of user-defined attribute.
udaValue	Number	This field contains the unique identifier of the Attribute Group being added or delete to the item list.
udaValueDescription	String	This field contains the value of the Attribute Group.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-325 udaFreeform

Name	Data Type	Description
udaId	Number	This field contains a number identifying the user-defined attribute.
udaDescription	String	This field contains description of user-defined attribute.
udaText	String	This field contains the text value of the user-defined attribute for the item.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-326 udaDate

Name	Data Type	Description
udaId	Number	This field contains a number identifying the user-defined attribute.
udaDescription	String	This field contains description of user-defined attribute.
udaDate	String	This field contains the effective date for the udaId.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-327 itemBOM

Name	Data Type	Description
componentItem	String	This field specifies unique identifier for the component item.
packQuantity	Number	his field specifies contains the quantity of each item in the pack item.

Table 5-328 itemTicket

Name	Data Type	Description
ticketTypeId	String	This field uniquely identifies the ticket type which is associated with the item.
ticketTypeDescription	String	This field contains a description of the ticket or label type.
shelfEdgeLabelInd	String	This field contains a description of the ticket or label type.
poPrintType	String	This field indicates when the ticket type for the given item should be printed by default, upon the approval or receipt of the purchase order. Valid values are A and R.
printOnPcInd	String	This field indicates whether this type of ticket should be printed for this item when a permanent price change goes into effect. Valid values in this field are Y - Yes N - No.
ticketOverPercentage	Number	This field contains a percent which indicates the number of tickets which should be printed for a given event. If the event causing tickets to be printed is approving or receiving a purchase order, then this field indicates the quantity of tickets which should be printed greater than the quantity of the purchase order. If the event causing the tickets to be printed is a permanent price change, this field would indicate the quantity of tickets which should be printed greater than the stock on hand.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
customFlexAttribute		This list holds custom flex attributes for the item ticket record.

Table 5-329 relatedItem

Name	Data Type	Description
relationshipId	Number	A system generated numeric field that uniquely identifies the relationship record.
relationshipName	String	This field holds user entered name of the relationship.
relationshipType	String	This field holds user entered name of the relationship.
mandatoryInd	String	Indicates whether the relationship is mandatory or not. Valid values are Y - Yes, N - No.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
details		This list holds the related item detail records.

Table 5-330 relatedItem (details)

Name	Data Type	Description
relatedItem	String	Item for which related items are defined. Valid transaction level/sellable item. Multiple items can be defined for a relationship.
priority	Number	This field indicates relationship priority. Applicable only for relationship type Substitute.
startDate	String	The related item can be used on transactions starting this date.
endDate	String	This related item can be used on transactions until this date. A value of null means that it is always effective.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-331 hts

Name	Data Type	Description
hts	string	The unique identifier for the Harmonized Tariff Schedule code.
importCountry	String	The unique identifier for the country that the item will be imported into.
originCountry	String	The country where the item was manufactured or significantly altered.
effectFrom	String	The date from which the Item/HTS relationship is valid. This field is used to maintain historical information related to the Item/HTS relationship.
effectTo	String	The date until when the Item/HTS relationship is valid. This field is used to maintain historical information related to the item/HTS relationship.
clearingZoneId	String	The concept of 'clearing zone' represents a country's zone-level point of entry of goods. This field holds the Clearing Zone ID for the effective HTS code. Clearing zones are defined by import country.
status	String	Used to indicate the status of the Item/HTS relationship.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
assessments	Collection of Object	References a collection of assessments associated to the item HTS.

Table 5-332 hts (assessments)

Name	Data Type	Description
componentId	String	The code representing the specific assessment component.
computationValueBase	String	The Computation Value Base representing the base value for calculating the assessment.
componentRate	Number	The rate to be charged against the calculation base. This field will hold a percentage value if the Calculation basis of the Component is Value or a monetary amount if the Calculation Basis is Specific.
perCount	Number	A count indicating the amount of the Per Count Unit of Measure to which the rate applies. This column is only used for specific (per-unit) assessments.
perCountUom	String	The unit of measure in which the Per Count is specified. This column is only used from specific (per-unit) assessments.
estimatedAssessmentValue	Number	Contains the calculated value of the component.
componentCurrency	String	Contains the currency of the component.
nominationFlag1	String	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 1), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 1), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 1). For example, if cost component ABC has a + in Nomination Flag 1, then all CVBs that include Nomination Flag 1 will include this cost component value in their calculation basis.
inDuty	String	If Import Management is enabled in Merchandising (i. e. system_options. import_ind = Y), the inDuty flag is used to indicate if the value of the cost component should be included in total duty.
nominationFlag3	String	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 3), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 3), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 3). For example, if cost component ABC has a + in Nomination Flag 3, then all CVBs that include Nomination Flag 3 will include this cost component value in their calculation basis.
inExpense	String	The inExpense flag is used to indicate if the value of the cost component should be included in total expenses.
inAlc	String	The inALC flag is used for cost components where the retailer does not expect to receive an actual value for the charge via an obligation or customs entry. The inALC flag allows the value of the cost component to be included in ALC via direct nomination and indicates to the system that the estimated value on the order should be used as the actual value as well because no other actual will be provided.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-333 expense

Name	Data Type	Description
supplier	String	The unique identifier for the supplier.
countryOfSourcing	Number	The country where the item was manufactured or significantly altered.
ladingPort	String	The final destination lading port of the item if the Expense Type is Country.
dischargePort	String	The port where the item will enter the importing country.
costZoneGroupId	Number	This field holds the items Zone Group, it is stored here for performance reasons.
costZoneId	Number	The final destination zone of the item if the Expense Type is Zone.
baseExpenseInd	String	Indicates whether or not this Set of Expenses is also the base Set of Expenses.
componentId	String	The code representing the specific expense component.
computationValueBase	String	The Computation Value Base representing the base value for calculating the expense.
componentRate	Number	The rate to be charged against the calculation base. This field will hold a percentage value if the Calculation basis of the Component is Value or a monetary amount if the Calculation Basis is Specific.
perCount	Number	A count indicating the amount of the Per Count Unit of Measure to which the rate applies. This column is only used for specific (per-unit) expenses.
perCountUom	String	The unit of measure in which the Per Count is specified. This column is only used from specific (per-unit) expenses.
estimatedAssessmentValue	Number	Contains the calculated value of the component.
componentCurrency	String	Contains the currency of the expense.
nominationFlag1	String	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 1), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 1), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 1). For example, if cost component ABC has a + in Nomination Flag 1, then all CVBs that include Nomination Flag 1 will include this cost component value in their calculation basis.
inDuty	String	If Import Management is enabled in Merchandising (i. e. system_options. import_ind = Y), the inDuty flag is used to indicate if the value of the cost component should be included in total duty.
nominationFlag3	String	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 3), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 3), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 3). For example, if cost component ABC has a + in Nomination Flag 3, then all CVBs that include Nomination Flag 3 will include this cost component value in their calculation basis.
inExpense	String	The inExpense flag is used to indicate if the value of the cost component should be included in total expenses.
inAlc	String	The inALC flag is used for cost components where the retailer does not expect to receive an actual value for the charge via an obligation or customs entry. The inALC flag allows the value of the cost component to be included in ALC via direct nomination and indicates to the system that the estimated value on the order should be used as the actual value as well because no other actual will be provided.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-334 Elements in JSON Output

Elements	Description
items	The first element is named as items and contains a number of child elements. Each child element corresponds to a row in the result set generated by the query.
hasMore	This is dependent on limit value. If the total rows are more than the limit defined, then hasMore will be set to true else false.
limit	This is used to limit the rows to control the paging of result data. Based on the limit, next and previous links are displayed. For example: If the limit is set to 25, internal it tries to fetch 26 rows. If 26th row exists, then 25 rows are returned along with a "next" link else no links would be added to the JSON response.
links	“self”: This contains URI pointing to current page. “next”: This contains URI pointing to the next page of results.

Table Impact

The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
ITEM_MASTER_CFA_EXT	Yes	No	No	No
ITEM_SUPPLIER_CFA_EXT	Yes	No	No	No
ITEM_SUPP_COUNTRY_CFA_EXT	Yes	No	No	No
ITEM_SUPP_COUNTRY_LOC_CFA_EXT	Yes	No	No	No
MERCHAPI_EXT_ITEM	Yes	Yes	Yes	Yes
V_MERCHAPI_EXT_ITEM_JSON	Yes	No	No	No
ICL_RMS_ITEM_MASTER	Yes	No	Yes	Yes
ICL_RMS_ITEM_SUPPLIER	Yes	No	Yes	Yes
ICL_RMS_ITEM_SUPP_UOM	Yes	No	Yes	Yes
ICL_RMS_ITEM_SUPP_CTRY	Yes	No	Yes	Yes
ICL_RMS_ITEM_SUPP_CTRY_DIM	Yes	No	Yes	Yes
ICL_RMS_ITEM_SUPP_MANU_CTRY	Yes	No	Yes	Yes
ICL_RMS_ITEM_TICKET	Yes	No	Yes	Yes
ICL_RMS_UDA_ITEM_DATE	Yes	No	Yes	Yes
ICL_RMS_UDA_ITEM_LOV	Yes	No	Yes	Yes
ICL_RMS_UDA_ITEM_FF	Yes	No	Yes	Yes
ICL_RMS_ITEM_IMAGE	Yes	No	Yes	Yes
ICL_RMS_ITEM_SEASONS	Yes	No	Yes	Yes
ICL_RMS_RELATED_ITEM	No	Yes	No	No
ICL_RMS_ITEM_HTS	Yes	No	Yes	Yes
ICL_RMS_ITEM_EXP	Yes	No	Yes	Yes

Get Item Details for Provided Item

Endpoints

MerchIntegrations/services/foundation/item
MerchIntegrations/services/foundation/item/{itemId}

Functional Area

Items

Business Overview

This service can be used by external applications to get all or selected items and its details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/item?itemLevel={itemlevel}&tranLevel={tranLevel}&deptId={deptId}&classId={classId}subclassId={subclassId}&status={status}&itemType={itemType}&inventoryInd={inventoryInd}&supplier={supplier}&referenceItem={referenceItem}&offsetkey={offsetkey}&limit={limit}&since={since}&before={before}

/MerchIntegrations/services/foundation/item/{itemId}

Input Parameters

Table 5-335 /MerchIntegrations/services/foundation/item

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
itemLevel	No	String	Item’s Level. Valid values are 1, 2 and 3.
tranLevel	No	String	Item’s Transaction Level. Valid Values are 1,2 and 3.
deptId	No	String	Department ID.
classId	No	String	Class ID.
subclassId	No	String	Subclass ID.
status	No	String	Status of the item. At this time, will always contain ‘A’ as only approved items are interfaced.
itemType	No	String	Item Type. Valid values are S - Simple Pack, C - Complex Pack, A - Deposit Container, E - Deposit Contents, T - Deposit Returned Item, Z - Deposit Crate, O - Transformed Orderable, L - Transformed Sellable, R - Regular Item.
inventoryInd	No	String	Inventoried. Must be 'Y' or 'N'.
supplier	No	String	Supplier ID.
referenceItem	No	String	Reference Item.
offsetkey	No	String	Offset Key. Valid Value is an Item Id.
limit	No	String	Pagination limit. Default Value is 1000.

Table 5-336 /MerchIntegrations/services/foundation/item/{itemId}

Parameter Name	Required	Data Type	Description
itemId	Yes	Number	Item Number.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE and DELETE.
item	String	This field specifies unique alphanumeric value that identifies the item.
itemNumberType	String	Indicates the type of the item ID, for example UPC-12. The valid values for this column are maintained in code type UPCT.
status	String	This field specifies status of the item.
itemLevel	Number	This field specifies Number indicating which of the three levels the item resides. The item level determines if the item stands alone or if it is part of a family of related items. The item level also determines how the item may be used throughout the system.
tranLevel	Number	This field specifies Number indicating which of the three levels transactions occur for the item's group. The transaction level is the level at which the item's inventory is tracked in the system. The transaction level item will be counted, transferred, shipped, etc. The transaction level may be at the current item or up to 2 levels above or below the current item. Only one level of the hierarchy of an item family may contain transaction level items.
itemDescription	String	This field specifies long description of the item. This description is used throughout the system to help online users identify the item. For items that have parents, this description will default to the parent’s description plus any differentiators. For items without parents this description will default to null.
shortDescription	String	This field specifies shortened description of the item. This description is the default for downloading to the POS. For items that have parents, this description will default to the parent's short description. For items without parents, this description will default to null.
itemDescriptionUppercase	String	This field specifies all upper-case description of the item (same as upper(itemDescription). This field is not displayed in the on-line item maintenance dialog but is used in item list of value search processing throughout the system.
itemDescriptionSecondary	String	This field specifies secondary descriptions of the item. This field can only be populated when secondary_desc_ind on the system options is Y.
itemParent	String	This field specifies alphanumeric value that uniquely identifies the item/group at the level above the item.
itemGrandparent	String	This field specifies alphanumeric value that uniquely identifies the item/group at two levels above the item.
sellableInd	String	This field indicates if the item can be sold.
orderableInd	String	This field indicates if the item can be ordered.
inventoryInd	String	This field indicates whether the retailer intends to maintain inventory of the item. Non-inventory items cannot be put on any transactions except sales.
packInd	String	This field indicates if the item is a pack. A pack item is a collection of items that may be either ordered or sold as a unit. Packs require details (i.e., component items and quantities, etc.) that other items do not. This field is required by the database.
simplePackInd	String	This field indicates if pack item is a simple pack or not. This field will only be available if the item is a pack item. A simple pack is an item whose components are all the same item (i.e., a six pack of cola, etc). Valid values are - Yes, this item is a simple pack; N - No if this is not a simple pack.
containsInnerInd	String	This field indicates if pack item contains inner packs. Vendor packs will never contain inner packs and this field will be defaulted to 'N'. This field will only be available if the item is a pack item. Valid values are Y - Yes, this pack contains inner packs; N - No, this pack does not contain inner packs.
dept	Number	This field specifies number identifying the department to which the item is attached. The item's department will be the same as that of its parent (and, by transitivity, to that of its grandparent).
deptName	String	This field contains the name of the department.
class	Number	Number identifying the class to which the item is attached.
className	String	This field contains the name of the class.
uniqueClassId	Number	This field uniquely identify the class which the item belongs to. Class is not unique ID the merchandise hierarchy. The combination of Dept/Class is unique but requires use of a composite key. The composite key is generally used in user interfaces. The unique ID can be used in back-end processing or in systems that cannot have a composite key in the merchandise hierarchy.
subclass	Number	This field specifies number identifying the subclass to which the item is attached. The item's subclass will be the same as that of its parent (and, by transitivity, to that of its grandparent). Valid values for this field are located on the subclass table.
subclassName	String	This field contains the name of the subclass.
uniqueSubclassId	Number	This field uniquely identifies the subclass which the item belongs to. Subclass is not unique ID the merchandise hierarchy. The combination of Dept/Class/Subclass is unique but requires use of a composite key. The unique ID can be used in back-end processing or in systems that cannot have a composite key in the merchandise hierarchy.
unitRetail	Number	This field holds the unit retail in the standard unit of measure for the item/zone combination. This field is stored in the local currency.
variableUpcFormatId	String	This field will hold the format ID that corresponds to the item's variable UPC. This value is only used for items with variable UPCs.
variableWeightUpcPrefix	Number	This field holds the prefix for variable weight UPCs. The prefix determines the format of the eventual UPC and will be used to decode variable weight UPCs that are uploaded from the POS. It is the client’s responsibility to download this value to their POS system.
diff1	String	This field contains diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e., Men's pant sizes) or a value (6 oz). For an item that is not a parent, this field may contain a value (34X34, Red, etc.). Valid values are found on the diff_group and diff_id tables.
diff1Type	String	This field will hold a value of all possible differential types. (for example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). The valid values for this column are maintained in code type 'DIFF' and on the diff_type table.
diff2	String	This field contains diff_group or diff_id that differentiates the current item from its itemParent.
diff2Type	String	This field will hold a value of all possible differential types. (for example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). The valid values for this column are maintained in code type 'DIFF' and on the diff_type table.
diff3	String	This field contains diff_group or diff_id that differentiates the current item from its itemParent.
diff3Type	String	This field will hold a value of all possible differential types. (For example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). The valid values for this column are maintained in code type 'DIFF' and on the diff_type table.
diff4	String	This field contains diff_group or diff_id that differentiates the current item from its itemParent.
diff4Type	String	This field will hold a value of all possible differential types. (For example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). The valid values for this column are maintained in code type 'DIFF' and on the diff_type table.
costZoneGroupId	Number	This field contains cost zone group associated with the item. This field is only required when elc_ind (landed cost indicator) is set to 'Y' on the system_options table.
standardUom	String	This field contains unit of measure in which stock of the item is tracked at a corporate level.
uomConversionFactor	Number	This field contains Conversion factor between an 'Each' and the standard_uom when the standard_uom is not in the quantity class.
packageSize	Number	This field holds the size of the product printed on any packaging.
packageUom	String	This field holds the unit of measure associated with the package size. This field is used for reporting purposes and by Retek Price Management to determine same sized and different sized items.
merchandiseInd	String	This field indicates if the item is a merchandise item (Y, N).
storeOrderMultiple	String	This field indicates Merchandise shipped from the warehouses to the stores must be specified in this unit type. Valid values are C - Cases; I - Inner; E - Eaches.
forecastInd	String	This field indicates if this item will be interfaced to an external forecasting system (Y, N).
manufacturerRecommendedRetail	Number	This field contains manufacturer's recommended retail price for the item. Used for informational purposes only. This field is stored in the primary currency.
manufacturerRetailCurrencyCode	String	The field indicates the currency code of the Manufacturer's retail price.
originalRetail	Number	The field indicated the original retail price of the item per unit. This field is stored in the primary currency.
originalRetailCurrencyCode	String	The field indicates the currency code of the original retail price.
retailLabelType	String	This field indicates any special label type associated with an item (i.e., pre-priced or cents off).
retailLabelTypeDescription	String	Contains the retail label type description corresponding to the retailLabelType value.
retailLabelValue	Number	This field represents the value associated with the retail label type.
handlingTemperature	String	Holds the temperature information associated with the item. The valid values for this column are maintained in code type 'HTMP'.
handlingTemperatureDescription	String	Contains the Handling temperature description corresponding to the handlingTemperature value.
handlingSensitivity	String	Holds the handling sensitivity information associated with the item. The valid values for this column are maintained in code type 'HSEN'.
handlingSensitivityDescription	String	Contains the Handling sensitivity description corresponding to the handlingSensitivity value.
catchWeightInd	String	Indicates whether the item should be weighed when it arrives at a location. Valid values for this field are 'Y' and 'N'.
catchWeightType	String	The field will hold catch weight type for a simple pack catch weight item. The value is based on the component items orderType and saleType: 2 - orderType - Variable Weight, saleType - Loose Weight 4 - orderType - Variable Weight, saleType - Variable Weight Each.
catchWeightUom	String	The field indicates the UOM for Catchweight Items.
orderType	String	The field determines how catch weight items are ordered. Valid values are F - fixed weight V - Variable weight. The valid values for this column are maintained in code type ORDT.
saleType	String	The field indicates the method of how catch weight items are sold in store locations. Valid values are V - variable weight each L - Loose weight. The valid values for this column are maintained in code type STPE.
wasteType	String	The field identifies the wastage type as either sales or spoilage wastage. Valid values are SP - spoilage; and SL - Sales.
wasteTypeDescription	String	The field contains the Waste Type description corresponding to the wasteType value.
averageWastePercentage	Number	The field indicates average percent of wastage for the item over its shelf life. Used in inflating the retail price for wastage items.
defaultWastePercentage	Number	The field indicates default daily wastage percent for spoilage type wastage items. This value will default to all item locations and represents the average amount of wastage that occurs on a daily basis.
constantDimensionInd	String	The field indicates that the dimensions of the product are always the same, regardless of the supplier. If this field is Y, the dimensions for all suppliers will be defaulted to the primary supplier/primary country dimensions. Editing of dimensions for the item will only be allowed for the primary supplier/primary country.
packType	String	The field indicates if pack item is a vendor pack or a buyer pack. Valid values are V - Vendor; B - Buyer.
orderAsType	String	This field indicates if pack item is receivable at the component level or at the pack level (for a buyer pack only). Valid Values are E - Eaches (component level) P - Pack (buyer pack only).
comments	String	The field holds any comments associated with the item.
itemServiceLevel	String	The field Holds a value that restricts the type of shipment methods that RCOM can select for an item.
giftWrapInd	String	This field will contain a value of 'Y' if the item is eligible to be gift wrapped.
shipAloneInd	String	This field will contain a value of 'Y' if the item should be shipped to the customer is a separate package versus being grouped together in a box.
brandName	String	This field contains the brand associated to an item.
brandDescription	String	The field contains the brand description associated to an item.
perishableInd	String	A grocery item attribute used to indicate whether an item is perishable or not.
itemTransformInd	String	The field show that an item is associated with an item transformation. The item will be either the sellable item or orderable item in the transformation process.
depositItemType	String	The field contains deposit item component type. A NULL value in this field indicates that this item is not part of a deposit item relationship. The possible values are - E - Contents A - Container Z - Crate T - Returned Item (Empty bottle) P - Complex pack (with deposit items) The Returned item is flagged only to enable these items to be mapped to a separate GL account if required.
containerItem	String	The field holds the container item number for a contents item. This field is only populated and required if the depositItemType - E.
depositInPricePerUom	String	This field indicates if the deposit amount is included in the price per UOM calculation for a contents item ticket. This value is only required if the depositItemType - E. Valid values are I - Include deposit amount E - Exclude deposit amount.
notionalPackInd	String	The field indicates to the Store Inventory System if a sellable simple pack needs to be broken down to its component item.
sohInquiryAtPackInd	String	The field indicates to the Store Inventory System if a notional simple pack item's inventory should be displayed in packs.
purchaseType	String	The field indicates if an item is a normal, consignment or concession item - 'N' for normal, 'S' for consignment, 'C' for concession.
productClassification	String	The field contains item combinability codes (The valid values for this column are maintained in code type 'PCLA') which provide a way to define which items can be combined (packed or boxed) together.
productClassificationDescription	String	This field will hold the description of the product classification.
itemAggregateInd	String	This field holds indicator to aggregate inventory and sales for the item. Currently, this indicator is used by allocation and MFP to aggregate inventory for items. For staple items this indictor should be N.
diff1AggregateInd	String	This field holds indicator for the corresponding diff. Indicator to aggregate inventory and sales for an item at Parent/Diff level (e.g., Style/Color or Style/Size.
diff2AggregateInd	String	This field holds indicator for the corresponding diff. Indicator to aggregate inventory and sales for an item at Parent/Diff level (e.g., Style/Color or Style/Size.
diff3AggregateInd	String	This field holds indicator for the corresponding diff. Indicator to aggregate inventory and sales for an item at Parent/Diff level (e.g., Style/Color or Style/Size.
diff4AggregateInd	String	This field holds indicator for the corresponding diff. Indicator to aggregate inventory and sales for an item at Parent/Diff level (e.g., Style/Color or Style/Size.
diff1Level	String	This field will contain either ID or GROUP, based on whether the diff1 is a group diff or a diff id.
diff1Description	String	This field will hold the description of differentiator.
diff2Level	String	This field will contain either ID or GROUP, based on whether the diff1 is a group diff or a diff id.
diff2Description	String	This field will hold the description of differentiator.
diff3Level	String	This field will contain either ID or GROUP, based on whether the diff1 is a group diff or a diff id.
diff3Description	String	This field will hold the description of differentiator.
diff4Level	String	This field will contain either ID or GROUP, based on whether the diff1 is a group diff or a diff id.
diff4Description	String	This field will hold the description of differentiator.
primaryImageUrl	String	This field will hold the primary item image URL.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
customFlexAttribute		This list holds custom flex attributes for the item.
itemTranslation		This list holds translation attributes for the item.
itemSupplier		This list holds supplier's attributes for the item.
itemUda		This list holds uda attributes for the item.
itemImage		This list holds image attributes for the item.
referenceItem		This list holds the attributes of the reference item.
itemBOM		This list holds pack attributes for the item.
itemTicket		This list holds ticket attributes for the item.
relatedItem		This list holds related item's attributes for the item.
cacheTimestamp	String	This field specifies date and time when the item record was last maintained.

Table 5-337 customFlexAttribute

Name	Data Type	Description
name	String	This field will hold the custom flex attribute name.
value	String	This field will hold the numeric or string value of the custom flex attribute.
valueDate	String	This field will hold the date value of the custom flex attribute.
createDateTime	String	This field will hold the date time when the custom flex attribute was inserted.
updateDateTime	String	This field will hold the date time when the custom flex attribute was last updated.

Table 5-338 itemTranslation

Name	Data Type	Description
languageCode	Number	This field contains the language in which the translated text is maintained
languageName	String	This field contains description of language code in which the translated text is maintained
isoCode	String	This field will hold the ISO code associated with the given language.
itemDescription	String	This field will hold the ISO code associated with the given language.
itemDescriptionSecondary	String	This field holds long description of the item.
shortDescription	String	This field holds shortened description of the item. This description is the default for downloading to the POS. For items that have parents, this description will default to the parents short description. For items without parents, this description will default to null
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-339 itemSupplier

Name	Data Type	Description
supplier	Number	This field specifies unique identifier for the supplier.
primarySupplierInd	String	This field indicates whether this supplier is the primary supplier for the item. An item can have one and only one primary supplier.
vpn	String	This field contains the Vendor Product Number for the Item/Supplier.
supplierLabel	String	This field contains the supplier label. It will only be populated if item is a parent item.
supplierDiff1	String	This field contains the first supplier differentiator and/or description. This field may only contain a value for items with an item parent.
supplierDiff2	String	This field contains the second supplier differentiator and/or description. This field may only contain a value for items with an item parent.
supplierDiff3	String	This field contains the third supplier differentiator and/or description. This field may only contain a value for items with an item parent.
supplierDiff4	String	This field contains the fourth supplier differentiator and/or description. This field may only contain a value for items with an item parent.
palletName	String	This field specifies code referencing the name used to refer to the pallet.
caseName	String	This field specifies code referencing the name used to refer to the case.
innerName	String	This field specifies code referencing the name used to refer to the inner.
supplierDiscontinueDate	String	This field specifies the date when the supplier discontinues an item.
directShipInd	String	This field indicates that any item associated with this supplier is eligible for a direct shipment from the supplier to the customer.
primaryCaseSize	String	This field indicates the primary case size for the item supplier when an orderable item is configured for informal case types.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
customFlexAttribute		This list holds custom flex attributes for the item's supplier record.
itemSupplierCountry		This list holds attributes for the item supplier's country record.
itemSupplierCountryOfManufacture		This list holds attributes for the item supplier's country of manufacturing record
itemSupplierUom		This list holds attributes for the item supplier’s UOM record.

Table 5-340 itemSupplierCountry

Name	Data Type	Description
originCountry	String	This field specifies country where the item was manufactured or significantly altered.
primarySupplierInd	String	This field indicates whether this supplier is the primary supplier for the item. Each item can have one and only one primary supplier.
primaryCountryInd	String	This field indicates whether this country is the primary country for the item/supplier. Each item/supplier combination can have one and only one primary country.
unitCost	Number	This field contains the current corporate unit cost for the item from the supplier /origin country.
leadTime	Number	This field contains the number of days that will elapse between the date an order is written and the delivery to the store or warehouse from the supplier.
pickupLeadTime	Number	This field contains the time that will be taken to get the item from the supplier to the initial receiving location.
supplierPackSize	Number	This field contains the quantity that orders must be placed in multiples of for the supplier for the item.
innerPackSize	Number	This field contains the break pack size for this item from the supplier.
roundLevel	String	This field is used to determine how order quantities will be rounded to case, layer and pallet.
minimumOrderQuantity	Number	This field contains the minimum quantity that can be ordered at once from the supplier for the item.
maximumOrderQuantity	Number	This field contains the maximum quantity that can be ordered at once from the supplier for the item.
packingMethod	String	This field indicates whether the packing method for the item in the container is flat or hanging.
defaultUop	String	This field contains the default unit of purchase for the item/supplier/country. Valid values include 'C' - Case and 'P' – Pallet.
ti	Number	This field contains number of shipping units (cases) that make up one tier of the pallet. Multiply TI x HI to get total number of units (cases) in a Pallet.
hi	Number	This field contains number of tiers that make up a complete pallet. Multiply TI x HI to get total number of units (cases) in a Pallet.
costUom	String	This field contains cost UOM is held to allow costs to be managed in a separate UOM to the standard UOM.
toleranceType	String	The unit of tolerance for catch weight simple packs. Valid values are: 'A' - actual 'P' - percent.
maximumTolerance	Number	The maximum tolerance value for the catch weight simple pack.
minimumTolerance	Number	The minimum tolerance value for the catch weight simple pack.
roundToInnerPercentage	Number	This field will hold the Inner Rounding Threshold value. During rounding, this value is used to determine whether to round partial Inner quantities up or down. If the Inner-fraction in question is less than the Threshold proportion, it is rounded down; if not, it is rounded up.
roundToCasePercentage	Number	This field will hold the Case Rounding Threshold value. During rounding, this value is used to determine whether to round partial Case quantities up or down. If the Case-fraction in question is less than the Threshold proportion, it is rounded down; if not, it is rounded up.
roundToLayerPercentage	Number	This field will hold the Layer Rounding Threshold value. During rounding, this value is used to determine whether to round partial Layer quantities up or down. If the Layer-fraction in question is less than the Threshold proportion, it is rounded down; if not, it is rounded up.
roundToPalletPercentage	Number	This field will hold the Pallet Rounding Threshold value. During rounding, this value is used to determine whether to round partial Pallet quantities up or down. If the Pallet -fraction in question is less than the Threshold proportion, it is rounded down; if not, it is rounded up.
supplierHierarchyType1	String	This field identifies partner type of supplier hierarchy level 1. This field will always have the partner type S1 which indicates manufacturer.
supplierHierarchyLevel1	String	This field contains highest level of supplier hierarchy which is there to indicate a partner, such as a manufacturer, in the supply chain that gives rebates to the retailer.
supplierHierarchyType2	String	This field identifies partner type of supplier hierarchy level 2. This field will always have the partner type S2 which indicates distributor.
supplierHierarchyLevel2	String	This field contains second highest level of supplier hierarchy which is there to indicate a partner, such as a distributor, in the supply chain that gives rebates to the retailer.
supplierHierarchyType3	String	This field identifies partner type of supplier hierarchy level 3. This field will always have the partner type S3 which indicates wholesaler.
supplierHierarchyLevel3	String	Third highest level of supplier hierarchy which is there to indicate a partner, such as a wholesaler, in the supply chain that gives rebates to the retailer.
negotiatedItemCost	Number	This field will hold the supplier negotiated item cost for the primary delivery country of the item. Once a location is associated with the item, the primary locations negotiated item cost will be stored in this field.
extendedBaseCost	Number	This field will hold the extended base cost for the primary delivery country of the item. Once a location is associated with the item, the primary locations extended base cost will be stored in this field. Extended base cost is the cost inclusive of all the taxes that affect the WAC. In case of GTAX, Extended Base Cost = Base Cost + Non-recoverable taxes. In case of VAT, Extended Base Cost = Base Cost.
inclusiveCost	Number	This field will hold the inclusive cost for the primary delivery country of the item. Once a location is associated with the item, the primary locations inclusive cost will be stored in this field. This cost will have both the recoverable and non-recoverable taxes included. In case of GTAX, Inclusive Cost = Base Cost + Non-recoverable taxes + Recoverable Taxes. In case of VAT, Inclusive Cost = Base Cost + VAT.
baseCost	Number	This field will hold the tax exclusive cost of the item.
purchaseType	Number	This field contains a code to indicate whether the item is normal merchandise (i.e., owned by the retailer), consignment stock or a concession item. Valid values are 0 - Owned, 1 - Consignment, 2 - Concession.
calculationBasis	String	This field indicates if the cost for the consignment/concession item will be managed either based on cost per unit or as a percentage of retail. Valid values are C - Cost per Unit, P - Purchase Rate.
purchaseRate	Number	This field contains the percentage of the retail price which will determine the cost paid to the supplier for a consignment or concession item.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
customFlexAttribute		This list holds custom flex attributes for the item supplier's country record.
itemSupplierCountryDimension		This list holds dimension attributes for the item supplier's country record.

Table 5-341 itemSupplierCountryOfManufacture

Name	Data Type	Description
countryId	String	This field holds country ID of manufacturer.
primaryInd	String	This field indicates primary country of manufacturer indicator.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-342 ItemSupplierCountryDimension

Name	Data Type	Description
dimensionObject	String	This field Specific object whose dimensions are specified in this record (e.g. case, pallet, each). The valid values for this column are maintained in code type DIMO.
dimensionObjectDescription	String	This field contains description of the dimension object.
presentationMethod	String	This field describes the packaging (if any) being taken into consideration in the specified dimensions. The valid values for this column are maintained in code type PCKT.
presentationMethodDescription	String	This field contains description of the presentation method.
length	Number	This field contains length of dimension object measured in units specified in terms of the LWH Unit of Measure.
width	Number	This field contains width of dimension object measured in units specified in terms of the LWH Unit of Measure.
height	Number	This field contains height of dimension object measured in units specified in terms of the LWH Unit of Measure.
lwhUom	String	This field contains measurement for length, width, and height.
weight	Number	This field contains weight of dimension object measured in units specified in terms of the Weight Unit of Measure.
netWeight	Number	This field contains net weight of the dimension object (weight without packaging) measured in units specified in terms of the Weight Unit of Measure.
weightUom	String	This field contains unit of measurement for Weight and Net Weight.
liquidVolume	Number	This field contains unit of measurement for volume.
liquidVolumeUom	String	This field contains unit of measurement for liquid volume. Liquid volumes are only convertible to other liquid volumes.
statisticalCube	Number	This field contains statistical value of the dimension object's dimensions to be used for loading purposes.
tareWeight	Number	This field contains amount of weight to be subtracted for packaging materials. Used to calculate the true net weight of the dimension object.
tareType	String	This field indicates whether the tare weight for the dimension object is wet or dry.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-343 ItemSupplierUom

Name	Data Type	Description
uom	String	This field holds unit of measure that the item is being measured in.
value	Number	This field holds value of measure.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-344 itemImage

Name	Data Type	Description
imageName	String	This field specifies name of the image.
imageAddress	String	This field specifies path where the image file is stored.
imageType	String	This field contains the type of the image of the item. The valid values for this column are maintained in code type IITD.
primaryImageInd	String	This field indicates whether this record is the primary image of the item or not. Valid values are Y - Yes and N - No.
displayPriority	Number	This field specifies display sequence order of images associated to the item per priority.
imageDescription	String	This field contains the description associated with the image of the item.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-345 itemSeason

Name	Data Type	Description
seasonId	Number	This field contains the season identifier.
phaseId	Number	This field contains the phase identifier.
sequenceNo	Number	This field contains a sequence number that combined with the item number will make each record unique.
diffId	String	This field holds a value for group/differentiator combination records only.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-346 referenceItem

Name	Data Type	Description
referenceItem	String	This field holds the unique identifier for the item.
primaryInd	String	This field indicates if the sub-transaction level item is designated as the primary sub-transaction level item.
formatId	String	This field will hold the format id that corresponds to the item's variable UPC. This value is only used for items with variable UPCs.
prefix	Number	This field holds the prefix for variable weight UPCs. The prefix determines the format of the eventual UPC and will be used to decode variable weight UPCs that are uploaded from the POS.
itemNoType	String	This field holds code specifying what type of the item is. The valid values for this column are maintained in code type UPCT.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-347 itemUDA

Name	Data Type	Description
udaLOV		This list will hold attributes for the item's uda list of values.
udaFreeform		This list will hold attributes for the item's uda free form.
udaDate		This list will hold attributes for the item's uda date.

Table 5-348 udaLOV

Name	Data Type	Description
udaId	Number	This field contains a number identifying the user-defined attribute.
udaDescription	String	This field contains description of user-defined attribute.
udaValue	Number	This field contains the unique identifier of the Attribute Group being added or delete to the item list.
udaValueDescription	String	This field contains the value of the Attribute Group.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-349 udaFreeform

Name	Data Type	Description
udaId	Number	This field contains a number identifying the user-defined attribute.
udaDescription	String	This field contains description of user-defined attribute.
udaText	String	This field contains the text value of the user-defined attribute for the item.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-350 udaDate

Name	Data Type	Description
udaId	Number	This field contains a number identifying the user-defined attribute.
udaDescription	String	This field contains description of user-defined attribute.
udaDate	String	This field contains the effective date for the udaId.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-351 itemBOM

Name	Data Type	Description
componentItem	String	This field specifies unique identifier for the component item.
packQuantity	Number	his field specifies contains the quantity of each item in the pack item.

Table 5-352 itemTicket

Name	Data Type	Description
ticketTypeId	String	This field uniquely identifies the ticket type which is associated with the item.
ticketTypeDescription	String	This field contains a description of the ticket or label type.
shelfEdgeLabelInd	String	This field contains a description of the ticket or label type.
poPrintType	String	This field indicates when the ticket type for the given item should be printed by default, upon the approval or receipt of the purchase order. Valid values are A and R.
printOnPcInd	String	This field indicates whether this type of ticket should be printed for this item when a permanent price change goes into effect. Valid values in this field are Y - Yes N - No.
ticketOverPercentage	Number	This field contains a percent which indicates the number of tickets which should be printed for a given event. If the event causing tickets to be printed is approving or receiving a purchase order, then this field indicates the quantity of tickets which should be printed greater than the quantity of the purchase order. If the event causing the tickets to be printed is a permanent price change, this field would indicate the quantity of tickets which should be printed greater than the stock on hand.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
customFlexAttribute		This list holds custom flex attributes for the item ticket record.

Table 5-353 relatedItem

Name	Data Type	Description
relationshipId	Number	A system generated numeric field that uniquely identifies the relationship record.
relationshipName	String	This field holds user entered name of the relationship.
relationshipType	String	This field holds user entered name of the relationship.
mandatoryInd	String	Indicates whether the relationship is mandatory or not. Valid values are Y - Yes, N - No.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
details		This list holds the related item detail records.

Table 5-354 relatedItem (details)

Name	Data Type	Description
relatedItem	String	Item for which related items are defined. Valid transaction level/sellable item. Multiple items can be defined for a relationship.
priority	Number	This field indicates relationship priority. Applicable only for relationship type Substitute.
startDate	String	The related item can be used on transactions starting this date.
endDate	String	This related item can be used on transactions until this date. A value of null means that it is always effective.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-355 Elements in JSON Output

Elements	Description
items	The first element is named as items and contains a number of child elements. Each child element corresponds to a row in the result set generated by the query.
hasMore	This is dependent on limit value. If the total rows are more than the limit defined, then hasMore will be set to true else false.
limit	This is used to limit the rows to control the paging of result data. Based on the limit, next and previous links are displayed. For example: If the limit is set to 25, internal it tries to fetch 26 rows. If 26th row exists, then 25 rows are returned along with a "next" link else no links would be added to the JSON response.
links	“self”: This contains URI pointing to current page. “next”: This contains URI pointing to the next page of results.

Example JSON Output:

" {
    "items": [
      {
      "action": "INSERT",
      "item": "100500002",
      "itemNumberType": "ITEM",
      "status": "A",
      "itemLevel": 1,
      "tranLevel": 1,
      "itemDescription": "100500002",
      "shortDescription": "100500002",
      "itemDescriptionUppercase": null,
      "itemDescriptionSecondary": null,
      "itemParent": null,
      "itemGrandparent": null,
      "sellableInd": "Y",
      "orderableInd": "Y",
      "inventoryInd": "Y",
      "packInd": "N",
      "simplePackInd": "N",
      "containsInnerInd": "N",
      "dept": 1414,
      "deptName": "CG Dept new",
      "classId": 1515,
      "class": 1515,
      "className": "CG Class New",
      "uniqueClassId": 10001,
      "subclass": 1616,
      "subclassName": "CG subclass new",
      "uniqueSubclassId": 10001,
      "unitRetail": 12.1,
      "variableUpcFormatId": null,
      "variableWeightUpcPrefix": null,
      "diff1": "BLACK_9665",
      "diff1Type": "C_3688",
      "diff2": "WHITE_7219",
      "diff2Type": "C_6787",
      "diff3": null,
      "diff3Type": null,
      "diff4": null,
      "diff4Type": null,
      "costZoneGroupId": 1000,
      "standardUom": "EA",
      "uomConversionFactor": null,
      "packageSize": 111,
      "packageUom": "KG",
      "merchandiseInd": "Y",
      "storeOrderMultiple": "E",
      "forecastInd": "N",
      "manufacturerRecommendedRetail": null,
      "manufacturerRetailCurrencyCode": "USD",
      "originalRetail": 12.1,
      "originalRetailCurrencyCode": "USD",
      "retailLabelType": null,
      "retailLabelTypeDescription": null,
      "retailLabelValue": null,
      "handlingTemperature": null,
      "handlingTemperatureDescription": null,
      "handlingSensitivity": null,
      "handlingSensitivityDescription": null,
      "catchWeightInd": "N",
      "catchWeightType": null,
      "catchWeightUom": null,
      "orderType": null,
      "saleType": null,
      "wasteType": "SL",
      "wasteTypeDescription": "Sales Wastage",
      "averageWastePercentage": 10,
      "defaultWastePercentage": null,
      "constantDimensionInd": "N",
      "packType": null,
      "orderAsType": null,
      "comments": null,
      "itemServiceLevel": null,
      "giftWrapInd": "N",
      "shipAloneInd": "N",
      "brandName": null,
      "brandDescription": null,
      "perishableInd": "Y",
      "itemTransformInd": "N",
      "depositItemType": null,
      "containerItem": null,
      "depositInPricePerUom": null,
      "notionalPackInd": "N",
      "sohInquiryAtPackInd": "N",
      "purchaseType": null,
      "productClassification": null,
      "productClassificationDescription": null,
      "itemAggregateInd": "N",
      "diff1AggregateInd": "N",
      "diff2AggregateInd": "N",
      "diff3AggregateInd": "N",
      "diff4AggregateInd": "N",
      "diff1Level": "ID",
      "diff1Description": "Auto Black BLACK_9665",
      "diff2Level": "ID",
      "diff2Description": "New White WHITE_7219",
      "diff3Level": null,
      "diff3Description": null,
      "diff4Level": null,
      "diff4Description": null,
      "primaryImageUrl": null,
      "createDateTime": "2021-10-11T18:15:35.000Z",
      "updateDateTime": "2021-10-11T18:19:32.000Z",
      "customFlexAttribute": null,
      "itemTranslation": null,
      "itemSupplier": [
        {
          "supplier": 24241,
          "primarySupplierInd": "Y",
          "vpn": null,
          "supplierLabel": null,
          "consignmentRate": null,
          "supplierDiff1": null,
          "supplierDiff2": null,
          "supplierDiff3": null,
          "supplierDiff4": null,
          "palletName": "PAL",
          "caseName": "CS",
          "innerName": "INR",
          "supplierDiscontinueDate": null,
          "directShipInd": "N",
          "primaryCaseSize": null,
          "createDateTime": "2021-10-11T18:15:35.000Z",
          "updateDateTime": "2021-10-11T18:15:35.000Z",
          "customFlexAttribute": null,
          "itemSupplierCountry": [
            {
              "originCountry": "US",
              "primarySupplierInd": "Y",
              "primaryCountryInd": "Y",
              "unitCost": 10,
              "leadTime": null,
              "pickupLeadTime": null,
              "supplierPackSize": 1,
              "innerPackSize": 1,
              "roundLevel": "C",
              "minimumOrderQuantity": null,
              "maximumOrderQuantity": null,
              "packingMethod": "HANG",
              "defaultUop": "EA",
              "ti": 1,
              "hi": 1,
              "costUom": "EA",
              "toleranceType": null,
              "maximumTolerance": null,
              "minimumTolerance": null,
              "roundToInnerPercentage": 50,
              "roundToCasePercentage": 50,
              "roundToLayerPercentage": 50,
              "roundToPalletPercentage": 50,
              "supplierHierarchyType1": null,
              "supplierHierarchyLevel1": null,
              "supplierHierarchyType2": null,
              "supplierHierarchyLevel2": null,
              "supplierHierarchyType3": null,
              "supplierHierarchyLevel3": null,
              "negotiatedItemCost": null,
              "extendedBaseCost": null,
              "inclusiveCost": null,
              "baseCost": null,
              "purchaseType": 0,
              "calculationBasis": null,
              "purchaseRate": null,
              "createDateTime": "2021-10-11T18:15:35.000Z",
              "updateDateTime": "2021-10-11T18:15:35.000Z",
              "customFlexAttribute": null,
              "itemSupplierCountryDimension": null
            }
          ],
          "itemSupplierCountryOfManufacture": [
            {
              "countryId": "US",
              "primaryInd": "Y",
              "createDateTime": "2021-10-11T18:15:35.000Z",
              "updateDateTime": "2021-10-11T18:15:35.000Z"
            }
          ],
          "itemSupplierUom": null
        }
      ],
      "itemUda": {
        "udaLov": null,
        "udaFreeform": null,
        "udaDate": null
      },
      "itemImage": null,
      "itemSeason": null,
      "referenceItem": [
        {
          "referenceItem": "100450050",
          "primaryInd": "N",
          "formatId": null,
          "prefix": null,
          "itemNoType": "ITEM",
          "createDateTime": "2021-10-11T18:18:18.000Z",
          "updateDateTime": "2021-10-11T18:20:23.000Z"
        },
        {
          "referenceItem": "100450068",
          "primaryInd": "Y",
          "formatId": null,
          "prefix": null,
          "itemNoType": "ITEM",
          "createDateTime": "2021-10-11T18:20:15.000Z",
          "updateDateTime": "2021-10-11T18:20:32.000Z"
        }
      ],
      "itemBOM": null,
      "itemTicket": null,
      "relatedItem": null,
      "cacheTimestamp": "2022-02-15T12:21:17.002Z" 
 }
],
    "hasMore": true,
    "limit": 0,
    "count": 0,
    "links": [
    {
      "href": "https://<hostname>:<portnumber>/MerchIntegrations/services/foundation/item?itemLevel=1&tranLevel=1&deptId=1414&classId=1515&subclassId=1616&limit=1000&since=1970-01-01T00:00:00.001Z&before=2022-03-30T09:49:44.480246+00:00",
      "rel": "self"
    }
  ] 
}"

Table Impact

The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
ITEM_MASTER_CFA_EXT	Yes	No	No	No
ITEM_SUPPLIER_CFA_EXT	Yes	No	No	No
ITEM_SUPP_COUNTRY_CFA_EXT	Yes	No	No	No
ITEM_SUPP_COUNTRY_LOC_CFA_EXT	Yes	No	No	No
MERCHAPI_EXT_ITEM	Yes	Yes	Yes	Yes
V_MERCHAPI_EXT_ITEM_JSON	Yes	No	No	No
ICL_RMS_ITEM_MASTER	Yes	No	Yes	Yes
ICL_RMS_ITEM_SUPPLIER	Yes	No	Yes	Yes
ICL_RMS_ITEM_SUPP_UOM	Yes	No	Yes	Yes
ICL_RMS_ITEM_SUPP_CTRY	Yes	No	Yes	Yes
ICL_RMS_ITEM_SUPP_CTRY_DIM	Yes	No	Yes	Yes
ICL_RMS_ITEM_SUPP_MANU_CTRY	Yes	No	Yes	Yes
ICL_RMS_ITEM_TICKET	Yes	No	Yes	Yes
ICL_RMS_UDA_ITEM_DATE	Yes	No	Yes	Yes
ICL_RMS_UDA_ITEM_LOV	Yes	No	Yes	Yes
ICL_RMS_UDA_ITEM_FF	Yes	No	Yes	Yes
ICL_RMS_ITEM_IMAGE	Yes	No	Yes	Yes
ICL_RMS_ITEM_SEASONS	Yes	No	Yes	Yes
ICL_RMS_RELATED_ITEM	No	Yes	No	No

Get Item Location Details

Endpoints

MerchIntegrations/services/foundation/item/location

Functional Area

Items

Business Overview

This service can be used by external applications to get item-location information for all or selected items from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/item/location /foundation/item/location?limit=1000&item={item}&locationType={locationType}&location={location}&itemLocationStatus={itemLocationStatus}&purchaseType={purchaseType}&tranLevelInd={tranLevelInd}&itemNumberType={itemNumberType}&departmentId={departmentId}&classId={classId}&subclassId={subclassId}&inventoried={inventoried}&sellable={sellable}&orderable={orderable}&offsetkey={offsetkey}}&since={since}&before={before}

Input Parameters

Table 5-356 /MerchIntegrations/services/foundation/item/location

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
item	No	String	Item Number
locationType	No	String	This contains the type of location. Valid values are STORE, WAREHOUSE or EXTERNAL_FINISHER
location	No	String	This field contains numeric identifier of the location in which the item is to be found. This field may contain a store, warehouse or external finisher.
itemLocationStatus	No	String	Current status of item at the store or warehouse. Valid values are: A = Active, item is valid and can be ordered and sold, I = Inactive, item is valid but cannot be ordered or sold, C = Discontinued, item is valid and sellable but no longer orderable, D = Delete, item is invalid and cannot be ordered or sold.
purchaseType	No	String	This field contains a code to indicate whether the item is normal merchandise (i.e. owned by the retailer), consignment stock or a concession item. Valid values are 0 - Owned, 1 - Consignment, 2 - Concession.
tranLevelInd	No	String	Indicates whether the items being searched are at transaction level or not. Valid values are Y and N.
itemNumberType	No	String	Code specifying what type the item is. Valid values for this field are in the code type UPCT on the code_head and code_detail tables.
departmentId	No	String	The number of the department to which the item is attached.
classId	No	String	The number of the class to which the item is attached.
subclassId	No	String	The number of the subclass to which the item is attached.
inventoried	No	String	Indicates if an item holds inventory or not for item transformations. Valid values are: Y = yes and N = no.
sellable	No	String	Indicates if the item can be sold to end consumers. Certain item types like pack items or certain transformable items are configured as non-sellable, as they are not sold to end consumers. Valid values are Y or N.
orderable	No	String	Indicates if the item can be ordered from a supplier. Certain items like sellable packs, certain transformable items, or non-physical items (e.g. services) are configured as non-orderable, as they are not purchased in their sellable form from a supplier. Valid values are Y or N.
offsetkey	No	String	Offset Key. Valid Values are Location type - E, S or W Location type and location Location type, location and item number Ex: E,1001,TestItem
limit	No	String	Pagination limit. Default Value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Output

Name	Data Type			Description
action	String		Action for Item VAT details. Valid Values are INSERT, UPDATE and DELETE.
item	String		This field holds the ID of the item.
itemLevel	Number		This field specifies Number indicating which of the three levels transactions occur for the item's group. The transaction level is the level at which the item's inventory is tracked in the system. The transaction level item will be counted, transferred, shipped, etc. The transaction level may be at the current item or up to 2 levels above or below the current item. Only one level of the hierarchy of an item family may contain transaction level items.
tranLevel	Number		This field specifies Number indicating which of the three levels transactions occur for the item's group. The transaction level is the level at which the item's inventory is tracked in the system. The transaction level item will be counted, transferred, shipped, etc. The transaction level may be at the current item or up to 2 levels above or below the current item. Only one level of the hierarchy of an item family may contain transaction level items.
location	Number	This field contains numeric identifier of the location in which the item is to be found. This field may contain a store, warehouse or external finisher.
locationType	String	This field contains the type of location in which the item is to be found. Valid values are Store (S), Warehouse (W) and External Finisher (E).
status	String	Current status of item at the store or warehouse. Valid values are: A = Active, item is valid and can be ordered and sold, I = Inactive, item is valid but cannot be ordered or sold, C = Discontinued, item is valid and sellable but no longer orderable, D = Delete, item is invalid and cannot be ordered or sold.
physicalWarehouse	Number	This field contains numeric identifier of the physical warehouse in which the item is to be found.
storeType	String	This field indicate whether a particular store is a franchise or company store
stockholdingInd	String		This field indicates whether or not the location can hold stock.
localItemDescription	String		This field specifies selling local description of the item. This field will default to the items description but will be over-ridable. This value will be downloaded to the POS.
localShortDescription	String		Contains the local short description of the item. This field will default to the items short description but will be over-ridable. This value will be downloaded to the POS.
primarySupplier	Number		This field contains the primary supplier of the item at the location
primaryCountry	String		This field contains the primary country of the item at the location
unitCost	Number		This field is the current unit cost of the item for the item/supplier/origin_country combination. This field is stored in the supplier’s currency.
costUom	String		A cost UOM is held to allow costs to be managed in a separate UOM than the standard UOM.
purchaseType	String		This field contains a code to indicate whether the item is normal merchandise (i.e. owned by the retailer), consignment stock or a concession item. Valid values are 0 - Owned, 1 - Consignment, 2 - Concession.
calculationBasis	String		This field indicates if the cost for the consignment/concession item will be managed either based on cost per unit or as a percentage of retail. Valid values are C - Cost per Unit, P - Purchase Rate.
purchaseRate	Number		This column contains the percentage of the retail price which will determine the cost paid to the supplier for a consignment or concession item.
pricingControl	String		This field contains the pricing control of the item which will determine the item price is controlled by Retailer or Supplier when supplier-controlled pricing for Consignment/Concession ownership model is used within the Merchandising suite of solutions. Valid values are: R – Retailer S – Supplier For owned items, the value is always NULL.
receiveAsType	String		This column determines whether the stock on hand for a pack component item or the pack itself will be updated when a pack is received at a warehouse. Valid values are Each (E) or Pack (P). This value is required for all pack items where the location type is Warehouse (W). For vendor packs, this must be set to Pack (P), for buyer packs it can be either Each (E) or Pack (P).
taxableInd	String		This field indicates whether or not the item is taxable at the store. Valid values are:Y = Yes, the item is taxable N = No, the item is not taxable.
sourceMethod	String		This field will be used to specify how the ad-hoc PO/TSF creation process should source the item/location request. If the value is Warehouse, the process will attempt to fill the request by creating a transfer from the warehouse mentioned in the source_wh field. If this warehouse doesn't have enough inventory to fill the request, a purchase order will be created for the item/location's primary supplier. For warehouses, it is used by Oracle Retail Allocation to determine the valid sources and destinations for warehouse to warehouse allocations.
sourceWarehouse	String		This field will be used by the ad-hoc PO/Transfer creation process to determine which warehouse to fill the stores request from. It will also be used by the Allocation process to support warehouse to warehouse allocations. A value will be required in this field if the sourcing method is Warehouse.
unitRetail	Number		This field contains the unit retail price in the standard unit of measure for the item/location combination. This field is stored in the local currency.
sellingUnitRetail	Number		This field contains the unit retail price in the selling unit of measure for the item/location combination. This field is stored in the local currency.
sellingUom	String		This field contains the selling unit of measure for an items single-unit retail.
storePriceInd	String		This field indicates if an item at a particular store location can have the unit retail marked down by the store.
uinType	String		This field contains the unique identification number (UIN) used to identify the instances of the item at the location.
uinLabel	String		This field contains the label for the UIN when displayed in the store system.
captureTime	String		This field indicates when the UIN should be captured for an item during transaction processing.
externalUinInd	String		This Yes/No indicator indicates if UIN is being generated in the external system.
rangedInd	String		This field determines if the location is ranged intentionally by the user for replenishment/selling or incidentally ranged by the Merchandising programs when item is not ranged to a specific location on the transaction.
itemParent	String		This field contains the alphanumeric value that uniquely identifies the item/group at the level above the item.
itemGrandparent	String		This field contains the alphanumeric value that uniquely identifies the item/group two levels above the item.
ti	Number		This field contains the number of shipping units (cases) that make up one tier of a pallet. Multiply TI x HI to get total number of cases for a pallet.
hi	Number		This field contains the number of tiers that make up a complete pallet (height). Multiply TI x HI to get total number of cases for a pallet.
storeOrderMultiple	String		This field contains the multiple in which the item needs to be shipped from a warehouse to the location.
dailyWastePercent	Number		This field contains the average percentage lost from inventory on a daily basis due to natural wastage.
measureOfEach	Number		This field contains the size of an each in terms of the uom_of_price. For example 12 oz. Used in ticketing
measureOfPrice	Number		This field contains the size to be used on the ticket in terms of the uom_of_price. For example, if the user wants the ticket to have the label print the price per ounce, this value would be 1. If the user wanted the price per 100 grams this value would be 100. This is used in ticketing.
uomOfPrice	String		This field contains th unit of measure that will be used on the ticket for this item.
primaryVariant	String		This field is used to address sales of PLUs (i.e. above transaction level items) when inventory is tracked at a lower level (i.e. UPC). This field will only contain a value for items one level higher than the transaction level. Valid choices will be any transaction level item that is a child of this item. In order to select a transaction level item as the primary variant, the item/location relationship must exist at the transaction level. Both the transaction level item (i.e. UPC) and the higher than transcation level item (i.e. PLU) will be sent to the POS to allow the store to sell the PLU. The information sent for the PLU will be the same information sent for the Transaction level item (i.e. UPC).
primaryCostPack	String		This field contains an item number that is a simple pack containing the item in the item column for this record. If populated, the cost of the future cost table will be driven from the simple pack and the deals and cost changes for the simple pack.
inboundHandlingDays	Number		This field indicates the number of inbound handling days for an item at a warehouse type location.
regularUnitRetail	Number		This field holds the unit retail in the standard unit of measure for the item/location (zone) combination. This field is stored in the local currency.
multiUnits	Number		This field contains the multi-units for the item/location (zone) combination.
multiUnitRetail	Number		This field holds the multi-unit retail in the multi-selling unit of measure for the item/location (zone) combination. This field is stored in the local currency.
multiSellingUom	String		This field holds the selling unit of measure for this item/location (zone) combinations multi-unit retail.
clearanceInd	String		Indicates if item is on clearance at the store. Valid values are: Y = Yes, the item is on clearance, N = No, the item is not on clearance.
costingLocation	Number		This field contains the identifier of the costing location for the franchise store. This field may contain a store or a warehouse.
costingLocationType	String		This field holds the type of costing location in the costing location field.
currencyCode	String		This field contains the currency code under which the location operates.
pickupLeadTime	Number		This field contains the time it takes to get the item from the Supplier to the Initial Receiving Location. This value will be defaulted to the item_supp_country_loc pickup lead time field. The ordering dialog will reference the item/supplier/country/location pickup lead time as the value may vary by location.
rfidInd	String		This field allows the retailer to specify if the item should be RFID tagged or not.
primaryReplenishmentSupplier	Number		This field contains the numeric identifier of the supplier from which the specified location will source the replenishment demand for the specified item location. Used for items on Direct to Store/Warehouse or Cross-docked replenishment.
replenishmentMethod	String		This field contains the character code for the algorithm that will be used to calculate the recommended order quantity for the item location. Valid values include Constant, Min/Max, Floating point, Time Supply, Dynamic, SO Store Orders.
rejectStoreOrderInd	String		This field contains an indicator that determines if uploaded store orders should be rejected. If the indicator is N, then store orders for all need dates are valid. If Y, store orders with needs date on or after the NEXT_DELIVERY_DATE are valid.
nextDeliveryDate	String		This field contains the next delivery date calculated for the next review cycle. If, for the next review cycle, an order will be created that is calculated to arrive on Thursday, this field will be updated with Thursdays date.
multipleReplenishmentsPerDayInd	String		This field indicates if an item can be replenished multiple times per day at the location. Default value is N.
launchDate	String		This field holds the date that they item should first be sold at the location. This value will be downloaded to the POS.
quantityKeyOptions	String		This field determines whether the qty key on a POS should be used for this item at the location. Valid values are in the code_type RPO. Current values include R - required, P - Prohibited, and O - Optional. Additional values can be added to the code type as needed. This value will be downloaded to the POS as needed.
manualPriceEntry	String		Determines whether the price can/should be entered manually on a POS for this item at the location. Valid values are in the code_type RPO. Current values include R - required, P - Prohibited, and O - Optional. Additional values can be added or removed as needed. This value will be downloaded to the POS.
depositCode	String		This field indicates whether a deposit is associated with this item at the location. Valid values are in the code_type DEPO. Additional values may be added or removed as needed. The only processing in Merchandising involving the deposit code is downloading it to the POS. Deposits are not subtracted from the retail of an item uploaded to Merchandising, etc. This kind of processing is the responsibility of the client and should occur before sales are sent to any Oracle Retail application.
foodStampInd	String		This field indicates whether the item is approved for food stamps at the location. This value will be downloaded to the POS.
wic_ind	String		This field indicates whether the item is approved for WIC at the location. This value will be downloaded to the POS.
proportionalTarePercent	Number		This field holds the value associated of the packaging in items sold by weight at the location. The proportional tare is the proportion of the total weight of a unit of an item that is packaging (i.e. if the tare item is bulk candy, this is the proportional of the total weight of one piece of candy that is the candy wrapper). The only processing Merchandising does involving the proportional tare percent is downloading it to the POS. Proportional tare is not subtracted from items sold by weight when sales are uploaded to Merchandising, etc. This kind of processing is the responsibility of the client and should occur before sales are sent to any Oracle Retail application.
fixedTareValue	Number		This field holds the value associated of the packaging in items sold by weight at the location. Fixed tare is the tare of the packagine used to (i.e. if the tare item is bulk candy, this is weight of the bag and twist tie). The only processing Merchandising does involving the fixed tare value is downloading it to the POS. Fixed tare is not subtracted from items sold by weight when sales are uploaded to Merchandising, etc. This kind of processing is the responsibility of the client and should occur before sales are sent to any Oracle Retail application.
fixedTareUom	String		This field holds the unit of measure value associated with the tare value. The only processing Merchandising does involving the fixed tare value and UOM is downloading it to the POS. Fixed tare is not subtracted from items sold by weight when sales are uploaded to Merchandising, etc. This kind of processing is the responsibility of the client and should occur before sales are sent to any Oracle Retail application.
rewardEligibleInd	String		This field holds whether the item is legally valid for various types of bonus point/award programs at the location. This value will be downloaded to the POS.
nationalBrandCompetitorItem	String		This field holds the nationally branded item to which you would like to compare the current item. This nationally branded item must exist as an item in Merchandising (i.e. on the item_master table).
returnPolicy	String		This field will contain a value of Yes when the item can be returned to the location
stopSaleInd	String		This field indicates that sale of the item should be stopped immediately at the location (i.e. in case of recall etc). This value will be downloaded to the POS.
electronicMarketClubs	String		This field holds the code that represents the marketing clubs to which the item belongs at the location. Valid values can belong to the code_type MTKC. Additional values can be added or removed from the code type as needed. This value will be downloaded to the POS.
reportCode	String		This field contains the code to determine which reports the location should run. Valid values are defined in the code type REPC.
requiredShelfLifeOnSelection	Number		This field holds the required shelf life for an item on selection in days. This field is not required. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems that may need it for processing.
requiredShelfLifeOnReceipt	Number		This field holds the required shelf life for an item on receipt in days. This field is not required. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems that may need it for processing.
storeReorderableInd	String		This field indicates whether the store may re-order the item. This field is required to be either Y - yes or N - no. The field will default to N. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems that may need it for processing.
rackSize	String		This field indicates the rack size that should be used for the item. This field is not required. Valid values for the field can be found and defined in the code_type RACK. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems that may need it for processing.
fullPalletItem	String		This field indicates whether a store must reorder an item in full pallets only. This field is required to be either Y - yes or N - no. The field will default to N.
inStoreMarketBasket	String		This field holds the in store market basket code for this item/location combination. Valid values for the field can be found in the code_type STMB. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems that may need it for processing.
storageLocation	String		This field holds the in store market basket code for this item/location combination. Valid values for the field can be found in the code_type STMB.
alternateStorageLocation	String		This field holds the preferred alternate storage location or bin number for the item at the location. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems that may need it for processing.
returnableInd	String		This field contains a value of Yes when the item can be returned to the location
refundableInd	String		This field contains a value of Yes when the item is refundable at the location.
backOrderInd	String		This field contains a value of Yes when the item can be back ordered to the location.
promotableInd	String		This attribute, which has valid values of Y or N, determines whether or not the item can be promoted. This flag will be sent to the selling solutions (e.g. POS, OMS) to help their pricing engines know whether or not to include this item location in the items eligible for a specific promotion. This new attribute is intended to be used for item location combinations that are never promoted so that users setting up promotions do not need to specify them as exclusions on the promotion.
createDateTime	String		This field holds the record creation date.
updateDateTime	String		This field holds the date when the record was last updated.
CustomFlexAttribute			This List holds custom flex attributes for the item-location.
cacheTimestamp	String		This field specifies date and time when the item VAT record was last maintained.

Table 5-357 customFlexAttribute

Name	Data Type		Description
name	String	This field will hold the custom flex attribute name.
value	String	This field will hold the numeric or string value of the custom flex attribute.
valueDate	String	This field will hold the date value of the custom flex attribute.
createDateTime	String	This field will hold the date time when the custom flex attribute was inserted.
updateDateTime	String	This field will hold the date time when the custom flex attribute was last updated.

Elements in JSON Output:

{
  "items": [
    {
      "action": "INSERT",
      "item": "100000323",
      "itemLevel": 1,
      "tranLevel": 1,
      "location": 4678,
      "locationType": "E",
      "status": "A",
      "physicalWarehouse": null,
      "storeType": null,
      "stockholdingInd": null,
      "localItemDescription": "100000323 .",
      "localShortDescription": "100000323",
      "primarySupplier": 2400,
      "primaryCountry": "US",
      "unitCost": 10,
      "costUom": "EA",
      "purchaseType": 0,
      "calculationBasis": null,
      "purchaseRate": null,
      "pricingControl": null,
      "receiveAsType": null,
      "taxableInd": "N",
      "sourceMethod": null,
      "sourceWarehouse": null,
      "unitRetail": 13.2078,
      "sellingUnitRetail": 13.2,
      "sellingUom": "EA",
      "storePriceInd": "N",
      "uinType": null,
      "uinLabel": null,
      "captureTime": null,
      "externalUinInd": "N",
      "rangedInd": "Y",
      "itemParent": null,
      "itemGrandparent": null,
      "ti": 1,
      "hi": 1,
      "storeOrderMultiple": "E",
      "dailyWastePercent": null,
      "measureOfEach": null,
      "measureOfPrice": null,
      "uomOfPrice": null,
      "primaryVariant": null,
      "primaryCostPack": null,
      "inboundHandlingDays": null,
      "regularUnitRetail": 13.2,
      "multiUnits": null,
      "multiUnitRetail": null,
      "multiSellingUom": null,
      "clearanceInd": "N",
      "costingLocation": null,
      "costingLocationType": null,
      "currencyCode": "USD",
      "pickupLeadTime": null,
      "rfidInd": "N",
      "primaryReplenishmentSupplier": null,
      "replenishmentMethod": null,
      "rejectStoreOrderInd": null,
      "nextDeliveryDate": null,
      "multipleReplenishmentsPerDayInd": null,
      "launchDate": null,
      "quantityKeyOptions": null,
      "manualPriceEntry": null,
      "depositCode": null,
      "foodStampInd": null,
      "wicInd": null,
      "proportionalTarePercent": null,
      "fixedTareValue": null,
      "fixedTareUom": null,
      "rewardEligibleInd": null,
      "nationalBrandCompetitorItem": null,
      "returnPolicy": null,
      "stopSaleInd": null,
      "electronicMarketClubs": null,
      "reportCode": null,
      "requiredShelfLifeOnSelection": null,
      "requiredShelfLifeOnReceipt": null,
      "storeReorderableInd": null,
      "rackSize": null,
      "fullPalletItem": null,
      "inStoreMarketBasket": null,
      "storageLocation": null,
      "alternateStorageLocation": null,
      "returnableInd": null,
      "refundableInd": null,
      "backOrderInd": null,
      "promotableInd": "Y",
      "createDateTime": "2021-06-17T10:34:51.000Z",
      "updateDateTime": "2021-06-17T10:34:51.000Z",
      "customFlexAttribute": null,
      "cacheTimestamp": "2023-03-24T06:59:38.120Z"
    }
  ],
  "hasMore": true,
  "limit": 1,
  "count": 1,
  "links": [
    {
      "href": "http://localhost:8080/MerchIntegrations/services/foundation/item/location?limit=1&since=1970-01-01T00:00:00.001Z&before=2023-03-30T09:59:27.742986+08:00",
      "rel": "self"
    },
    {
      "href": "http://localhost:8080/MerchIntegrations/services/foundation/item/location?offsetkey=E%2C4678%2C100000323&limit=1&since=1970-01-01T00:00:00.001Z&before=2023-03-30T09:59:27.742986+08:00",
      "rel": "next"
    }
  ]
}

Elements	Description
items	The first element is named as items and contains a number of child elements. Each child element corresponds to a row in the result set generated by the query.
hasMore	This is dependent on limit value. If the total rows are more than the limit defined, then hasMore will be set to true else false.
limit	This is used to limit the rows to control the paging of result data. Based on the limit, next and previous links are displayed. For example: If the limit is set to 25, internal it tries to fetch 26 rows. If 26th row exists, then 25 rows are returned along with a "next" link else no links would be added to the JSON response.
links	“self”: This contains URI pointing to current page. “next”: This contains URI pointing to the next page of results.

Table Impact

The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
ITEM_LOC_TRAITS	Yes	No	No	No
ITEM_SUPP_COUNTRY_LOC	Yes	No	No	No
REPL_ITEM_LOC	Yes	No	No	No
MERCHAPI_ITEM_LOC	Yes	Yes	Yes	Yes
V_MERCHAPI_ITEM_LOC_JSON	Yes	No	No	No
ICL_RMS_ITEM_LOC	Yes	No	Yes	Yes
ICL_RMS_REPL_ITEM_LOC	Yes	No	Yes	Yes
MERCHAPI_EXT_ITEM_LOC_CFA	Yes	Yes	No	Yes

Get Item VAT Details

Endpoints

MerchIntegrations/services/foundation/item/vat

MerchIntegrations/services/foundation/item/vat/{item}

Functional Area

Items

Business Overview

This service can be used by external applications to get VAT information for all or selected items from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/vat/item?item={item}&vatRegion={vatRegion}& activeDate={activeDate}&vatType={vatType}&offsetkey={offsetkey}&limit={limit}&since={since}&before={before}

/MerchIntegrations/services/foundation/item/vat/{item}

Input Parameters

Table 5-358 /MerchIntegrations/services/foundation/item/vat

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
item	No	String	Item Number.
vatRegion	No	Number	Vat Region.
activeDate	No	String	Active date for item VAT on future cost. Format: YYYY-MM-DD
vatType	No	String	VAT Type. Valid values are R - Retail, C - Cost, B - Both.
offsetkey	No	String	Offset Key. Valid Value is an Item Id.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Table 5-359 /MerchIntegrations/services/foundation/item/vat/{item}

Parameter Name	Required	Data Type	Description
item	Yes	Number	Item Number.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Output

Name	Data Type					Description
action			String		Action for Item VAT details. Valid Values are INSERT, UPDATE and DELETE.
item			String		This field holds the ID of the item.
vatRegion			Number		This field contains the number of the Value Added Tax region a location belongs to.
activeDate			String		This field holds the active date for record on future cost.
vatType		String		This field indicates the type of VAT. Valid values include R (Retail), C (Cost), B (Both).
vatCode		String		This field contains the alphanumeric identification for the VAT code.
vatRate			Number		This field contains the VAT rate for the item-location.
reverseVatInd			String		This field contains the VAT rate for the item-location.
createDateTime			String		This field holds the record creation date.
updateDateTime			String		This field holds the date when the record was last updated.
cacheTimestamp			String		This field specifies date and time when the item VAT record was last maintained.

Elements in JSON Output

Elements	Description
items	The first element is named as items and contains a number of child elements. Each child element corresponds to a row in the result set generated by the query.
hasMore	This is dependent on limit value. If the total rows are more than the limit defined, then hasMore will be set to true else false.
limit	This is used to limit the rows to control the paging of result data. Based on the limit, next and previous links are displayed. For example: If the limit is set to 25, internal it tries to fetch 26 rows. If 26th row exists, then 25 rows are returned along with a "next" link else no links would be added to the JSON response.
links	“self”: This contains URI pointing to current page. “next”: This contains URI pointing to the next page of results.

Example JSON input

"{
  "items": [
    {
      "action": null,
      "item": "104900054",
      "vatRegion": 1000,
      "activeDate": "2021-10-01",
      "vatType": "B",
      "vatCode": "S",
      "vatRate": 10,
      "reverseVatInd": "N",
      "createDateTime": "2022-03-29T10:07:45.000Z",
      "updateDateTime": "2022-03-29T10:07:45.000Z",
      "cacheTimestamp": "2022-03-29T12:32:58.009Z"
    }
  ],
  "hasMore": false,
  "limit": 10000,
  "count": 1,
  "links": null
}"

Table Impact

The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
VAT_ITEM	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
MERCHAPI_EXT_ITEM_VAT	Yes	Yes	Yes	Yes
V_MERCHAPI_EXT_ITEM_VAT_JSON	Yes	No	No	No
ICL_RMS_VAT_ITEM	Yes	No	Yes	Yes

Get Item VAT Details by Item Number

Endpoints

MerchIntegrations/services/foundation/item/vat
MerchIntegrations/services/foundation/item/vat/{item}

Functional Area

Items

Business Overview

This service can be used by external applications to retrieve VAT information for all or selected items from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/vat/item?item={item}&vatRegion={vatRegion}&activeDate={activeDate}&vatType={vatType}&offsetkey={offsetkey}&limit={limit}&since={since}&before={before}

/MerchIntegrations/services/foundation/item/vat/{item}

Input Parameters

Table 5-360 /MerchIntegrations/services/foundation/item/vat

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
item	No	String	Item Number.
vatRegion	No	Number	Vat Region.
activeDate	No	String	Active date for item VAT on future cost. Format: YYYY-MM-DD
vatType	No	String	VAT Type. Valid values are R - Retail, C - Cost, B - Both.
offsetkey	No	String	Offset Key. Valid Value is an Item ID.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Table 5-361 /MerchIntegrations/services/foundation/item/vat/{item}

Parameter Name	Required	Data Type	Description
item	Yes	Number	Item Number.

Output

Name	Data Type	Description
action	String	Action for Item VAT details. Valid Values are INSERT, UPDATE and DELETE.
item	String	This field holds the ID of the item.
vatRegion	Number	This field contains the number of the Value Added Tax region a location belongs to.
activeDate	String	This field holds the active date for record on future cost.
vatType	String	This field indicates the type of VAT. Valid values include R (Retail), C (Cost), B (Both).
vatCode	String	This field contains the alphanumeric identification for the VAT code.
vatRate	Number	This field contains the VAT rate for the item-location.
reverseVatInd	String	This field contains the VAT rate for the item-location.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
cacheTimestamp	String	This field specifies date and time when the item VAT record was last maintained.

Elements in JSON Output

Elements	Description
items	The first element is named as items and contains a number of child elements. Each child element corresponds to a row in the result set generated by the query.
hasMore	This is dependent on limit value. If the total rows are more than the limit defined, then hasMore will be set to true else false.
limit	This is used to limit the rows to control the paging of result data. Based on the limit, next and previous links are displayed. For example: If the limit is set to 25, internal it tries to fetch 26 rows. If 26th row exists, then 25 rows are returned along with a "next" link else no links would be added to the JSON response.
links	“self”: This contains URI pointing to current page. “next”: This contains URI pointing to the next page of results.

Example JSON input:

"{
  "items": [
    {
      "action": null,
      "item": "104900054",
      "vatRegion": 1000,
      "activeDate": "2021-10-01",
      "vatType": "B",
      "vatCode": "S",
      "vatRate": 10,
      "reverseVatInd": "N",
      "createDateTime": "2022-03-29T10:07:45.000Z",
      "updateDateTime": "2022-03-29T10:07:45.000Z",
      "cacheTimestamp": "2022-03-29T12:32:58.009Z"
    }
  ],
  "hasMore": false,
  "limit": 10000,
  "count": 1,
  "links": null
}"

Table Impact

The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
VAT_ITEM	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
MERCHAPI_EXT_ITEM_VAT	Yes	Yes	Yes	Yes
V_MERCHAPI_EXT_ITEM_VAT_JSON	Yes	No	No	No
ICL_RMS_VAT_ITEM	Yes	No	Yes	Yes

Item ELC Upload Service

The following services are included in this functional area:

• Create Item Conditional Tariff Treatments

• Create Item Expenses

• Create Item HTS

• Create Item HTS Assessments

• Delete Item Conditional Tariff Treatments

• Delete Item Expenses

• Delete Item HTS

• Delete Item HTS Assessments

• Update Item Expenses

• Update Item HTS

• Update Item HTS Assessments

Create Item Conditional Tariff Treatments

Functional Area

Items - Item Definition

Business Overview

Tariff Treatments, also known as Special Programs, are used to determine the applicable duty to be assessed when importing goods into a particular country. Tariff treatments may or may not be conditional. A conditional tariff treatment indicates that only certain types of goods will be eligible for the special rates. When import items are defined in the system, the user must indicate for which conditional tariff treatments the item is eligible.

This service allows the user to add one or more conditional tariff treatments to an item that is at or above the transaction level, including vendor packs.

Recalculate Orders

• The Recalculate Orders parameter can be passed in as Yes (Y) or No (N) when a conditional tariff treatment is being added to or removed from an item.  Adding and removing conditional tariff treatments to or from an item changes the item's eligibility for the tariff treatment which may result in a different duty rate.  This parameter provides a way to indicate whether or not open orders should be recalculated.

• When Recalculate Orders is passed in as Yes (Y) on a ‘Create’ or ‘Delete’, after successful creation or deletion of the item conditional tariff treatment record, during the nightly batch run, the system searches for and recalculates all the order/item/HTS/assessments for the item followed by all expenses for all locations for the same item in order to update the value of any expenses that are based on assessment values, where the order/item or order/item/location has no receipts and the order is not closed.

• When Recalculate Orders is passed in as Yes (Y) on a parent item, then all child items will be queued for order/item recalculation.

Service Type

POST

ReST URL

MerchIntegrations/services/item/conditionalTariffTreatments/create

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-362 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-363 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
conditionalTariffTreatment	No	Collection of Object	Child node.

Table 5-364 ConditionalTariffTreatment - Object. See list of elements for detail

Element Name	Required	Data Type	Description
tariffTreatment	Yes	String (10)	The unique identifier for the Conditional Tariff Program code. This refers to the tariff_treatment field from tariff_treatment table which are conditional. Example values are - CA (NAFTA for Canada CA), A+ (Generalized System of Preferences A+).
recalculateOrderInd	No	String (1)	The optional field indicates if open orders associated with the item should have assessments and expenses recalculated.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "conditionalTariffTreatment": [
        {
          "tariffTreatment": "CA",
          "recalculateOrderInd": "Y"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Create Item Expenses

Functional Area

Items - Item Definition

Business Overview

This service is used to add expenses to an existing item in Merchandising. Expenses can also be created together with the creation of a new item.  For more details on item creation, see the Create Items service description.

Service Type

POST

ReST URL

MerchIntegrations/services/item/expenses/create

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-365 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-366 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
expense	No	Collection of Object	References a collection of item expenses.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-367 Expense - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	Number (10)	The unique identifier for the supplier.
componentId	Yes	String (10)	The code representing the specific expense component.
dischargePort	Yes	String (5)	The port where the item will enter the importing country.
originCountry	No	String (3)	The country where the item was manufactured or significantly altered.
ladingPort	No	String (5)	The final destination lading port of the item if the Expense Type is Country.
costZoneId	No	Number (10)	The final destination zone of the item if the Expense Type is Zone.
costZoneGroupId	No	Number (4)	This field holds the items Zone Group, it is stored here for performance reasons.
baseExpenseInd	No	String (1)	Indicates whether or not this Set of Expenses is also the base Set of Expenses.
computationValueBase	No	String (10)	The Computation Value Base representing the base value for calculating the expense.
componentRate	No	Number (20,4)	The rate to be charged against the calculation base. This field will hold a percentage value if the Calculation basis of the Component is Value or a monetary amount if the Calculation Basis is Specific.
perCount	No	Number (12,4)	A count indicating the amount of the Per Count Unit of Measure to which the rate applies. This column is only used for specific (per-unit) expenses.
perCountUom	No	String (4)	The unit of measure in which the Per Count is specified. This column is only used from specific (per-unit) expenses.
componentCurrency	No	String (3)	Contains the currency the expense is to be entered in. If the Calculation Basis is V (Value), then the comp_currency will be NULL.
updateOrdersInd	No	String (1)	Indicates that new changes will be reflected to associated order-location expense record.
nominationFlag1	No	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 1), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 1), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 1). For example, if cost component ABC has a + in Nomination Flag 1, then all CVBs that include Nomination Flag 1 will include this cost component value in their calculation basis.
inDuty	No	String (1)	If Import Management is enabled in Merchandising (i. e. system_options. import_ind = Y), the inDuty flag is used to indicate if the value of the cost component should be included in total duty.
nominationFlag3	No	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 3), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 3), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 3). For example, if cost component ABC has a + in Nomination Flag 3, then all CVBs that include Nomination Flag 3 will include this cost component value in their calculation basis.
inExpense	No	String (1)	The inExpense flag is used to indicate if the value of the cost component should be included in total expenses.
inAlc	No	String (1)	The inALC flag is used for cost components where the retailer does not expect to receive an actual value for the charge via an obligation or customs entry. The inALC flag allows the value of the cost component to be included in ALC via direct nomination and indicates to the system that the estimated value on the order should be used as the actual value as well because no other actual will be provided.

Table 5-368 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-369 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "expense": [
        {
          "supplier": 2400,
          "componentId": "AGCOMM",
          "dischargePort": "480",
          "originCountry": "US",
          "ladingPort": "7",
          "costZoneId": 696323,
          "costZoneGroupId": 1000,
          "baseExpenseInd": "N",
          "computationValueBase": null,
          "componentRate": 3.55,
          "perCount": 1,
          "perCountUom": "EA",
          "componentCurrency": "USD",
          "updateOrdersInd": "Y",
          "nominationFlag1": "N",
          "inDuty": "N",
          "nominationFlag3": "N",
          "inExpense": "+",
          "inAlc": "N"
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Create Item HTS

Functional Area

Items - Item Definition

Business Overview

This service is used to add HTS and Assessments to an existing item in Merchandising. HTS and Assessments can also be created together with the creation of a new item.  For more details on item creation, see the Create Items service description.

Service Type

POST

ReST URL

MerchIntegrations/services/item/hts/create

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-370 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-371 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
hts	No	Collection of Object	References a collection of item HTS.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-372 Hts - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hts	Yes	String (25)	The unique identifier for the Harmonized Tariff Schedule code.
importCountry	Yes	String (3)	The unique identifier for the country that the item will be imported into.
originCountry	Yes	String (3)	The country where the item was manufactured or significantly altered.
effectFrom	Yes	date	The date from which the Item/HTS relationship is valid. This field is used to maintain historical information related to the Item/HTS relationship.
effectTo	Yes	date	The date until when the Item/HTS relationship is valid. This field is used to maintain historical information related to the item/HTS relationship.
clearingZoneId	No	String (5)	The concept of 'clearing zone' represents a country's zone-level point of entry of goods. This field holds the Clearing Zone ID for the effective HTS code. Clearing zones are defined by import country.
status	No	String (1)	Used to indicate the status of the Item/HTS relationship. Valid values are (W)orksheet and (A)pproved.
assessments	No	Collection of Object	References a collection of assessments associated to the item HTS.

Table 5-373 Assessments - Object. See list of elements for detail

Element Name	Required	Data Type	Description
componentId	Yes	String (10)	The code representing the specific assessment component.
computationValueBase	No	String (10)	The Computation Value Base representing the base value for calculating the assessment.
componentRate	No	Number (20,4)	The rate to be charged against the calculation base. This field will hold a percentage value if the Calculation basis of the Component is Value or a monetary amount if the Calculation Basis is Specific.
perCount	No	Number (12,4)	A count indicating the amount of the Per Count Unit of Measure to which the rate applies. This column is only used for specific (per-unit) assessments.
perCountUom	No	String (4)	The unit of measure in which the Per Count is specified. This column is only used from specific (per-unit) assessments.
estimatedAssessmentValue	No	Number (26,10)	Contains the calculated value of the component.
nominationFlag1	No	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 1), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 1), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 1). For example, if cost component ABC has a + in Nomination Flag 1, then all CVBs that include Nomination Flag 1 will include this cost component value in their calculation basis.
inDuty	No	String (1)	If Import Management is enabled in Merchandising (i. e. system_options. import_ind = Y), the inDuty flag is used to indicate if the value of the cost component should be included in total duty.
nominationFlag3	No	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 3), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 3), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 3). For example, if cost component ABC has a + in Nomination Flag 3, then all CVBs that include Nomination Flag 3 will include this cost component value in their calculation basis.
inExpense	No	String (1)	The inExpense flag is used to indicate if the value of the cost component should be included in total expenses.
inAlc	No	String (1)	The inALC flag is used for cost components where the retailer does not expect to receive an actual value for the charge via an obligation or customs entry. The inALC flag allows the value of the cost component to be included in ALC via direct nomination and indicates to the system that the estimated value on the order should be used as the actual value as well because no other actual will be provided.

Table 5-374 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-375 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "106150023",
      "dataLoadingDestination": "RMS",
      "hts": [
        {
          "hts": "9014111112",
          "importCountry": "US",
          "originCountry": "HK",
          "effectFrom": "2001-12-31",
          "effectTo": "2001-12-31",
          "clearingZoneId": null,
          "status": "W",
          "assessments": [
            {
              "componentId": "DTY7AUS",
              "computationValueBase": null,
              "componentRate": 3.55,
              "perCount": 1,
              "perCountUom": "EA",
              "estimatedAssessmentValue": 12.25,
              "nominationFlag1": "N",
              "inDuty": "+",
              "nominationFlag3": "N",
              "inExpense": "N",
              "inAlc": "N"
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Create Item HTS Assessments

Functional Area

Items - Item Definition

Business Overview

This service is used to add HTS Assessments to an existing item in Merchandising. HTS Assessments can also be created together with the creation of a new item. For more details on item creation, see the Create Items service description.

Service Type

POST

ReST URL

MerchIntegrations/services/item/hts/assessments/create

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-376 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-377 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
hts	No	Collection of Object	References a collection of item HTS.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-378 Hts - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hts	Yes	String (25)	The unique identifier for the Harmonized Tariff Schedule code.
importCountry	Yes	String (3)	The unique identifier for the country that the item will be imported into.
originCountry	Yes	String (3)	The country where the item was manufactured or significantly altered.
effectFrom	Yes	date	The date from which the Item/HTS relationship is valid. This field is used to maintain historical information related to the Item/HTS relationship.
effectTo	Yes	date	The date until when the Item/HTS relationship is valid. This field is used to maintain historical information related to the item/HTS relationship.
assessments	No	Collection of Object	References a collection of assessments associated to the item HTS.

Table 5-379 Assessments - Object. See list of elements for detail

Element Name	Required	Data Type	Description
componentId	Yes	String (10)	The code representing the specific assessment component.
computationValueBase	No	String (10)	The Computation Value Base representing the base value for calculating the assessment.
componentRate	No	Number (20,4)	The rate to be charged against the calculation base. This field will hold a percentage value if the Calculation basis of the Component is Value or a monetary amount if the Calculation Basis is Specific.
perCount	No	Number (12,4)	A count indicating the amount of the Per Count Unit of Measure to which the rate applies. This column is only used for specific (per-unit) assessments.
perCountUom	No	String (4)	The unit of measure in which the Per Count is specified. This column is only used from specific (per-unit) assessments.
estimatedAssessmentValue	No	Number (26,10)	Contains the calculated value of the component.
nominationFlag1	No	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 1), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 1), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 1). For example, if cost component ABC has a + in Nomination Flag 1, then all CVBs that include Nomination Flag 1 will include this cost component value in their calculation basis.
inDuty	No	String (1)	If Import Management is enabled in Merchandising (i. e. system_options. import_ind = Y), the inDuty flag is used to indicate if the value of the cost component should be included in total duty.
nominationFlag3	No	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 3), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 3), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 3). For example, if cost component ABC has a + in Nomination Flag 3, then all CVBs that include Nomination Flag 3 will include this cost component value in their calculation basis.
inExpense	No	String (1)	The inExpense flag is used to indicate if the value of the cost component should be included in total expenses.
inAlc	No	String (1)	The inALC flag is used for cost components where the retailer does not expect to receive an actual value for the charge via an obligation or customs entry. The inALC flag allows the value of the cost component to be included in ALC via direct nomination and indicates to the system that the estimated value on the order should be used as the actual value as well because no other actual will be provided.

Table 5-380 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-381 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "106150023",
      "dataLoadingDestination": "RMS",
      "hts": [
        {
          "hts": "9014111112",
          "importCountry": "US",
          "originCountry": "HK",
          "effectFrom": "2001-12-31",
          "effectTo": "2001-12-31",
          "assessments": [
            {
              "componentId": "MPFUS",
              "computationValueBase": "VFDUS",
              "componentRate": 0.21,
              "perCount": null,
              "perCountUom": null,
              "estimatedAssessmentValue": 0,
              "nominationFlag1": "N",
              "inDuty": "+",
              "nominationFlag3": "N",
              "inExpense": "N",
              "inAlc": "N"
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item Conditional Tariff Treatments

Functional Area

Items - Item Definition

Business Overview

Tariff Treatments, also known as Special Programs, are used to determine the applicable duty to be assessed when importing goods into a particular country. Tariff treatments may or may not be conditional. A conditional tariff treatment indicates that only certain types of goods will be eligible for the special rates. When import items are defined in the system, the user must indicate for which conditional tariff treatments the item is eligible.

This service will allow the user to add one or more conditional tariff treatments to an item that is at or above the transaction level, including vendor packs.

Recalculate Orders

• The Recalculate Orders parameter can be passed in as Yes (Y) or No (N) when a conditional tariff treatment is being added to or removed from an item.  Adding and removing conditional tariff treatments to or from an item changes the item's eligibility for the tariff treatment which may result in a different duty rate.  This parameter provides a way to indicate whether or not open orders should be recalculated.

• When Recalculate Orders is passed in as Yes (Y) on a ‘Create’ or ‘Delete’, after successful creation or deletion of the item conditional tariff treatment record, during the nightly batch run, the system will search for and recalculate all the order/item/HTS/assessments for the item followed by all expenses for all locations for the same item in order to update the value of any expenses that are based on assessment values, where the order/item or order/item/location has no receipts and the order is not closed.

• When Recalculate Orders is passed in as Yes (Y) on a parent item, then all child items will be queued for order/item recalculation.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/conditionalTariffTreatments/delete

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-382 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-383 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
conditionalTariffTreatment	No	Collection of Object	Child node.

Table 5-384 ConditionalTariffTreatment - Object. See list of elements for detail

Element Name	Required	Data Type	Description
tariffTreatment	Yes	String (10)	The code representing the Conditional Tariff Program code to be deleted. This refers to the tariff_treatment field from tariff_treatment table which are conditional. Example values are - CA (NAFTA for Canada CA), A+ (Generalized System of Preferences A+).
recalculateOrderInd	No	String (1)	The optional field indicates if open orders associated with the item should have assessments and expenses recalculated.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "conditionalTariffTreatment": [
        {
          "tariffTreatment": "CA",
          "recalculateOrderInd": "Y"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item Expenses

Functional Area

Items - Item Definition

Business Overview

This service is used to delete any expenses that are associated with an item in Merchandising. In order to perform this deletion, the item/supplier/component ID/discharge port must exist for the item in Merchandising, else an error will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/expenses/delete

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-385 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-386 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
expense	No	Collection of Object	References a collection of item expense.

Table 5-387 Expense - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	Number (10)	The supplier affected by the deletion activity.
componentId	Yes	String (10)	The code representing the specific expense component to be deleted.
dischargePort	Yes	String (5)	The port where the item will enter the importing country.
originCountry	No	String (3)	The country where the item was manufactured or significantly altered.
ladingPort	No	String (5)	The final destination lading port of the item if the Expense Type is Country.
costZoneId	No	Number (10)	The final destination zone of the item if the Expense Type is Zone.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "expense": [
        {
          "supplier": 2400,
          "componentId": "ORDCST",
          "dischargePort": "480",
          "originCountry": "US",
          "ladingPort": "7",
          "costZoneId": 696323
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item HTS

Functional Area

Items - Item Definition

Business Overview

This service is used to delete any Harmonized Tariff Schedule (HTS) that is linked with an item within Merchandising. In order to perform the deletion, the record to be deleted must exist in Merchandising, else an error will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/hts/delete

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-388 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-389 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
hts	No	Collection of Object	References a collection of item hts.

Table 5-390 Hts - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hts	Yes	String (25)	The unique identifier for the Harmonized Tariff Schedule code.
importCountry	Yes	String (3)	The unique identifier for the country that the item will be imported into.
originCountry	Yes	String (3)	The country where the item was manufactured or significantly altered.
effectFrom	Yes	date	The date from which the Item/HTS relationship is valid. This field is used to maintain historical information related to the Item/HTS relationship.
effectTo	Yes	date	The date until when the Item/HTS relationship is valid. This field is used to maintain historical information related to the item/HTS relationship.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "hts": [
        {
          "hts": "9014111112",
          "importCountry": "US",
          "originCountry": "CA",
          "effectFrom": "2001-12-31",
          "effectTo": "2001-12-31"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item HTS Assessments

Functional Area

Items - Item Definition

Business Overview

This service is used to delete any assessments that are associated with an existing item HTS record within Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/hts/assessments/delete

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-391 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-392 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
hts	No	Collection of Object	References a collection of item hts.

Table 5-393 Hts - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hts	Yes	String (25)	The unique identifier for the Harmonized Tariff Schedule code.
importCountry	Yes	String (3)	The unique identifier for the country that the item will be imported into.
originCountry	Yes	String (3)	The country where the item was manufactured or significantly altered.
effectFrom	Yes	date	The date from which the Item/HTS relationship is valid. This field is used to maintain historical information related to the Item/HTS relationship.
effectTo	Yes	date	The date until when the Item/HTS relationship is valid. This field is used to maintain historical information related to the item/HTS relationship.
assessments	No	Collection of Object	References a collection of assessments associated to the item HTS.

Table 5-394 Assessments - Object. See list of elements for detail

Element Name	Required	Data Type	Description
componentId	Yes	String (10)	The code representing the specific assessment component to be deleted.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "106150023",
      "hts": [
        {
          "hts": "9014111112",
          "importCountry": "US",
          "originCountry": "CA",
          "effectFrom": "2001-12-31",
          "effectTo": "2001-12-31",
          "assessments": [
            {
              "componentId": "DTYCAUS"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Item Expenses

Functional Area

Items - Item Definition

Business Overview

This service is used to update one or more expenses that are associated with an item within Merchandising. In order to perform an update, the specified item/supplier/component ID must exist within Merchandising, else an error will be returned.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/expenses/update

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-395 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-396 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
expense	No	Collection of Object	References a collection of item expenses.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-397 Expense - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	Number (10)	The unique identifier for the supplier.
componentId	Yes	String (10)	The code representing the specific expense component.
dischargePort	Yes	String (5)	The port where the item will enter the importing country.
originCountry	No	String (3)	The country where the item was manufactured or significantly altered.
ladingPort	No	String (5)	The final destination lading port of the item if the Expense Type is Country.
costZoneId	No	Number (10)	The final destination zone of the item if the Expense Type is Zone.
costZoneGroupId	No	Number (4)	This field holds the items Zone Group, it is stored here for performance reasons.
baseExpenseInd	No	String (1)	Indicates whether or not this Set of Expenses is also the base Set of Expenses.
computationValueBase	No	String (10)	The Computation Value Base representing the base value for calculating the expense.
componentRate	No	Number (20,4)	The rate to be charged against the calculation, base. This field will hold a percentage value if the Calculation basis of the Component is Value or a monetary amount if the Calculation Basis is Specific.
perCount	No	Number (12,4)	A count indicating the amount of the Per Count Unit of Measure to which the rate applies. This column is only used for specific (per-unit) expenses.
perCountUom	No	String (4)	The unit of measure in which the Per Count is specified. This column is only used from specific (per-unit) expenses.
componentCurrency	No	String (3)	Contains the currency the expense is to be entered in. If the Calculation Basis is V (Value), then the comp_currency will be NULL.
updateOrdersInd	No	String (1)	Indicates that new changes will be reflected to associated order-location expense record.
nominationFlag1	No	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 1), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 1), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 1). For example, if cost component ABC has a + in Nomination Flag 1, then all CVBs that include Nomination Flag 1 will include this cost component value in their calculation basis.
inDuty	No	String (1)	See description for nomFlag1. If ALC is turned on (i. e. system_options. import_ind = Y), inDuty flag is used to indicate the status of a component in duty calculation, inExpense flag is used to indicate the status of a component in ELC calculation, inALC flag is used to indicate the status of a component in ALC calculation, i. e. these 3 flags can not be used for any other purposes if ALC is turned on.
nominationFlag3	No	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 3), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 3), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 3). For example, if cost component ABC has a + in Nomination Flag 3, then all CVBs that include Nomination Flag 3 will include this cost component value in their calculation basis.
inExpense	No	String (1)	The inExpense flag is used to indicate if the value of the cost component should be included in total expenses.
inAlc	No	String (1)	The inALC flag is used for cost components where the retailer does not expect to receive an actual value for the charge via an obligation or customs entry. The inALC flag allows the value of the cost component to be included in ALC via direct nomination and indicates to the system that the estimated value on the order should be used as the actual value as well because no other actual will be provided.

Table 5-398 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-399 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "expense": [
        {
          "supplier": 2400,
          "componentId": "AGCOMM",
          "dischargePort": "480",
          "originCountry": "US",
          "ladingPort": "7",
          "costZoneId": 696323,
          "costZoneGroupId": 1000,
          "baseExpenseInd": "N",
          "computationValueBase": null,
          "componentRate": 5.6,
          "perCount": 3,
          "perCountUom": "EA",
          "componentCurrency": "USD",
          "updateOrdersInd": "Y",
          "nominationFlag1": "N",
          "inDuty": "N",
          "nominationFlag3": "N",
          "inExpense": "+",
          "inAlc": "N"
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Item HTS

Functional Area

Items - Item Definition

Business Overview

This service is used to update HTS of an existing item in Merchandising. In order to update HTS, the record to be updated must exist in Merchandising, otherwise, an error will be returned. Status and origin country ID can be updated at the HTS level.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/hts/update

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-400 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-401 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
hts	No	Collection of Object	References a collection of item HTS.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-402 Hts - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hts	Yes	String (25)	The unique identifier for the Harmonized Tariff Schedule code.
importCountry	Yes	String (3)	The unique identifier for the country that the item will be imported into.
originCountry	Yes	String (3)	The country where the item was manufactured or significantly altered.
effectFrom	Yes	date	The date from which the Item/HTS relationship is valid. This field is used to maintain historical information related to the Item/HTS relationship.
effectTo	Yes	date	The date until when the Item/HTS relationship is valid. This field is used to maintain historical information related to the item/HTS relationship.
clearingZoneId	No	String (5)	The concept of 'clearing zone' represents a country's zone-level point of entry of goods. This field holds the Clearing Zone ID for the effective HTS code. Clearing zones are defined by import country.
status	No	String (1)	Used to indicate the status of the Item/HTS relationship. Valid values are (W)orksheet and (A)pproved.

Table 5-403 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-404 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "hts": [
        {
          "hts": "9014111111",
          "importCountry": "US",
          "originCountry": "CA",
          "effectFrom": "2001-12-31",
          "effectTo": "2001-12-31",
          "clearingZoneId": null,
          "status": "W"
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Item HTS Assessments

Functional Area

Items - Item Definition

Business Overview

This service is used to update existing item HTS assessments in Merchandising. To update HTS assessments, the record to be updated must exist in Merchandising; otherwise, an error will be returned.  All HTS assessment fields except for component ID can be updated.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/hts/assessments/update

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-405 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-406 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
hts	No	Collection of Object	References a collection of item HTS.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-407 Hts - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hts	Yes	String (25)	The unique identifier for the Harmonized Tariff Schedule code.
importCountry	Yes	String (3)	The unique identifier for the country that the item will be imported into.
originCountry	Yes	String (3)	The country where the item was manufactured or significantly altered.
effectFrom	Yes	date	The date from which the Item/HTS relationship is valid. This field is used to maintain historical information related to the Item/HTS relationship.
effectTo	Yes	date	The date until when the Item/HTS relationship is valid. This field is used to maintain historical information related to the item/HTS relationship.
assessments	No	Collection of Object	References a collection of assessments associated to the item HTS.

Table 5-408 Assessments - Object. See list of elements for detail

Element Name	Required	Data Type	Description
componentId	Yes	String (10)	The code representing the specific assessment component.
computationValueBase	No	String (10)	The Computation Value Base representing the base value for calculating the assessment.
componentRate	No	Number (20,4)	The rate to be charged against the calculation base. This field will hold a percentage value if the Calculation basis of the Component is Value or a monetary amount if the Calculation Basis is Specific.
perCount	No	Number (12,4)	A count indicating the amount of the Per Count Unit of Measure to which the rate applies. This column is only used for specific (per-unit) assessments.
perCountUom	No	String (4)	The unit of measure in which the Per Count is specified. This column is only used from specific (per-unit) assessments.
estimatedAssessmentValue	No	Number (26,10)	Contains the calculated value of the component.
nominationFlag1	No	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 1), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 1), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 1). For example, if cost component ABC has a + in Nomination Flag 1, then all CVBs that include Nomination Flag 1 will include this cost component value in their calculation basis.
inDuty	No	String (1)	If Import Management is enabled in Merchandising (i. e. system_options. import_ind = Y), the inDuty flag is used to indicate if the value of the cost component should be included in total duty.
nominationFlag3	No	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 3), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 3), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 3). For example, if cost component ABC has a + in Nomination Flag 3, then all CVBs that include Nomination Flag 3 will include this cost component value in their calculation basis.
inExpense	No	String (1)	The inExpense flag is used to indicate if the value of the cost component should be included in total expenses.
inAlc	No	String (1)	The inALC flag is used for cost components where the retailer does not expect to receive an actual value for the charge via an obligation or customs entry. The inALC flag allows the value of the cost component to be included in ALC via direct nomination and indicates to the system that the estimated value on the order should be used as the actual value as well because no other actual will be provided.

Table 5-409 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-410 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "106150023",
      "dataLoadingDestination": "RMS",
      "hts": [
        {
          "hts": "9014111112",
          "importCountry": "US",
          "originCountry": "CA",
          "effectFrom": "2001-12-31",
          "effectTo": "2001-12-31",
          "assessments": [
            {
              "componentId": "DTYCAUS",
              "computationValueBase": null,
              "componentRate": 100,
              "perCount": 1,
              "perCountUom": "EA",
              "estimatedAssessmentValue": 100,
              "nominationFlag1": "N",
              "inDuty": "+",
              "nominationFlag3": "N",
              "inExpense": "N",
              "inAlc": "N"
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Item Location Upload Service

The following services are included in this functional area:

• Create Item Locations

• Manage Item Location Status Update Requests

• Update Item Locations

Create Item Locations

Functional Area

Items - Item Definition

Business Overview

This service subscribes to items and their locations from external systems to create item location combinations in Merchandising. Item/location relationships can be created for an item and a single location or using one of the levels of the organizational hierarchy.

When a new item location is created, this service will first validate that all required fields are present in the message.  Additionally, when creating a new item location at least one detail line must also be included in the request payload.  After that, business level validation on the input information will be performed.

Service Type

POST

ReST URL

MerchIntegrations/services/item/locations/create

Availability During Nightly Batch Cycle

This service will not be available during total duration of nightly batch run cycle.

Input Payload Details

Table 5-411 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of item-location records.

Table 5-412 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The identifier for the item.
hierarchyLevel	Yes	String (2)	The level of the organizational hierarchy to which the hier_value field pertains. Valid values are CH (chain), AR (area), RE (region), DI (district), S (store), and W (warehouse).
locations	Yes	Collection of Object	References a collection of hierarchy details.

Table 5-413 Locations - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hierarchyValue	Yes	Number (10)	Valid ID for a chain, area, region, district, store or warehouse given based on the hierarchy Level.
primarySupplier	No	Number (10)	The primary supplier for the item at the location. If not populated, this will default from the primary supplier on the ITEM_SUPPLIER table.
primaryCountry	No	String (3)	The primary country for the item at the location. If not populated on a create message this will default from the primary country on the ITEM_SUPP_COUNTRY table.
localItemDescription	No	String (250)	Local description for the item at the location. If not populated on the message this will default from the ITEM_MASTER table.
status	Yes	String (1)	The status of the item at the location.
storeOrderMultiple	Yes	String (1)	The unit type of the item shipped from the warehouse to the location. Valid values are C (cases), I (inners), and E (eaches). Eaches will default if left null on a create message.
receiveAsType	No	String (1)	The unit in which the warehouse will receive goods. Valid values are E (eaches) and P (pack). This field only applies to buyer packs. If the item is not a buyer pack this field should be null.
taxableInd	Yes	String (1)	Indicates if the item is taxable at the location. Valid values are 'Y' and 'N'. If not populated on the message it will default to 'Y'.
ti	No	Number (12)	Number of shipping units (cases) that make up one tier of a pallet. Multiply TI x HI to get total number of cases for a pallet.
hi	No	Number (12)	Number of tiers that make up a complete pallet (height). Multiply TI x HI to get total number of cases for a pallet.
dailyWastePercent	No	Number (12,4)	Average percentage lost from inventory on a daily basis due to natural wastage.
localShortDescription	No	String (120)	The local short description of the item. Will default to the item's short description. Will be downloaded to the POS.
uinType	No	String (6)	This attribute will contain the type of the unique identification number (UIN) used to identify instances of the item at the location. Valid values for this attribute should be user-definable on the Merchandising code tables. This attribute should be nullable.
uinLabel	No	String (6)	This attribute will contain the label for the UIN when displayed in Store Inventory Operations. Valid values should be user-definable on the Merchandising code tables. This attribute should be nullable but a value is required when a UIN Type is specified.
captureTime	No	String (6)	This attribute will indicate when the UIN should be captured for an item during transaction processing. There are 2 valid values for this field which should be stored on the Merchandising code tables: Sale and Store Receiving. This attribute should be nullable.
externalUinInd	No	String (1)	This Yes/No indicator indicates if UIN is being generated in the external system (e. g. SIM). This value will always be N (no) when the Capture Time attribute is set to Sale.
sourceMethod	No	String (1)	Determines the source method for a requested item at a store. Valid values: 'W'(warehouse) and 'S'(supplier), default value is 'S'.
sourceWarehouse	No	Number (10)	If the source_method is 'W', this field contains the source warehouse for fulfilling item requests at a store.
unitCost	No	Number (20,4)	The current corporate unit cost for the item in the location's currency. This field will only be used to establish the item supplier country loc unit cost; it cannot be modified.
purchaseType	No	String (1)	This contains a code to indicate whether the item is normal merchandise (i. e. owned by the retailer), consignment stock or a concession item. Valid values are 0 - Owned, 1 - Consignment, 2 - Concession.
calculationBasis	No	String (1)	This indicates if the cost for the consignment/concession item will be managed either based on cost per unit or as a percentage of retail. Valid values are C - Cost per Unit, P - Purchase Rate.
purchaseRate	No	Number (12,4)	This column contains the percentage of the retail price which will determine the cost paid to the supplier for a consignment or concession item.
pricingControl	No	String (1)	This indicates whether the price for the consignment/concession item will be managed by supplier or by retailer when supplier-controlled pricing for Consignment/Concession ownership model is used within the Merchandising suite of solutions. Valid values are: R – Retailer, S – Supplier. If no value is provided for consignment/concession purchase types, this will be defaulted from item/supplier/country of sourcing /location if purchase type is Consignment/Concession at item/supplier/ country of sourcing/location level. If purchase type is Owned at item/supplier/country of sourcing/location level, then this will be defaulted from item/supplier/country of sourcing if purchase type is Consignment/Concession at item/supplier/country of sourcing level. If purchase type is Owned at item/supplier/country of sourcing level, then this will be defaulted based on Default Pricing Control at supplier site level.
promotableInd	No	String (1)	This field will indicate if the item can be included on promotions or not.
rfidInd	No	String (1)	This indicates if the item is RFID tagged or not. Valid values are Yes (Y) and No (N).
ticketMeasureOfAnEach	No	Number (12,4)	Size of an each in terms of the uom_of_price. For example 12 oz. Used in ticketing.
ticketPerCount	No	Number (12,4)	Size to be used on the ticket in terms of the uom_of_price. For example, if the user wants the ticket to have the label print the price per ounce, this value would be 1. If the user wanted the price per 100 grams this value would be 100. Used in ticketing.
ticketUom	No	String (4)	Unit of measure that will be used on the ticket for this item.
primaryVariant	No	String (25)	This field is used to address sales of PLUs (i. e. above transaction level items) when inventory is tracked at a lower level (i. e. UPC). This field will only contain a value for items one level higher than the transaction level.
primaryCostPack	No	String (25)	This field contains an item number that is a simple pack containing the item in the item column for this record. If populated, the cost of the future cost table will be driven from the simple pack and the deals and cost changes for the simple pack.
inboundHandlingDays	No	Number (2)	This field indicates the number of inbound handling days for an item at a warehouse type location.
rangedInd	No	String (1)	This column determines if the location is ranged intentionally by the user for replenishment/selling or incidentally ranged by the RMS programs when item is not ranged to a specific location on the transaction.
costingLocation	No	Number (10)	Numeric identifier of the costing location for the franchise store. This field may contain a store or a warehouse.
sellingPhaseStartDate	No	date	Used to determine the timing of the generation of markdown recommendation, which will occur x weeks after the start of this phase.
updSellDateOnStOrdRcpt	No	String (1)	This indicates whether or not to update the Selling Phase Start Date for the item/location when a purchase order of this item is received at the store.
updSellDateOnWh2stRcpt	No	String (1)	This indicates whether or not to update the Selling Phase Start Date for the item/location when a warehouse to store transfer/allocation of this item is received at the store.
updSellDateOnSt2stRcpt	No	String (1)	This indicates whether or not to update the Selling Phase Start Date for the item/location when a store-to-store transfer of this item is received at the store.
minUnitsForSellDateReset	No	Number (12,4)	This field contains the minimum shipped quantity of an item on a transfer/allocation that will trigger the resetting of the Selling Phase Start Date. This value is only used if either of the Set Selling Start Date upon Receipt of a Warehouse to Store Transfer/Allocation or Set Selling Start Date upon Receipt of a Store to Store Transfer are set to Yes (Y).
mfgSugRetailInclTax	No	Number (20,4)	This field holds the tax-inclusive Manufacturer Suggested Retail in local currency and in an item’s standard UOM. It is used when default_tax_type is GTS or SVAT.
mfgSugRetailExclTax	No	Number (20,4)	This field holds the tax-exclusive Manufacturer Suggested Retail in local currency and in an item’s standard UOM. It is used when default_tax_type is SALES.
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL
trait	No	Record	References a location trait record.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-414 Trait - Object. See list of elements for detail

Element Name	Required	Data Type	Description
launchDate	No	date	The date the item should first be sold at the location. Value will be downloaded to the POS. No internal processing occurs from this field.
quantityKeyOptions	No	String (6)	Determines whether the qty key on a POS should be used for this item at the location. Valid values are in the code_type 'RPO'. Current values include 'R - required', 'P - Prohibited', and 'O - Optional'. Additional values can be added to the code type
manualPriceEntry	No	String (6)	Determines whether the price can/should be entered manually on a POS for this item at the location. Valid values are in the code_type 'RPO'. Current values include 'R - required', 'P - Prohibited', and 'O - Optional'. Additional values can be added.
depositCode	No	String (6)	Indicates whether a deposit is associated with this item at the location. Values are in the code_type 'DEPO'. The only processing in Merchandising is downloading it to the POS. Examples are None (NONE), Maine - 0.10 (ME2) and Maine - 0.05 (ME1).
foodStampInd	No	String (1)	Indicates whether the item is approved for food stamps at the location. This value will be downloaded to the POS.
wicInd	No	String (1)	Indicates whether the item is approved for WIC at the location. This value will be downloaded to the POS.
proportionalTarePercent	No	Number (12,4)	For items sold by weight, this is the proportion of the total weight of a unit of an item that is packaging.
fixedTareValue	No	Number (12,4)	Holds the weight of the packaging in items sold by weight at the location; i. e. if the tare item is bulk candy, this is weight of the bag and twist tie). The only processing Merchandising does is to download it to POS.
fixedTareUom	No	String (4)	Holds the unit of measure value associated with the tare value. The only processing Merchandising does involving the fixed tare value and UOM is downloading it to the POS. Fixed tare is not subtracted from items sold by weight when sales are uploaded to Merchandising, etc
rewardEligibleInd	No	String (1)	Holds whether the item is legally valid for various types of bonus point/award programs at the location. This value will be downloaded to the POS.
nationalBrandCompetitorItem	No	String (25)	Holds the nationally branded item to which you would like to compare the current item. This nationally branded item must exist as an item in Merchandising (i. e. on the item_master table).
returnPolicy	No	String (6)	The return policy for the item at the location. Valid values are in the code_type 'RETP'. This value will be downloaded to the POS. Examples are All returns accepted (ALL), Customer ID needed for return (ID) and Manager approval needed for return (MNGR).
stopSaleInd	No	String (1)	Indicates that sale of the item should be stopped immediately at the location (i. e. in case of recall etc). This value will be downloaded to the POS.
electronicMarketClubs	No	String (6)	Code for the marketing clubs to which the item belongs at the location. Valid values are in the code_type 'MTKC'. Examples are Baby Club (B), Baby/Family Clubs (BF) and Deli Club (D).
reportCode	No	String (6)	Code to determine which reports the location should run. Values are in the code type REPC (Report Code). Examples are All Locations Reports(ALL) and No Location Report (NO).
requiredShelfLifeOnSelection	No	Number (4)	Holds the required shelf life for an item on selection in days. This field is not required. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems that may need it.
requiredShelfLifeOnReceipt	No	Number (4)	Holds the required shelf life for an item on receipt in days. This field is not required. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems that may need it for processing
investmentBuyShelfLife	No	Number (4)	The Investment Buy-specific shelf life for the item/location.
storeReorderableInd	No	String (1)	A code (Y or N) to indicate whether the store may re-order the item. Will default to N. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems.
rackSize	No	String (6)	Indicates the rack size that should be used for the item. Valid values for the field are in the code_type 'RACK'. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate to external systems. Examples are large (L), Medium (M) and Small (S).
fullPalletItem	No	String (1)	A code (Y or N) to indicate whether a store must reorder an item in full pallets only. Will default to N. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate to external systems.
inStoreMarketBasket	No	String (6)	The in store market basket code for this item/location. Valid values for the field are in the code_type 'STMB'. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems. Examples are A item at this loc (A), B item at this loc (B) and C item at this loc (C).
storageLocation	No	String (7)	Holds the current storage location or bin number for the item at the location. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems that may need it for processing.
alternateStorageLocation	No	String (7)	Holds the preferred alternate storage location or bin number for the item at the location. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems that may need it for processing
returnableInd	No	String (1)	This field will contain a value of 'Y'es when the item can be returned to the location,
refundableInd	No	String (1)	This field will contain a value of 'Y'es when the item is refundable at the location.
backOrderInd	No	String (1)	This field will contain a value of 'Y'es when the item can be back ordered to the location.

Table 5-415 CustomFlexAttribute - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Table 5-416 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-417 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100000024",
      "hierarchyLevel": "S",
      "locations": [
        {
          "hierarchyValue": 6000,
          "primarySupplier": 6100,
          "primaryCountry": "US",
          "localItemDescription": "100000024 at 6000",
          "status": "A",
          "storeOrderMultiple": "E",
          "receiveAsType": null,
          "taxableInd": "N",
          "ti": 1,
          "hi": 1,
          "dailyWastePercent": 1,
          "localShortDescription": "100000024 at 6000",
          "uinType": null,
          "uinLabel": null,
          "captureTime": null,
          "externalUinInd": "N",
          "sourceMethod": "S",
          "sourceWarehouse": null,
          "unitCost": 9.65,
          "purchaseType": null,
          "calculationBasis": null,
          "purchaseRate": 1,
          "pricingControl": "R",
          "promotableInd": "N",
          "rfidInd": "N",
          "ticketMeasureOfAnEach": 2,
          "ticketPerCount": 1,
          "ticketUom": "EA",
          "primaryVariant": "100100090",
          "primaryCostPack": "100100080",
          "inboundHandlingDays": 1,
          "rangedInd": "Y",
          "costingLocation": 199,
          "sellingPhaseStartDate": "2001-12-31",
          "updSellDateOnStOrdRcpt": "N",
          "updSellDateOnWh2stRcpt": "N",
          "updSellDateOnSt2stRcpt": "N",
          "minUnitsForSellDateReset": 50,
          "mfgSugRetailInclTax": 20,
          "mfgSugRetailExclTax": 18.12,
          "customFlexAttribute": [
            {
              "name": "REVIEW_DATE",
              "value": null,
              "valueDate": null
            }
          ],
          "rfidInd": "N",
          "trait": {
            "launchDate": "2001-12-31",
            "quantityKeyOptions": null,
            "manualPriceEntry": null,
            "depositCode": null,
            "foodStampInd": "N",
            "wicInd": "N",
            "proportionalTarePercent": 3,
            "fixedTareValue": 3,
            "fixedTareUom": "EA",
            "rewardEligibleInd": "N",
            "nationalBrandCompetitorItem": null,
            "returnPolicy": null,
            "stopSaleInd": "N",
            "electronicMarketClubs": null,
            "reportCode": null,
            "requiredShelfLifeOnSelection": 1000,
            "requiredShelfLifeOnReceipt": 1000,
            "investmentBuyShelfLife": 1000,
            "storeReorderableInd": "Y",
            "rackSize": null,
            "fullPalletItem": null,
            "inStoreMarketBasket": null,
            "storageLocation": null,
            "alternateStorageLocation": null,
            "returnableInd": "N",
            "refundableInd": "N",
            "backOrderInd": "N"
          },
          "localizationExtensions": [
            {
              "country": "BR",
              "attributes": [
                {
                  "name": "SPECIAL_CATEGORY_CODE",
                  "value": "WS_PRC_08",
                  "valueDate": "2001-12-31"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Manage Item Location Status Update Requests

Functional Area

Items - Item Definition

Business Overview

This service provides the capability to create and maintain requests to update item/location status from an external system or source. This service takes in a collection of item locations along with the desired status and the effective date upon which each update should take place.  

Possible status values can be found under the Item/Location Statuses (STST) code type, which includes values such as Active (A), Inactive (I), Discontinued (C) and Deleted (D). The effective date on a new request must be at least one day later than the current business date (virtual date + 1). The service will accept approved transaction level items or approved reference items.  When a reference item is provided, the system will update the item/location status for the associated transaction level item. Locations must be a store, physical warehouse or virtual warehouse. If a physical warehouse is provided, requests will be created/updated/deleted for all virtual warehouses under the physical warehouse. Requests can be created for item/location combinations where the item is not yet ranged to the location. In this case, when the request is processed by the Scheduled Item Maintenance (sitmain) batch program, the item will be ranged to the location with the provided status.

This single service supports complete maintenance of item location status update requests, which includes the ability to create, update and delete requests. The service takes in an external request reference number. The external system can update or delete a previously created request by passing updates against an external request reference number sent earlier. Removal of item locations or scheduled status date can be accomplished by omitting them in an update request. Deleting of an existing request will require the Delete flag to be set on the update request. No details (item locations or status-date combinations) are required on a Request having the Delete flag set.

Item/location status update requests created via this service can also be viewed and maintained via the Item/Location Update screen which is accessed via the Manage Scheduled Item Updates link under the Items > Scheduled Item Maintenance folder in the Tasks list.

This webservice will enable interfacing of item locations status change requests into Merchandising.  Processing of these requests out will continue to be carried out by the Scheduled Item Maintenance (sitmain) batch process.  This batch program will update the item-location status the night before the effective date on the request.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/location/statusUpdateRequests/manage

Availability During Nightly Batch Cycle

This service will not be available during total duration of nightly batch run cycle.

Input Payload Details

Table 5-418 Manage - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	Collection of the input details for which item location status update is requested.

Table 5-419 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
externalRequestId	Yes	Number (10)	External request id against which the item location status update request will be created.
description	No	String (120)	Request description.
deleteFlag	No	String (1)	Indicate if the request is to be deleted. Valid values are Y - Yes and N - No.
details	No	Collection of Object	Collection of status/update dates on which the new status will be updated. The maximum number of the status/update dates allowed is 999.
itemLocations	No	Collection of Object	Collection of item/locations for which the status updates are requested. The maximum number of the items/locations allowed is 999.

Table 5-420 Details - Object. See list of elements for detail

Element Name	Required	Data Type	Description
status	Yes	String (1)	The status to update. Valid values are A - Active, I - Inactive, C - Discontinued and D - Delete.
updateDate	Yes	date	The future date on which status update will take place. The expected date format is YYYY-MM-DD.

Table 5-421 ItemLocations - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The transaction level or below transaction level item for which status update is requested.
location	Yes	Number (10)	The location at which item status will be updated. Valid location can be a store, physical warehouse or virtual warehouse.

Table 5-422 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
externalRequestId	Yes	Number (10)	External requested id against which errors are encountered.
errorMessages	Yes	Array of String	List of errors identified during business data processing of the request.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "externalRequestId": 12122,
      "description": "Request description",
      "deleteFlag": "N",
      "details": [
        {
          "status": "I",
          "updateDate": "2001-12-31"
        }
      ],
      "itemLocations": [
        {
          "item": "101050103",
          "location": 1531
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element "validationErrors" will be present when input payload or input parameters are not as per the schema definition of this service. The element "businessError" will be present if the payload passes schema validation but exception is caught while processing business logic.

Table 5-423 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
externalRequestId	Yes	Number (10)	External requested id against which errors are encountered.
errorMessages	Yes	Array of String	List of errors identified during business data processing of the request.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    {
      "externalRequestId": 12122,
      "errorMessages": [
        "Input location is not a valid store or warehouse. Input location is 1531."
      ]
    }
  ]
}

Update Item Locations

Functional Area

Items - Item Definition

Business Overview

This service is used to subscribe to items and their linked locations from external systems in order to update this data at the item/location level within Merchandising. Item/location relationships can be updated for an item and a single location or using one of the levels of the organizational hierarchy.

When an item location is updated, this service will first validate that all the required fields are present in the message. Additionally, when creating a new item/location record, at least one detail line must also be included in the request payload in order to be able to perform business level validation on the input information.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/locations/update

Availability During Nightly Batch Cycle

This service will not be available during total duration of nightly batch run cycle.

Input Payload Details

Table 5-424 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of item-location records.

Table 5-425 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The identifier for the item.
hierarchyLevel	Yes	String (2)	The level of the organizational hierarchy to which the hier_value field pertains. Valid values are CH (chain), AR (area), RE (region), DI (district), S (store), and W (warehouse).
locations	Yes	Collection of Object	References a collection of hierarchy details.

Table 5-426 Locations - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hierarchyValue	Yes	Number (10)	The same value as in the hier_level field.
primarySupplier	No	Number (10)	The primary supplier for the item at the location. If not populated on a create message this will default from the primary supplier on the ITEM_SUPPLIER table.
primaryCountry	No	String (3)	The primary country for the item at the location. If not populated on a create message this will default from the primary country on the ITEM_SUPP_COUNTRY table.
localItemDescription	No	String (250)	Local description for the item at the location. If not populated on the message this will default from the ITEM_MASTER table.
status	Yes	String (1)	The status of the item at the location.
storeOrderMultiple	Yes	String (1)	The unit type of the item shipped from the warehouse to the location. Valid values are C (cases), I (inners), and E (eaches). Eaches will default if left null on a create message.
receiveAsType	No	String (1)	The unit in which the warehouse will receive goods. Valid values are E (eaches) and P (pack). This field only applies to buyer packs. If the item is not a buyer pack this field should be null.
taxableInd	Yes	String (1)	Indicates if the item is taxable at the location. Valid values are 'Y' and 'N'. If not populated on the message it will default to 'Y'.
ti	No	Number (12)	Number of shipping units (cases) that make up one tier of a pallet. Multiply TI x HI to get total number of cases for a pallet.
hi	No	Number (12)	Number of tiers that make up a complete pallet (height). Multiply TI x HI to get total number of cases for a pallet.
dailyWastePercent	No	Number (12,4)	Average percentage lost from inventory on a daily basis due to natural wastage.
localShortDescription	No	String (120)	The local short description of the item. Will default to the item's short description. Will be downloaded to the POS.
uinType	No	String (6)	This attribute will contain the type of the unique identification number (UIN) used to identify instances of the item at the location. Valid values for this attribute should be user-definable on the Merchandising code tables. This attribute should be nullable.
uinLabel	No	String (6)	This attribute will contain the label for the UIN when displayed in Store Inventory Operations. Valid values should be user-definable on the Merchandising code tables. This attribute should be nullable but a value is required when a UIN Type is specified.
captureTime	No	String (6)	This attribute will indicate when the UIN should be captured for an item during transaction processing. There are 2 valid values for this field which should be stored on the Merchandising code tables: Sale and Store Receiving. This attribute should be nullable.
externalUinInd	No	String (1)	This Yes/No indicator indicates if UIN is being generated in the external system (e. g. SIM). This value will always be N (no) when the Capture Time attribute is set to Sale.
sourceMethod	No	String (1)	Determines the source method for a requested item at a store. Valid values: 'W'(warehouse) and 'S'(supplier), default value is 'S'.
sourceWarehouse	No	Number (10)	If the source_method is 'W', this field contains the source warehouse for fulfilling item requests at a store.
promotableInd	No	String (1)	This field will indicates,if the item can be included on promotions or not.
rfidInd	No	String (1)	This indicates if the item is RFID tagged or not. Valid values are Yes (Y) and No (N).
ticketMeasureOfAnEach	No	Number (12,4)	Size of an each in terms of the uom_of_price. For example 12 oz. Used in ticketing.
ticketPerCount	No	Number (12,4)	Size to be used on the ticket in terms of the uom_of_price. For example, if the user wants the ticket to have the label print the price per ounce, this value would be 1. If the user wanted the price per 100 grams this value would be 100. Used in ticketing.
ticketUom	No	String (4)	Unit of measure that will be used on the ticket for this item.
primaryVariant	No	String (25)	This field is used to address sales of PLUs (i. e. above transaction level items) when inventory is tracked at a lower level (i. e. UPC). This field will only contain a value for items one level higher than the transaction level.
primaryCostPack	No	String (25)	This field contains an item number that is a simple pack containing the item in the item column for this record. If populated, the cost of the future cost table will be driven from the simple pack and the deals and cost changes for the simple pack.
inboundHandlingDays	No	Number (2)	This field indicates the number of inbound handling days for an item at a warehouse type location.
rangedInd	No	String (1)	This column determines if the location is ranged intentionally by the user for replenishment/selling or incidentally ranged by the RMS programs when item is not ranged to a specific location on the transaction.
costingLocation	No	Number (10)	Numeric identifier of the costing location for the franchise store. This field may contain a store or a warehouse.
sellingPhaseStartDate	No	date	Used to determine the timing of the generation of markdown recommendation, which will occur x weeks after the start of this phase.
updSellDateOnStOrdRcpt	No	String (1)	This indicates whether or not to update the Selling Phase Start Date for the item/location when a purchase order of this item is received at the store.
updSellDateOnWh2stRcpt	No	String (1)	This indicates whether or not to update the Selling Phase Start Date for the item/location when a warehouse to store transfer/allocation of this item is received at the store.
updSellDateOnSt2stRcpt	No	String (1)	This indicates whether or not to update the Selling Phase Start Date for the item/location when a store-to-store transfer of this item is received at the store.
minUnitsForSellDateReset	No	Number (12,4)	This field contains the minimum shipped quantity of an item on a transfer/allocation that will trigger the resetting of the Selling Phase Start Date. This value is only used if either of the Set Selling Start Date upon Receipt of a Warehouse to Store Transfer/Allocation or Set Selling Start Date upon Receipt of a Store to Store Transfer are set to Yes (Y).
mfgSugRetailInclTax	No	Number (20,4)	This field holds the tax-inclusive Manufacturer Suggested Retail in local currency and in an item’s standard UOM. It is used when default_tax_type is GTS or SVAT.
mfgSugRetailExclTax	No	Number (20,4)	This field holds the tax-exclusive Manufacturer Suggested Retail in local currency and in an item’s standard UOM. It is used when default_tax_type is SALES.
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL.
trait	No	Record	Child node.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-427 Trait - Object. See list of elements for detail

Element Name	Required	Data Type	Description
launchDate	No	date	The date the item should first be sold at the location. Value will be downloaded to the POS. No internal processing occurs from this field.
quantityKeyOptions	No	String (6)	Determines whether the qty key on a POS should be used for this item at the location. Valid values are in the code_type 'RPO'. Current values include 'R - required', 'P - Prohibited', and 'O - Optional'. Additional values can be added to the code type
manualPriceEntry	No	String (6)	Determines whether the price can/should be entered manually on a POS for this item at the location. Valid values are in the code_type 'RPO'. Current values include 'R - required', 'P - Prohibited', and 'O - Optional'. Additional values can be added.
depositCode	No	String (6)	Indicates whether a deposit is associated with this item at the location. Values are in the code_type 'DEPO'. The only processing in Merchandising is downloading it to the POS. Examples are None (NONE), Maine - 0.10 (ME2) and Maine - 0.05 (ME1).
foodStampInd	No	String (1)	Indicates whether the item is approved for food stamps at the location. This value will be downloaded to the POS.
wicInd	No	String (1)	Indicates whether the item is approved for WIC at the location. This value will be downloaded to the POS.
proportionalTarePercent	No	Number (12,4)	For items sold by weight, this is the proportion of the total weight of a unit of an item that is packaging.
fixedTareValue	No	Number (12,4)	Holds the weight of the packaging in items sold by weight at the location; i. e. if the tare item is bulk candy, this is weight of the bag and twist tie). The only processing Merchandising does is to download it to POS.
fixedTareUom	No	String (4)	Holds the unit of measure value associated with the tare value. The only processing Merchandising does involving the fixed tare value and UOM is downloading it to the POS. Fixed tare is not subtracted from items sold by weight when sales are uploaded to Merchandising, etc
rewardEligibleInd	No	String (1)	Holds whether the item is legally valid for various types of bonus point/award programs at the location. This value will be downloaded to the POS.
nationalBrandCompetitorItem	No	String (25)	Holds the nationally branded item to which you would like to compare the current item. This nationally branded item must exist as an item in Merchandising (i. e. on the item_master table).
returnPolicy	No	String (6)	The return policy for the item at the location. Valid values are in the code_type 'RETP'. This value will be downloaded to the POS. Examples are All returns accepted (ALL), Customer ID needed for return (ID) and Manager approval needed for return (MNGR).
stopSaleInd	No	String (1)	Indicates that sale of the item should be stopped immediately at the location (i. e. in case of recall etc). This value will be downloaded to the POS.
electronicMarketClubs	No	String (6)	Code for the marketing clubs to which the item belongs at the location. Valid values are in the code_type 'MTKC'. Examples are Baby Club (B), Baby/Family Clubs (BF) and Deli Club (D).
reportCode	No	String (6)	Code to determine which reports the location should run. Values are in the code type REPC (Report Code). Examples are All Locations Reports(ALL) and No Location Report (NO).
requiredShelfLifeOnSelection	No	Number (4)	Holds the required shelf life for an item on selection in days. This field is not required. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems that may need it.
requiredShelfLifeOnReceipt	No	Number (4)	Holds the required shelf life for an item on receipt in days. This field is not required. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems that may need it for processing
investmentBuyShelfLife	No	Number (4)	The Investment Buy-specific shelf life for the item/location
storeReorderableInd	No	String (1)	A code (Y or N) to indicate whether the store may re-order the item. Will default to N. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems.
rackSize	No	String (6)	Indicates the rack size that should be used for the item. Valid values for the field are in the code_type 'RACK'. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate to external systems. Examples are large (L), Medium (M) and Small (S).
fullPalletItem	No	String (1)	A code (Y or N) to indicate whether a store must reorder an item in full pallets only. Will default to N. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate to external systems.
inStoreMarketBasket	No	String (6)	The in store market basket code for this item/location. Valid values for the field are in the code_type 'STMB'. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems. Examples are A item at this loc (A), B item at this loc (B) and C item at this loc (C).
storageLocation	No	String (7)	Holds the current storage location or bin number for the item at the location. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems that may need it for processing.
alternateStorageLocation	No	String (7)	Holds the preferred alternate storage location or bin number for the item at the location. No Merchandising processing is based on the value in this field. It is clients responsibility to communicate this value to external systems that may need it for processing
returnableInd	No	String (1)	This field will contain a value of 'Y'es when the item can be returned to the location
refundableInd	No	String (1)	This field will contain a value of 'Y'es when the item is refundable at the location.
backOrderInd	No	String (1)	This field will contain a value of 'Y'es when the item can be back ordered to the location

Table 5-428 CustomFlexAttribute - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Table 5-429 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-430 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100000024",
      "hierarchyLevel": "S",
      "locations": [
        {
          "hierarchyValue": 6000,
          "primarySupplier": 6100,
          "primaryCountry": "US",
          "localItemDescription": "100000024 at 6000",
          "status": "I",
          "storeOrderMultiple": "E",
          "receiveAsType": null,
          "taxableInd": "N",
          "ti": 1,
          "hi": 1,
          "dailyWastePercent": 1,
          "localShortDescription": "100000024 at 6000",
          "uinType": null,
          "uinLabel": null,
          "captureTime": null,
          "externalUinInd": "N",
          "sourceMethod": "S",
          "sourceWarehouse": null,
          "promotableInd": "N",
          "rfidInd": "N",
          "ticketMeasureOfAnEach": 2,
          "ticketPerCount": 1,
          "ticketUom": "EA",
          "primaryVariant": "100100090",
          "primaryCostPack": "100100080",
          "inboundHandlingDays": 1,
          "rangedInd": "Y",
          "costingLocation": 199,
          "sellingPhaseStartDate": "2001-12-31",
          "updSellDateOnStOrdRcpt": "N",
          "updSellDateOnWh2stRcpt": "N",
          "updSellDateOnSt2stRcpt": "N",
          "minUnitsForSellDateReset": 50,
          "mfgSugRetailInclTax": 20,
          "mfgSugRetailExclTax": 18.16,
          "customFlexAttribute": [
            {
              "name": "REVIEW_DATE",
              "value": null,
              "valueDate": null
            }
          ],
          "trait": {
            "launchDate": "2001-12-31",
            "quantityKeyOptions": null,
            "manualPriceEntry": null,
            "depositCode": null,
            "foodStampInd": "N",
            "wicInd": "N",
            "proportionalTarePercent": 3,
            "fixedTareValue": 3,
            "fixedTareUom": "EA",
            "rewardEligibleInd": "N",
            "nationalBrandCompetitorItem": null,
            "returnPolicy": null,
            "stopSaleInd": "N",
            "electronicMarketClubs": null,
            "reportCode": null,
            "requiredShelfLifeOnSelection": 1000,
            "requiredShelfLifeOnReceipt": 1000,
            "investmentBuyShelfLife": 1000,
            "storeReorderableInd": "Y",
            "rackSize": null,
            "fullPalletItem": null,
            "inStoreMarketBasket": null,
            "storageLocation": null,
            "alternateStorageLocation": null,
            "returnableInd": "N",
            "refundableInd": "N",
            "backOrderInd": "N"
          },
          "localizationExtensions": [
            {
              "country": "BR",
              "attributes": [
                {
                  "name": "SPECIAL_CATEGORY_CODE",
                  "value": "WS_PRC_08",
                  "valueDate": "2001-12-31"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Item Number Reservation Upload Service

The following services are included in this functional area:

• Generate and Reserve Item Numbers

Manage Item Numbers

Functional Area

Items - Item Definition

Business Overview

This service allows external systems to create or delete item number reservations. A list of item identifiers can be provided to be reserved (or removed from reservation) within Merchandising. These pre-reserved numbers will not be considered for any auto-generated item numbers or manual item entry in Merchandising.  Reserved numbers can be used as identifiers on new items through Item spreadsheet upload by providing the desired reserved item identifier and setting the Pre-Reserved flag to Yes on the Item_Master worksheet. During upload into Merchandising, the system will validate that the number exists as a reserved number. If found, the new item will be uploaded with the reserved number as its identifier and the reserved number will be deleted from the item reservation table (SVC_ITEM_RESERVATION).

• With an Action of CREATE, this service accepts one or more item numbers to be reserved. If the Action is left blank, it will be assumed to be CREATE.

  • The provided item identifiers must not correspond to existing items in Merchandising, nor should they be an existing reserved item number.

• With an Action of DELETE, this service accepts one or more currently reserved item numbers. These reservations will be removed, freeing up the identifiers for future item creation in Merchandising.

  • The provided item identifiers must be existing reserved item numbers.

Service Type

POST

ReST URL

MerchIntegrations/services/item/itemNumbers/manage

Input Payload Details

Table 5-431 Manage - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items identifiers to be reserved.

Table 5-432 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	No	String (10)	This optional field should be used to delete an existing reserved item number. Valid values are CREATE or DELETE. If this is not provided, it is defaulted to CREATE.
item	Yes	String (25)	References the item identifier that the external system wants to reserve. This item identifier should not exist in item_master and svc_item_reservation table.

Table 5-433 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	No	String (25)	Reference the item identifier that failed business validation
errorMessage	Yes	String (2000)	Contains the error message

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "action": "CREATE",
      "item": "1000012332"
    }
  ]
}

Response Code: 200 (Success)

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service. The element businessError will be present if the payload passes schema validation but an exception is caught while processing the business logic.

Table 5-434 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	No	String (25)	Reference the item identifier that failed business validation
errorMessage	Yes	String (2000)	Contains the error message

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    {
      "item": "1000012332",
      "errorMessage": "An item with this number is already in use"
    }
  ]
}

Generate and Reserve Item Numbers

Functional Area

Items - Item Definition

Business Overview

This service allows external systems such as Oracle Retail Assortment Planning (AP) to send a request to Merchandising to generate and reserve one or more item numbers. The next available item numbers are generated by Merchandising and are sent back to the calling solution as a response. These reserved numbers will not be considered for any auto-generated item numbers or manual item entry in Merchandising.

• This service allows the calling system to ask for 1 to n item numbers where n cannot exceed the 'Maximum Item Reserved Quantity', which is defined in the 'Coresvc_Item_Configuration' worksheet of the ‘Item Data Loading Configuration’ foundation data spreadsheet template, which is listed under the ‘Administration’ template type.

• The service generates the numbers and they are considered reserved until they expire.  The calling system can specify for how long the numbers are reserved. The days until expiry cannot exceed the ‘Maximum Item Expiry Days’, which is defined in the 'Coresvc_Item_Configuration' worksheet of the ‘Item Data Loading Configuration’ foundation data spreadsheet template, which is listed under the ‘Administration’ template type.

• The generated numbers can be of any item number type for which Merchandising supports auto-generation: ITEM, UPC-A, UPC-AS, EAN13, or EAN13S.

• Reserved numbers are stored in the Item Reservation table (SVC_ITEM_RESERVATION).

• Reserved numbers can be used as identifiers on new items through Item spreadsheet upload by providing the desired, reserved item identifier and setting the Pre-Reserved flag to Yes on the Item_Master worksheet. During upload into Merchandising, the system will validate that the number exists as a reserved number. If found, the new item will be uploaded with the reserved number as its identifier and the reserved number will be deleted from the item reservation table (SVC_ITEM_RESERVATION).

Service Type

POST

ReST URL

MerchIntegrations/services/item/itemNumbers/reserve

Input Payload Details

Table 5-435 Reserve - Object. See list of elements for detail

Element Name	Required	Data Type	Description
itemNumberType	Yes	String (6)	Contains the type of item number to reserve. It must be a valid number type in RMS that supports auto generation of item numbers, including ITEM, UPC-A, UPC-AS, EAN13.
quantity	Yes	Number (10)	Contains the number of item numbers to reserve. The maximum number of items that can be requested is configurable using Item Service configuration.
daysUntilExpiry	Yes	Number (10)	Indicates how long the calling solution wants Merchandising to retain the reservation. After this many days, the reservation will be released allowing these numbers to be used for other purposes. This is required and must be a value greater than 0. The max number of days is configurable using Item Service configuration.

Sample Input Message

{
  "itemNumberType": "ITEM",
  "quantity": 50,
  "daysUntilExpiry": 14
}

Response Code: 200 (Success)

Table 5-436 ReserveResponse - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	This is collection record. Refer to corresponding record details

Table 5-437 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	Contains the unique item number reserved in RMS.
itemNumberType	Yes	String (6)	Contains the type of item number in the item field.
expiryDate	Yes	date	The date when the reserved item number will expire.

Sample Response Message

{
  "items": [
    {
      "item": "100100076",
      "itemNumberType": "UPC-A",
      "expiryDate": "2001-12-31"
    }
  ]
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element "validationErrors" will be present when input payload or input parameters are not as per the schema definition of this service. The element "businessError" will be present if the payload passes schema validation but exception is caught while processing business logic.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    "Error message"
  ]
}

Item Placeholder Upload Service

The following services are included in this functional area:

• Create Placeholder Items

Create Placeholder Items

Functional Area

Items - Item Definition

Business Overview

This service supports subscribing to new placeholder items (Style/Color or Styles) created in A&IP as part of the slow item creation workflow. Using this service, A&IP can create items in the Item induction staging area within Merchandising with partial information of the item that can be enriched at a later point using the item induction process. The item number fetched using the Reserve item number service for the placeholder item number is used by A&IP.

The following item attributes are defaulted in this service -

• The transaction level of the item will be 2.

• The item will be a regular (non-pack, non-catchweight), sellable, orderable, inventoried, merchandise one.

• The item will be created in the Worksheet status

• The standard UOM will be set to Each (EA)

• The Store order multiple will be set to 'E' (Eaches).

• The item number type will be Manual.

• The aggregate indictors for the 2nd, 3rd and 4th differentiators will be set to 'N'.

• The pallet/case/inner name will be set to PAL/CS/INR respectively.

• The only UDA supported is LV (List of Values)

Service Type

POST

ReST URL

MerchIntegrations/services/item/placeholderItems/create

Input Payload Details

Table 5-438 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	It's a collection of Items record. Refer to items details

Table 5-439 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
itemParent	No	String (25)	The item at the level above this item. This value must be predefined as an item on the ITEM_MASTER table.
itemLevel	Yes	Number (1)	The level of the item. Valid values are 1 - Style item, 2 - Sku
diff1	No	String (10)	A differentiator id which differentiates a transaction level item from its parent item. If the item on the message is a parent this field may hold a differentiator group id.
dept	Yes	Number (4)	The number of the department to which this item belongs. This value must be predefined on the DEPS table. It cannot be modified.
class	Yes	Number (4)	The number of the class to which the item belongs. This value must be predefined on the CLASS table. It cannot be modified.
subclass	Yes	Number (4)	The number of the subclass to which the item belongs. This value must be predefined on the SUBCLASS table. It cannot be modified.
itemDescription	Yes	String (250)	The long description of the item.
itemSuppliers	No	Collection of Object	It is a collection of ItemSupplier record. Refer to itemSupplier details
itemUdas	No	Collection of Object	It is a collection of ItemUda's record. Refer to itemUdas details
itemAggregateInd	No	String (1)	Indicator to aggregate inventory and sales for the item.
diff1AggregateInd	No	String (1)	Indicator for the corresponding diff. Indicator to aggregate inventory and sales for an item at Parent/Diff level (e.g Style/Color or Style/Size).
brand	No	String (120)	This is added to capture the brand information of an item.

Table 5-440 ItemSuppliers - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	Number (10)	The identifier of the supplier who sources the item. This value must be predefined on the SUPS table.

Table 5-441 ItemUdas - Object. See list of elements for detail

Element Name	Required	Data Type	Description
udaId	Yes	Number (5)	This field contains a number identifying the User-Defined Attribute of type List of Value
udaValue	No	String (30)	This field contains value of the Used Defined attribute for the item.

Sample Input Message

{
  "items": [
    {
      "item": "100100076",
      "itemParent": null,
      "itemLevel": "1",
      "diff1": "BLACK",
      "dept": 3041,
      "class": 1,
      "subclass": 1,
      "itemDescription": "Placeholder item",
      "itemSuppliers": [
        {
          "supplier": 2400
        }
      ],
      "itemUdas": [
        {
          "udaId": 25021,
          "udaValue": "10"
        }
      ],
      "itemAggregateInd": "Y",
      "diff1AggregateInd": "Y",
      "brand": null
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS",
  "message": "Service call is successful"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element "validationErrors" will be present when input payload or input parameters are not as per the schema definition of this service. The element "businessError" will be present if the payload passes schema validation but exception is caught while processing business logic.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    "Error message"
  ]
}

Item Sourcing Upload Service

The following services are included in this functional area:

• Create Item Supplier Countries

• Create Item Supplier Countries of Manufacture

• Create Item Supplier Country Dimensions

• Create Item Supplier Country Locations

• Create Item Supplier Translations

• Create Item Suppliers

• Delete Item Supplier Countries

• Delete Item Supplier Countries of Manufacture

• Delete Item Supplier Country Dimensions

• Delete Item Supplier Country Locations

• Delete Item Supplier Translations

• Delete Item Suppliers

• Update Item Supplier Countries

• Update Item Supplier Countries of Manufacture

• Update Item Supplier Country Dimensions

• Update Item Supplier Country Locations

• Update Item Supplier Translations

• Update Item Suppliers

Create Item Supplier Countries

Functional Area

Items - Item Definition

Business Overview

This service is used to add country information to existing item supplier in Merchandising. The item supplier must already exist in Merchandising, else an error will be returned. Item supplier country can also be created together with the creation of a new item. For more details on item creation, see the Create Items service description.

Service Type

POST

ReST URL

MerchIntegrations/services/item/supplier/countries/create

Input Payload Details

Table 5-442 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-443 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
supplier	No	Collection of Object	References a collection of suppliers associated to the item.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-444 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	The identifier of the supplier who sources the item. This value must be predefined on the SUPS table.
countryOfSourcing	No	Collection of Object	References a collection of country of sourcing of the item.

Table 5-445 CountryOfSourcing - Object. See list of elements for detail

Element Name	Required	Data Type	Description
originCountry	Yes	String (3)	The identifier for the country where the item is sourced. This value must be predefined on the COUNTRY table.
primaryCountryInd	No	String (1)	This indicates if the country is the primary country for the item supplier. Valid values are Y (yes) and N (no).
unitCost	No	Number (20,4)	The current corporate unit cost for the item in the supplier's currency. This field will only be used to establish the item supplier country unit cost; it cannot be modified.
leadTime	No	Number (4)	This field contains the number of days that will elapse between the date an order is written and the delivery to the store or warehouse from the supplier. This field is defaulted from the default lead time set at the supplier level.
pickupLeadTime	No	Number (4)	Contains time it takes to get the item from the Supplier to the Initial Receiving Location. This value will be defaulted to the item_supp_country_loc pickup lead time field. The ordering dialog will reference the item/supplier/country/location pickup lead time as the value may vary by location.
mininumOrderQuantity	No	Number (12,4)	This field contains the minimum quantity that can be ordered at one time from the supplier for the item.
maximumOrderQuantity	No	Number (12,4)	This field contains the maximum quantity that can be ordered at one time from the supplier for the item.
supplierHierarchyLevel1	No	String (10)	Highest level of supplier hierarchy (e. g. manufacturer). This will be used for assigning rebates that come from a level in the supply chain that is higher than the supplier. This information is stored on item_supp_country for defaulting into item_supp_country_loc.
supplierHierarchyLevel2	No	String (10)	Second highest level of supplier hierarchy. This information is stored on item_supp_country for defaulting into item_supp_country_loc.
supplierHierarchyLevel3	No	String (10)	Third highest level of supplier hierarchy. This information is stored on item_supp_country for defaulting into item_supp_country_loc.
defaultUop	No	String (6)	Contains the default unit of purchase for the item/supplier/country. Valid values include: Standard Units of Measure C for Case P for Pallet
supplierPackSize	No	Number (12,4)	Contains the quantity that orders must be placed in multiples of for the supplier for the item.
innerPackSize	No	Number (12,4)	This field contains the break pack size for this item from the supplier.
ti	No	Number (12)	Number of shipping units (cases) that make up one tier of a pallet. Multiply TI x HI to get total number of units (cases) for a pallet.
hi	No	Number (12)	Number of tiers that make up a complete pallet (height). Multiply TI x HI to get total number of units (cases) for a pallet.
costUom	No	String (4)	Unit of measure associated with the item cost. It is held to allow costs to be managed in a separate UOM from the standard UOM.
toleranceType	No	String (6)	The unit of the tolerances for catch weight simple packs: A - actual, P - percent.
minimumTolerance	No	Number (12,4)	The minimum tolerance value for a catch weight simple pack.
maximumTolerance	No	Number (12,4)	The maximum tolerance value for a catch weight simple pack.
supplierHierarchyType1	No	String (6)	Identifies partner type of supplier hierarchy level 1 for the foreign key to the partner table.
supplierHierarchyType2	No	String (6)	Identifies partner type of supplier hierarchy level 2 for the foreign key to the partner table.
supplierHierarchyType3	No	String (6)	Identifies partner type of supplier hierarchy level 3 for the foreign key to the partner table.
roundLevel	No	String (6)	This column will be used to determine how order quantities will be rounded to Case, Layer and Pallet.
roundToInnerPercentage	No	Number (12,4)	The Inner Rounding Threshold value. Used to determine whether to round partial Inner quantities up or down.
roundToCasePercentage	No	Number (12,4)	The Case Rounding Threshold value. Used to determine whether to round partial Case quantities up or down.
roundToLayerPercentage	No	Number (12,4)	The Layer Rounding Threshold value. Used to determine whether to round partial Layer quantities up or down.
roundToPalletPercentage	No	Number (12,4)	The Pallet Rounding Threshold value. Used to determine whether to round partial Pallet quantities up or down.
packingMethod	No	String (6)	This field indicates whether the packing method of the item in the container is Flat or Hanging. Values for this field are defined in PKMT code type. Examples are: FLAT - Flat, HANG - Hanging.
defaultExpenseProfilesInd	No	String (1)	This field indicates whether expense profiles will be defaulted to new item-supplier-country relationship.
purchaseType	No	String (1)	This contains a code to indicate whether the item is normal merchandise (i. e. owned by the retailer), consignment stock or a concession item. Valid values are 0 - Owned, 1 - Consignment, 2 - Concession.
calculationBasis	No	String (1)	This indicates if the cost for the consignment/concession item will be managed either based on cost per unit or as a percentage of retail. Valid values are C - Cost per Unit, P - Purchase Rate.
purchaseRate	No	Number (12,4)	This column contains the percentage of the retail price which will determine the cost paid to the supplier for a consignment or concession item.
pricingControl	No	String (1)	This indicates whether the price for the consignment/concession item will be managed by supplier or by retailer when supplier-controlled pricing for Consignment/Concession ownership model is used within the Merchandising suite of solutions. Valid values are: R – Retailer S – Supplier If no value is provided for consignment/concession items, this will be defaulted based on the default pricing control at supplier site level.
dimension	No	Collection of Object	References a collection of item supplier country dimensions.
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-446 Dimension - Object. See list of elements for detail

Element Name	Required	Data Type	Description
dimensionObject	Yes	String (6)	Specific object whose dimensions are specified in this record (e. g. case, pallet, each). Valid codes are defined in the DIMO code type. Examples are: CA - Case, EA - Each.
tareWeight	No	Number (12,4)	Amount of weight to be subtracted for packaging materials. Used to calculate the true net weight of the dimensionObject.
tareType	No	String (6)	Indicates if tare weight for this dimensionObject is wet or dry. Valid values are defined in the TARE code type. Examples are: W - Wet tare weight, D - Dry tare weight.
lwhUom	No	String (4)	Unit of measurement for length, width, and height (e. g. inches, centimeters, feet). Valid values for this field are contained in uom field on uom_class table where uom_class field = DIMEN.
length	No	Number (12,4)	Length of dim_object measured in units specified in lwh_uom.
width	No	Number (12,4)	Width of dim_object measured in units specified in lwh_uom.
height	No	Number (12,4)	Height of dim_object measured in units specified in lwh_uom.
liquidVolume	No	Number (12,4)	Liquid volume, or capacity, of dim_object measured in units specified in volume_uom. Liquid volumes are only convertible to other liquid volumes.
liquidVolumeUom	No	String (4)	Unit of measurement for liquid_volume (e. g. ounces, liters). Liquid volumes are only convertible to other liquid volumes. Valid values for this field are contained in uom field on uom_class table where uom_class field = LVOL.
statisticalCase	No	String (12)	Statistical value of the dim_objects dimensions to be used for loading purposes.
weightUom	No	String (4)	Unit of measurement for weight (e. g. pounds, kilograms). Valid values for this field are contained in uom field on uom_class table where uom_class field = MASS.
weight	No	Number (12,4)	Weight of dim_object measured in units specified in weight_uom.
netWeight	No	Number (12,4)	Unit of measurement for length, width, and height (e. g. inches, centimeters, feet). Valid values for this field are contained in uom field on uom_class table where uom_class field = DIMEN.
presentationMethod	No	String (6)	Describes the packaging (if any) being taken into consideration in the specified dimensions. Valid codes are defined in the PCKT code type. Examples are: JHOOK - Peggable Packaging, STACK - Stackable Packaging.

Table 5-447 CustomFlexAttribute - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Table 5-448 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-449 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "supplier": [
        {
          "supplier": "2400",
          "countryOfSourcing": [
            {
              "originCountry": "US",
              "primaryCountryInd": "Y",
              "unitCost": 9.65,
              "leadTime": 1,
              "pickupLeadTime": 1,
              "mininumOrderQuantity": 1,
              "maximumOrderQuantity": 1,
              "supplierHierarchyLevel1": null,
              "supplierHierarchyLevel2": null,
              "supplierHierarchyLevel3": null,
              "defaultUop": null,
              "supplierPackSize": 1,
              "innerPackSize": 1,
              "ti": 1,
              "hi": 1,
              "costUom": "EA",
              "toleranceType": null,
              "minimumTolerance": 76.00,
              "maximumTolerance": 69.00,
              "supplierHierarchyType1": null,
              "supplierHierarchyType2": null,
              "supplierHierarchyType3": null,
              "roundLevel": "C",
              "roundToInnerPercentage": 50,
              "roundToCasePercentage": 50,
              "roundToLayerPercentage": 50,
              "roundToPalletPercentage": 50,
              "packingMethod": "HANG",
              "defaultExpenseProfilesInd": "Y",
              "purchaseType": "0",
              "calculationBasis": null,
              "purchaseRate": 18.00,
              "pricingControl": "R",
              "dimension": [
                {
                  "dimensionObject": "CA",
                  "tareWeight": 3,
                  "tareType": "D",
                  "lwhUom": "IN",
                  "length": 3,
                  "width": 3,
                  "height": 3,
                  "liquidVolume": 3,
                  "liquidVolumeUom": "EA",
                  "statisticalCase": null,
                  "weightUom": "EA",
                  "weight": 3,
                  "netWeight": 11.00,
                  "presentationMethod": null
                }
              ],
              "customFlexAttribute": [
                {
                  "name": "REVIEW_DATE",
                  "value": null,
                  "valueDate": "2001-12-31"
                }
              ],
              "localizationExtensions": [
                {
                  "country": "BR",
                  "attributes": [
                    {
                      "name": "SPECIAL_CATEGORY_CODE",
                      "value": "WS_PRC_08",
                      "valueDate": "2001-12-31"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Create Item Supplier Countries of Manufacture

Functional Area

Items - Item Definition

Business Overview

This service is used to add item supplier manufacturing country to an existing item supplier in Merchandising. The item supplier must already exist in Merchandising, else an error will be returned. Item supplier manufacturing country can also be created together with the creation of a new item. For more details on item creation, see the Create Items service description.

Service Type

POST

ReST URL

MerchIntegrations/services/item/supplier/countriesOfManufacture/create

Input Payload Details

Table 5-450 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-451 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
supplier	No	Collection of Object	References a collection of suppliers associated to the item.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-452 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	The identifier of the supplier who sources the item. This value must be predefined on the SUPS table.
countryOfManufacture	No	Collection of Object	References a collection of country of manufacture of the item.

Table 5-453 CountryOfManufacture - Object. See list of elements for detail

Element Name	Required	Data Type	Description
manufacturerCountry	Yes	String (23)	Country ID of manufacturer.
primaryManufacturerCountryInd	No	String (1)	Indicates if it's the primary country of manufacturer.

Table 5-454 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-455 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100300001",
      "dataLoadingDestination": "RMS",
      "supplier": [
        {
          "supplier": "2400",
          "countryOfManufacture": [
            {
              "manufacturerCountry": "BR",
              "primaryManufacturerCountryInd": "N"
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Create Item Supplier Country Dimensions

Functional Area

Items - Item Definition

Business Overview

This service is used to add dimensions to an existing item supplier country in Merchandising. Dimensions are not required for an item. However, if non-standard units of measure will be used for the item there must be a case-type dimension provided. For example, for a selling unit retail to be defined in ounces there must be a dimension defined containing the liquid and volume to be used when converting between a unit and an ounce. The item supplier country must already exist in Merchandising, else an error will be returned. Item supplier country dimension can also be created together with the creation of a new item. For more details on item creation, see the Create Items service description.

Service Type

POST

ReST URL

MerchIntegrations/services/item/supplier/country/dimensions/create

Input Payload Details

Table 5-456 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-457 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
supplier	No	Collection of Object	References a collection of suppliers associated to the item.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-458 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	The identifier of the supplier who sources the item. This value must be predefined on the SUPS table.
countryOfSourcing	No	Collection of Object	References a collection of country of sourcing of the item.

Table 5-459 CountryOfSourcing - Object. See list of elements for detail

Element Name	Required	Data Type	Description
originCountry	Yes	String (3)	The identifier for the country where the item is sourced. This value must be predefined on the COUNTRY table.
dimension	No	Collection of Object	References a collection of item supplier country dimensions.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-460 Dimension - Object. See list of elements for detail

Element Name	Required	Data Type	Description
dimensionObject	Yes	String (6)	Specific object whose dimensions are specified in this record (e. g. case, pallet, each). Valid codes are defined in the DIMO code type. Examples are: CA - Case, EA - Each.
tareWeight	No	Number (12,4)	Amount of weight to be subtracted for packaging materials. Used to calculate the true net weight of the dimensionObject.
tareType	No	String (6)	Indicates if tare weight for this dimensionObject is wet or dry. Valid values are defined in the TARE code type. Examples are: W - Wet tare weight, D - Dry tare weight.
lwhUom	No	String (4)	Unit of measurement for length, width, and height (e. g. inches, centimeters, feet). Valid values for this field are contained in uom field on uom_class table where uom_class field = DIMEN.
length	No	Number (12,4)	Length of dim_object measured in units specified in lwh_uom.
width	No	Number (12,4)	Width of dim_object measured in units specified in lwh_uom.
height	No	Number (12,4)	Height of dim_object measured in units specified in lwh_uom.
liquidVolume	No	Number (12,4)	Liquid volume, or capacity, of dim_object measured in units specified in volume_uom. Liquid volumes are only convertible to other liquid volumes.
liquidVolumeUom	No	String (4)	Unit of measurement for liquid_volume (e. g. ounces, liters). Liquid volumes are only convertible to other liquid volumes. Valid values for this field are contained in uom field on uom_class table where uom_class field = LVOL.
statisticalCase	No	String (12)	Statistical value of the dim_objects dimensions to be used for loading purposes.
weightUom	No	String (4)	Unit of measurement for weight (e. g. pounds, kilograms). Valid values for this field are contained in uom field on uom_class table where uom_class field = MASS.
weight	No	Number (12,4)	Weight of dim_object measured in units specified in weight_uom.
netWeight	No	Number (12,4)	Unit of measurement for length, width, and height (e. g. inches, centimeters, feet). Valid values for this field are contained in uom field on uom_class table where uom_class field = DIMEN.
presentationMethod	No	String (6)	Describes the packaging (if any) being taken into consideration in the specified dimensions. Valid codes are defined in the PCKT code type. Examples are: JHOOK - Peggable Packaging, STACK - Stackable Packaging.

Table 5-461 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-462 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "102250001",
      "dataLoadingDestination": "RMS",
      "supplier": [
        {
          "supplier": "2400",
          "countryOfSourcing": [
            {
              "originCountry": "US",
              "dimension": [
                {
                  "dimensionObject": "CA",
                  "tareWeight": 3,
                  "tareType": "D",
                  "lwhUom": "IN",
                  "length": 3,
                  "width": 3,
                  "height": 3,
                  "liquidVolume": 3,
                  "liquidVolumeUom": "EA",
                  "statisticalCase": null,
                  "weightUom": "EA",
                  "weight": 3,
                  "netWeight": 11.00,
                  "presentationMethod": null
                }
              ],
              "localizationExtensions": [
                {
                  "country": "BR",
                  "attributes": [
                    {
                      "name": "SPECIAL_CATEGORY_CODE",
                      "value": "WS_PRC_08",
                      "valueDate": "2001-12-31"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Create Item Supplier Country Locations

Functional Area

Items - Item Definition

Business Overview

This service is used to add location information to an existing item supplier country in Merchandising. Records are not required at this level for an item however, if provided the values override those defined at the item/supplier/country level for the specified location(s). The item supplier country must already exist in Merchandising, else an error will be returned.  Item supplier country location can also be created together with the creation of a new item. For more details on item creation, see the Create Items service description.

Service Type

POST

ReST URL

MerchIntegrations/services/item/supplier/country/locations/create

Input Payload Details

Table 5-463 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-464 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
itemSuppCountryLocHierarchyLevel	No	String (2)	The level of the organizational hierarchy used to create item supplier country location relationships. Valid values are: 'AS' - All Store, 'S' - Store, 'DW'- Default Warehouse, 'AW' - All Warehouses, 'W' - Warehouse, 'PW' - Physical Warehouse, 'D' - District, 'R' - Region, 'A' - Area, 'T' - Transfer zone, 'L' - Location trait.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
supplier	No	Collection of Object	References a collection of suppliers associated to the item.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-465 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	The identifier of the supplier who sources the item. This value must be predefined on the SUPS table.
countryOfSourcing	No	Collection of Object	References a collection of country of sourcing of the item.

Table 5-466 CountryOfSourcing - Object. See list of elements for detail

Element Name	Required	Data Type	Description
originCountry	Yes	String (3)	The identifier for the country where the item is sourced. This value must be predefined on the COUNTRY table.
location	No	Collection of Object	References a collection of item supplier country locations.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-467 Location - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hierarchyId	No	Number (10)	The specific location id for this Item Supplier Country Loc message. Corresponds with the value used in the iscloc_hier_level field.
unitCost	No	Number (20,4)	The unit cost for the item at the item supplier country loc level in the supplier's currency. This field will be used for creating new records, not updating existing records.
negotiatedItemCost	No	Number (20,4)	This will hold the supplier negotiated item cost.
pickupLeadTime	No	Number (4)	Contains time it takes to get the item from the Supplier to the Initial Receiving Location. This value will be defaulted to the item_supp_country_loc pickup lead time field. The ordering dialog will reference the item/supplier/country/location pickup lead time as the value may vary by location.
roundLevel	No	String (6)	This column will be used to determine how order quantities will be rounded to Case, Layer and Pallet.
roundToCasePercentage	No	Number (12,4)	The Case Rounding Threshold value. Used to determine whether to round partial case quantities up or down.
roundToLayerPercentage	No	Number (12,4)	The Layer Rounding Threshold value. Used to determine whether to round partial Layer quantities up or down.
roundToPalletPercentage	No	Number (12,4)	The Pallet Rounding Threshold value. Used to determine whether to round partial Pallet quantities up or down.
roundToInnerPercentage	No	Number (12,4)	The Inner Rounding Threshold value. Used to determine whether to round partial Inner quantities up or down.
supplierHierarchyLevel1	No	String (10)	Highest level of supplier hierarchy (e. g. manufacturer). This will be used forassigning rebates that come from a level in the supply chain that is higher than the supplier.
supplierHierarchyLevel2	No	String (10)	Second highest level of supplier hierarchy. Rebates at this level will include all eligible supplier/item/country/loc records assigned to this supplier hierarchy level.
supplierHierarchyLevel3	No	String (10)	Third highest level of supplier hierarchy, used for assigning rebates by a level other than supplier.
costUom	No	String (4)	Unit of measure associated with the item cost. It is held to allow costs to be managed in a separate UOM from the standard UOM.
purchaseType	No	String (1)	This contains a code to indicate whether the item is normal merchandise (i. e. owned by the retailer), consignment stock or a concession item. Valid values are 0 - Owned, 1 - Consignment, 2 - Concession.
calculationBasis	No	String (1)	This indicates if the cost for the consignment/concession item will be managed either based on cost per unit or as a percentage of retail. Valid values are C - Cost per Unit, P - Purchase Rate.
purchaseRate	No	Number (12,4)	This column contains the percentage of the retail price which will determine the cost paid to the supplier for a consignment or concession item.
pricingControl	No	String (1)	This indicates whether the price for the consignment/concession item will be managed by supplier or by retailer when supplier-controlled pricing for Consignment/Concession ownership model is used within the Merchandising suite of solutions. Valid values are: R – Retailer S – Supplier If no value is provided for consignment/concession items, this will be defaulted based on the default pricing control at supplier site level.
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named, flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL.

Table 5-468 CustomFlexAttribute - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Table 5-469 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-470 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100041",
      "itemSuppCountryLocHierarchyLevel": "S",
      "dataLoadingDestination": "RMS",
      "supplier": [
        {
          "supplier": "2400",
          "countryOfSourcing": [
            {
              "originCountry": "US",
              "location": [
                {
                  "hierarchyId": 1521,
                  "unitCost": 9.65,
                  "negotiatedItemCost": 9.65,
                  "pickupLeadTime": 1,
                  "roundLevel": "C",
                  "roundToCasePercentage": 50,
                  "roundToLayerPercentage": 50,
                  "roundToPalletPercentage": 50,
                  "roundToInnerPercentage": 50,
                  "supplierHierarchyLevel1": null,
                  "supplierHierarchyLevel2": null,
                  "supplierHierarchyLevel3": null,
                  "costUom": "EA",
                  "purchaseType": "0",
                  "calculationBasis": null,
                  "purchaseRate": 3,
                  "pricingControl": "R",
                  "customFlexAttribute": [
                    {
                      "name": "REVIEW_DATE",
                      "value": null,
                      "valueDate": "2001-12-31"
                    }
                  ]
                }
              ],
              "localizationExtensions": [
                {
                  "country": "BR",
                  "attributes": [
                    {
                      "name": "SPECIAL_CATEGORY_CODE",
                      "value": "WS_PRC_08",
                      "valueDate": "2001-12-31"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Create Item Supplier Translations

Functional Area

Items - Item Definition

Business Overview

If translations have been defined for items, at the supplier level, then they can be integrated as part of this service. This service will accept the language and the description specified in the language to add supplier level translations to an existing item in Merchandising.

Service Type

POST

ReST URL

MerchIntegrations/services/item/supplier/translations/create

Input Payload Details

Table 5-471 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-472 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
supplier	No	Collection of Object	References a collection of suppliers associated to the item.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-473 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	The identifier of the supplier who sources the item. This value must be predefined on the SUPS table.
translation	No	Collection of Object	References a collection of translations of item supplier description fields.

Table 5-474 Translation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This is the language ID.
supplierDiff1	No	String (120)	This field contains the first supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff2	No	String (120)	This field contains the second supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff3	No	String (120)	This field contains the third supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff4	No	String (120)	This field contains the fourth supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierLabel	No	String (15)	The supplier label for the item.

Table 5-475 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-476 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "supplier": [
        {
          "supplier": "2400",
          "translation": [
            {
              "language": 13,
              "supplierDiff1": "فرق المورد 1",
              "supplierDiff2": "فرق المورد 2",
              "supplierDiff3": "فرق المورد 3",
              "supplierDiff4": "فرق المورد 4",
              "supplierLabel": "عنصر تسمية المورد"
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Create Item Suppliers

Functional Area

Items - Item Definition

Business Overview

This service is used to add item suppliers to an existing item in Merchandising. The item must already exist in Merchandising, else an error will be returned. Item supplier can also be created together with the creation of a new item. For more details on item creation, see the Create Items service description.

Service Type

POST

ReST URL

MerchIntegrations/services/item/suppliers/create

Input Payload Details

Table 5-477 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-478 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
supplier	No	Collection of Object	References a collection of suppliers associated to the item.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-479 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	The identifier of the supplier who sources the item. This value must be predefined on the SUPS table.
primarySupplierInd	No	String (3)	Indicates if the supplier is the primary supplier for the item. Valid values are Y (yes) and N (no).
vpn	No	String (30)	The vendor product number associated with the item.
supplierLabel	No	String (15)	The supplier label for the item.
consignmentRate	No	Number (12,4)	This field contains the consignment rate for this item for the supplier.
supplierDiscontinueDate	No	date	Date which the supplier discontinues an item. The retailor should be aware that the supplier is able to reuse a UPC after 30 months and should work to ensure that no data exists in RMS for a UPC 30 months after it has been discontinued.
directShipInd	No	String (1)	Contains a value of Yes to indicate that any item asssociated with this supplier is eligible for a direct shipment from the supplier to the customer.
palletName	No	String (6)	Code referencing the name used to refer to the pallet. Valid codes are defined in the PALN code type. Examples are FLA - Flat, PAL - Pallet.
caseName	No	String (6)	Code referencing the name used to refer to the case. Valid codes are defined in the CASN code type. Examples are PACK - Pack, BX - Box, BG - Bag.
innerName	No	String (6)	Code referencing the name used to refer to the inner. Valid codes are defined in the INRN code type. Examples are SCS - Sub-Case, SPACK - Sub-Pack.
primaryCaseSize	No	String (6)	Used only if AIP is interfaced. Indicates the primary case size for the item supplier when an orderable item is configured for informal case types.
supplierDiff1	No	String (120)	This field contains the first supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff2	No	String (120)	This field contains the second supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff3	No	String (120)	This field contains the third supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff4	No	String (120)	This field contains the fourth supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
concessionRate	No	Number (12,4)	The concession rate is the margin that a particular supplier receives for the sale of a concession item.
defaultExpenseProfilesInd	No	String (1)	This field indicates whether expense profiles will be defaulted to new item-supplier relationship. Valid values are Y (yes) and N (no).
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL.
translation	No	Collection of Object	References a collection of translations of item supplier description fields.
countryOfSourcing	No	Collection of Object	References a collection of country of sourcing of the item.
countryOfManufacture	No	Collection of Object	References a collection of country of manufacture of the item.

Table 5-480 CountryOfSourcing - Object. See list of elements for detail

Element Name	Required	Data Type	Description
originCountry	Yes	String (3)	The identifier for the country where the item is sourced. This value must be predefined on the COUNTRY table.
primaryCountryInd	No	String (1)	This indicates if the country is the primary country for the item supplier. Valid values are Y (yes) and N (no).
unitCost	No	Number (20,4)	The current corporate unit cost for the item in the supplier's currency. This field will only be used to establish the item supplier country unit cost; it cannot be modified.
leadTime	No	Number (4)	This field contains the number of days that will elapse between the date an order is written and the delivery to the store or warehouse from the supplier. This field is defaulted from the default lead time set at the supplier level.
pickupLeadTime	No	Number (4)	Contains time it takes to get the item from the Supplier to the Initial Receiving Location. This value will be defaulted to the item_supp_country_loc pickup lead time field. The ordering dialog will reference the item/supplier/country/location pickup lead time as the value may vary by location.
mininumOrderQuantity	No	Number (12,4)	This field contains the minimum quantity that can be ordered at one time from the supplier for the item.
maximumOrderQuantity	No	Number (12,4)	This field contains the maximum quantity that can be ordered at one time from the supplier for the item.
supplierHierarchyLevel1	No	String (10)	Highest level of supplier hierarchy (e. g. manufacturer). This will be used for assigning rebates that come from a level in the supply chain that is higher than the supplier. This information is stored on item_supp_country for defaulting into item_supp_country_loc.
supplierHierarchyLevel2	No	String (10)	Second highest level of supplier hierarchy. This information is stored on item_supp_country for defaulting into item_supp_country_loc.
supplierHierarchyLevel3	No	String (10)	Third highest level of supplier hierarchy. This information is stored on item_supp_country for defaulting into item_supp_country_loc.
defaultUop	No	String (6)	Contains the default unit of purchase for the item/supplier/country. Valid values include: Standard Units of Measure C for Case P for Pallet
supplierPackSize	No	Number (12,4)	Contains the quantity that orders must be placed in multiples of for the supplier for the item.
innerPackSize	No	Number (12,4)	This field contains the break pack size for this item from the supplier.
ti	No	Number (12)	Number of shipping units (cases) that make up one tier of a pallet. Multiply TI x HI to get total number of units (cases) for a pallet.
hi	No	Number (12)	Number of tiers that make up a complete pallet (height). Multiply TI x HI to get total number of units (cases) for a pallet.
costUom	No	String (4)	Unit of measure associated with the item cost. It is held to allow costs to be managed in a separate UOM from the standard UOM.
toleranceType	No	String (6)	The unit of the tolerances for catch weight simple packs: A - actual, P - percent.
minimumTolerance	No	Number (12,4)	The minimum tolerance value for a catch weight simple pack.
maximumTolerance	No	Number (12,4)	The maximum tolerance value for a catch weight simple pack.
supplierHierarchyType1	No	String (6)	Identifies partner type of supplier hierarchy level 1 for the foreign key to the partner table.
supplierHierarchyType2	No	String (6)	Identifies partner type of supplier hierarchy level 2 for the foreign key to the partner table.
supplierHierarchyType3	No	String (6)	Identifies partner type of supplier hierarchy level 3 for the foreign key to the partner table.
roundLevel	No	String (6)	This column will be used to determine how order quantities will be rounded to Case, Layer and Pallet.
roundToInnerPercentage	No	Number (12,4)	The Inner Rounding Threshold value. Used to determine whether to round partial Inner quantities up or down.
roundToCasePercentage	No	Number (12,4)	The Case Rounding Threshold value. Used to determine whether to round partial Case quantities up or down.
roundToLayerPercentage	No	Number (12,4)	The Layer Rounding Threshold value. Used to determine whether to round partial Layer quantities up or down.
roundToPalletPercentage	No	Number (12,4)	The Pallet Rounding Threshold value. Used to determine whether to round partial Pallet quantities up or down.
packingMethod	No	String (6)	This field indicates whether the packing method of the item in the container is Flat or Hanging. Values for this field are defined in PKMT code type. Examples are: FLAT - Flat, HANG - Hanging.
defaultExpenseProfilesInd	No	String (1)	This field indicates whether expense profiles will be defaulted to new item-supplier-country relationship.
purchaseType	No	String (1)	This contains a code to indicate whether the item is normal merchandise (i. e. owned by the retailer), consignment stock or a concession item. Valid values are 0 - Owned, 1 - Consignment, 2 - Concession.
calculationBasis	No	String (1)	This indicates if the cost for the consignment/concession item will be managed either based on cost per unit or as a percentage of retail. Valid values are C - Cost per Unit, P - Purchase Rate.
purchaseRate	No	Number (12,4)	This column contains the percentage of the retail price which will determine the cost paid to the supplier for a consignment or concession item.
pricingControl	No	String (1)	This indicates whether the price for the consignment/concession item will be managed by supplier or by retailer when supplier-controlled pricing for Consignment/Concession ownership model is used within the Merchandising suite of solutions. Valid values are: R - Retailer, S - Supplier. If no value is provided for consignment/concession items, this will be defaulted based on the default pricing control at supplier site level.
dimension	No	Collection of Object	References a collection of item supplier country dimensions.
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-481 Dimension - Object. See list of elements for detail

Element Name	Required	Data Type	Description
dimensionObject	Yes	String (6)	Specific object whose dimensions are specified in this record (e. g. case, pallet, each). Valid codes are defined in the DIMO code type. Examples are: CA - Case, EA - Each.
tareWeight	No	Number (12,4)	Amount of weight to be subtracted for packaging materials. Used to calculate the true net weight of the dimensionObject.
tareType	No	String (6)	Indicates if tare weight for this dimensionObject is wet or dry. Valid values are defined in the TARE code type. Examples are: W - Wet tare weight, D - Dry tare weight.
lwhUom	No	String (4)	Unit of measurement for length, width, and height (e. g. inches, centimeters, feet). Valid values for this field are contained in uom field on uom_class table where uom_class field = DIMEN.
length	No	Number (12,4)	Length of dim_object measured in units specified in lwh_uom.
width	No	Number (12,4)	Width of dim_object measured in units specified in lwh_uom.
height	No	Number (12,4)	Height of dim_object measured in units specified in lwh_uom.
liquidVolume	No	Number (12,4)	Liquid volume, or capacity, of dim_object measured in units specified in volume_uom. Liquid volumes are only convertible to other liquid volumes.
liquidVolumeUom	No	String (4)	Unit of measurement for liquid_volume (e. g. ounces, liters). Liquid volumes are only convertible to other liquid volumes. Valid values for this field are contained in uom field on uom_class table where uom_class field = LVOL.
statisticalCase	No	String (12)	Statistical value of the dim_objects dimensions to be used for loading purposes.
weightUom	No	String (4)	Unit of measurement for weight (e. g. pounds, kilograms). Valid values for this field are contained in uom field on uom_class table where uom_class field = MASS.
weight	No	Number (12,4)	Weight of dim_object measured in units specified in weight_uom.
netWeight	No	Number (12,4)	Unit of measurement for length, width, and height (e. g. inches, centimeters, feet). Valid values for this field are contained in uom field on uom_class table where uom_class field = DIMEN.
presentationMethod	No	String (6)	Describes the packaging (if any) being taken into consideration in the specified dimensions. Valid codes are defined in the PCKT code type. Examples are: JHOOK - Peggable Packaging, STACK - Stackable Packaging.

Table 5-482 CustomFlexAttribute - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Table 5-483 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-484 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Table 5-485 CountryOfManufacture - Object. See list of elements for detail

Element Name	Required	Data Type	Description
manufacturerCountry	Yes	String (23)	Country ID of manufacturer.
primaryManufacturerCountryInd	No	String (1)	Indicates if it's the primary country of manufacturer.

Table 5-486 Translation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This is the language ID.
supplierDiff1	No	String (120)	This field contains the first supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff2	No	String (120)	This field contains the second supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff3	No	String (120)	This field contains the third supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff4	No	String (120)	This field contains the fourth supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierLabel	No	String (15)	The supplier label for the item.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "supplier": [
        {
          "supplier": "2400",
          "primarySupplierInd": "Y",
          "vpn": null,
          "supplierLabel": null,
          "consignmentRate": 3,
          "supplierDiscontinueDate": "2001-12-31",
          "directShipInd": "Y",
          "palletName": "PAL",
          "caseName": "CS",
          "innerName": "INR",
          "primaryCaseSize": null,
          "supplierDiff1": null,
          "supplierDiff2": null,
          "supplierDiff3": null,
          "supplierDiff4": null,
          "concessionRate": 1,
          "defaultExpenseProfilesInd": "Y",
          "customFlexAttribute": [
            {
              "name": "REVIEW_DATE",
              "value": null,
              "valueDate": "2001-12-31"
            }
          ],
          "translation": [
            {
              "language": 2,
              "supplierDiff1": null,
              "supplierDiff2": null,
              "supplierDiff3": null,
              "supplierDiff4": null,
              "supplierLabel": null
            }
          ],
          "countryOfSourcing": [
            {
              "originCountry": "US",
              "primaryCountryInd": "Y",
              "unitCost": 9.65,
              "leadTime": 1,
              "pickupLeadTime": 1,
              "mininumOrderQuantity": 1,
              "maximumOrderQuantity": 1,
              "supplierHierarchyLevel1": null,
              "supplierHierarchyLevel2": null,
              "supplierHierarchyLevel3": null,
              "defaultUop": "EA",
              "supplierPackSize": 1,
              "innerPackSize": 1,
              "ti": 1,
              "hi": 1,
              "costUom": "EA",
              "toleranceType": null,
              "minimumTolerance": 76.00,
              "maximumTolerance": 69.00,
              "supplierHierarchyType1": null,
              "supplierHierarchyType2": null,
              "supplierHierarchyType3": null,
              "roundLevel": "C",
              "roundToInnerPercentage": 50,
              "roundToCasePercentage": 50,
              "roundToLayerPercentage": 50,
              "roundToPalletPercentage": 50,
              "packingMethod": "HANG",
              "defaultExpenseProfilesInd": "Y",
              "purchaseType": "0",
              "calculationBasis": null,
              "purchaseRate": 18.00,
              "pricingControl": "R",
              "dimension": [
                {
                  "dimensionObject": "PA",
                  "tareWeight": 17.00,
                  "tareType": "D",
                  "lwhUom": "IN",
                  "length": 3,
                  "width": 3,
                  "height": 3,
                  "liquidVolume": 3,
                  "liquidVolumeUom": null,
                  "statisticalCase": null,
                  "weightUom": "LBS",
                  "weight": 3,
                  "netWeight": 11.00,
                  "presentationMethod": null
                }
              ],
              "customFlexAttribute": [
                {
                  "name": "REVIEW_DATE",
                  "value": null,
                  "valueDate": "2001-12-31"
                }
              ],
              "localizationExtensions": [
                {
                  "country": "BR",
                  "attributes": [
                    {
                      "name": "SPECIAL_CATEGORY_CODE",
                      "value": "WS_PRC_08",
                      "valueDate": "2001-12-31"
                    }
                  ]
                }
              ]
            }
          ],
          "countryOfManufacture": [
            {
              "manufacturerCountry": "BR",
              "primaryManufacturerCountryInd": "N"
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item Supplier Countries

Functional Area

Items - Item Definition

Business Overview

This service is used to delete existing item/supplier/country level information from Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/supplier/countries/delete

Input Payload Details

Table 5-487 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-488 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
supplier	No	Collection of Object	References a collection of item supplier.

Table 5-489 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	Item Supplier affected by the deletion activity.
countryOfSourcing	No	Collection of Object	References a collection of item supplier country information.

Table 5-490 CountryOfSourcing - Object. See list of elements for detail

Element Name	Required	Data Type	Description
originCountry	Yes	String (3)	The supplier country affected by the deletion activity.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "supplier": [
        {
          "supplier": "2400",
          "countryOfSourcing": [
            {
              "originCountry": "US"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item Supplier Countries of Manufacture

Functional Area

Items - Item Definition

Business Overview

This service is used to delete an existing item supplier country of manufacturing information from Merchandising. In order to delete an item supplier manufacturing country, the supplier manufacturing country must exist for the item in Merchandising, otherwise, an error will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/supplier/countriesOfManufacture/delete

Input Payload Details

Table 5-491 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-492 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
supplier	No	Collection of Object	References a collection of item supplier.

Table 5-493 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	Item Supplier affected by the deletion activity.
countryOfManufacture	No	Collection of Object	References a collection of country of manufacture of the item.

Table 5-494 CountryOfManufacture - Object. See list of elements for detail

Element Name	Required	Data Type	Description
manufacturerCountry	Yes	String (23)	Country ID of manufacturer.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100000059",
      "supplier": [
        {
          "supplier": "2400",
          "countryOfManufacture": [
            {
              "manufacturerCountry": "BR"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item Supplier Country Dimensions

Functional Area

Items - Item Definition

Business Overview

This service is used to delete item supplier country dimensions in Merchandising. In order to delete an item supplier country dimension, the supplier country dimension must exist for the item in Merchandising, otherwise, an error will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/supplier/country/dimensions/delete

Input Payload Details

Table 5-495 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-496 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
supplier	No	Collection of Object	References a collection of item supplier.

Table 5-497 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	Item Supplier affected by the deletion activity.
countryOfSourcing	No	Collection of Object	References a collection of item supplier country information.

Table 5-498 CountryOfSourcing - Object. See list of elements for detail

Element Name	Required	Data Type	Description
originCountry	Yes	String (3)	The supplier country affected by the deletion activity.
dimension	No	Collection of Object	References a collection of item supplier country dimension.

Table 5-499 Dimension - Object. See list of elements for detail

Element Name	Required	Data Type	Description
dimensionObject	Yes	String (6)	The dimension object.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "supplier": [
        {
          "supplier": "2400",
          "countryOfSourcing": [
            {
              "originCountry": "US",
              "dimension": [
                {
                  "dimensionObject": "CA"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item Supplier Country Locations

Functional Area

Items - Item Definition

Business Overview

This service is used to delete item supplier country locations from an existing item supplier country in Merchandising. To delete an item supplier country location, the supplier country location must exist for the item in Merchandising; otherwise, an error will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/supplier/country/locations/delete

Input Payload Details

Table 5-500 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-501 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
hierarchyLevel	No	String (2)	The level of the organizational hierarchy used to delete item supplier country location relationships. Valid values are: 'AS' - All Store, 'S' - Store, 'DW'- Default Warehouse, 'AW' - All Warehouses, 'W' - Warehouse, 'PW' - Physical Warehouse, 'AI' - All internal finishers, 'I' - Internal finisher, 'D' - District, 'R' - Region, 'A' - Area, 'T' - Transfer zone, 'L' - Location trait.
supplier	No	Collection of Object	References a collection of item supplier.

Table 5-502 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	Item Supplier affected by the deletion activity.
countryOfSourcing	No	Collection of Object	References a collection of item supplier country information.

Table 5-503 CountryOfSourcing - Object. See list of elements for detail

Element Name	Required	Data Type	Description
originCountry	Yes	String (3)	The supplier country affected by the deletion activity.
location	No	Collection of Object	References a collection of item supplier country location.

Table 5-504 Location - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hierarchyId	Yes	Number (10)	The id of the location hierarchy level affected by the message.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100068",
      "hierarchyLevel": "S",
      "supplier": [
        {
          "supplier": "2400",
          "countryOfSourcing": [
            {
              "originCountry": "US",
              "location": [
                {
                  "hierarchyId": 1111
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item Supplier Translations

Functional Area

Items - Item Definition

Business Overview

This service is used to delete supplier level translations from an existing item in Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/supplier/translations/delete

Input Payload Details

Table 5-505 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-506 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
supplier	No	Collection of Object	References a collection of item supplier.

Table 5-507 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	Item Supplier affected by the deletion activity.
translation	No	Collection of Object	References a collection of translations of item supplier description fields.

Table 5-508 Translation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
language	Yes	Number (6)	The language ID.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "supplier": [
        {
          "supplier": "2400",
          "translation": [
            {
              "language": 2
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item Suppliers

Functional Area

Items - Item Definition

Business Overview

This service is used to delete supplier details from existing items within Merchandising. In order to delete an item supplier, the specified supplier must exist for the item in Merchandising, else an error will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/suppliers/delete

Input Payload Details

Table 5-509 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-510 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
supplier	No	Collection of Object	References a collection of item supplier.

Table 5-511 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	Item Supplier affected by the deletion activity.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "supplier": [
        {
          "supplier": "2400"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Item Supplier Countries

Functional Area

Items - Item Definition

Business Overview

This service is used to modify existing item supplier country information in Merchandising. To update item supplier country information, the supplier country must exist for the item in Merchandising; otherwise, an error will be returned.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/supplier/countries/update

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-512 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-513 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
supplier	No	Collection of Object	References a collection of suppliers associated to the item.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-514 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	The identifier of the supplier who sources the item. This value must be predefined on the SUPS table.
countryOfSourcing	No	Collection of Object	References a collection of country of sourcing of the item.

Table 5-515 CountryOfSourcing - Object. See list of elements for detail

Element Name	Required	Data Type	Description
originCountry	Yes	String (3)	The identifier for the country where the item is sourced. This value must be predefined on the COUNTRY table.
primaryCountryInd	No	String (1)	This indicates if the country is the primary country for the item supplier. Valid values are Y (yes) and N (no).
unitCost	No	Number (20,4)	The current corporate unit cost for the item in the supplier's currency. This field will only be used to establish the item supplier country unit cost; it cannot be modified.
leadTime	No	Number (4)	This field contains the number of days that will elapse between the date an order is written and the delivery to the store or warehouse from the supplier. This field is defaulted from the default lead time set at the supplier level.
pickupLeadTime	No	Number (4)	Contains time it takes to get the item from the Supplier to the Initial Receiving Location. This value will be defaulted to the item_supp_country_loc pickup lead time field. The ordering dialog will reference the item/supplier/country/location pickup lead time as the value may vary by location.
mininumOrderQuantity	No	Number (12,4)	This field contains the minimum quantity that can be ordered at one time from the supplier for the item.
maximumOrderQuantity	No	Number (12,4)	This field contains the maximum quantity that can be ordered at one time from the supplier for the item.
supplierHierarchyLevel1	No	String (10)	Highest level of supplier hierarchy (e. g. manufacturer). This will be used for assigning rebates that come from a level in the supply chain that is higher than the supplier. This information is stored on item_supp_country for defaulting into item_supp_country_loc.
supplierHierarchyLevel2	No	String (10)	Second highest level of supplier hierarchy. This information is stored on item_supp_country for defaulting into item_supp_country_loc.
supplierHierarchyLevel3	No	String (10)	Third highest level of supplier hierarchy. This information is stored on item_supp_country for defaulting into item_supp_country_loc.
defaultUop	No	String (6)	Contains the default unit of purchase for the item/supplier/country. Valid values include: Standard Units of Measure C for Case P for Pallet
supplierPackSize	No	Number (12,4)	Contains the quantity that orders must be placed in multiples of for the supplier for the item.
innerPackSize	No	Number (12,4)	This field contains the break pack size for this item from the supplier.
ti	No	Number (12)	Number of shipping units (cases) that make up one tier of a pallet. Multiply TI x HI to get total number of units (cases) for a pallet.
hi	No	Number (12)	Number of tiers that make up a complete pallet (height). Multiply TI x HI to get total number of units (cases) for a pallet.
costUom	No	String (4)	Unit of measure associated with the item cost. It is held to allow costs to be managed in a separate UOM from the standard UOM.
toleranceType	No	String (6)	The unit of the tolerances for catch weight simple packs: A - actual, P - percent.
minimumTolerance	No	Number (12,4)	The minimum tolerance value for a catch weight simple pack.
maximumTolerance	No	Number (12,4)	The maximum tolerance value for a catch weight simple pack.
supplierHierarchyType1	No	String (6)	Identifies partner type of supplier hierarchy level 1 for the foreign key to the partner table.
supplierHierarchyType2	No	String (6)	Identifies partner type of supplier hierarchy level 2 for the foreign key to the partner table.
supplierHierarchyType3	No	String (6)	Identifies partner type of supplier hierarchy level 3 for the foreign key to the partner table.
roundLevel	No	String (6)	This column will be used to determine how order quantities will be rounded to Case, Layer and Pallet.
roundToInnerPercentage	No	Number (12,4)	The Inner Rounding Threshold value. Used to determine whether to round partial Inner quantities up or down.
roundToCasePercentage	No	Number (12,4)	The Case Rounding Threshold value. Used to determine whether to round partial Case quantities up or down.
roundToLayerPercentage	No	Number (12,4)	The Layer Rounding Threshold value. Used to determine whether to round partial Layer quantities up or down.
roundToPalletPercentage	No	Number (12,4)	The Pallet Rounding Threshold value. Used to determine whether to round partial Pallet quantities up or down.
packingMethod	No	String (6)	This field indicates whether the packing method of the item in the container is Flat or Hanging. Values for this field are defined in PKMT code type. Examples are: FLAT - Flat, HANG - Hanging.
defaultExpenseProfilesInd	No	String (1)	This field indicates whether expense profiles will be defaulted to new item-supplier-country relationship.
purchaseType	No	String (1)	This contains a code to indicate whether the item is normal merchandise (i. e. owned by the retailer), consignment stock or a concession item. Valid values are 0 - Owned, 1 - Consignment, 2 - Concession.
calculationBasis	No	String (1)	This indicates if the cost for the consignment/concession item will be managed either based on cost per unit or as a percentage of retail. Valid values are C - Cost per Unit, P - Purchase Rate.
purchaseRate	No	Number (12,4)	This column contains the percentage of the retail price which will determine the cost paid to the supplier for a consignment or concession item.
pricingControl	No	String (1)	This indicates whether the price for the consignment/concession item will be managed by supplier or by retailer when supplier-controlled pricing for Consignment/Concession ownership model is used within the Merchandising suite of solutions. Valid values are: R – Retailer S – Supplier. If no value is provided for consignment/concession items, this will be defaulted based on the default pricing control at supplier site level.
dimension	No	Collection of Object	References a collection of item supplier country dimensions.
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-516 Dimension - Object. See list of elements for detail

Element Name	Required	Data Type	Description
dimensionObject	Yes	String (6)	Specific object whose dimensions are specified in this record (e. g. case, pallet, each). Valid codes are defined in the DIMO code type. Examples are: CA - Case, EA - Each.
tareWeight	No	Number (12,4)	Amount of weight to be subtracted for packaging materials. Used to calculate the true net weight of the dimensionObject.
tareType	No	String (6)	Indicates if tare weight for this dimensionObject is wet or dry. Valid values are defined in the TARE code type. Examples are: W - Wet tare weight, D - Dry tare weight.
lwhUom	No	String (4)	Unit of measurement for length, width, and height (e. g. inches, centimeters, feet). Valid values for this field are contained in uom field on uom_class table where uom_class field = DIMEN.
length	No	Number (12,4)	Length of dim_object measured in units specified in lwh_uom.
width	No	Number (12,4)	Width of dim_object measured in units specified in lwh_uom.
height	No	Number (12,4)	Height of dim_object measured in units specified in lwh_uom.
liquidVolume	No	Number (12,4)	Liquid volume, or capacity, of dim_object measured in units specified in volume_uom. Liquid volumes are only convertible to other liquid volumes.
liquidVolumeUom	No	String (4)	Unit of measurement for liquid_volume (e. g. ounces, liters). Liquid volumes are only convertible to other liquid volumes. Valid values for this field are contained in uom field on uom_class table where uom_class field = LVOL.
statisticalCase	No	String (12)	Statistical value of the dim_objects dimensions to be used for loading purposes.
weightUom	No	String (4)	Unit of measurement for weight (e. g. pounds, kilograms). Valid values for this field are contained in uom field on uom_class table where uom_class field = MASS.
weight	No	Number (12,4)	Weight of dim_object measured in units specified in weight_uom.
netWeight	No	Number (12,4)	Unit of measurement for length, width, and height (e. g. inches, centimeters, feet). Valid values for this field are contained in uom field on uom_class table where uom_class field = DIMEN.
presentationMethod	No	String (6)	Describes the packaging (if any) being taken into consideration in the specified dimensions. Valid codes are defined in the PCKT code type. Examples are: JHOOK - Peggable Packaging, STACK - Stackable Packaging.

Table 5-517 CustomFlexAttribute - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Table 5-518 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-519 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "supplier": [
        {
          "supplier": "2400",
          "countryOfSourcing": [
            {
              "originCountry": "US",
              "primaryCountryInd": "Y",
              "unitCost": 9.65,
              "leadTime": 1,
              "pickupLeadTime": 1,
              "mininumOrderQuantity": 1,
              "maximumOrderQuantity": 1,
              "supplierHierarchyLevel1": null,
              "supplierHierarchyLevel2": null,
              "supplierHierarchyLevel3": null,
              "defaultUop": null,
              "supplierPackSize": 1,
              "innerPackSize": 1,
              "ti": 1,
              "hi": 1,
              "costUom": "EA",
              "toleranceType": null,
              "minimumTolerance": 76.00,
              "maximumTolerance": 69.00,
              "supplierHierarchyType1": null,
              "supplierHierarchyType2": null,
              "supplierHierarchyType3": null,
              "roundLevel": "C",
              "roundToInnerPercentage": 50,
              "roundToCasePercentage": 50,
              "roundToLayerPercentage": 50,
              "roundToPalletPercentage": 50,
              "packingMethod": "HANG",
              "defaultExpenseProfilesInd": "Y",
              "purchaseType": "0",
              "calculationBasis": null,
              "purchaseRate": 18.00,
              "pricingControl": "R",
              "dimension": [
                {
                  "dimensionObject": "CA",
                  "tareWeight": 3,
                  "tareType": "D",
                  "lwhUom": "IN",
                  "length": 3,
                  "width": 3,
                  "height": 3,
                  "liquidVolume": 3,
                  "liquidVolumeUom": "EA",
                  "statisticalCase": null,
                  "weightUom": "EA",
                  "weight": 3,
                  "netWeight": 11.00,
                  "presentationMethod": null
                }
              ],
              "customFlexAttribute": [
                {
                  "name": "REVIEW_DATE",
                  "value": null,
                  "valueDate": "2001-12-31"
                }
              ],
              "localizationExtensions": [
                {
                  "country": "BR",
                  "attributes": [
                    {
                      "name": "SPECIAL_CATEGORY_CODE",
                      "value": "WS_PRC_08",
                      "valueDate": "2001-12-31"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Item Supplier Countries of Manufacture

Functional Area

Items - Item Definition

Business Overview

This service is used to modify manufacturing country of an existing item supplier in Merchandising. To update item supplier country manufacturing information, the supplier manufacturing country must exist for the item in Merchandising; otherwise, an error will be returned.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/supplier/countriesOfManufacture/update

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-520 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-521 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
supplier	No	Collection of Object	References a collection of suppliers associated to the item.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-522 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	The identifier of the supplier who sources the item. This value must be predefined on the SUPS table.
countryOfManufacture	No	Collection of Object	References a collection of country of manufacture of the item.

Table 5-523 CountryOfManufacture - Object. See list of elements for detail

Element Name	Required	Data Type	Description
manufacturerCountry	Yes	String (23)	Country ID of manufacturer.
primaryManufacturerCountryInd	No	String (1)	Indicates if it's the primary country of manufacturer.

Table 5-524 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-525 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100600020",
      "dataLoadingDestination": "RMS",
      "supplier": [
        {
          "supplier": "2400",
          "countryOfManufacture": [
            {
              "manufacturerCountry": "BR",
              "primaryManufacturerCountryInd": "N"
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Item Supplier Country Dimensions

Functional Area

Items - Item Definition

Business Overview

This service is used to modify dimensions for an existing item supplier country in Merchandising. To update item supplier country dimension information, the supplier country dimension must exist for the item in Merchandising, otherwise, an error will be returned.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/supplier/country/dimensions/update

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-526 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-527 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
supplier	No	Collection of Object	References a collection of suppliers associated to the item.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-528 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	The identifier of the supplier who sources the item. This value must be predefined on the SUPS table.
countryOfSourcing	No	Collection of Object	References a collection of country of sourcing of the item.

Table 5-529 CountryOfSourcing - Object. See list of elements for detail

Element Name	Required	Data Type	Description
originCountry	Yes	String (3)	The identifier for the country where the item is sourced. This value must be predefined on the COUNTRY table.
dimension	No	Collection of Object	References a collection of item supplier country dimensions.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-530 Dimension - Object. See list of elements for detail

Element Name	Required	Data Type	Description
dimensionObject	Yes	String (6)	Specific object whose dimensions are specified in this record (e. g. case, pallet, each). Valid codes are defined in the DIMO code type. Examples are: CA - Case, EA - Each.
tareWeight	No	Number (12,4)	Amount of weight to be subtracted for packaging materials. Used to calculate the true net weight of the dimensionObject.
tareType	No	String (6)	Indicates if tare weight for this dimensionObject is wet or dry. Valid values are defined in the TARE code type. Examples are: W - Wet tare weight, D - Dry tare weight.
lwhUom	No	String (4)	Unit of measurement for length, width, and height (e. g. inches, centimeters, feet). Valid values for this field are contained in uom field on uom_class table where uom_class field = DIMEN.
length	No	Number (12,4)	Length of dim_object measured in units specified in lwh_uom.
width	No	Number (12,4)	Width of dim_object measured in units specified in lwh_uom.
height	No	Number (12,4)	Height of dim_object measured in units specified in lwh_uom.
liquidVolume	No	Number (12,4)	Liquid volume, or capacity, of dim_object measured in units specified in volume_uom. Liquid volumes are only convertible to other liquid volumes.
liquidVolumeUom	No	String (4)	Unit of measurement for liquid_volume (e. g. ounces, liters). Liquid volumes are only convertible to other liquid volumes. Valid values for this field are contained in uom field on uom_class table where uom_class field = LVOL.
statisticalCase	No	String (12)	Statistical value of the dim_objects dimensions to be used for loading purposes.
weightUom	No	String (4)	Unit of measurement for weight (e. g. pounds, kilograms). Valid values for this field are contained in uom field on uom_class table where uom_class field = MASS.
weight	No	Number (12,4)	Weight of dim_object measured in units specified in weight_uom.
netWeight	No	Number (12,4)	Unit of measurement for length, width, and height (e. g. inches, centimeters, feet). Valid values for this field are contained in uom field on uom_class table where uom_class field = DIMEN.
presentationMethod	No	String (6)	Describes the packaging (if any) being taken into consideration in the specified dimensions. Valid codes are defined in the PCKT code type. Examples are: JHOOK - Peggable Packaging, STACK - Stackable Packaging.

Table 5-531 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-532 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "supplier": [
        {
          "supplier": "2400",
          "countryOfSourcing": [
            {
              "originCountry": "US",
              "dimension": [
                {
                  "dimensionObject": "CA",
                  "tareWeight": 3,
                  "tareType": "D",
                  "lwhUom": "IN",
                  "length": 3,
                  "width": 3,
                  "height": 3,
                  "liquidVolume": 3,
                  "liquidVolumeUom": "EA",
                  "statisticalCase": null,
                  "weightUom": "EA",
                  "weight": 3,
                  "netWeight": 11.00,
                  "presentationMethod": null
                }
              ],
              "localizationExtensions": [
                {
                  "country": "BR",
                  "attributes": [
                    {
                      "name": "SPECIAL_CATEGORY_CODE",
                      "value": "WS_PRC_08",
                      "valueDate": "2001-12-31"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Item Supplier Country Locations

Functional Area

Items - Item Definition

Business Overview

This service is used to modify locations of an existing item supplier country in Merchandising. To update item supplier country location information, the supplier country location must exist for the item in Merchandising; otherwise, an error will be returned.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/supplier/country/locations/update

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-533 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-534 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
itemSuppCountryLocHierarchyLevel	No	String (2)	The level of the organizational hierarchy used to update item supplier country location relationships. Valid values are: 'S' - Store and 'W' - Warehouse.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
supplier	No	Collection of Object	References a collection of suppliers associated to the item.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-535 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	The identifier of the supplier who sources the item. This value must be predefined on the SUPS table.
countryOfSourcing	No	Collection of Object	References a collection of country of sourcing of the item.

Table 5-536 CountryOfSourcing - Object. See list of elements for detail

Element Name	Required	Data Type	Description
originCountry	Yes	String (3)	The identifier for the country where the item is sourced. This value must be predefined on the COUNTRY table.
location	No	Collection of Object	References a collection of item supplier country locations.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-537 Location - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hierarchyId	Yes	Number (10)	The specific location id for this Item Supplier Country Loc message. Corresponds with the value used in the iscloc_hier_level field.
unitCost	No	Number (20,4)	The unit cost for the item at the item supplier country loc level in the supplier's currency. This field will be used for creating new records, not updating existing records.
negotiatedItemCost	No	Number (20,4)	This will hold the supplier negotiated item cost.
pickupLeadTime	No	Number (4)	Contains time it takes to get the item from the Supplier to the Initial Receiving Location. This value will be defaulted to the item_supp_country_loc pickup lead time field. The ordering dialog will reference the item/supplier/country/location pickup lead time as the value may vary by location.
roundLevel	No	String (6)	This column will be used to determine how order quantities will be rounded to Case, Layer and Pallet.
roundToCasePercentage	No	Number (12,4)	The Case Rounding Threshold value. Used to determine whether to round partial case quantities up or down.
roundToLayerPercentage	No	Number (12,4)	The Layer Rounding Threshold value. Used to determine whether to round partial Layer quantities up or down.
roundToPalletPercentage	No	Number (12,4)	The Pallet Rounding Threshold value. Used to determine whether to round partial Pallet quantities up or down.
roundToInnerPercentage	No	Number (12,4)	The Inner Rounding Threshold value. Used to determine whether to round partial Inner quantities up or down.
supplierHierarchyLevel1	No	String (10)	Highest level of supplier hierarchy (e. g. manufacturer). This will be used forassigning rebates that come from a level in the supply chain that is higher than the supplier.
supplierHierarchyLevel2	No	String (10)	Second highest level of supplier hierarchy. Rebates at this level will include all eligible supplier/item/country/loc records assigned to this supplier hierarchy level.
supplierHierarchyLevel3	No	String (10)	Third highest level of supplier hierarchy, used for assigning rebates by a level other than supplier.
costUom	No	String (4)	Unit of measure associated with the item cost. It is held to allow costs to be managed in a separate UOM from the standard UOM.
purchaseType	No	String (1)	This contains a code to indicate whether the item is normal merchandise (i. e. owned by the retailer), consignment stock or a concession item. Valid values are 0 - Owned, 1 - Consignment, 2 - Concession.
calculationBasis	No	String (1)	This indicates if the cost for the consignment/concession item will be managed either based on cost per unit or as a percentage of retail. Valid values are C - Cost per Unit, P - Purchase Rate.
purchaseRate	No	Number (12,4)	This column contains the percentage of the retail price which will determine the cost paid to the supplier for a consignment or concession item.
pricingControl	No	String (1)	This indicates whether the price for the consignment/concession item will be managed by supplier or by retailer when supplier-controlled pricing for Consignment/Concession ownership model is used within the Merchandising suite of solutions. Valid values are: R – Retailer S – Supplier. If no value is provided for consignment/concession purchase types, this will be defaulted from item/supplier/country of sourcing if purchase type is Consignment/Concession at item/supplier/country of sourcing level. If purchase type is Owned at item/supplier/country of sourcing level, this will be defaulted based on Default Pricing Control at supplier site level.
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL.

Table 5-538 CustomFlexAttribute - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Table 5-539 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-540 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100068",
      "itemSuppCountryLocHierarchyLevel": "S",
      "dataLoadingDestination": "RMS",
      "supplier": [
        {
          "supplier": "2400",
          "countryOfSourcing": [
            {
              "originCountry": "US",
              "location": [
                {
                  "hierarchyId": 1111,
                  "unitCost": 9.65,
                  "negotiatedItemCost": 9.65,
                  "pickupLeadTime": 1000,
                  "roundLevel": "C",
                  "roundToCasePercentage": 50,
                  "roundToLayerPercentage": 50,
                  "roundToPalletPercentage": 50,
                  "roundToInnerPercentage": 50,
                  "supplierHierarchyLevel1": null,
                  "supplierHierarchyLevel2": null,
                  "supplierHierarchyLevel3": null,
                  "costUom": "EA",
                  "purchaseType": "0",
                  "calculationBasis": null,
                  "purchaseRate": 3,
                  "pricingControl": "R",
                  "customFlexAttribute": [
                    {
                      "name": "REVIEW_DATE",
                      "value": null,
                      "valueDate": "2001-12-31"
                    }
                  ]
                }
              ],
              "localizationExtensions": [
                {
                  "country": "BR",
                  "attributes": [
                    {
                      "name": "SPECIAL_CATEGORY_CODE",
                      "value": "WS_PRC_08",
                      "valueDate": "2001-12-31"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Item Supplier Translations

Functional Area

Items - Item Definition

Business Overview

This service is used to modify supplier level translations of an existing item within Merchandising.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/supplier/translations/update

Input Payload Details

Table 5-541 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-542 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
supplier	No	Collection of Object	References a collection of suppliers associated to the item.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-543 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	The identifier of the supplier who sources the item. This value must be predefined on the SUPS table.
translation	No	Collection of Object	References a collection of translations of item supplier description fields.

Table 5-544 Translation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This is the language ID.
supplierDiff1	No	String (120)	This field contains the first supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff2	No	String (120)	This field contains the second supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff3	No	String (120)	This field contains the third supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff4	No	String (120)	This field contains the fourth supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierLabel	No	String (15)	The supplier label for the item.

Table 5-545 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-546 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "106150023",
      "dataLoadingDestination": "RMS",
      "supplier": [
        {
          "supplier": "2400",
          "translation": [
            {
              "language": 2,
              "supplierDiff1": "Lieferantenunterschied 1",
              "supplierDiff2": "Lieferant Diff 2 Modifiziert",
              "supplierDiff3": "Lieferantenunterschied 3",
              "supplierDiff4": "Lieferantenunterschied 4",
              "supplierLabel": "Lieferantenetikett Geändert"
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Item Suppliers

Functional Area

Items - Item Definition

Business Overview

This service is used to update supplier level information linked with an item within Merchandising. The specified supplier must already exist for the item in Merchandising, else an error will be returned.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/suppliers/update

Availability During Nightly Batch Cycle

This service will not be available during total duration of nightly batch run cycle.

Input Payload Details

Table 5-547 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-548 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
supplier	No	Collection of Object	References a collection of suppliers associated to the item.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-549 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	The identifier of the supplier who sources the item. This value must be predefined on the SUPS table.
primarySupplierInd	No	String (3)	Indicates if the supplier is the primary supplier for the item. Valid values are Y (yes) and N (no).
vpn	No	String (30)	The vendor product number associated with the item.
supplierLabel	No	String (15)	The supplier label for the item.
consignmentRate	No	Number (12,4)	This field contains the consignment rate for this item for the supplier.
supplierDiscontinueDate	No	date	Date which the supplier discontinues an item. The retailor should be aware that the supplier is able to reuse a UPC after 30 months and should work to ensure that no data exists in RMS for a UPC 30 months after it has been discontinued.
directShipInd	No	String (1)	Contains a value of Yes to indicate that any item asssociated with this supplier is eligible for a direct shipment from the supplier to the customer.
palletName	No	String (6)	Code referencing the name used to refer to the pallet. Valid codes are defined in the PALN code type. Examples are FLA - Flat, PAL - Pallet.
caseName	No	String (6)	Code referencing the name used to refer to the case. Valid codes are defined in the CASN code type. Examples are PACK - Pack, BX - Box, BG - Bag.
innerName	No	String (6)	Code referencing the name used to refer to the inner. Valid codes are defined in the INRN code type. Examples are SCS - Sub-Case, SPACK - Sub-Pack.
primaryCaseSize	No	String (6)	Used only if AIP is interfaced. Indicates the primary case size for the item supplier when an orderable item is configured for informal case types.
supplierDiff1	No	String (120)	This field contains the first supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff2	No	String (120)	This field contains the second supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff3	No	String (120)	This field contains the third supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff4	No	String (120)	This field contains the fourth supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
concessionRate	No	Number (12,4)	The concession rate is the margin that a particular supplier receives for the sale of a concession item.
defaultExpenseProfilesInd	No	String (1)	This field indicates whether expense profiles will be defaulted to new item-supplier relationship. Valid values are Y (yes) and N (no).
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL.

Table 5-550 CustomFlexAttribute - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Table 5-551 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-552 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "supplier": [
        {
          "supplier": "2400",
          "primarySupplierInd": "Y",
          "vpn": null,
          "supplierLabel": null,
          "consignmentRate": 3,
          "supplierDiscontinueDate": "2001-12-31",
          "directShipInd": "Y",
          "palletName": "PAL",
          "caseName": "CS",
          "innerName": "INR",
          "primaryCaseSize": null,
          "supplierDiff1": null,
          "supplierDiff2": null,
          "supplierDiff3": null,
          "supplierDiff4": null,
          "concessionRate": 1,
          "defaultExpenseProfilesInd": "Y",
          "customFlexAttribute": [
            {
              "name": "REVIEW_DATE",
              "value": null,
              "valueDate": "2001-12-31"
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Item Taxes Upload Service

The following services are included in this functional area:

• Create Item Taxes

• Delete Item Taxes

Create Item Taxes

Functional Area

Items - Item Definition

Business Overview

This service is used to add Value Added Tax (VAT) information to an existing item in Merchandising when the tax solution for the system is Simple VAT (SVAT).  The item must already exist in Merchandising, else an error will be returned. Item Tax information can also be provided during the creation of a new item. For more details on item creation, see the Item Upload Service description.

Service Type

POST

ReST URL

MerchIntegrations/services/item/taxes/create

Availability During Nightly Batch Cycle

This service will not be available during total duration of nightly batch run cycle.

Input Payload Details

Table 5-553 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-554 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
itemLevel	No	Number (1)	The level of the item. Valid values are 1 (single level or pack item), 2 (child item), and 3 (grandchild item).
tranLevel	No	Number (1)	The transaction level of the item. Valid values are 1, 2, and 3. If this is a transaction item this will equal the item level. If the item is a pack this will equal 1. This value cannot be modified.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
vat	No	Collection of Object	References a collection of vat information.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-555 Vat - Object. See list of elements for detail

Element Name	Required	Data Type	Description
vatType	Yes	String (1)	Indicates if the VAT rate is used for purchasing or selling. Valid values are C (cost), R (retail) and B (both).
vatRegion	Yes	Number (6)	The identifier for the VAT region. This value must be predefined on the VAT_REGION table. This node is optional, if it is included this field is required.
vatCode	Yes	String (6)	The identifier for the VAT code. This node is optional, if it is included in the message this field is required.
activeDate	Yes	date	The date that the VAT rate became active for the item/VAT region combination.
reverseVatInd	No	String (1)	Indicates if the item is subject to reverse charge VAT at the vat region. Valid values are Y (yes) and N (no).

Table 5-556 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-557 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "itemLevel": 1,
      "tranLevel": 1,
      "dataLoadingDestination": "RMS",
      "vat": [
        {
          "vatType": "B",
          "vatRegion": 1000,
          "vatCode": "S",
          "activeDate": null,
          "reverseVatInd": "N"
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item Taxes

Functional Area

Items - Item Definition

Business Overview

This service is used to delete VAT (value added tax) information of an existing item in Merchandising when default tax type for the system is SVAT (Simple VAT). In order to delete an item tax, the tax information must exist for the item in Merchandising, otherwise, an error will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/taxes/delete

Availability During Nightly Batch Cycle

This service will not be available during total duration of nightly batch run cycle.

Input Payload Details

Table 5-558 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-559 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
vat	No	Collection of Object	References a collection of item VAT.

Table 5-560 Vat - Object. See list of elements for detail

Element Name	Required	Data Type	Description
vatType	Yes	String (1)	The vat type of the vat item info to be deleted. Valid values are C (cost), R (retail) and B (both).
vatRegion	Yes	Number (6)	The vat region of the vat item info to be deleted.
activeDate	Yes	date	The active date of the vat item info to be deleted.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "vat": [
        {
          "vatType": "R",
          "vatRegion": 1000,
          "activeDate": null
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Item Up Charge Download Service

The following services are included in this functional area:

• Get Item Up Charges for Future Date

Get Item Up Charges for Future Date

Functional Area

Items - Item Definition

Business Overview

This service can be used to retrieve the complete list of up charges and the calculated up charge value that is expected to be a part of the future cost for the item, location and future date combination provided in the service call. 

The From Location input is optional, and if one is not provided, the system will use the source/default location of the provided To Location as the From Location in order to determine the list of up charges to be calculated and passed out of the service.

Service Type

POST

ReST URL

MerchIntegrations/services/item/upCharges/futureDate/get

Input Payload Details

Table 5-561 Get - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection. The maximum number of the items allowed in a collection is 9999.
items	Yes	Collection of Object	References a collection of From Location, To Location, Future Date and Items.

Table 5-562 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
fromLocation	No	Number (10)	The source location to fetch the Item Up Charges. This does not need to be provided if the To Location is a franchise location.
toLocation	Yes	Number (10)	The destination location to fetch the Item Up Charges.
futureDate	Yes	date	The future date to fetch the details of the Future Cost for the given Item/ToLocation combination. The expected date format is YYYY-MM-DD.
itemList	Yes	Array of String	The item/items for which the Up Charge details are requested. The maximum number of the items allowed is 9999.

Table 5-563 GetError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
errors	Yes	Collection of Object

Table 5-564 Errors - Object. See list of elements for detail

Element Name	Required	Data Type	Description
fromLocation	Yes	Number (10)	The source location to fetch the Item Up Charges.
toLocation	Yes	Number (10)	The destination location to fetch the Item Up Charges.
futureDate	Yes	date	The future date to fetch the details of the Future Cost for the given Item/ToLocation combination. The expected date format is YYYY-MM-DD.
errors	Yes	Array of String	List of errors.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "fromLocation": 10003,
      "toLocation": 1521,
      "futureDate": "2001-12-31",
      "itemList": [
        "108200021"
      ]
    }
  ]
}

Response Code: 200 (Success)

Table 5-565 GetResponse - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	References a collection of From Location, To Location, Item and Upcharge details returned as response.

Table 5-566 GetResponse.Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
fromLocation	Yes	Number (10)	The source location to fetch the Item Up Charges.
toLocation	Yes	Number (10)	The destination location to fetch the Item Up Charges.
futureDate	Yes	date	The future date to fetch the details of the Future Cost for the given Item/ToLocation combination. The expected date format is YYYY-MM-DD.
item	Yes	String (25)	The item for which the Up Charge details are requested.
totalUpChargeAmount	Yes	Number (20,4)	The Total Up Charge Amount for the given Item/FromLocation/ToLocation/FutureDate combination.
currencyCode	Yes	String (3)	The currency of the ToLocation in which the Total Up Charge Amount is calculated.
upCharges	Yes	Collection of Object	Details of the individual Item Up Charge Components.

Table 5-567 UpCharges - Object. See list of elements for detail

Element Name	Required	Data Type	Description
componentId	Yes	String (10)	Up Charge component.
componentDescription	Yes	String (250)	Description of the Up Charge component.
upChargeGroup	Yes	String (6)	Group to which the Up Charge component belongs. Valid values are defined in code type UCHG (Up Charge Group) with values: A-Admin. Fee, F-Freight, K-Special K Fees, M-Miscellaneous, T-Taxes, W-Franchise.
calculationBasis	Yes	String (6)	Indicates whether the component is calculated on a per-unit (Specific) or ad valorem (Value) basis. Valid values are Value (V) or Specific (S).
componentRate	Yes	Number (20,4)	The rate to be charged against the cost of the Item/To Location combinations. The value in this field will be a percentage if the calculation basis is V (Value), and a monetary amount if the calculation basis is S (Specific).
costBasis	Yes	String (1)	The basis, the Up Charge will be calculated against. Valid values are defined in code type UCCB (Up Charge Cost Basis) with values: Weighted Average Cost (W) and Supplier Cost (S) and Off-Invoice Net Cost (N).
computationValueBase	Yes	String (10)	The Computation Value Basis for the Up Charge component.
perCount	Yes	Number (12,4)	The amount of the Per Count Unit of Measure to which the rate applies. This will only contain a value if the calculation basis is S (Specific).
perCountUom	Yes	String (4)	The unit of measure in which the Per Count is specified. This column will only contain a value if the calculation basis is S (Specific).
componentCurrency	Yes	String (3)	Currency of the Up Charge component.
upChargeAmount	Yes	Number (20,4)	The calculated Up Charge Amount for the specific Up Charge Component. This will be in the currency of the ToLocation.

Sample Response Message

{
  "items": [
    {
      "fromLocation": 10003,
      "toLocation": 1521,
      "futureDate": "2001-12-31",
      "item": "108200021",
      "totalUpChargeAmount": 1.5,
      "currencyCode": "USD",
      "upCharges": [
        {
          "componentId": "TSFINSUR",
          "componentDescription": "Transfer Insurance",
          "upChargeGroup": "M",
          "calculationBasis": "V",
          "componentRate": 1.5,
          "costBasis": "W",
          "computationValueBase": null,
          "perCount": null,
          "perCountUom": null,
          "componentCurrency": "USD",
          "upChargeAmount": 1.5
        }
      ]
    }
  ]
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element "validationErrors" will be present when input payload or input parameters are not as per the schema definition of this service. The element "businessError" will be present if the payload passes schema validation but exception is caught while processing business logic.

Table 5-568 GetError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
errors	Yes	Collection of Object

Table 5-569 Errors - Object. See list of elements for detail

Element Name	Required	Data Type	Description
fromLocation	Yes	Number (10)	The source location to fetch the Item Up Charges.
toLocation	Yes	Number (10)	The destination location to fetch the Item Up Charges.
futureDate	Yes	date	The future date to fetch the details of the Future Cost for the given Item/ToLocation combination. The expected date format is YYYY-MM-DD.
errors	Yes	Array of String	List of errors.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    {
      "errors": [
        {
          "fromLocation": 10003,
          "toLocation": 1521,
          "futureDate": "2001-12-31",
          "errors": [
            "Invalid Item."
          ]
        }
      ]
    }
  ]
}

Item Upload Service

The following services are included in this functional area:

• Create Item Description Translations

• Create Item Image Translations

• Create Item Images

• Create Item Seasons

• Create Item Tickets

• Create Item UDAs

• Create Item Up Charges

• Create Items

• Delete Item Description Translations

• Delete Item Image Translations

• Delete Item Images

• Delete Item Seasons

• Delete Item Tickets

• Delete Item UDAs

• Delete Item Up Charges

• Delete Items

• Update Item Description Translations

• Update Item Image Translations

• Update Item Images

• Update Item Tickets

• Update Item UDAs

• Update Item Up Charge Details

• Update Items

Create Item Description Translations

Functional Area

Items - Item Definition

Business Overview

If translations have been defined for items, at item header level, then they can be integrated as part of this service. This service will accept the language and the description specified in the language to add item description translations to an existing item in Merchandising.

Service Type

POST

ReST URL

MerchIntegrations/services/item/description/translations/create

Input Payload Details

Table 5-570 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-571 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
translation	No	Collection of Object	References a collection of translations of the item description field.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-572 Translation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This field will hold the language in which the translated text is maintained.
shortDescription	No	String (120)	This field will hold the translated text of the shortened description of the item.
itemDescription	Yes	String (250)	This field will hold the translated text of the primary description of the item.
itemDescriptionSecondary	No	String (250)	This field will hold the translated text of the secondary description of the item.
longDesc	No	String (2000)	Long description of the item.

Table 5-573 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-574 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "106150023",
      "dataLoadingDestination": "RMS",
      "translation": [
        {
          "language": 5,
          "shortDescription": "登録項目",
          "itemDescription": "レギュラーアイテム 106150023",
          "itemDescriptionSecondary": "レギュラーアイテム二次 106150023",
          "longDesc": "100100076 Item Regular"
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Create Item Image Translations

Functional Area

Items - Item Definition

Business Overview

If translations have been defined for items, at the image level, then they can be integrated as part of this service. The service will accept the language and the description specified in the language to add image level translations to an existing item in Merchandising.

Service Type

POST

ReST URL

MerchIntegrations/services/item/image/translations/create

Input Payload Details

Table 5-575 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-576 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
image	No	Collection of Object	References a collection of item images.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-577 Image - Object. See list of elements for detail

Element Name	Required	Data Type	Description
imageName	Yes	String (120)	The name of the image.
translation	No	Collection of Object	References a collection of translations of item image description field.

Table 5-578 Translation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This is the language ID.
imageDescription	Yes	String (40)	The description associated with the image.

Table 5-579 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-580 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100083",
      "dataLoadingDestination": "RMS",
      "image": [
        {
          "imageName": "imageName1",
          "translation": [
            {
              "language": 8,
              "imageDescription": "供应商形象优先"
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Create Item Images

Functional Area

Items - Item Definition

Business Overview

This service is used to add images to an existing item in Merchandising. If translations have been defined for the item image, then these can be integrated as part of this service as well. The supporting node of this integration will accept the language and the related description specified in the language.

Service Type

POST

ReST URL

MerchIntegrations/services/item/images/create

Input Payload Details

Table 5-581 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-582 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
image	No	Collection of Object	References a collection of item images.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-583 Image - Object. See list of elements for detail

Element Name	Required	Data Type	Description
imageName	Yes	String (120)	The name of the image.
imageAddress	No	String (255)	Path where the file of the image is stored.
imageDescription	No	String (40)	The description associated with the image.
imageType	No	String (6)	Field indicating the type of the image of the item. Can be H(igh), M(edium), L(ow) and T(humbnail).
primaryImageInd	No	String (1)	Field indicating whether the record is a primary image or not.
displayPriority	No	Number (4)	Field to specify the display sequence order of images associated to the item per priority.
translation	No	Collection of Object	References a collection of translations of item image description field.

Table 5-584 Translation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This is the language ID.
imageDescription	Yes	String (40)	The description associated with the image.

Table 5-585 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-586 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "image": [
        {
          "imageName": "imageName1",
          "imageAddress": "http://www.oracle.com/",
          "imageDescription": "imageDesc1",
          "imageType": "T",
          "primaryImageInd": "Y",
          "displayPriority": 1,
          "translation": [
            {
              "language": 2,
              "imageDescription": "Item Image"
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Create Item Seasons

Functional Area

Items - Item Definition

Business Overview

This service is used to add seasons to an existing item in Merchandising. Item Seasons can also be created together with the creation of a new item. For more details on item creation, see the Create Items service description.

Service Type

POST

ReST URL

MerchIntegrations/services/item/seasons/create

Input Payload Details

Table 5-587 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-588 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
season	No	Collection of Object	References a collection of item seasons.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-589 Season - Object. See list of elements for detail

Element Name	Required	Data Type	Description
seasonId	Yes	Number (3)	The season identifier.
phaseId	Yes	Number (3)	The phase identifier.
sequenceNo	No	Number (4)	This field contains a sequence number that combined with the item number will make each record unique.
diffId	No	String (10)	This field will hold a value for group/differentiator combination records only.

Table 5-590 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-591 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "season": [
        {
          "seasonId": 1,
          "phaseId": 1,
          "sequenceNo": 1,
          "diffId": null
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Create Item Tickets

Functional Area

Items - Item Definition

Business Overview

This service is used to add tickets to an existing item in Merchandising. Tickets may be created together with the creation of a new item as well.  For more details on item creation, see the Create Items service description.

Service Type

POST

ReST URL

MerchIntegrations/services/item/tickets/create

Input Payload Details

Table 5-592 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-593 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
ticket	No	Collection of Object	References a collection of item ticket.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-594 Ticket - Object. See list of elements for detail

Element Name	Required	Data Type	Description
ticketTypeId	Yes	String (4)	This unique identifier for the ticket type which is associated with the item.
poPrintType	No	String (1)	This field indicates when the ticket type for the given item should be printed by default, upon the approval (A) or receipt (R) of the purchase order.
printOnPriceChangeInd	No	String (1)	This field indicates whether or not this type of ticket should be printed for this item when a permanent price change goes into effect. Valid values are Y (yes) and N (no).
ticketOverPrintPercentage	No	Number (12,4)	This field contains a percent which indicates the amount of tickets which should be printed for a given event.

Table 5-595 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-596 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "102350095",
      "dataLoadingDestination": "RMS",
      "ticket": [
        {
          "ticketTypeId": "TKT2",
          "poPrintType": "R",
          "printOnPriceChangeInd": "Y",
          "ticketOverPrintPercentage": 99
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Create Item UDAs

Functional Area

Items - Item Definition

Business Overview

This service is used to add user defined attributes (UDAs) of type date, freeform text, or list of values to an existing item in Merchandising.  UDAs can also be added to a item as the item is being created.  For more details on item creation, see the Create Items service description.

Service Type

POST

ReST URL

MerchIntegrations/services/item/uda/create

Input Payload Details

Table 5-597 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-598 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
uda	No	Collection of Object	References a collection of item UDAs.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-599 Uda - Object. See list of elements for detail

Element Name	Required	Data Type	Description
udaId	Yes	Number (5)	This field contains a number identifying the User-Defined Attribute.
displayType	Yes	String (2)	This field contains the display type (how the UDA values will be displayed to the user) for the given UDA. The valid values are DT -Date, FF - Free From, LV - List of values.
udaDate	No	date	This field contains the text value of the Used Defined attribute for the item.
udaValue	No	String (30)	This field contains value of the Used Defined attribute for the item.
udaText	No	String (250)	This field contains the text value of the Used Defined attribute for the item.

Table 5-600 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-601 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100087",
      "dataLoadingDestination": "RMS",
      "uda": [
        {
          "udaId": 201,
          "displayType": "FF",
          "udaDate": "2001-12-31",
          "udaValue": null,
          "udaText": "UDA FF Text 100100087"
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Create Item Up Charges

Functional Area

Items - Item Definition

Business Overview

This service is used to add upcharges to an existing item in Merchandising. Upcharges can also be created together with the creation of a new item.  For more details on item creation, see the Create Items service description.

Service Type

POST

ReST URL

MerchIntegrations/services/item/upCharges/create

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-602 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-603 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
upcharge	No	Collection of Object	References a collection of item upcharges.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-604 Upcharge - Object. See list of elements for detail

Element Name	Required	Data Type	Description
fromLocationType	Yes	String (6)	Location type of the from_loc. This can be S - Store,W - Warehouse,A - Area,R - Region,C - Country,AS - All Stores,AW - All Warehouses,PW - Physical Warehouse
fromLocation	No	String (10)	Depending on the from_loc_type, this contains the organization hierarchy value of store, warehouse, area, region, or country from which transferring goods will incur upcharges. It will not contain a value when from_loc_type is AS (all stores) or AW (all warehouses).
toLocationType	Yes	String (6)	Location_type of the to_loc. This can be S - Store,W - Warehouse,A - Area,R - Region,C - Country,AS - All Stores,AW - All Warehouses,PW - Physical Warehouse
toLocation	No	String (10)	Depending on the to_loc_type, this contains the organization hierarchy value of store, warehouse, area, region, or country to which transferring goods will incur upcharges. It will not contain a value when to_loc_type is AS (all stores) or AW (all warehouses).
details	Yes	Collection of Object	References a collection of item upcharge detail records.

Table 5-605 Details - Object. See list of elements for detail

Element Name	Required	Data Type	Description
componentId	Yes	String (10)	Up Charge component.
componentRate	Yes	Number (20,4)	The rate to be charged against the cost of the Item/To Location combinations within the department. The value in this field will be a percentage if the calculation basis is V (Value), and a monetary amount if the calculation basis is S.
perCount	No	Number (12,4)	count indicating the amount of the Per Count Unit of Measure to which the rate applies. This will only contain a value if the calculation basis is S (Specific).
perCountUom	No	String (4)	contains the unit of measure in which the Per Count is specified. This column will only contain a value if the calculation basis is S (Specific).
upChargeGroup	Yes	String (6)	group to which the component ID belongs. This can be A-Admin. Fee,F-Freight,K-Special K Fees,M-Miscellaneous,T-Taxes,W-Franchise.
componentCurrency	Yes	String (3)	Currency of the Up Charge component.
transferAllocationDefaultInd	No	String (1)	Indicates whether all existing transfers and allocations belonging to the hierarchy should be updated or not.
computationValueBase	No	String (10)	Contains the Computation Value Basis for the Up Charge component.
costBasis	No	String (6)	Contains the basis the Up Charge will be calculated against. Valid values are defined in code type UCCB (Up Charge Cost Basis) with values: Weighted Average Cost (W) and Supplier Cost (S) and Off-Invoice Net Cost (N).
includeInTotalUpchargeInd	No	String (1)	Used to determine if the value of the individual up charge component is used to calculate the total up charge (Y) or if it is only used as the basis of calculating another up charge (N).

Table 5-606 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-607 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100550000",
      "dataLoadingDestination": "RMS",
      "upcharge": [
        {
          "fromLocationType": "S",
          "fromLocation": "1411",
          "toLocationType": "W",
          "toLocation": "50002",
          "details": [
            {
              "componentId": "WHFEE",
              "componentRate": 6.66,
              "perCount": 1,
              "perCountUom": "EA",
              "upChargeGroup": "A",
              "componentCurrency": "USD",
              "transferAllocationDefaultInd": "Y",
              "computationValueBase": null,
              "costBasis": null,
              "includeInTotalUpchargeInd": "Y"
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Create Items

Functional Area

Items - Item Definition

Business Overview

This service is used by an external system to create items in Merchandising.

The item request payload includes the detail nodes, the suppliers, and supplier/countries. If the item is not a non-sellable pack, the item/zone/price node is also required. Optional nodes can be included in the message for supplier/countries, supplier/country/locations, pack components, item/VAT, dimensions, UDAs, seasons, images, translations, HTS, assessments, expenses, and up charges.

This service supports the insertion of data into the Item Induction staging tables without requiring that the data sent to be functionally complete. If a complete set of item data is sent by the external system through this service, then it is possible to automatically trigger the upload of the data directly into Merchandising by setting a flag in the input payload, such that item information is uploaded without further user interaction.

Items must be created and maintained following a logical hierarchy as outlined by the referential integrity of the item database tables: Item parents before child items; item components before items that are packs; items before item-suppliers; item/suppliers before item/supplier/countries; items before item/locations (a separate service), and so on. Failing to do so results in message failure.

The auto-creation of item children using differentiator records attached to an item parent, as currently occurs using Merchandising online processes, is not supported in this service.

When a new item is created, this service will first validate that all required fields are present in the message. After that, business level validation on the input information will be performed. If all the validations are met, then the item is created with the status defined in the message. If the status in the message is approved, then the item is also subjected to a series of approval checks. For an item to be successfully approved, mandatory information, such as supplier, supplier country, component item information (if item is a pack), is required to be passed as part of the item message. If the item cannot be approved, it is not created. The following information can be included for the item: Expenses, HTS and Assessments, Tickets, UDAs, VAT (for SVAT tax type), Up Charges, Images, Seasons, Item Supplier Country Locations, Item Supplier Countries of Manufacture, and Item Supplier Country Dimensions. If included, these are created simultaneously with the creation of the item. 

If item VAT is not populated, item VAT defaults to the corresponding department's VAT information.

Service Type

POST

ReST URL

MerchIntegrations/services/items/create

Input Payload Details

Table 5-608 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-609 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
itemParent	No	String (25)	The item at the level above this item. This value must be predefined as an item on the ITEM_MASTER table.
itemGrandparent	No	String (25)	The item two levels above this item. This value must be predefined as an item on the ITEM_MASTER table.
itemNumberType	No	String (6)	Contains the code specifying what type the item is. Valid codes are defined in the UPCT code type. Examples are: MANL - Manual, ITEM - Oracle Retail Item Number.
itemLevel	No	Number (1)	The level of the item. Valid values are 1 (single level or pack item), 2 (child item), and 3 (grandchild item).
tranLevel	No	Number (1)	The transaction level of the item. Valid values are 1, 2, and 3. If this is a transaction item this will equal the item level. If the item is a pack this will equal 1. This value cannot be modified.
status	No	String (1)	Status of the item.
inventoryInd	No	String (1)	This indicates if an item holds inventory or not for item transformation. Valid values are Y (yes) and N (no).
dept	No	Number (4)	The number of the department to which this item belongs. This value must be predefined on the DEPS table. It cannot be modified.
class	No	Number (4)	The number of the class to which the item belongs. This value must be predefined on the CLASS table. It cannot be modified.
subclass	No	Number (4)	The number of the subclass to which the item belongs. This value must be predefined on the SUBCLASS table. It cannot be modified.
itemDescription	No	String (250)	The long description of the item.
shortDescription	No	String (120)	The short description of the item. If this field is not populated it will default from the long description.
itemDescriptionSecondary	No	String (250)	Secondary descriptions of the item.
standardUom	No	String (4)	The unit of measure at which the item is tracked at the corporate level. This will be defaulted to EA (eaches) if not populated on the message. It cannot be modified.
sellableInd	No	String (1)	If the item is a pack, this value indicates if the pack can be sold as a unique unit. Valid values are Y (yes) and N (no). This value cannot be modified. It should be Y for a non-pack item.
orderableInd	No	String (1)	If the item is a pack, this field indicates if it can be placed on orders. Valid values are Y (yes) and N (no). This field cannot be modified. It should be Y for a non-pack item.
simplePackInd	No	String (1)	Indicates if the item is a simple pack. This field is required if the item is a pack. Valid values are Y (yes) and N (no). This value cannot be modified.
packInd	No	String (1)	Indicates if the item is a pack item. Valid values are Y (yes) and N (no). This value cannot be modified.
containsInnerInd	No	String (1)	This should be Y (yes) if the item is a pack and at least one component item is a pack; otherwise it should be N (no).
packType	No	String (1)	If the item is a pack, this field will indicate what type of pack it is. Valid values are B (buyer) and V (vendor). This field cannot be modified. If the item is not a pack this value should be null.
orderAsType	No	String (1)	If the item is an orderable buyer pack, this indicates how it will be ordered. Valid values are E (eaches) and P (pack). This field cannot be modified. If the item is not a pack, this should be null.
diff1	No	String (10)	Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz).
diff2	No	String (10)	Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz).
diff3	No	String (10)	Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz).
diff4	No	String (10)	Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz).
storeOrderMultiple	No	String (1)	The unit type of merchandise shipped from the warehouse to the store for this item. Valid values are C (cases), I (inners), and E (eaches).
forecastInd	No	String (1)	Indicates whether the item is forecastable. Valid value are Y (yes) and N (no). This value should be N if the item is a pack.
uomConversionFactor	No	Number (20,10)	Conversion factor between an Each and the standard_uom when the standard_uom is not in the quantity class (e. g. if standard_uom = lb and 1 lb = 10 eaches, this factor will be 10). This factor will be used to convert sales and stock data when an item is retailed in eaches but does not have eaches as its standard unit of measure.
packageSize	No	Number (12,4)	Holds the size of the product printed on any packaging (i. e. 24 ounces). This field is used for reporting purposes, as well as by Oracle Retail Price Mangement to determine same sized and different sized items.
handlingTemperature	No	String (6)	Holds the temperature information associated with the item. Valid codes are defined in the HTMP code type. Examples are: FRIDGE - Keep Refrigerated, FROZEN - Keep Frozen.
handlingSensitivity	No	String (6)	Holds the sensitivity information associated with the item. Valid codes are defined in the HSEN code type. Examples are: EXPLOD - Explosive, FRAG - Fragile.
manufacturerRecommendedRetail	No	Number (20,4)	Manufacturers recommended retail price for the item in primary currency. Used for informational purposes only.
wasteType	No	String (6)	Identifies the wastage type as either sales or spoilage wastage. Valid values are: SP - Spoilage, SL - Sales Wastage is not applicable to pack items.
averageWastePercentage	No	Number (12,4)	Average percent of wastage for the item over its shelf life. Used in inflating the retail price for wastage items.
catchWeightInd	No	String (1)	Indiactes whether the item should be weighed when it arives at a location. Valid values for this field are Y and N.
orderType	No	String (6)	This determines how catch weight items are ordered. Valid codes are defined in the ORDT code type. Examples are: F - fixed weight, V - Variable weight.
saleType	No	String (6)	This indicates the method of how catch weight items are sold in store locations. Valid values are: V - variable weight each, L - Loose weight.
catchWeightUom	No	String (4)	Unit of measure of a catch weight item.
depositItemType	No	String (6)	This is the deposit item component type. Valid values are: E - Contents, A - Container, Z - Crate, T - Returned Item (Empty bottle), P - Complex pack (with deposit items).
containerItem	No	String (25)	This holds the container item number for a content item.
packageUom	No	String (4)	Holds the unit of measure associated with the package size. This field is used for reporting purposes and by Retek Price Management to determine same sized and different sized items.
formatId	No	String (1)	This field will hold the format ID that corresponds to the items variable UPC. This value is only used for items with variable UPCs.
prefix	No	Number (2)	This column holds the prefix for variable weight UPCs.
itemTransformationInd	No	String (1)	This indicates if an item is associated with an item transformation process. If yes, the item will be either the sellable item or the orderable item in the transformation process.
brandName	No	String (120)	This is added to capture the brand information of an item.
productClassification	No	String (6)	This defines which items can be combined (packed or boxed) together. Valid codes are defined in the PCLA code type. Examples are: APP - Apparel, GRC - Grocery.
merchandiseInd	No	String (1)	Indicates if the item is a merchandise item. Valid values are Y (yes) and N (no).
originalRetail	No	Number (20,4)	The original retail price of the item per unit. This field is stored in the primary currency.
retailLabelType	No	String (6)	This field indicates any special label type assoctiated with an item. Valid codes are defined in the RTLT code type. Examples are: COFF - Cents Off, EXTRA - Extra Product, PREP - Pre-Priced.
retailLabelValue	No	Number (20,4)	This field represents the value associated with the retail label type.
defaultWastePercentage	No	Number (12,4)	Default daily wastage percent for spoilage type wastage items.
itemServiceLevel	No	String (6)	Holds a value that restricts the type of shipment methods that RCOM can select for an item.
depositInPricePerUom	No	String (6)	This field indicates if the deposit amount is included in the price per UOM calculation for a contents item ticket. Valid codes are defined in the DITM code type. Examples are: E - Exclusive of Deposit Amount, I - Inclusive of Deposit Amount.
constantDimensionInd	No	String (1)	Indicates that the dimensions of the product are always the same, regardless of the supplier. If this field is Y, the dimensions for all suppliers will be defaulted to the primary supplier/primary country dimensions. Editing of dimensions for the item will only be allowed for the primary supplier/primary country.
giftWrapInd	No	String (1)	This field will contain a value of 'Y' if the item is eligible to be gift wrapped.
shipAloneInd	No	String (1)	This field will contain a value of Y if the item should be shipped to the customer is a seperate package versus being grouped together in a box.
itemAggregateInd	No	String (1)	This field holds an indicator of whether the retailer wants to aggregate inventory and sales for the item with the inventory and sales of other child items. For staple items, this indicator is always set to N. For fashion items, this indicator may be Y. If this indicator is Y, the retailer may also define which diff positions should be aggregated into item/diff combinations. Aggregated sales and inventory planning data can be used for inventory decision making and other reporting.
diff1AggregateInd	No	String (1)	This field holds an indicator (Y/N) of whether the retailer wants to aggregate inventory and sales for the item by the first Diff defined for the item (e.g Style/Color).
diff2AggregateInd	No	String (1)	This field holds an indicator (Y/N) of whether the retailer wants to aggregate inventory and sales for the item by the second Diff defined for the item (e.g Style/Waist Size).
diff3AggregateInd	No	String (1)	This field holds an indicator (Y/N) of whether the retailer wants to aggregate inventory and sales for the item by the third Diff defined for the item (e.g Style/Inseam).
diff4AggregateInd	No	String (1)	This field holds an indicator (Y/N) of whether the retailer wants to aggregate inventory and sales for the item by the fourth Diff defined for the item (e.g Style/Pattern).
perishableInd	No	String (1)	Indicates if an item is perishable.
storePackInventoryInd	No	String (1)	Indicates if inventory for a sellable simple pack should be tracked at a pack level in Store Inventory Operations. Valid values are Y (yes) for tracking at a pack level and N (no) for tracking at a component level.
sohInquiryAtPackInd	No	String (1)	Indicates in Store Inventory Operations if a notional simple pack item's inventory should be displayed in packs. Valid values are Y (yes) and N (no).
aipCaseType	No	String (6)	Only used if AIP is integrated. Determines which case sizes to extract against an item in the AIP interface. Applicable only to non-pack orderable items. Valid values are defined in the AIPT code type. Examples are: F - Formal and I - Informal.
costZoneGroupId	No	Number (4)	The cost zone from the cost_zone_group table to which the item belongs. This should be null if landed cost is not being used in the system or the item is an orderable buyer pack.
itemSuppCountryLocHierarchyLevel	No	String (2)	The level of the organizational hierarchy used to create item supplier country location relationships. Valid values are: 'AS' - All Store, 'S' - Store, 'DW'- Default Warehouse, 'AW' - All Warehouses, 'W' - Warehouse, 'PW' - Physical Warehouse, 'D' - District, 'R' - Region, 'A' - Area, 'T' - Transfer zone, 'L' - Location trait.
itemZonePriceHierarchyLevel	No	String (2)	The level of the organizational hierarchy used to create item zone price relationships. Valid values are CH (chain), AR (area), RE (region), DI (district), S (store), and W (warehouse). This value should be null if the item is a non sellable pack.
comments	No	String (2000)	Comments associated with the item.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL
translation	No	Collection of Object	References a collection of translations of the item description field.
supplier	No	Collection of Object	References a collection of suppliers associated to the item.
retailByZone	No	Collection of Object	References a collection of item zone price information.
packDetail	No	Collection of Object	References a collection of component items if the item is a pack item.
vat	No	Collection of Object	References a collection of vat information.
uda	No	Collection of Object	References a collection of item UDAs.
season	No	Collection of Object	References a collection of item seasons.
image	No	Collection of Object	References a collection of item images.
primaryReferenceItemInd	No	String(1)	This filed indicates whether the sub-transaction level item is designated as the primary sub-transaction level item. For transaction level items and above, the value in this field will be N.
hts	No	Collection of Object	References a collection of item HTS.
expense	No	Collection of Object	References a collection of item expenses.
ticket	No	Collection of Object	References a collection of item ticket.
upcharge	No	Collection of Object	References a collection of item upcharges.
conditionalTariffTreatment	No	Collection of Object	References a collection of item conditional tariff treatments
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.
longDesc	No	String (2000)	Long description of the item.

Table 5-610 Supplier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	String (10)	The identifier of the supplier who sources the item. This value must be predefined on the SUPS table.
primarySupplierInd	No	String (3)	Indicates if the supplier is the primary supplier for the item. Valid values are Y (yes) and N (no).
vpn	No	String (30)	The vendor product number associated with the item.
supplierLabel	No	String (15)	The supplier label for the item.
consignmentRate	No	Number (12,4)	This field contains the consignment rate for this item for the supplier.
supplierDiscontinueDate	No	date	Date which the supplier discontinues an item. The retailor should be aware that the supplier is able to reuse a UPC after 30 months and should work to ensure that no data exists in RMS for a UPC 30 months after it has been discontinued.
directShipInd	No	String (1)	Contains a value of Yes to indicate that any item asssociated with this supplier is eligible for a direct shipment from the supplier to the customer.
palletName	No	String (6)	Code referencing the name used to refer to the pallet. Valid codes are defined in the PALN code type. Examples are FLA - Flat, PAL - Pallet.
caseName	No	String (6)	Code referencing the name used to refer to the case. Valid codes are defined in the CASN code type. Examples are PACK - Pack, BX - Box, BG - Bag.
innerName	No	String (6)	Code referencing the name used to refer to the inner. Valid codes are defined in the INRN code type. Examples are SCS - Sub-Case, SPACK - Sub-Pack.
primaryCaseSize	No	String (6)	Used only if AIP is interfaced. Indicates the primary case size for the item supplier when an orderable item is configured for informal case types.
supplierDiff1	No	String (120)	This field contains the first supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff2	No	String (120)	This field contains the second supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff3	No	String (120)	This field contains the third supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff4	No	String (120)	This field contains the fourth supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
concessionRate	No	Number (12,4)	The concession rate is the margin that a particular supplier receives for the sale of a concession item.
defaultExpenseProfilesInd	No	String (1)	This field indicates whether expense profiles will be defaulted to new item-supplier relationship. Valid values are Y (yes) and N (no).
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL
translation	No	Collection of Object	References a collection of translations of item supplier description fields.
countryOfSourcing	No	Collection of Object	References a collection of country of sourcing of the item.
countryOfManufacture	No	Collection of Object	References a collection of country of manufacture of the item.

Table 5-611 CountryOfSourcing - Object. See list of elements for detail

Element Name	Required	Data Type	Description
originCountry	Yes	String (3)	The identifier for the country where the item is sourced. This value must be predefined on the COUNTRY table.
primaryCountryInd	No	String (1)	This indicates if the country is the primary country for the item supplier. Valid values are Y (yes) and N (no).
unitCost	No	Number (20,4)	The current corporate unit cost for the item in the supplier's currency. This field will only be used to establish the item supplier country unit cost; it cannot be modified.
leadTime	No	Number (4)	This field contains the number of days that will elapse between the date an order is written and the delivery to the store or warehouse from the supplier. This field is defaulted from the default lead time set at the supplier level.
pickupLeadTime	No	Number (4)	Contains time it takes to get the item from the Supplier to the Initial Receiving Location. This value will be defaulted to the item_supp_country_loc pickup lead time field. The ordering dialog will reference the item/supplier/country/location pickup lead time as the value may vary by location.
mininumOrderQuantity	No	Number (12,4)	This field contains the minimum quantity that can be ordered at one time from the supplier for the item.
maximumOrderQuantity	No	Number (12,4)	This field contains the maximum quantity that can be ordered at one time from the supplier for the item.
supplierHierarchyLevel1	No	String (10)	Highest level of supplier hierarchy (e. g. manufacturer). This will be used for assigning rebates that come from a level in the supply chain that is higher than the supplier. This information is stored on item_supp_country for defaulting into item_supp_country_loc.
supplierHierarchyLevel2	No	String (10)	Second highest level of supplier hierarchy. This information is stored on item_supp_country for defaulting into item_supp_country_loc.
supplierHierarchyLevel3	No	String (10)	Third highest level of supplier hierarchy. This information is stored on item_supp_country for defaulting into item_supp_country_loc.
defaultUop	No	String (6)	Contains the default unit of purchase for the item/supplier/country. Valid values include: Standard Units of Measure C for Case P for Pallet
supplierPackSize	No	Number (12,4)	Contains the quantity that orders must be placed in multiples of for the supplier for the item.
innerPackSize	No	Number (12,4)	This field contains the break pack size for this item from the supplier.
ti	No	Number (12)	Number of shipping units (cases) that make up one tier of a pallet. Multiply TI x HI to get total number of units (cases) for a pallet.
hi	No	Number (12)	Number of tiers that make up a complete pallet (height). Multiply TI x HI to get total number of units (cases) for a pallet.
costUom	No	String (4)	Unit of measure associated with the item cost. It is held to allow costs to be managed in a separate UOM from the standard UOM.
toleranceType	No	String (6)	The unit of the tolerances for catch weight simple packs: A - actual, P - percent.
minimumTolerance	No	Number (12,4)	The minimum tolerance value for a catch weight simple pack.
maximumTolerance	No	Number (12,4)	The maximum tolerance value for a catch weight simple pack.
supplierHierarchyType1	No	String (6)	Identifies partner type of supplier hierarchy level 1 for the foreign key to the partner table.
supplierHierarchyType2	No	String (6)	Identifies partner type of supplier hierarchy level 2 for the foreign key to the partner table.
supplierHierarchyType3	No	String (6)	Identifies partner type of supplier hierarchy level 3 for the foreign key to the partner table.
roundLevel	No	String (6)	This column will be used to determine how order quantities will be rounded to Case, Layer and Pallet.
roundToInnerPercentage	No	Number (12,4)	The Inner Rounding Threshold value. Used to determine whether to round partial Inner quantities up or down.
roundToCasePercentage	No	Number (12,4)	The Case Rounding Threshold value. Used to determine whether to round partial Case quantities up or down.
roundToLayerPercentage	No	Number (12,4)	The Layer Rounding Threshold value. Used to determine whether to round partial Layer quantities up or down.
roundToPalletPercentage	No	Number (12,4)	The Pallet Rounding Threshold value. Used to determine whether to round partial Pallet quantities up or down.
packingMethod	No	String (6)	This field indicates whether the packing method of the item in the container is Flat or Hanging. Values for this field are defined in PKMT code type. Examples are: FLAT - Flat, HANG - Hanging.
defaultExpenseProfilesInd	No	String (1)	This field indicates whether expense profiles will be defaulted to new item-supplier-country relationship.
purchaseType	No	String (1)	This contains a code to indicate whether the item is normal merchandise (i. e. owned by the retailer), consignment stock or a concession item. Valid values are 0 - Owned, 1 - Consignment, 2 - Concession.
calculationBasis	No	String (1)	This indicates if the cost for the consignment/concession item will be managed either based on cost per unit or as a percentage of retail. Valid values are C - Cost per Unit, P - Purchase Rate.
purchaseRate	No	Number (12,4)	This column contains the percentage of the retail price which will determine the cost paid to the supplier for a consignment or concession item.
pricingControl	No	String (1)	This indicates whether the price for the consignment/concession item will be managed by supplier or by retailer when supplier-controlled pricing for Consignment/Concession ownership model is used within the Merchandising suite of solutions. Valid values are: R – Retailer, S – Supplier. If no value is provided for consignment/concession items, this will be defaulted based on the default pricing control at supplier site level.
dimension	No	Collection of Object	References a collection of item supplier country dimensions.
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL
location	No	Collection of Object	References a collection of item supplier country locations.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-612 Location - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hierarchyId	Yes	Number (10)	The specific location id for this Item Supplier Country Loc message. Corresponds with the value used in the iscloc_hier_level field.
unitCost	No	Number (20,4)	The unit cost for the item at the item supplier country loc level in the supplier's currency. This field will be used for creating new records, not updating existing records.
negotiatedItemCost	No	Number (20,4)	This will hold the supplier negotiated item cost.
pickupLeadTime	No	Number (4)	Contains time it takes to get the item from the Supplier to the Initial Receiving Location. This value will be defaulted to the item_supp_country_loc pickup lead time field. The ordering dialog will reference the item/supplier/country/location pickup lead time as the value may vary by location.
roundLevel	No	String (6)	This column will be used to determine how order quantities will be rounded to Case, Layer and Pallet.
roundToCasePercentage	No	Number (12,4)	The Case Rounding Threshold value. Used to determine whether to round partial case quantities up or down.
roundToLayerPercentage	No	Number (12,4)	The Layer Rounding Threshold value. Used to determine whether to round partial Layer quantities up or down.
roundToPalletPercentage	No	Number (12,4)	The Pallet Rounding Threshold value. Used to determine whether to round partial Pallet quantities up or down.
roundToInnerPercentage	No	Number (12,4)	The Inner Rounding Threshold value. Used to determine whether to round partial Inner quantities up or down.
supplierHierarchyLevel1	No	String (10)	Highest level of supplier hierarchy (e. g. manufacturer). This will be used forassigning rebates that come from a level in the supply chain that is higher than the supplier.
supplierHierarchyLevel2	No	String (10)	Second highest level of supplier hierarchy. Rebates at this level will include all eligible supplier/item/country/loc records assigned to this supplier hierarchy level.
supplierHierarchyLevel3	No	String (10)	Third highest level of supplier hierarchy, used for assigning rebates by a level other than supplier.
costUom	No	String (4)	Unit of measure associated with the item cost. It is held to allow costs to be managed in a separate UOM from the standard UOM.
purchaseType	No	String (1)	This contains a code to indicate whether the item is normal merchandise (i. e. owned by the retailer), consignment stock or a concession item. Valid values are 0 - Owned, 1 - Consignment, 2 - Concession.
calculationBasis	No	String (1)	This indicates if the cost for the consignment/concession item will be managed either based on cost per unit or as a percentage of retail. Valid values are C - Cost per Unit, P - Purchase Rate.
purchaseRate	No	Number (12,4)	This column contains the percentage of the retail price which will determine the cost paid to the supplier for a consignment or concession item.
pricingControl	No	String (1)	This indicates whether the price for the consignment/concession item will be managed by supplier or by retailer when supplier-controlled pricing for Consignment/Concession ownership model is used within the Merchandising suite of solutions. Valid values are: R – Retailer, S – Supplier. If no value is provided for consignment/concession items, this will be defaulted based on the default pricing control at supplier site level.
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL

Table 5-613 CustomFlexAttribute - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Table 5-614 Dimension - Object. See list of elements for detail

Element Name	Required	Data Type	Description
dimensionObject	Yes	String (6)	Specific object whose dimensions are specified in this record (e. g. case, pallet, each). Valid codes are defined in the DIMO code type. Examples are: CA - Case, EA - Each.
tareWeight	No	Number (12,4)	Amount of weight to be subtracted for packaging materials. Used to calculate the true net weight of the dimensionObject.
tareType	No	String (6)	Indicates if tare weight for this dimensionObject is wet or dry. Valid values are defined in the TARE code type. Examples are: W - Wet tare weight, D - Dry tare weight.
lwhUom	No	String (4)	Unit of measurement for length, width, and height (e. g. inches, centimeters, feet). Valid values for this field are contained in uom field on uom_class table where uom_class field = DIMEN.
length	No	Number (12,4)	Length of dim_object measured in units specified in lwh_uom.
width	No	Number (12,4)	Width of dim_object measured in units specified in lwh_uom.
height	No	Number (12,4)	Height of dim_object measured in units specified in lwh_uom.
liquidVolume	No	Number (12,4)	Liquid volume, or capacity, of dim_object measured in units specified in volume_uom. Liquid volumes are only convertible to other liquid volumes.
liquidVolumeUom	No	String (4)	Unit of measurement for liquid_volume (e. g. ounces, liters). Liquid volumes are only convertible to other liquid volumes. Valid values for this field are contained in uom field on uom_class table where uom_class field = LVOL.
statisticalCase	No	String (12)	Statistical value of the dim_objects dimensions to be used for loading purposes.
weightUom	No	String (4)	Unit of measurement for weight (e. g. pounds, kilograms). Valid values for this field are contained in uom field on uom_class table where uom_class field = MASS.
weight	No	Number (12,4)	Weight of dim_object measured in units specified in weight_uom.
netWeight	No	Number (12,4)	Unit of measurement for length, width, and height (e. g. inches, centimeters, feet). Valid values for this field are contained in uom field on uom_class table where uom_class field = DIMEN.
presentationMethod	No	String (6)	Describes the packaging (if any) being taken into consideration in the specified dimensions. Valid codes are defined in the PCKT code type. Examples are: JHOOK - Peggable Packaging, STACK - Stackable Packaging.

Table 5-615 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-616 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Table 5-617 CountryOfManufacture - Object. See list of elements for detail

Element Name	Required	Data Type	Description
manufacturerCountry	Yes	String (23)	Country ID of manufacturer.
primaryManufacturerCountryInd	No	String (1)	Indicates if it's the primary country of manufacturer.

Table 5-618 Translation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This is the language ID.
supplierDiff1	No	String (120)	This field contains the first supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff2	No	String (120)	This field contains the second supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff3	No	String (120)	This field contains the third supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierDiff4	No	String (120)	This field contains the fourth supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
supplierLabel	No	String (15)	The supplier label for the item.

Table 5-619 PackDetail - Object. See list of elements for detail

Element Name	Required	Data Type	Description
componentItem	Yes	String (25)	The component item within the pack. This value must be predefined on ITEM_MASTER. It will only be populated if the item on the message is a pack item. This value cannot be modified. Only transaction level items can be pack components.
quantity	Yes	Number (12,4)	The quantity of the component item. This value cannot be modified.

Table 5-620 Vat - Object. See list of elements for detail

Element Name	Required	Data Type	Description
vatType	Yes	String (1)	Indicates if the VAT rate is used for purchasing or selling. Valid values are C (cost), R (retail) and B (both).
vatRegion	Yes	Number (6)	The identifier for the VAT region. This value must be predefined on the VAT_REGION table. This node is optional, if it is included this field is required.
vatCode	Yes	String (6)	The identifier for the VAT code. This node is optional, if it is included in the message this field is required.
activeDate	Yes	date	The date that the VAT rate became active for the item/VAT region combination.
reverseVatInd	No	String (1)	Indicates if the item is subject to reverse charge VAT at the vat region. Valid values are Y (yes) and N (no).

Table 5-621 RetailByZone - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hierarchyId	Yes	Number (10)	The specific hierarchy id for this Item Zone Price message. Corresponds with value used in izp_hier_level field.
sellingUnitRetail	No	Number (20,4)	The selling unit retail value in the currency and the selling UOM on the message. This field cannot be modified.
sellingUom	No	String (4)	The selling unit of measure for the item's single unit retail. This field cannot be modified.
multiUnitSellingUom	No	String (4)	The selling unit of measure for the item's multi unit retail. This field cannot be modified.
country	No	String (3)	Not used.
currencyCode	No	String (3)	The code of the currency the retail value and zones are in. Item zone price records will only be created for stores with the same currency as the retail value on the message.
multiUnits	No	Number (12,4)	The multi units for the item zone. This field cannot be modified.
multiUnitRetail	No	Number (20,4)	The multi unit retail in the currency and the multi unit UOM specified on the message. This field cannot be modified.

Table 5-622 Uda - Object. See list of elements for detail

Element Name	Required	Data Type	Description
udaId	Yes	Number (5)	This field contains a number identifying the User-Defined Attribute.
displayType	Yes	String (2)	This field contains the display type (how the UDA values will be displayed to the user) for the given UDA. The valid values are DT -Date, FF - Free From, LV - List of values.
udaDate	No	date	This field contains the text value of the Used Defined attribute for the item.
udaValue	No	String (30)	This field contains value of the Used Defined attribute for the item.
udaText	No	String (250)	This field contains the text value of the Used Defined attribute for the item.

Table 5-623 Season - Object. See list of elements for detail

Element Name	Required	Data Type	Description
seasonId	Yes	Number (3)	The season identifier.
phaseId	Yes	Number (3)	The phase identifier.
sequenceNo	No	Number (4)	This field contains a sequence number that combined with the item number will make each record unique.
diffId	No	String (10)	This field will hold a value for group/differentiator combination records only.

Table 5-624 Image - Object. See list of elements for detail

Element Name	Required	Data Type	Description
imageName	Yes	String (120)	The name of the image.
imageAddress	No	String (255)	Path where the file of the image is stored.
imageDescription	No	String (40)	The description associated with the image.
imageType	No	String (6)	Field indicating the type of the image of the item. Can be H(igh), M(edium), L(ow) and T(humbnail).
primaryImageInd	No	String (1)	Field indicating whether the record is a primary image or not.
displayPriority	No	Number (4)	Field to specify the display sequence order of images associated to the item per priority.
translation	No	Collection of Object	References a collection of translations of item image description field.

Table 5-625 Image.Translation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This is the language ID.
imageDescription	Yes	String (40)	The description associated with the image.

Table 5-626 Items.Translation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This field will hold the language in which the translated text is maintained.
shortDescription	No	String (120)	This field will hold the translated text of the shortened description of the item.
itemDescription	Yes	String (250)	This field will hold the translated text of the primary description of the item.
itemDescriptionSecondary	No	String (250)	This field will hold the translated text of the secondary description of the item.
longDesc	No	String (2000)	Long description of the item.

Table 5-627 Hts - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hts	Yes	String (25)	The unique identifier for the Harmonized Tariff Schedule code.
importCountry	Yes	String (3)	The unique identifier for the country that the item will be imported into.
originCountry	Yes	String (3)	The country where the item was manufactured or significantly altered.
effectFrom	Yes	date	The date from which the Item/HTS relationship is valid. This field is used to maintain historical information related to the Item/HTS relationship.
effectTo	Yes	date	The date until when the Item/HTS relationship is valid. This field is used to maintain historical information related to the item/HTS relationship.
clearingZoneId	No	String (5)	The concept of 'clearing zone' represents a country's zone-level point of entry of goods. This field holds the Clearing Zone ID for the effective HTS code. Clearing zones are defined by import country.
status	No	String (1)	Used to indicate the status of the Item/HTS relationship. Valid values are (W)orksheet and (A)pproved.
assessments	No	Collection of Object	References a collection of assessments associated to the item HTS.

Table 5-628 Assessments - Object. See list of elements for detail

Element Name	Required	Data Type	Description
componentId	Yes	String (10)	The code representing the specific assessment component.
computationValueBase	No	String (10)	The Computation Value Base representing the base value for calculating the assessment.
componentRate	No	Number (20,4)	The rate to be charged against the calculation base. This field will hold a percentage value if the Calculation basis of the Component is Value or a monetary amount if the Calculation Basis is Specific.
perCount	No	Number (12,4)	A count indicating the amount of the Per Count Unit of Measure to which the rate applies. This column is only used for specific (per-unit) assessments.
perCountUom	No	String (4)	The unit of measure in which the Per Count is specified. This column is only used from specific (per-unit) assessments.
estimatedAssessmentValue	No	Number (26,10)	Contains the calculated value of the component.
nominationFlag1	No	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 1), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 1), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 1). For example, if cost component ABC has a + in Nomination Flag 1, then all CVBs that include Nomination Flag 1 will include this cost component value in their calculation basis.
inDuty	No	String (1)	If Import Management is enabled in Merchandising (i. e. system_options. import_ind = Y), the inDuty flag is used to indicate if the value of the cost component should be included in total duty.
nominationFlag3	No	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 3), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 3), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 3). For example, if cost component ABC has a + in Nomination Flag 3, then all CVBs that include Nomination Flag 3 will include this cost component value in their calculation basis.
inExpense	No	String (1)	The inExpense flag is used to indicate if the value of the cost component should be included in total expenses.
inAlc	No	String (1)	The inALC flag is used for cost components where the retailer does not expect to receive an actual value for the charge via an obligation or customs entry. The inALC flag allows the value of the cost component to be included in ALC via direct nomination and indicates to the system that the estimated value on the order should be used as the actual value as well because no other actual will be provided.

Table 5-629 Expense - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	Yes	Number (10)	The unique identifier for the supplier.
componentId	Yes	String (10)	The code representing the specific expense component.
dischargePort	Yes	String (5)	The port where the item will enter the importing country.
originCountry	No	String (3)	The country where the item was manufactured or significantly altered.
ladingPort	No	String (5)	The final destination lading port of the item if the Expense Type is Country.
costZoneId	No	Number (10)	The final destination zone of the item if the Expense Type is Zone.
costZoneGroupId	No	Number (4)	This field holds the items Zone Group, it is stored here for performance reasons.
baseExpenseInd	No	String (1)	Indicates whether or not this Set of Expenses is also the base Set of Expenses.
computationValueBase	No	String (10)	The Computation Value Base representing the base value for calculating the expense.
componentRate	No	Number (20,4)	The rate to be charged against the calculation base. This field will hold a percentage value if the Calculation basis of the Component is Value or a monetary amount if the Calculation Basis is Specific.
perCount	No	Number (12,4)	A count indicating the amount of the Per Count Unit of Measure to which the rate applies. This column is only used for specific (per-unit) expenses.
perCountUom	No	String (4)	The unit of measure in which the Per Count is specified. This column is only used from specific (per-unit) expenses.
componentCurrency	No	String (3)	Contains the currency the expense is to be entered in. If the Calculation Basis is V (Value), then the comp_currency will be NULL.
updateOrdersInd	No	String (1)	Indicates that new changes will be reflected to associated order-location expense record.
nominationFlag1	No	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 1), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 1), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 1). For example, if cost component ABC has a + in Nomination Flag 1, then all CVBs that include Nomination Flag 1 will include this cost component value in their calculation basis.
inDuty	No	String (1)	If Import Management is enabled in Merchandising (i. e. system_options. import_ind = Y), the inDuty flag is used to indicate if the value of the cost component should be included in total duty.
nominationFlag3	No	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 3), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 3), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 3). For example, if cost component ABC has a + in Nomination Flag 3, then all CVBs that include Nomination Flag 3 will include this cost component value in their calculation basis.
inExpense	No	String (1)	The inExpense flag is used to indicate if the value of the cost component should be included in total expenses.
inAlc	No	String (1)	The inALC flag is used for cost components where the retailer does not expect to receive an actual value for the charge via an obligation or customs entry. The inALC flag allows the value of the cost component to be included in ALC via direct nomination and indicates to the system that the estimated value on the order should be used as the actual value as well because no other actual will be provided.

Table 5-630 Ticket - Object. See list of elements for detail

Element Name	Required	Data Type	Description
ticketTypeId	Yes	String (4)	This unique identifier for the ticket type which is associated with the item.
poPrintType	No	String (1)	This field indicates when the ticket type for the given item should be printed by default, upon the approval or receipt of the purchase order.
printOnPriceChangeInd	No	String (1)	This field indicates whether or not this type of ticket should be printed for this item when a permanent price change goes into effect. Valid values are Y (yes) and N (no).
ticketOverPrintPercentage	No	Number (12,4)	This field contains a percent which indicates the amount of tickets which should be printed for a given event.

Table 5-631 Upcharge - Object. See list of elements for detail

Element Name	Required	Data Type	Description
fromLocationType	Yes	String (6)	Location type of the from_loc. This can be S - Store,W - Warehouse,A - Area,R - Region,C - Country,AS - All Stores,AW - All Warehouses,PW - Physical Warehouse
fromLocation	No	String (10)	Depending on the from_loc_type, this contains the organization hierarchy value of store, warehouse, area, region, or country from which transferring goods will incur upcharges. It will not contain a value when from_loc_type is AS (all stores) or AW (all warehouses).
toLocationType	Yes	String (6)	Location_type of the to_loc. This can be S - Store,W - Warehouse,A - Area,R - Region,C - Country,AS - All Stores,AW - All Warehouses,PW - Physical Warehouse
toLocation	No	String (10)	Depending on the to_loc_type, this contains the organization hierarchy value of store, warehouse, area, region, or country to which transferring goods will incur upcharges. It will not contain a value when to_loc_type is AS (all stores) or AW (all warehouses).
details	Yes	Collection of Object	References a collection of item upcharge detail records.

Table 5-632 Details - Object. See list of elements for detail

Element Name	Required	Data Type	Description
componentId	Yes	String (10)	Up Charge component.
componentRate	Yes	Number (20,4)	The rate to be charged against the cost of the Item/To Location combinations within the department. The value in this field will be a percentage if the calculation basis is V (Value), and a monetary amount if the calculation basis is S.
perCount	No	Number (12,4)	count indicating the amount of the Per Count Unit of Measure to which the rate applies. This will only contain a value if the calculation basis is S (Specific).
perCountUom	No	String (4)	contains the unit of measure in which the Per Count is specified. This column will only contain a value if the calculation basis is S (Specific).
upChargeGroup	Yes	String (6)	group to which the component ID belongs. This can be A-Admin. Fee,F-Freight,K-Special K Fees,M-Miscellaneous,T-Taxes,W-Franchise.
componentCurrency	Yes	String (3)	Currency of the Up Charge component.
transferAllocationDefaultInd	No	String (1)	Indicates whether all existing transfers and allocations belonging to the hierarchy should be updated or not.
computationValueBase	No	String (10)	Contains the Computation Value Basis for the Up Charge component.
costBasis	No	String (6)	Contains the basis the Up Charge will be calculated against. Valid values are defined in code type UCCB (Up Charge Cost Basis) with values: Weighted Average Cost (W) and Supplier Cost (S) and Off-Invoice Net Cost (N).
includeInTotalUpchargeInd	No	String (1)	Used to determine if the value of the individual up charge component is used to calculate the total up charge (Y) or if it is only used as the basis of calculating another up charge (N).

Table 5-633 ConditionalTariffTreatment - Object. See list of elements for detail

Element Name	Required	Data Type	Description
tariffTreatment	No	String (10)	The unique identifier for the Conditional Tariff Program code. This refers to the tariff_treatment field from the tariff_treatment table, which are conditional. Example values are - CA (NAFTA for Canada CA), A+ (Generalized System of Preferences A+).
recalculateOrderInd	No	String (1)	The optional field indicates if open orders associated with the item should have assessments and expenses recalculated.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "itemParent": null,
      "itemGrandparent": null,
      "itemNumberType": "MANL",
      "itemLevel": 1,
      "tranLevel": 1,
      "status": "W",
      "inventoryInd": "Y",
      "dept": 3041,
      "class": 1,
      "subclass": 1,
      "itemDescription": "Regular Item 100100076",
      "shortDescription": "100100076 Item",
      "itemDescriptionSecondary": "100100076 Item Regular",
      "standardUom": "EA",
      "sellableInd": "Y",
      "orderableInd": "Y",
      "simplePackInd": "N",
      "packInd": "N",
      "containsInnerInd": "N",
      "packType": null,
      "orderAsType": null,
      "diff1": null,
      "diff2": null,
      "diff3": null,
      "diff4": null,
      "storeOrderMultiple": "E",
      "forecastInd": null,
      "uomConversionFactor": 3,
      "packageSize": 90.00,
      "handlingTemperature": null,
      "handlingSensitivity": null,
      "manufacturerRecommendedRetail": 12.99,
      "wasteType": null,
      "averageWastePercentage": 18.00,
      "catchWeightInd": "N",
      "orderType": null,
      "saleType": null,
      "catchWeightUom": null,
      "depositItemType": null,
      "containerItem": null,
      "packageUom": null,
      "formatId": null,
      "prefix": null,
      "itemTransformationInd": "N",
      "brandName": null,
      "productClassification": null,
      "merchandiseInd": "Y",
      "originalRetail": 12.99,
      "retailLabelType": null,
      "retailLabelValue": null,
      "defaultWastePercentage": null,
      "itemServiceLevel": null,
      "depositInPricePerUom": "I",
      "constantDimensionInd": "Y",
      "giftWrapInd": "Y",
      "shipAloneInd": "Y",
      "itemAggregateInd": "N",
      "diff1AggregateInd": "N",
      "diff2AggregateInd": "N",
      "diff3AggregateInd": "N",
      "diff4AggregateInd": "N",
      "perishableInd": "Y",
      "storePackInventoryInd": "N",
      "sohInquiryAtPackInd": "N",
      "aipCaseType": null,
      "costZoneGroupId": 1000,
      "itemSuppCountryLocHierarchyLevel": "S",
      "itemZonePriceHierarchyLevel": "S",
      "comments": null,
      "dataLoadingDestination": "RMS",
      "customFlexAttribute": [
        {
          "name": "REVIEW_DATE",
          "value": null,
          "valueDate": "2001-12-31"
        }
      ],
      "translation": [
        {
          "language": 2,
          "shortDescription": "shortDesc",
          "itemDescription": "itemDesc",
          "itemDescriptionSecondary": "itemDescSecondary",
          "longDesc": "100100076 Item Regular"
        }
      ],
      "supplier": [
        {
          "supplier": "2400",
          "primarySupplierInd": "Y",
          "vpn": null,
          "supplierLabel": null,
          "consignmentRate": 3,
          "supplierDiscontinueDate": "2001-12-31",
          "directShipInd": "Y",
          "palletName": "PAL",
          "caseName": "CS",
          "innerName": "INR",
          "primaryCaseSize": null,
          "supplierDiff1": null,
          "supplierDiff2": null,
          "supplierDiff3": null,
          "supplierDiff4": null,
          "concessionRate": 1,
          "defaultExpenseProfilesInd": "Y",
          "customFlexAttribute": [
            {
              "name": "REVIEW_DATE",
              "value": null,
              "valueDate": "2001-12-31"
            }
          ],
          "translation": [
            {
              "language": 2,
              "supplierDiff1": null,
              "supplierDiff2": null,
              "supplierDiff3": null,
              "supplierDiff4": null,
              "supplierLabel": null
            }
          ],
          "countryOfSourcing": [
            {
              "originCountry": "US",
              "primaryCountryInd": "Y",
              "unitCost": 9.65,
              "leadTime": 1,
              "pickupLeadTime": 1,
              "mininumOrderQuantity": 1,
              "maximumOrderQuantity": 1,
              "supplierHierarchyLevel1": null,
              "supplierHierarchyLevel2": null,
              "supplierHierarchyLevel3": null,
              "defaultUop": "EA",
              "supplierPackSize": 1,
              "innerPackSize": 1,
              "ti": 1,
              "hi": 1,
              "costUom": "EA",
              "toleranceType": null,
              "minimumTolerance": 76.00,
              "maximumTolerance": 69.00,
              "supplierHierarchyType1": null,
              "supplierHierarchyType2": null,
              "supplierHierarchyType3": null,
              "roundLevel": "C",
              "roundToInnerPercentage": 50,
              "roundToCasePercentage": 50,
              "roundToLayerPercentage": 50,
              "roundToPalletPercentage": 50,
              "packingMethod": "HANG",
              "defaultExpenseProfilesInd": "Y",
              "purchaseType": "0",
              "calculationBasis": null,
              "purchaseRate": 18.00,
              "pricingControl": "R",
              "dimension": [
                {
                  "dimensionObject": "PA",
                  "tareWeight": 12,
                  "tareType": "D",
                  "lwhUom": "IN",
                  "length": 3,
                  "width": 3,
                  "height": 3,
                  "liquidVolume": 3,
                  "liquidVolumeUom": null,
                  "statisticalCase": null,
                  "weightUom": "LBS",
                  "weight": 3,
                  "netWeight": 11.00,
                  "presentationMethod": null
                }
              ],
              "customFlexAttribute": [
                {
                  "name": "REVIEW_DATE",
                  "value": null,
                  "valueDate": "2001-12-31"
                }
              ],
              "location": [
                {
                  "hierarchyId": 113605,
                  "unitCost": 9.65,
                  "negotiatedItemCost": 9.65,
                  "pickupLeadTime": 1000,
                  "roundLevel": "C",
                  "roundToCasePercentage": 3,
                  "roundToLayerPercentage": 3,
                  "roundToPalletPercentage": 3,
                  "roundToInnerPercentage": 3,
                  "supplierHierarchyLevel1": null,
                  "supplierHierarchyLevel2": null,
                  "supplierHierarchyLevel3": null,
                  "costUom": "EA",
                  "purchaseType": "0",
                  "calculationBasis": null,
                  "purchaseRate": 3,
                  "pricingControl": "R",
                  "customFlexAttribute": [
                    {
                      "name": "REVIEW_DATE",
                      "value": null,
                      "valueDate": "2001-12-31"
                    }
                  ]
                }
              ],
              "localizationExtensions": [
                {
                  "country": "BR",
                  "attributes": [
                    {
                      "name": "SPECIAL_CATEGORY_CODE",
                      "value": "WS_PRC_08",
                      "valueDate": "2001-12-31"
                    }
                  ]
                }
              ]
            }
          ],
          "countryOfManufacture": [
            {
              "manufacturerCountry": "BR",
              "primaryManufacturerCountryInd": "N"
            }
          ]
        }
      ],
      "retailByZone": [
        {
          "hierarchyId": 113605,
          "sellingUnitRetail": 12.99,
          "sellingUom": "EA",
          "multiUnitSellingUom": "EA",
          "country": "US",
          "currencyCode": "USD",
          "multiUnits": 3,
          "multiUnitRetail": 12.99
        }
      ],
      "packDetail": [
        {
          "componentItem": null,
          "quantity": 3
        }
      ],
      "vat": [
        {
          "vatType": "B",
          "vatRegion": 1000,
          "vatCode": "S",
          "activeDate": null,
          "reverseVatInd": "N"
        }
      ],
      "uda": [
        {
          "udaId": 201,
          "displayType": "FF",
          "udaDate": null,
          "udaValue": null,
          "udaText": null
        }
      ],
      "season": [
        {
          "seasonId": 100,
          "phaseId": 100,
          "sequenceNo": 1000,
          "diffId": null
        }
      ],
      "image": [
        {
          "imageName": "imageName1",
          "imageAddress": "http://www.oracle.com/",
          "imageDescription": "imageDesc1",
          "imageType": "T",
          "primaryImageInd": "Y",
          "displayPriority": 1,
          "translation": [
            {
              "language": 2,
              "imageDescription": "Item Image"
            }
          ]
        }
      ],
      "primaryReferenceItemInd": "N",
      "hts": [
        {
          "hts": null,
          "importCountry": "US",
          "originCountry": "US",
          "effectFrom": "2001-12-31",
          "effectTo": "2001-12-31",
          "clearingZoneId": null,
          "status": "W",
          "assessments": [
            {
              "componentId": "AGCOMM",
              "computationValueBase": "TDTYUS",
              "componentRate": 3.55,
              "perCount": null,
              "perCountUom": null,
              "estimatedAssessmentValue": null,
              "nominationFlag1": "N",
              "inDuty": "+",
              "nominationFlag3": "N",
              "inExpense": "N",
              "inAlc": "N"
            }
          ]
        }
      ],
      "expense": [
        {
          "supplier": 2400,
          "componentId": "AGCOMM",
          "dischargePort": "480",
          "originCountry": "US",
          "ladingPort": "7",
          "costZoneId": 696323,
          "costZoneGroupId": 1000,
          "baseExpenseInd": "N",
          "computationValueBase": null,
          "componentRate": 3.55,
          "perCount": 1,
          "perCountUom": "EA",
          "componentCurrency": "USD",
          "updateOrdersInd": "Y",
          "nominationFlag1": "N",
          "inDuty": "N",
          "nominationFlag3": "N",
          "inExpense": "+",
          "inAlc": "N"
        }
      ],
      "ticket": [
        {
          "ticketTypeId": null,
          "poPrintType": null,
          "printOnPriceChangeInd": "Y",
          "ticketOverPrintPercentage": 3
        }
      ],
      "upcharge": [
        {
          "fromLocationType": "S",
          "fromLocation": "6000",
          "toLocationType": "S",
          "toLocation": "6001",
          "details": [
            {
              "componentId": null,
              "componentRate": 3.55,
              "perCount": 3,
              "perCountUom": "EA",
              "upChargeGroup": null,
              "componentCurrency": "USD",
              "transferAllocationDefaultInd": "Y",
              "computationValueBase": null,
              "costBasis": null,
              "includeInTotalUpchargeInd": null
            }
          ]
        }
      ],
      "conditionalTariffTreatment": [
        {
          "tariffTreatment": "CA",
          "recalculateOrderInd": "Y"
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ],
      "longDesc": "100100076 Item Regular"
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item Description Translations

Functional Area

Items - Item Definition

Business Overview

This service is used to delete header level translations of an existing item in Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/description/translations/delete

Input Payload Details

Table 5-634 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-635 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
translation	No	Collection of Object	References a collection of translations of item description field.

Table 5-636 Translation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
language	Yes	Number (6)	The language ID.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "translation": [
        {
          "language": 5
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item Image Translations

Functional Area

Items - Item Definition

Business Overview

This service is used to delete image level translations from an existing item within Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/image/translations/delete

Input Payload Details

Table 5-637 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-638 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
image	No	Collection of Object	References a collection of item image.

Table 5-639 Image - Object. See list of elements for detail

Element Name	Required	Data Type	Description
imageName	Yes	String (120)	The name of the image.
translation	No	Collection of Object	References a collection of translations of item image description field.

Table 5-640 Translation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
language	Yes	Number (6)	The language ID.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100000041",
      "image": [
        {
          "imageName": "Omni_Int_Delta_Change",
          "translation": [
            {
              "language": 38
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item Images

Functional Area

Items - Item Definition

Business Overview

This service is used to delete an existing item image information from Merchandising. In order to perform this deletion, the image must exist for the item in Merchandising, else an error will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/images/delete

Input Payload Details

Table 5-641 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-642 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
image	No	Collection of Object	References a collection of item image.

Table 5-643 Image - Object. See list of elements for detail

Element Name	Required	Data Type	Description
imageName	Yes	String (120)	The name of the image.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "image": [
        {
          "imageName": "imageName"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item Seasons

Functional Area

Items - Item Definition

Business Overview

This service is used to delete season data from an existing item in Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/seasons/delete

Input Payload Details

Table 5-644 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-645 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
season	No	Collection of Object	References a collection of item season.

Table 5-646 Season - Object. See list of elements for detail

Element Name	Required	Data Type	Description
seasonId	Yes	Number (3)	The season identifier.
phaseId	Yes	Number (3)	The phase identifier
diffId	No	String (10)	This field will hold a value for group/differentiator combination records only.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "season": [
        {
          "seasonId": 1,
          "phaseId": 1,
          "diffId": null
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item Tickets

Functional Area

Items - Item Definition

Business Overview

This service is used to delete existing item tickets from Merchandising. In order to perform this deletion, the item/ticket type ID must exist within Merchandising, else an error will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/tickets/delete

Input Payload Details

Table 5-647 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-648 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
ticket	No	Collection of Object	References a collection of item ticket.

Table 5-649 Ticket - Object. See list of elements for detail

Element Name	Required	Data Type	Description
ticketTypeId	Yes	String (4)	Id of the ticket type associated with the item.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "ticket": [
        {
          "ticketTypeId": "TKT1"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item UDAs

Functional Area

Items - Item Definition

Business Overview

This service is used to delete item UDAs in Merchandising. In order to delete an item UDA, the UDA must exist for the item in Merchandising, otherwise, an error will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/uda/delete

Input Payload Details

Table 5-650 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-651 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
uda	No	Collection of Object	References a collection of item uda.

Table 5-652 Uda - Object. See list of elements for detail

Element Name	Required	Data Type	Description
udaId	Yes	Number (5)	This field contains a number uniquely identifying the User-Defined Attribute.
displayType	Yes	String (2)	This field contains the display type (how the UDA values will be displayed to the user) for the given UDA. The valid values are DT -Date, FF - Free From, LV - List of values.
udaDateValueText	No	String (250)	This field contains value of the Used Defined attribute for the item

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "uda": [
        {
          "udaId": 201,
          "displayType": "FF",
          "udaDateValueText": "FF14St"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Item Up Charges

Functional Area

Items - Item Definition

Business Overview

This service is used to delete existing item upcharges from Merchandising. In order to delete item upcharges, the upcharge or upcharge/component id must exist for the item in Merchandising, otherwise, an error will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/upCharges/delete

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-653 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-654 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.
upcharge	No	Collection of Object	References a collection of item upcharge.

Table 5-655 Upcharge - Object. See list of elements for detail

Element Name	Required	Data Type	Description
fromLocationType	Yes	String (6)	Location type of the from_loc. This can be S - Store,W - Warehouse,A - Area,R - Region,C - Country,AS - All Stores,AW - All Warehouses,PW - Physical Warehouse
fromLocation	No	String (10)	Depending on the from_loc_type, this contains the organization hierarchy value of store, warehouse, area, region, or country from which transferring goods will incur upcharges. It will not contain a value when from_loc_type is AS (all stores) or AW (all warehouses).
toLocationType	Yes	String (6)	Location_type of the to_loc. This can be S - Store,W - Warehouse,A - Area,R - Region,C - Country,AS - All Stores,AW - All Warehouses,PW - Physical Warehouse
toLocation	No	String (10)	Depending on the to_loc_type, this contains the organization hierarchy value of store, warehouse, area, region, or country from which transferring goods will incur upcharges. It will not contain a value when to_loc_type is AS (all stores) or AW (all warehouses).
details	No	Collection of Object	References a collection of item upcharge detail records.

Table 5-656 Details - Object. See list of elements for detail

Element Name	Required	Data Type	Description
componentId	Yes	String (10)	This field contains the unique identifier of the Up Charge component.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "104600060",
      "upcharge": [
        {
          "fromLocationType": "S",
          "fromLocation": "1211",
          "toLocationType": "S",
          "toLocation": "1111",
          "details": [
            {
              "componentId": "WHFEE"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Delete Items

Functional Area

Items - Item Definition

Business Overview

This service is used to delete existing items within Merchandising based on the item number present in the message.

If you are deleting an item, the service will first validate that the item number provided is valid.  If the item does not exist in Merchandising, an error message will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/items/delete

Input Payload Details

Table 5-657 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-658 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076"
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Item Description Translations

Functional Area

Items - Item Definition

Business Overview

This service is used to modify header level translations of an existing item in Merchandising.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/description/translations/update

Input Payload Details

Table 5-659 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-660 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
translation	No	Collection of Object	References a collection of translations of the item description field.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-661 Translation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This field will hold the language in which the translated text is maintained.
shortDescription	No	String (120)	This field will hold the translated text of the shortened description of the item.
itemDescription	Yes	String (250)	This field will hold the translated text of the primary description of the item.
itemDescriptionSecondary	No	String (250)	This field will hold the translated text of the secondary description of the item.
longDesc	No	String (2000)	Long description of the item.

Table 5-662 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-663 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "106150023",
      "dataLoadingDestination": "RMS",
      "translation": [
        {
          "language": 5,
          "shortDescription": "アイテム106150023",
          "itemDescription": "レギュラーアイテム 106150023",
          "itemDescriptionSecondary": "レギュラーアイテム二次 106150023",
          "longDesc": "100100076 Item Regular"
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Item Image Translations

Functional Area

Items - Item Definition

Business Overview

This service is used to modify image level translations of an existing item within Merchandising.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/image/translations/update

Input Payload Details

Table 5-664 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-665 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
image	No	Collection of Object	References a collection of item images.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-666 Image - Object. See list of elements for detail

Element Name	Required	Data Type	Description
imageName	Yes	String (120)	The name of the image.
translation	No	Collection of Object	References a collection of translations of item image description field.

Table 5-667 Translation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This is the language ID.
imageDescription	Yes	String (40)	The description associated with the image.

Table 5-668 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-669 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "image": [
        {
          "imageName": "imageName1",
          "translation": [
            {
              "language": 20,
              "imageDescription": "Προηγούμενη εικόνα"
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Item Images

Functional Area

Items - Item Definition

Business Overview

This service is used to update an existing item image within Merchandising. In order to update an item image, the specified image name must exist for the item in Merchandising, else an error will be returned.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/images/update

Input Payload Details

Table 5-670 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-671 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
image	No	Collection of Object	References a collection of item images.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-672 Image - Object. See list of elements for detail

Element Name	Required	Data Type	Description
imageName	Yes	String (120)	The name of the image.
imageAddress	No	String (255)	Path where the file of the image is stored.
imageDescription	No	String (40)	The description associated with the image.
imageType	No	String (6)	Field indicating the type of the image of the item. Can be H(igh), M(edium), L(ow) and T(humbnail).
primaryImageInd	No	String (1)	Field indicating whether the record is a primary image or not.
displayPriority	No	Number (4)	Field to specify the display sequence order of images associated to the item per priority.

Table 5-673 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-674 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "image": [
        {
          "imageName": "imageName1",
          "imageAddress": "http://www.oracle.com/",
          "imageDescription": "imageDesc1",
          "imageType": "T",
          "primaryImageInd": "Y",
          "displayPriority": 1
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Item Tickets

Functional Area

Items - Item Definition

Business Overview

This service is used to modify tickets of existing items in Merchandising. In order to update tickets, the item/ticket type id must exist in Merchandising, otherwise, an error will be returned. All item ticket fields except for ticket type ID are updateable and will go through the same validation as in the creation of item tickets.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/tickets/update

Input Payload Details

Table 5-675 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-676 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
ticket	No	Collection of Object	References a collection of item ticket.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-677 Ticket - Object. See list of elements for detail

Element Name	Required	Data Type	Description
ticketTypeId	Yes	String (4)	This unique identifier for the ticket type which is associated with the item.
poPrintType	No	String (1)	This field indicates when the ticket type for the given item should be printed by default, upon the approval (A) or receipt (R) of the purchase order.
printOnPriceChangeInd	No	String (1)	This field indicates whether or not this type of ticket should be printed for this item when a permanent price change goes into effect. Valid values are Y (yes) and N (no).
ticketOverPrintPercentage	No	Number (12,4)	This field contains a percent which indicates the amount of tickets which should be printed for a given event.

Table 5-678 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-679 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "102350132",
      "dataLoadingDestination": "RMS",
      "ticket": [
        {
          "ticketTypeId": "TKT1",
          "poPrintType": "R",
          "printOnPriceChangeInd": "N",
          "ticketOverPrintPercentage": 3
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Item UDAs

Functional Area

Items - Item Definition

Business Overview

This service is used to modify UDAs for an existing item in Merchandising. In order to update an item UDA of type date, freeform text, or list of values, the UDA must exist for the item in Merchandising, otherwise, an error will be returned.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/uda/update

Input Payload Details

Table 5-680 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-681 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
uda	No	Collection of Object	References a collection of item UDAs.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-682 Uda - Object. See list of elements for detail

Element Name	Required	Data Type	Description
udaId	Yes	Number (5)	This field contains a number identifying the User-Defined Attribute.
displayType	Yes	String (2)	This field contains the display type (how the UDA values will be displayed to the user) for the given UDA. The valid values are DT -Date, FF - Free From, LV - List of values.
udaDate	No	date	This field contains the text value of the Used Defined attribute for the item.
udaValue	No	String (30)	This field contains value of the Used Defined attribute for the item.
udaText	No	String (250)	This field contains the text value of the Used Defined attribute for the item.
newUdaDate	No	date	This field contains the value for modification the uda_date of the Used Defined attribute for the item.
newUdaValue	No	String (30)	This field contains the value for modification the uda_value of the Used Defined attribute for the item.
newUdaText	No	String (250)	This field contains the value for modification the uda_date of the Used Defined attribute for the item.

Table 5-683 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-684 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "uda": [
        {
          "udaId": 10000,
          "displayType": "FF",
          "udaDate": "2001-12-31",
          "udaValue": null,
          "udaText": null,
          "newUdaDate": "2001-12-31",
          "newUdaValue": null,
          "newUdaText": null
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Item Up Charge Details

Functional Area

Items - Item Definition

Business Overview

This service is used to modify details for existing item upcharges in Merchandising. To update an item upcharge detail, the upcharge/component ID must exist for the item in Merchandising; otherwise, an error will be returned.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/upCharge/details/update

Availability During Nightly Batch Cycle

This service will not be available when batches affecting either inventory or cost are in-progress.

Input Payload Details

Table 5-685 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-686 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
upcharge	No	Collection of Object	References a collection of item upcharges.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-687 Upcharge - Object. See list of elements for detail

Element Name	Required	Data Type	Description
fromLocationType	Yes	String (6)	Location type of the from_loc. This can be S - Store,W - Warehouse,A - Area,R - Region,C - Country,AS - All Stores,AW - All Warehouses,PW - Physical Warehouse
fromLocation	No	String (10)	Depending on the from_loc_type, this contains the organization hierarchy value of store, warehouse, area, region, or country from which transferring goods will incur upcharges. It will not contain a value when from_loc_type is AS (all stores) or AW (all warehouses).
toLocationType	Yes	String (6)	Location_type of the to_loc. This can be S - Store,W - Warehouse,A - Area,R - Region,C - Country,AS - All Stores,AW - All Warehouses,PW - Physical Warehouse
toLocation	No	String (10)	Depending on the to_loc_type, this contains the organization hierarchy value of store, warehouse, area, region, or country to which transferring goods will incur upcharges. It will not contain a value when to_loc_type is AS (all stores) or AW (all warehouses).
details	Yes	Collection of Object	References a collection of item upcharge detail records.

Table 5-688 Details - Object. See list of elements for detail

Element Name	Required	Data Type	Description
componentId	Yes	String (10)	Up Charge component.
componentRate	Yes	Number (20,4)	The rate to be charged against the cost of the Item/To Location combinations within the department. The value in this field will be a percentage if the calculation basis is V (Value), and a monetary amount if the calculation basis is S.
perCount	No	Number (12,4)	count indicating the amount of the Per Count Unit of Measure to which the rate applies. This will only contain a value if the calculation basis is S (Specific).
perCountUom	No	String (4)	contains the unit of measure in which the Per Count is specified. This column will only contain a value if the calculation basis is S (Specific).
upChargeGroup	Yes	String (6)	group to which the component ID belongs. This can be A-Admin. Fee,F-Freight,K-Special K Fees,M-Miscellaneous,T-Taxes,W-Franchise.
componentCurrency	Yes	String (3)	Currency of the Up Charge component.
transferAllocationDefaultInd	No	String (1)	Indicates whether all existing transfers and allocations belonging to the hierarchy should be updated or not.
computationValueBase	No	String (10)	Contains the Computation Value Basis for the Up Charge component.
costBasis	No	String (6)	Contains the basis the Up Charge will be calculated against. Valid values are defined in code type UCCB (Up Charge Cost Basis) with values: Weighted Average Cost (W) and Supplier Cost (S) and Off-Invoice Net Cost (N).
includeInTotalUpchargeInd	No	String (1)	Used to determine if the value of the individual up charge component is used to calculate the total up charge (Y) or if it is only used as the basis of calculating another up charge (N).

Table 5-689 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-690 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100500029",
      "dataLoadingDestination": "RMS",
      "upcharge": [
        {
          "fromLocationType": "W",
          "fromLocation": "10001",
          "toLocationType": "S",
          "toLocation": "1231",
          "details": [
            {
              "componentId": "WHFEE",
              "componentRate": 3.55,
              "perCount": 1,
              "perCountUom": "EA",
              "upChargeGroup": "A",
              "componentCurrency": "USD",
              "transferAllocationDefaultInd": "Y",
              "computationValueBase": null,
              "costBasis": null,
              "includeInTotalUpchargeInd": "Y"
            }
          ]
        }
      ],
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Update Items

Functional Area

Items - Item Definition

Business Overview

This service is used to modify header level information of existing items in Merchandising.

Updates can be made to the items that are in Worksheet, Submitted, or Approved status. In order to perform the update, the service will validate that the item number included in the message already exists within Merchandising. Only header level fields need to be provided for header level updates. Any item details included in the message will be ignored for a header level update message. There are certain fields that are not allowed to be updated at the header level depending on the status, and if these are still provided in the message, an appropriate error message will be returned. Any custom flexible attributes (CFAS) defined at the item level, can be updated as part of this service. The flexible attributes are treated as a single group and the complete CFAS payload needs to be included in the message for Update. If an attribute is omitted from the message or is included with an empty (NULL) value, then the existing value will be cleared out.

This service can also be used to reinstate a deleted item back to its previous status. In such a scenario, the status needs to be passed as 'R' which will solely reinstate the item to its last defined status and ignore any updates to other fields included in the payload.

Service Type

PUT

ReST URL

MerchIntegrations/services/items/update

Availability During Nightly Batch Cycle

This service will not be available during total duration of nightly batch run cycle.

Input Payload Details

Table 5-691 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of items.

Table 5-692 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
status	No	String (1)	Status of the item.
itemDescription	No	String (250)	The long description of the item.
shortDescription	No	String (120)	The short description of the item. If this field is not populated it will default from the long description.
itemDescriptionSecondary	No	String (250)	Secondary descriptions of the item.
standardUom	No	String (4)	The unit of measure at which the item is tracked at the corporate level. This will be defaulted to EA (eaches) if not populated on the message. It cannot be modified.
diff1	No	String (10)	Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz).
diff2	No	String (10)	Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz).
diff3	No	String (10)	Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz).
diff4	No	String (10)	Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz).
storeOrderMultiple	No	String (1)	The unit type of merchandise shipped from the warehouse to the store for this item. Valid values are C (cases), I (inners), and E (eaches).
forecastInd	No	String (1)	Indicates whether the item is forecastable. Valid value are Y (yes) and N (no). This value should be N if the item is a pack.
uomConversionFactor	No	Number (20,10)	Conversion factor between an Each and the standard_uom when the standard_uom is not in the quantity class (e. g. if standard_uom = lb and 1 lb = 10 eaches, this factor will be 10). This factor will be used to convert sales and stock data when an item is retailed in eaches but does not have eaches as its standard unit of measure.
packageSize	No	Number (12,4)	Holds the size of the product printed on any packaging (i. e. 24 ounces). This field is used for reporting purposes, as well as by Oracle Retail Price Mangement to determine same sized and different sized items.
handlingTemperature	No	String (6)	Holds the temperature information associated with the item. Valid codes are defined in the HTMP code type. Examples are: FRIDGE - Keep Refrigerated, FROZEN - Keep Frozen.
handlingSensitivity	No	String (6)	Holds the sensitivity information associated with the item. Valid codes are defined in the HSEN code type. Examples are: EXPLOD - Explosive, FRAG - Fragile.
manufacturerRecommendedRetail	No	Number (20,4)	Manufacturers recommended retail price for the item in primary currency. Used for informational purposes only.
wasteType	No	String (6)	Identifies the wastage type as either sales or spoilage wastage. Valid values are: SP - Spoilage, SL - Sales Wastage is not applicable to pack items.
averageWastePercentage	No	Number (12,4)	Average percent of wastage for the item over its shelf life. Used in inflating the retail price for wastage items.
catchWeightInd	No	String (1)	Indiactes whether the item should be weighed when it arives at a location. Valid values for this field are Y and N.
containerItem	No	String (25)	This holds the container item number for a content item.
packageUom	No	String (4)	Holds the unit of measure associated with the package size. This field is used for reporting purposes and by Retek Price Management to determine same sized and different sized items.
brandName	No	String (120)	This is added to capture the brand information of an item.
productClassification	No	String (6)	This defines which items can be combined (packed or boxed) together. Valid codes are defined in the PCLA code type. Examples are: APP - Apparel, GRC - Grocery.
originalRetail	No	Number (20,4)	The original retail price of the item per unit. This field is stored in the primary currency.
retailLabelType	No	String (6)	This field indicates any special label type assoctiated with an item. Valid codes are defined in the RTLT code type. Examples are: COFF - Cents Off, EXTRA - Extra Product, PREP - Pre-Priced.
retailLabelValue	No	Number (20,4)	This field represents the value associated with the retail label type.
defaultWastePercentage	No	Number (12,4)	Default daily wastage percent for spoilage type wastage items.
itemServiceLevel	No	String (6)	Holds a value that restricts the type of shipment methods that RCOM can select for an item.
depositInPricePerUom	No	String (6)	This field indicates if the deposit amount is included in the price per UOM calculation for a contents item ticket. Valid codes are defined in the DITM code type. Examples are: E - Exclusive of Deposit Amount, I - Inclusive of Deposit Amount.
constantDimensionInd	No	String (1)	Indicates that the dimensions of the product are always the same, regardless of the supplier. If this field is Y, the dimensions for all suppliers will be defaulted to the primary supplier/primary country dimensions. Editing of dimensions for the item will only be allowed for the primary supplier/primary country.
giftWrapInd	No	String (1)	This field will contain a value of 'Y' if the item is eligible to be gift wrapped.
shipAloneInd	No	String (1)	This field will contain a value of Y if the item should be shipped to the customer is a seperate package versus being grouped together in a box.
aipCaseType	No	String (6)	Only used if AIP is integrated. Determines which case sizes to extract against an item in the AIP interface. Applicable only to non-pack orderable items. Valid values are defined in the AIPT code type. Examples are: F - Formal and I - Informal.
comments	No	String (2000)	Comments associated with the item.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL.
primaryReferenceItemInd	No	String (1)	This filed indicates whether the sub-transaction level item is designated as the primary sub-transaction level item. For transaction level items and above the value in this field will be N.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.
longDesc	No	String (2000)	Long description of the item.

Table 5-693 CustomFlexAttribute - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Table 5-694 LocalizationExtensions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
country	Yes	String (3)	Id of the country associated with the localization attributes.
attributes	Yes	Collection of Object	This holds the details of localization attributes.

Table 5-695 Attributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
name	Yes	String (30)	Holds the attribute name.
value	No	String (250)	Holds the numeric or string value of the attribute.
valueDate	No	date	Holds the date value of the attribute.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "status": "W",
      "itemDescription": "Regular Item 100100076",
      "shortDescription": "100100076 Item",
      "itemDescriptionSecondary": "100100076 Item Regular",
      "standardUom": "EA",
      "diff1": null,
      "diff2": null,
      "diff3": null,
      "diff4": null,
      "storeOrderMultiple": "E",
      "forecastInd": null,
      "uomConversionFactor": 3,
      "packageSize": 90.00,
      "handlingTemperature": null,
      "handlingSensitivity": null,
      "manufacturerRecommendedRetail": 12.99,
      "wasteType": null,
      "averageWastePercentage": 18.00,
      "catchWeightInd": "N",
      "containerItem": null,
      "packageUom": null,
      "brandName": null,
      "productClassification": null,
      "originalRetail": 12.99,
      "retailLabelType": null,
      "retailLabelValue": null,
      "defaultWastePercentage": null,
      "itemServiceLevel": null,
      "depositInPricePerUom": "I",
      "constantDimensionInd": "Y",
      "giftWrapInd": "Y",
      "shipAloneInd": "Y",
      "aipCaseType": null,
      "comments": null,
      "dataLoadingDestination": "RMS",
      "customFlexAttribute": [
        {
          "name": "REVIEW_DATE",
          "value": null,
          "valueDate": "2001-12-31"
        }
      ],
      "primaryReferenceItemInd": "N",
      "localizationExtensions": [
        {
          "country": "BR",
          "attributes": [
            {
              "name": "SPECIAL_CATEGORY_CODE",
              "value": "WS_PRC_08",
              "valueDate": "2001-12-31"
            }
          ]
        }
      ],
      "longDesc": "100100076 Item Regular"
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors will be present when input payload or input parameters do not match the schema definition for this service.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ]
}

Item Foundation

The following services are included in this functional area:

• Brand Download Service

  • Get Brands

• Brand Upload Service

  • Manage Brands

• Differentiator Download Service

  • Get Differentiator Details

  • Get Differentiator Details for Provided Differentiator

  • Get Differentiator Details for Single Differentiator

• Differentiator Group Download Service

  • Get Differentiator Groups

  • Get Differentiators for Provided Group

• Differentiator Group Upload Service

  • Create Differentiator Group Details

  • Create Differentiator Groups

  • Delete Differentiator Group Details

  • Delete Differentiator Groups

  • Update Differentiator Group Details

  • Update Differentiator Groups

• Differentiator Type Download Service

  • Get Differentiator Type Details for Provided Type

  • Get Differentiator Types

• Differentiator Upload Service

  • Create Differentiators

  • Delete Differentiators

  • Update Differentiators

• Seasons and Phases Download Service

  • Get Seasons and Phases Service

• User Defined Attribute (UDA) Download Service

  • REST Endpoint for UDA details

  • REST Endpoint to Fetch UDA by UDA ID

Brand Download Service

The following services are included in this functional area:

• Get Brands

Get Brands

Endpoints

/MerchIntegrations/services/item/brands

Functional Area

Items - Item Foundation

Business Overview

This service retrieves all Brand records. This service supports pagination and the page size of each response is controlled by the query parameter 'limit'. This service takes an optional query parameter of brand name to retrieve the specified brand.

Service Type

GET

ReST URL

/MerchIntegrations/services/item/brands?offsetkey={offsetkey}&limit={limit}&brandName=[brandName]

Input Parameters

Parameter Name	Required	Data Type	Description
offsetkey	No	String	Offset Key. Valid Value is brand name
limit	No	Number	Pagination limit. Default Value is 1000.
brandName	No	String	Brand Name. Searches for a specific brand

Output – Brand

Name	Data Type	Description
brandName	String	This field contains the brand name.
brandDescription	String	This field contains the brand description.
createDatetime	Datetime	This field contains the date-time in UTC when this record was created.
lastUpdateDatetime	Datetime	This field contains the date-time in UTC when this record was updated.

Table 5-696 Elements in JSON Output

Elements	Description
items	The first element is named as items and contains a number of child elements. Each child element corresponds to a row in the result set generated by the query.
hasMore	This is dependent on limit value. If the total rows are more than then limit defined then hasMore will be set to true else false.
limit	This is used to limit the rows to control the paging of result data. Based on the limit, next and previous links are displayed. For example: If the limit is set to 25, internal it tries to fetch 26 rows. If 26th row exists then 25 rows are returned along with a "next" link else no links would be added to the JSON response.
links	“self” : This contains URI pointing to current page. “next”: This contains URI pointing to the next page of results.

Example JSON output:

{
  "items": [
    {
      "brandName": "ORCL",
      "brandDescription": "ORACLE",
      "createDatetime": "2020-12-31T23:59:59.000Z",
      "lastUpdateDatetime": "2021-12-31T23:59:59.000Z "
    }
  ],
  "hasMore": true,
  "limit": 1,
  "count": 1,
  "links": [
    {
      "http://server:port/MerchIntegrations/services/item/brands?limit=1",
      "rel": "self"
    },
    {
      "href": "http://server:port /MerchIntegrations/services/item/brands?offsetkey=ORCL&limit=1",
      "rel": "next"
    }
  ]
}

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
BRAND	Yes	No	No	No

Brand Upload Service

The following services are included in this functional area:

• Manage Brands

Manage Brands

Functional Area

Items - Item Foundation

Business Overview

This service allows external system to manage brand data. It supports creating, updating and deleting brand records as well as managing translated brand descriptions.

This service accepts brand data as input. If the delete indicator is set to 'N' (or is empty) and the input brand name does not exists in the system, a new brand record will be created. If the brand name already exists, it will update the brand description (if provided) and the provided translation entries.

A value of 'Y' in the delete indicator will delete the brand record if the brand is not attached with any item.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/brands/manage

Input Payload Details

Table 5-697 Manage - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of Brand Data.

Table 5-698 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
brandName	Yes	String (30)	This field contains the brand name. This is maintained in upper case.
brandDescription	No	String (120)	This field contains the description of the brand. This field is optional and if provided, brand description will be updated for an existing record. This field is requried for new brand creation and any update request where transalation records are not being maintained.
deleteInd	No	String (1)	This optional field allows for delete of existing brand record provided the brand is not attached to any item. If this is set to Y (Yes), input brand name must exists in the system. Default value is 'N'
translation	No	Collection of Object	References a collection of translations of the brand description field.

Table 5-699 Translation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This field contains the language ID. This value must be predefined on the LANG table. This should not be the system primary language id.
brandDescription	No	String (120)	This field contains the translated description of the brand in the provided language id. This field is optional for delete of an existing transaction entry.
deleteInd	No	String (1)	This optional field allows for delete of existing translation entry for brand. If this is set to Y (Yes), the transalation entry must exists for the input language id. Default value is 'N'

Table 5-700 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
brandName	Yes	String (30)	This field contains the input brand name for which validation error happened
errorMessage	Yes	String (2000)	This field contains the error message.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "brandName": "NEW",
      "brandDescription": "New Brand",
      "deleteInd": null,
      "translation": [
        {
          "language": 3,
          "brandDescription": "Nouvelle marque",
          "deleteInd": null
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element "validationErrors" will be present when input payload or input parameters are not as per the schema definition of this service. The element "businessError" will be present if the payload passes schema validation but exception is caught while processing business logic.

Table 5-701 ManageError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
brandName	Yes	String (30)	This field contains the input brand name for which validation error happened
errorMessage	Yes	String (2000)	This field contains the error message.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    {
      "brandName": "NEW",
      "errorMessage": "Delete failed because brand is associated with one or more items"
    }
  ]
}

Differentiator Download Service

The following services are included in this functional area:

• Get Differentiator Details

• Get Differentiator Details for Provided Differentiator

• Get Differentiator Details for Single Differentiator

Get Differentiator Details

Endpoints

MerchIntegrations/services/foundation/diffid 

MerchIntegrations/services/foundation/diffid/{diffId}

Functional Area

Items – Item Foundation

Business Overview

This service can be used by external applications to get all or selected diff IDs and its details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/diffid? since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

/MerchIntegrations/services/foundation/diffId/{diffId}

Input Parameters for MerchIntegrations/services/foundation/diffId

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value is combination of sort_order_seq and node id.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Input Parameters for MerchIntegrations/services/foundation/diffId/{diffId}

Parameter Name	Required	Data Type	Description
differentiatorId	Yes	String	This field contains a unique identifier of the differentiator
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Output – Diff ID

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE and DELETE.
diffId	String	This field contains a unique identifier of the differentiator.
diffDescription	String	This field contains the description of the differentiator.
diffType	String	This field contains a code indicating the type of differentiator, for example C for Color.
industryCode	String	This field is used to hold the unique code used by industry standards to identify the differentiator
industrySubgroup	String	This field is used to hold a sub-grouping code used by industry standards to further identify the differentiator
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
cacheTimestamp	String	This field specifies date and time when the Diff ID record was last maintained.

Elements in JSON Output

Elements	Description
items	The first element is named as items and contains a number of child elements. Each child element corresponds to a row in the result set generated by the query.
hasMore	This is dependent on limit value. If the total rows are more than then limit defined then hasMore will be set to true else false.
limit	This is used to limit the rows to control the paging of result data. Based on the limit, next and previous links are displayed. For example: If the limit is set to 25, internal it tries to fetch 26 rows. If 26th row exists then 25 rows are returned along with a "next" link else no links would be added to the JSON response.
links	“self” : This contains URI pointing to current page. “next”: This contains URI pointing to the next page of results.

Example JSON Output

{
  "items": [
    {
      "action": "INSERT",
      "diffId": "1",
      "diffDescription": "Pot Size",
      "diffType": "POTSZ",
      "industryCode": null,
      "industrySubgroup": null,
      "createDateTime": "2005-02-01T00:00:00.000Z",
      "updateDateTime": "2005-02-01T00:00:00.000Z",
      "cacheTimestamp": "2021-08-31T07:55:38.434Z"
    }
  ],
  "hasMore": false,
  "limit": 1000,
  "count": 1,
  "links": [
    {
      "href": "https://<hostname>:<port>/rgbu-rex-rgbu-dev1-mfcs19-1/MerchIntegrations/services/foundation/diffid?limit=10000&since=1970-01-01T00:00:00.001Z&before=2022-03-25T09:17:01.879357+00:00",
      "rel": "self"
    }
  ]
}

Table Impact

The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ICL_RMS_DIFF_IDS	Yes	No	Yes	Yes
MERCHAPI_EXT_DIFF_IDS	Yes	Yes	Yes	Yes
V_ MERCHAPI_EXT_DIFF_IDS _JSON	Yes	No	No	No

Get Differentiator Details for Provided Differentiator

Endpoints

MerchIntegrations/services/foundation/diffid 
MerchIntegrations/services/foundation/diffid/{diffId}

Functional Area

Items - Item Foundation

Business Overview

This service can be used by external applications to get all or selected diff IDs and its details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/diffid? since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

/MerchIntegrations/services/foundation/diffId/{diffId}

Input Parameters for MerchIntegrations/services/foundation/diffId

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value is combination of sort_order_seq and node ID.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Input Parameters for MerchIntegrations/services/foundation/diffId/{diffId}

Parameter Name	Required	Data Type	Description
differentiatorId	Yes	String	This field contains a unique identifier of the differentiator

Output - Diff ID

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE and DELETE.
diffId	String	This field contains a unique identifier of the differentiator.
diffDescription	String	This field contains the description of the differentiator.
diffType	String	This field contains a code indicating the type of differentiator, for example C for Color.
industryCode	String	This field is used to hold the unique code used by industry standards to identify the differentiator
industrySubgroup	String	This field is used to hold a sub-grouping code used by industry standards to further identify the differentiator
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
cacheTimestamp	String	This field specifies date and time when the Diff ID record was last maintained.

Elements in JSON Output

Elements	Description
items	The first element is named as items and contains a number of child elements. Each child element corresponds to a row in the result set generated by the query.
hasMore	This is dependent on limit value. If the total rows are more than then limit defined then hasMore will be set to true else false.
limit	This is used to limit the rows to control the paging of result data. Based on the limit, next and previous links are displayed. For example: If the limit is set to 25, internal it tries to fetch 26 rows. If 26th row exists then 25 rows are returned along with a "next" link else no links would be added to the JSON response.
links	“self” : This contains URI pointing to current page. “next”: This contains URI pointing to the next page of results.

Example JSON output:

{
  "items": [
    {
      "action": "INSERT",
      "diffId": "1",
      "diffDescription": "Pot Size",
      "diffType": "POTSZ",
      "industryCode": null,
      "industrySubgroup": null,
      "createDateTime": "2005-02-01T00:00:00.000Z",
      "updateDateTime": "2005-02-01T00:00:00.000Z",
      "cacheTimestamp": "2021-08-31T07:55:38.434Z"
    }
  ],
  "hasMore": false,
  "limit": 1000,
  "count": 1,
  "links": [
    {
      "href": "https://<hostname>:<port>/rgbu-rex-rgbu-dev1-mfcs19-1/MerchIntegrations/services/foundation/diffid?limit=10000&since=1970-01-01T00:00:00.001Z&before=2022-03-25T09:17:01.879357+00:00",
      "rel": "self"
    }
  ]
}

Table Impact

The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ICL_RMS_DIFF_IDS	Yes	No	Yes	Yes
MERCHAPI_EXT_DIFF_IDS	Yes	Yes	Yes	Yes
V_ MERCHAPI_EXT_DIFF_IDS _JSON	Yes	No	No	No

Get Differentiator Details for Single Differentiator

This section describes the Diff Detail service.

Business Overview

Diff Detail service allows user to retrieve Diff description for a selected Diff Id.

Service Type

Get

ReST URL

DiffIds/diffIdDetail?diffId={diffId}

Input Parameters

Parameter Name	Required	Description
Diff_Id	Yes	Diff ID

Output

RestDiffIdsRecRDO

Parameter Name	Data Type
industrySubgroup	String
diffGroupDesc	String
diffType	String
diffDesc	String
industryCode	String
diffGroupId	String
diffTypeDesc	String

JSON Structure
    { 
       "industrySubgroup": null,
        "diffGroupDesc": null,
        "diffType": null,
        "diffDesc": "null,
        "industryCode": null,
        "diffGroupId": null,
        "diffTypeDesc": null,
        "links": [],
        "hyperMediaContent": {
            "linkRDO": []
        }
  }

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
DIFF_IDS	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Differentiator Group Download Service

The following services are included in this functional area:

• Get Differentiator Groups

• Get Differentiators for Provided Group

Get Differentiator Groups

Endpoints

MerchIntegrations/services/foundation/diffgroup 

MerchIntegrations/services/foundation/diffgroup/{diffGroupId}

Functional Area

Items – Item Foundation

Business Overview

This service can be used by external applications to get all or selected diff groups and its details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/diffgroup? since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

/MerchIntegrations/services/foundation/diffgroup/{diffGroupId}

Input Parameters for MerchIntegrations/services/foundation/diffgroup

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value is combination of sort_order_seq and node id.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Input Parameters for MerchIntegrations/services/foundation/diffgroup/{diffGroupId}

Parameter Name	Required	Data Type	Description
diffGroupId	Yes	String	Differentiator Group ID
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Output – Diff Group Head

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE and DELETE.
diffGroupId	String	This field contains the ID of the diff group being added or updated.
diffGroupDescription	String	This field contains the description of the diff group.
diffType	String	This field contains the code for the types of diffs contained in this group, such as S for size.
createDateTime	String	This field holds the record creation date.
UpdateDateTime	String	This field holds the date when the record was last updated.
details		This List holds list attributes for Diff Group Details
cacheTimestamp	String	This field specifies date and time when Diff Group record was last maintained.

Output – Diff Group Details

Name	Data Type	Description
diffId	String	This field contains the ID of the diff that is included in the group.
displaySequence	Number	This field contains the display sequence for the diff in the group.
createDateTime	String	This field holds the record creation date.

Elements in JSON Output

Elements	Description
items	The first element is named as items and contains a number of child elements. Each child element corresponds to a row in the result set generated by the query.
hasMore	This is dependent on limit value. If the total rows are more than then limit defined then hasMore will be set to true else false.
limit	This is used to limit the rows to control the paging of result data. Based on the limit, next and previous links are displayed. For example: If the limit is set to 25, internal it tries to fetch 26 rows. If 26th row exists then 25 rows are returned along with a "next" link else no links would be added to the JSON response.
links	“self” : This contains URI pointing to current page. “next”: This contains URI pointing to the next page of results.

Example JSON Output

{
   "items": [
     {
       "action": "UPDATE",
       "diffGroupId": "BASIC CLRS",
       "diffGroupDescription": "Basic Color Pallet",
       "diffType": "C",
       "createDateTime": "2004-10-12T08:52:47.000Z",
       "updateDateTime": "2004-10-12T08:52:47.000Z",
       "details": [
         {
           "diffId": "BLACK",
           "displaySequence": null,
           "createDateTime": "2004-09-27T00:00:00.000Z"
         },
         {
           "diffId": "WHITE",
           "displaySequence": null,
           "createDateTime": "2005-01-29T00:00:00.000Z"
         }
       ],
       "cacheTimestamp": "2022-07-02T00:15:20.548Z"
     }
   ],
   "hasMore": true,
   "limit": 1,
   "count": 1,
   "links": [
     {
       "href": "http://<hostname>:<port>/MerchIntegrations/services/foundation/diffgroup?limit=1&since=1970-01-01T00:00:00.001Z&before=2022-07-18T23:39:19.734588+00:00",
       "rel": "self"
     },
     {
       "href": "http://<hostname>:<port>/MerchIntegrations/services/foundation/diffgroup?offsetkey=BASIC+CLRS&limit=1&since=1970-01-01T00:00:00.001Z&before=2022-07-18T23:39:19.734588+00:00",
       "rel": "next"
     }
   ]
 }

Table Impact

The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ICL_RMS_DIFF_GROUP	Yes	No	Yes	Yes
MERCHAPI_EXT_DIFF_GROUP	Yes	Yes	Yes	Yes
V_ MERCHAPI_EXT_DIFF_GROUP _JSON	Yes	No	No	No

Get Differentiators for Provided Group

Endpoints

MerchIntegrations/services/foundation/diffgroup 
MerchIntegrations/services/foundation/diffgroup/{diffGroupId}

Functional Area

Items - Item Foundation

Business Overview

This service can be used by external applications to get all or selected diff groups and its details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/diffgroup? since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

/MerchIntegrations/services/foundation/diffgroup/{diffGroupId}

Input Parameters for MerchIntegrations/services/foundation/diffgroup

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value is combination of sort_order_seq and node ID.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Input Parameters for MerchIntegrations/services/foundation/diffgroup/{diffGroupId}

Parameter Name	Required	Data Type	Description
diffGroupId	Yes	String	Differentiator Group ID

Output – Diff Group Head

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE and DELETE.
diffGroupId	String	This field contains the ID of the diff group being added or updated.
diffGroupDescription	String	This field contains the description of the diff group.
diffType	String	This field contains the code for the types of diffs contained in this group, such as S for size.
createDateTime	String	This field holds the record creation date.
UpdateDateTime	String	This field holds the date when the record was last updated.
details		This List holds list attributes for Diff Group Details
cacheTimestamp	String	This field specifies date and time when Diff Group record was last maintained.

Output – Diff Group Details

Name	Data Type	Description
diffId	String	This field contains the ID of the diff that is included in the group.
displaySequence	Number	This field contains the display sequence for the diff in the group.
createDateTime	String	This field holds the record creation date.

Elements in JSON Output

Elements	Description
items	The first element is named as items and contains a number of child elements. Each child element corresponds to a row in the result set generated by the query.
hasMore	This is dependent on limit value. If the total rows are more than then limit defined then hasMore will be set to true else false.
limit	This is used to limit the rows to control the paging of result data. Based on the limit, next and previous links are displayed. For example: If the limit is set to 25, internal it tries to fetch 26 rows. If 26th row exists then 25 rows are returned along with a "next" link else no links would be added to the JSON response.
links	“self” : This contains URI pointing to current page. “next”: This contains URI pointing to the next page of results.

Example JSON output:

{
   "items": [
     {
       "action": "UPDATE",
       "diffGroupId": "BASIC CLRS",
       "diffGroupDescription": "Basic Color Pallet",
       "diffType": "C",
       "createDateTime": "2004-10-12T08:52:47.000Z",
       "updateDateTime": "2004-10-12T08:52:47.000Z",
       "details": [
         {
           "diffId": "BLACK",
           "displaySequence": null,
           "createDateTime": "2004-09-27T00:00:00.000Z"
         },
         {
           "diffId": "WHITE",
           "displaySequence": null,
           "createDateTime": "2005-01-29T00:00:00.000Z"
         }
       ],
       "cacheTimestamp": "2022-07-02T00:15:20.548Z"
     }
   ],
   "hasMore": true,
   "limit": 1,
   "count": 1,
   "links": [
     {
       "href": "http://<hostname>:<port>/MerchIntegrations/services/foundation/diffgroup?limit=1&since=1970-01-01T00:00:00.001Z&before=2022-07-18T23:39:19.734588+00:00",
       "rel": "self"
     },
     {
       "href": "http://<hostname>:<port>/MerchIntegrations/services/foundation/diffgroup?offsetkey=BASIC+CLRS&limit=1&since=1970-01-01T00:00:00.001Z&before=2022-07-18T23:39:19.734588+00:00",
       "rel": "next"
     }
   ]
 }

Table Impact

The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ICL_RMS_DIFF_GROUP	Yes	No	Yes	Yes
MERCHAPI_EXT_DIFF_GROUP	Yes	Yes	Yes	Yes
V_ MERCHAPI_EXT_DIFF_GROUP _JSON	Yes	No	No	No

Differentiator Group Upload Service

The following services are included in this functional area:

• Create Differentiator Group Details

• Create Differentiator Groups

• Delete Differentiator Group Details

• Delete Differentiator Groups

• Update Differentiator Group Details

• Update Differentiator Groups

Create Differentiator Group Details

Functional Area

Items - Item Foundation

Business Overview

This service is used to create Differentiator Group details for existing Diff Groups in Merchandising. Successful creation of a Differentiator Group detail depends on if all required fields are present in the message and field specific business validations.

Service Type

POST

ReST URL

MerchIntegrations/services/item/differentiator/group/details/create

Input Payload Details

Table 5-702 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	It's a referenced element. For detailed description, please refer referenced element doc.

Table 5-703 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffGroupId	Yes	String (10)	A unique differentiator group identifier.
details	No	Collection of Object	Description is not available.

Table 5-704 Details - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffId	Yes	String (10)	The identifier of the differentiator contained within the differentiator group. This id must be unique within the diff group. This must be populated when a diff group is being created since a diff group needs at least one diff id. Value must be predefined in the DIFF_IDS table.
displaySequence	No	Number (4)	The order in which the differentiators within the differentiator group are displayed on-line.

Sample Input Message

{
  "items": [
    {
      "diffGroupId": "Y21 Colors",
      "details": [
        {
          "diffId": "BLACK",
          "displaySequence": 1
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS",
  "message": "Service call is successful"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element "validationErrors" will be present when input payload or input parameters are not as per the schema definition of this service. The element "businessError" will be present if the payload passes schema validation but exception is caught while processing business logic.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    "Error message"
  ]
}

Create Differentiator Groups

Functional Area

Items - Item Foundation

Business Overview

This service is used to create Differentiator Groups in Merchandising. Successful creation of a Differentiator Group depends on if all required fields are present in the message and field specific business validations.

Service Type

POST

ReST URL

MerchIntegrations/services/item/differentiator/groups/create

Input Payload Details

Table 5-705 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	References a collection of differentiator groups.

Table 5-706 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffGroupId	Yes	String (10)	A unique differentiator group identifier.
diffType	Yes	String (6)	A differentiator type which is predefined on the DIFF_TYPE table. Each diff group is composed of one diff type.
diffGroupDescription	Yes	String (120)	The description of the differentiator group.
details	No	Collection of Object	References a collection of differentiators within the differentiator group.

Table 5-707 Details - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffId	Yes	String (10)	The identifier of the differentiator contained within the differentiator group. This id must be unique within the diff group. This must be populated when a diff group is being created since a diff group needs at least one diff id. Value must be predefined in the DIFF_IDS table.
displaySequence	No	Number (4)	The order in which the differentiators within the differentiator group are displayed on-line.

Sample Input Message

{
  "items": [
    {
      "diffGroupId": "Y21 Colors",
      "diffType": "C",
      "diffGroupDescription": "Year 2021 Colors",
      "details": [
        {
          "diffId": "BLACK",
          "displaySequence": 1
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS",
  "message": "Service call is successful"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element "validationErrors" will be present when input payload or input parameters are not as per the schema definition of this service. The element "businessError" will be present if the payload passes schema validation but exception is caught while processing business logic.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    "Error message"
  ]
}

Delete Differentiator Group Details

Functional Area

Items - Item Foundation

Business Overview

This service is used to delete existing differentiator group details from Merchandising. For successful deletion, validation is performed to ensure that the provided Differentiator is associated with the Differentiator Group.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/differentiator/group/details/delete

Input Payload Details

Table 5-708 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	It's a referenced element. For detailed description, please refer referenced element doc.

Table 5-709 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffGroupId	Yes	String (10)	A unique differentiator group identifier.
details	No	Collection of Object	Description is not available.

Table 5-710 Details - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffId	Yes	String (10)	The identifier of the differentiator contained within the differentiator group. This id must be unique within the diff group. Value must be predefined in the DIFF_IDS table.

Sample Input Message

{
  "items": [
    {
      "diffGroupId": "Y21 Colors",
      "details": [
        {
          "diffId": "BLACK"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS",
  "message": "Service call is successful"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element "validationErrors" will be present when input payload or input parameters are not as per the schema definition of this service. The element "businessError" will be present if the payload passes schema validation but exception is caught while processing business logic.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    "Error message"
  ]
}

Delete Differentiator Groups

Functional Area

Items - Differentiators

Business Overview

This service is used to delete existing Differentiator Groups from Merchandising. For successful deletion, this API will validate that the Differentiator Group is valid and that it is not associated with any items or diff ranges.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/differentiator/groups/delete

Input Payload Details

Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	References a collection of differentiator groups.

Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffGroupId	Yes	String (10)	A unique differentiator group identifier.

Sample Input Message

{
  "items": [
    {
      "diffGroupId": "Y21 Colors"
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS",
  "message": "Service call is successful"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors is present when the input payload or input parameters do not match the schema definition for this service. The element businessError is present when the payload passes the schema validation but an exception is caught while processing the business logic.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    "Error message"
  ]
}

Update Differentiator Group Details

Functional Area

Items - Item Foundation

Business Overview

This service is used to update existing Differentiator Group details in Merchandising. Successful update of a Differentiator Group detail depends on if all required fields are present in the message. Only field that can be updated using this API is Display Sequence.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/differentiator/group/details/update

Input Payload Details

Table 5-711 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	It's a referenced element. For detailed description, please refer referenced element doc.

Table 5-712 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffGroupId	Yes	String (10)	A unique differentiator group identifier.
items	No	Collection of Object	Description is not available.

Table 5-713 Items.Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffId	Yes	String (10)	The identifier of the differentiator contained within the differentiator group. This id must be unique within the diff group. This must be populated when a diff group is being created since a diff group needs at least one diff id. Value must be predefined in the DIFF_IDS table.
displaySequence	No	Number (4)	The order in which the differentiators within the differentiator group are displayed on-line.

Sample Input Message

{
  "items": [
    {
      "diffGroupId": "Y21 Colors",
      "items": [
        {
          "diffId": "BLACK",
          "displaySequence": 1
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS",
  "message": "Service call is successful"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element "validationErrors" will be present when input payload or input parameters are not as per the schema definition of this service. The element "businessError" will be present if the payload passes schema validation but exception is caught while processing business logic.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    "Error message"
  ]
}

Update Differentiator Groups

Functional Area

Items - Item Foundation

Business Overview

This service is used to update existing Differentiator Groups in Merchandising. When updating a differentiator group, the group ID must already be present in the Merchandising. For a successful update, all of the required header level information needs to be included in the update, similar to that for creating a new Differentiator Group. However, the diff details should not be included in a header only update. Fields that can be updated using this API include:

• Differentiator type

• Differentiator group description

Service Type

PUT

ReST URL

MerchIntegrations/services/item/differentiator/groups/update

Input Payload Details

Table 5-714 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	References a collection of differentiator groups.

Table 5-715 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffGroupId	Yes	String (10)	A unique differentiator group identifier.
diffType	Yes	String (6)	A differentiator type which is predefined on the DIFF_TYPE table. Each diff group is composed of one diff type.
diffGroupDescription	Yes	String (120)	The description of the differentiator group.

Sample Input Message

{
  "items": [
    {
      "diffGroupId": "Y21 Colors",
      "diffType": "C",
      "diffGroupDescription": "Year 2021 Colors"
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS",
  "message": "Service call is successful"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element "validationErrors" will be present when input payload or input parameters are not as per the schema definition of this service. The element "businessError" will be present if the payload passes schema validation but exception is caught while processing business logic.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    "Error message"
  ]
}

Differentiator Type Download Service

The following services are included in this functional area:

• Get Differentiator Type Details for Provided Type

• Get Differentiator Types

Get Differentiator Type Details for Provided Type

Endpoints

MerchIntegrations/services/foundation/difftype 
MerchIntegrations/services/foundation/difftype/{diffType}

Functional Area

Items - Item Foundation

Business Overview

This service can be used by external applications to get all or selected diff types and its details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/difftype? since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

/MerchIntegrations/services/foundation/difftype/{diffType}

Input Parameters for Merchintegrations/services/foundation/difftype

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value is combination of sort_order_seq and node ID.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Input Parameters for Merchintegrations/services/foundation/difftype/{diffType}

Parameter Name	Required	Data Type	Description
diffType	Yes	String	Differentiator Type

Output - Diff ID

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE and DELETE.
diffType	String	This field contains a code indicating the type of differentiator, for example C for Color.
diffTypeDescription	String	This field holds the description of the diff type (e.g., Color, Size, and so on).
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
cacheTimestamp	String	This field specifies date and time when Diff Type record was last maintained.

Elements in JSON Output

Elements	Description
items	The first element is named as items and contains a number of child elements. Each child element corresponds to a row in the result set generated by the query.
hasMore	This is dependent on limit value. If the total rows are more than then limit defined then hasMore will be set to true else false.
limit	This is used to limit the rows to control the paging of result data. Based on the limit, next and previous links are displayed. For example: If the limit is set to 25, internal it tries to fetch 26 rows. If 26th row exists then 25 rows are returned along with a "next" link else no links would be added to the JSON response.
links	“self” : This contains URI pointing to current page. “next”: This contains URI pointing to the next page of results.

Example JSON Output

{
  "items": [
    {
      "action": "INSERT",
      "diffType": "POTSZ",
      "diffTypeDescription": "Pot Size",
      "createDateTime": "2020-11-23T00:00:00.000Z",
      "updateDateTime": "2021-07-13T00:00:00.000Z",
      "cacheTimestamp": "2021-08-31T07:51:43.095Z"
    }
  ],
  "hasMore": false,
  "limit": 10000,
  "count": 1,
  "links": [
    {
      "href": "https://rex.retail.us-phoenix-1.ocs.oc-test.com/rgbu-rex-rgbu-dev1-mfcs19-1/MerchIntegrations/services/foundation/difftype?limit=10000&since=1970-01-01T00:00:00.001Z&before=2022-03-25T09:27:21.798652+00:00",
      "rel": "self"
    }
  ]
}

Table Impact

The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ICL_RMS_DIFF_TYPE	Yes	No	Yes	Yes
MERCHAPI_EXT_DIFF_TYPE	Yes	Yes	Yes	Yes
V_ MERCHAPI_EXT_DIFF_TYPE _JSON	Yes	No	No	No

Get Differentiator Types

Endpoints

MerchIntegrations/services/foundation/difftype 

MerchIntegrations/services/foundation/difftype/{diffType}

Functional Area

Items – Item Foundation

Business Overview

This service can be used by external applications to get all or selected diff types and its details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/difftype? since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

/MerchIntegrations/services/foundation/difftype/{diffType}

Input Parameters for Merchintegrations/services/foundation/difftype

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value is combination of sort_order_seq and node id.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Input Parameters for Merchintegrations/services/foundation/difftype/{diffType}

Parameter Name	Required	Data Type	Description
diffType	Yes	String	Differentiator Type
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Output – Diff ID

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE and DELETE.
diffType	string	This field contains a code indicating the type of differentiator, for example C for Color.
diffTypeDescription	string	This field holds the description of the diff type (e.g., Color, Size, and so on).
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
cacheTimestamp	String	This field specifies date and time when Diff Type record was last maintained.

Elements in JSON Output

Elements	Description
items	The first element is named as items and contains a number of child elements. Each child element corresponds to a row in the result set generated by the query.
hasMore	This is dependent on limit value. If the total rows are more than then limit defined then hasMore will be set to true else false.
limit	This is used to limit the rows to control the paging of result data. Based on the limit, next and previous links are displayed. For example: If the limit is set to 25, internal it tries to fetch 26 rows. If 26th row exists then 25 rows are returned along with a "next" link else no links would be added to the JSON response.
links	“self” : This contains URI pointing to current page. “next”: This contains URI pointing to the next page of results.

Example JSON output:

{
  "items": [
    {
      "action": "INSERT",
      "diffType": "POTSZ",
      "diffTypeDescription": "Pot Size",
      "createDateTime": "2020-11-23T00:00:00.000Z",
      "updateDateTime": "2021-07-13T00:00:00.000Z",
      "cacheTimestamp": "2021-08-31T07:51:43.095Z"
    }
  ],
  "hasMore": false,
  "limit": 10000,
  "count": 1,
  "links": [
    {
      "href": "https://rex.retail.us-phoenix-1.ocs.oc-test.com/rgbu-rex-rgbu-dev1-mfcs19-1/MerchIntegrations/services/foundation/difftype?limit=10000&since=1970-01-01T00:00:00.001Z&before=2022-03-25T09:27:21.798652+00:00",
      "rel": "self"
    }
  ]
}

Table Impact

The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ICL_RMS_DIFF_TYPE	Yes	No	Yes	Yes
MERCHAPI_EXT_DIFF_TYPE	Yes	Yes	Yes	Yes
V_ MERCHAPI_EXT_DIFF_TYPE _JSON	Yes	No	No	No

Differentiator Upload Service

The following services are included in this functional area:

• Create Differentiators

• Delete Differentiators

• Update Differentiators

Create Differentiators

Functional Area

Items - Item Foundation

Business Overview

This service is used to create Differentiators in Merchandising from an external system. For successful creation of a new differentiator, this service will first validate that all required fields are present in the payload. After that, the following business level validation on the input information are performed before creating the differentiator.

• Verifies if the diff id does not contain white space or underscores

• Verifies if diff id is not already present as a diff id or diff group id

• Verifies if the diff type is a valid value in the DIFF_TYPE table

Service Type

POST

ReST URL

MerchIntegrations/services/item/differentiators/create

Input Payload Details

Table 5-716 Create - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	References a collection of differentiators.

Table 5-717 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffId	Yes	String (10)	The unique identifier of the differentiator.
diffType	Yes	String (6)	The identifier of the differentiator type. This value must be predefined on the DIFF_TYPE table.
diffDescription	Yes	String (120)	The description of the differentiator.
industryCode	No	String (10)	The unique reference number which represents all possible combinations of sizes according to the National Retail Federation.
industrySubgroup	No	String (10)	The unique reference number to represent a sub-grouping code used by industry standards to further identify the differentiator. For example, in the US, the National Retail Federation uses a subgroup for colors (e.g., purple is defined as 500; dark purple represents a range from 501 - 509, medium purple represents a range from 510 - 519, bright purple represents a range from 520 - 529, etc.).

Sample Input Message

{
  "items": [
    {
      "diffId": "XYZ02",
      "diffType": "C",
      "diffDescription": "XYZ02 diffDesc",
      "industryCode": null,
      "industrySubgroup": null
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS",
  "message": "Service call is successful"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element "validationErrors" will be present when input payload or input parameters are not as per the schema definition of this service. The element "businessError" will be present if the payload passes schema validation but exception is caught while processing business logic.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    "Error message"
  ]
}

Delete Differentiators

Functional Area

Items - Differentiators

Business Overview

This service is used to delete existing Differentiator from Merchandising. For a successful deletion, this service first validates that all required fields are present in the message and if Diff id to be deleted exists in Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/differentiators/delete

Input Payload Details

Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	References a collection of differentiators.

Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffId	Yes	String (10)	The unique identifier for the differentiator.

Sample Input Message

{
  "items": [
    {
      "diffId": "XYZ02"
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS",
  "message": "Service call is successful"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element validationErrors is present when the input payload or input parameters do not match the schema definition for this service. The element businessError is present when the payload passes the schema validation but an exception is caught while processing the business logic.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    "Error message"
  ]
}

Update Differentiators

Functional Area

Items - Item Foundation

Business Overview

This service is used to update existing Differentiator in Merchandising. For a successful update of an existing differentiator, this sevice will first validate that all required fields are present in the payload and business level validations are met. These business level validations are similar to those performed at the time of creation. Please refer to Create Differentiators service description for more details.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/differentiators/update

Input Payload Details

Table 5-718 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	References a collection of differentiators.

Table 5-719 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffId	Yes	String (10)	The unique identifier of the differentiator.
diffDescription	Yes	String (120)	The description of the differentiator.
industryCode	No	String (10)	The unique reference number which represents all possible combinations of sizes according to the National Retail Federation.
industrySubgroup	No	String (10)	The unique reference number to represent a sub-grouping code used by industry standards to further identify the differentiator. For example, in the US, the National Retail Federation uses a subgroup for colors (e.g., purple is defined as 500; dark purple represents a range from 501 - 509, medium purple represents a range from 510 - 519, bright purple represents a range from 520 - 529, etc.).

Sample Input Message

{
  "items": [
    {
      "diffId": "XYZ02",
      "diffDescription": "XYZ02 diffDesc UPdate",
      "industryCode": null,
      "industrySubgroup": null
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS",
  "message": "Service call is successful"
}

Response Code: 400 (Error)

In case of error, the following standard error response will be returned. The element "validationErrors" will be present when input payload or input parameters are not as per the schema definition of this service. The element "businessError" will be present if the payload passes schema validation but exception is caught while processing business logic.

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    "Error message"
  ]
}

Seasons and Phases Download Service

The following services are included in this functional area:

• Get Seasons and Phases Service

Get Seasons and Phases Service

Endpoints

​/MerchIntegrations/services/item/foundation/seasons

Functional Area

Items - Item Foundation

Business Overview

This service returns all seasons and all phases within a season. This service supports pagination, and the page size of each response is controlled by the query parameter limit. This service additionally supports two optional query parameters:

1. season - Include season ID as a query parameter to restrict the response to a specific season.

2. status - This optional parameter allows filtering the response based on season start and/or end date. The comparison uses the current server date. The following values are supported:

   • OLD - Retrieves seasons having an end date less than system date

   • ACTIVE - Retrieves seasons having a system date between the start date (inclusive) and end date (inclusive)

   • FUTURE - Retrieves seasons having a start date greater than the system date

   • ACTIVE_FUTURE - Retrieves seasons having an end date greater than or equal to the system date

   • OLD_ACTIVE - Retrieves seasons having a start date less than or equal to the system date

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/seasons?offsetkey={offsetkey}&limit={limit}&season=[season]&status=[status]

Input Parameters for MerchIntegrations/services/foundation/seasons

Parameter Name	Required	Data Type	Description
offsetkey	No	String	Offset Key. Valid Value is season id
limit	No	Number	Pagination limit. Default Value is 1000.
season	No	Number	Season Id. Searches for a specific season
status	No	String	Filter seasons based on comparison of current server date with season start and/or end date. Refer to service overview for more details.

Output – Season

Name	Data Type	Description
season	Number	This field contains the unique identifier for season
description	String	This field contains the description associated with the season
startDate	Date	This field contains the starting date for the season. Format yyyy-MM-dd
endDate	Date	This field contains the ending date for the season. Format yyyy-MM-dd
phases	Collection	List of Phases associated with the season

Output – Phases

Name	Data Type	Description
phase	Number	This field contains the identifier for phase that is associated with a season. The combination of season ID and phase ID makes a phase unique.
description	String	This field holds the description of the phase
startDate	Date	This field contains the starting date for the phase. Format yyyy-MM-dd
endDate	Date	This field contains the ending date for the phase. Format yyyy-MM-dd

Elements in JSON Output

Elements	Description
items	The first element is named items and contains a number of child elements. Each child element corresponds to a row in the result set generated by the query.
hasMore	This is dependent on the limit value. If the total rows are more than then limit defined, then hasMore is set to true, otherwise it is false.
limit	This is used to limit the rows to control the paging of result data. Based on the limit, next and previous links are displayed. For example: If limit is set to 25, internally it tries to fetch 26 rows. If 26th row exists, then 25 rows are returned along with a next link; otherwise, no links are added to the JSON response.
links	self: This contains a URI pointing to the current page. next: This contains a URI pointing to the next page of results.

Example JSON Output

{
  "items": [
    {
      "season": 10,
      "description": "Spring 2023 Collections",
      "startDate": "2023-03-20",
      "endDate": "2023-06-21",
      "phases": [
        {
          "phase": 2,
          "description": "Spring Break/Easter 2023",
          "startDate": "2023-04-03",
          "endDate": "2023-04-16"
        }
      ]
    }
  ],
  "hasMore": true,
  "limit": 1,
  "count": 1,
  "links": [
    {
      "href": "https Server:port/MerchIntegrations/services/item/foundation/seasons?limit=1",
      "rel": "self"
    },
    {
      "href": "https Server:port/MerchIntegrations/services/item/foundation/seasons?offsetkey=10&limit=1",
      "rel": "next"
    }
  ]
}

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
SEASONS	Yes	No	No	No
PHASES	Yes	No	No	No

User Defined Attribute (UDA) Download Service

The following services are included in this functional area:

• REST Endpoint for UDA details

• REST Endpoint to Fetch UDA by UDA ID

REST Endpoint for UDA details

Endpoints

MerchIntegrations/services/foundation/uda

MerchIntegrations/services/foundation/uda/{udaId}

Functional Area

Items – Item Foundation

Business Overview

This service can be used by external applications to get all or selected user defined attributes and its details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/uda?offsetkey={offsetkey}&limit={limit}&since={since}&before={before}

/MerchIntegrations/services/foundation/uda/{udaId}

Input Parameters

Table 5-720 /MerchIntegrations/services/foundation/uda

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value is a Uda Id.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Table 5-721 /MerchIntegrations/services/foundation/uda/{udaId}

Parameter Name	Required	Data Type	Description
udaId	Yes	Number	Number identifying the User Defined Attribute.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Output

Name	Data Type					Description
action			String		Action for UDA details. Valid Values are INSERT, UPDATE and DELETE.
udaId			Number		Number identifying the User Defined Attribute.
udaDescription			String		Description of the User Defined Attribute.
displayType			String		This field contains the display type (how the UDA values will be displayed to the user) for the given UDA. The valid values are DT-Date, FF - Free From, LV - List of values.
dataType		String		This field contains the data type of any valid values for the UDA. Valid values are Number, Alphanumeric and Date.
dataLength			Number		This field contains the data length of any valid values for the UDA.
singleValueInd			String		This field indicates whether or not the UDA should be constrained to having at most one value. Valid values are Y and N.
createDateTime			String		This field holds the record creation date.
updateDateTime			String		This field holds the date when the record was last updated.
udaListOfValues					This list holds the UDA list of values.
cacheTimestamp			String		This field specifies date and time when the UDA record was last maintained.

Table 5-722 udaListOfValues

Name	Data Type			Description
action		String	Action for UDA Value details. Valid Values are INSERT, UPDATE and DELETE.
udaValue		Number	This field contains a unique number identifying the User Defined Attribute value for the UDA. A UDA can have multiple values.
udaValueDescription		String	Description of the User Defined Attribute Values.
createDateTime		String	This field holds the record creation date.
updateDateTime		String	This field holds the date when the record was last updated.

Table 5-723 Elements in JSON Output

Elements	Description
items	The first element is named as items and contains a number of child elements. Each child element corresponds to a row in the result set generated by the query.
hasMore	This is dependent on limit value. If the total rows are more than the limit defined, then hasMore will be set to true else false.
limit	This is used to limit the rows to control the paging of result data. Based on the limit, next and previous links are displayed. For example: If the limit is set to 25, internal it tries to fetch 26 rows. If 26th row exists, then 25 rows are returned along with a "next" link else no links would be added to the JSON response.
links	“self”: This contains URI pointing to current page. “next”: This contains URI pointing to the next page of results.

Example JSON Onput

{
  "items": [
    {
      "action": null,
      "udaId": 23,
      "udaDescription": "NEW_UDA_MATERIAL",
      "displayType": "LV",
      "dataType": "ALPHA",
      "dataLength": 250,
      "singleValueInd": "N",
      "createDateTime": "2021-10-04T08:40:53.000Z",
      "updateDateTime": "2021-10-04T08:40:53.000Z",
      "udaListOfValues": [
        {
          "udaValue": 3,
          "udaValueDescription": "AUTO_ADMIN_Nylon",
          "createDateTime": "2021-10-04T08:40:53.000Z",
          "updateDateTime": "2021-10-04T08:40:53.000Z"
        },
        {
          "udaValue": 2,
          "udaValueDescription": "AUTO_ADMIN_Silk_Cotton",
          "createDateTime": "2021-10-04T08:40:53.000Z",
          "updateDateTime": "2021-10-04T08:40:53.000Z"
        },
        {
          "udaValue": 1,
          "udaValueDescription": "AUTO_ADMIN_100_Synthetic",
          "createDateTime": "2021-10-04T08:40:53.000Z",
          "updateDateTime": "2021-10-04T08:40:53.000Z"
        }
      ],
      "cacheTimestamp": "2021-10-04T08:50:56.868Z"
    }
  ],
  "hasMore": false,
  "limit": 1,
  "count": 1,
  "links": null
}"

Table Impact

The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
MERCHAPI_EXT_UDA	Yes	Yes	Yes	Yes
V_MERCHAPI_EXT_UDA_JSON	Yes	No	No	No
ICL_RMS_UDA	Yes	No	Yes	Yes

REST Endpoint to Fetch UDA by UDA ID

Endpoints

MerchIntegrations/services/foundation/uda
MerchIntegrations/services/foundation/uda/{udaId}

Functional Area

Items – Item Foundation

Business Overview

This service can be used by external applications to get all or selected user defined attributes and its details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/uda?offsetkey={offsetkey}&limit={limit}&since={since}&before={before}

/MerchIntegrations/services/foundation/uda/{udaId}

Input Parameters

Table 5-724 /MerchIntegrations/services/foundation/uda

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value is a Uda Id.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Table 5-725 /MerchIntegrations/services/foundation/uda/{udaId}

Parameter Name	Required	Data Type	Description
udaId	Yes	Number	Number identifying the User Defined Attribute.

Output

Name	Data Type	Description
action	String	Action for UDA details. Valid Values are INSERT, UPDATE and DELETE.
udaId	Number	Number identifying the User Defined Attribute.
udaDescription	String	Description of the User Defined Attribute.
displayType	String	This field contains the display type (how the UDA values will be displayed to the user) for the given UDA. The valid values are DT-Date, FF - Free From, LV - List of values.
dataType	String	This field contains the data type of any valid values for the UDA. Valid values are Number, Alphanumeric and Date.
dataLength	Number	This field contains the data length of any valid values for the UDA.
singleValueInd	String	This field indicates whether or not the UDA should be constrained to having at most one value. Valid values are Y and N.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
udaListOfValues		This list holds the UDA list of values.
cacheTimestamp	String	This field specifies date and time when the UDA record was last maintained.

Table 5-726 udaListOfValues

Name	Data Type	Description
action	String	Action for UDA Value details. Valid Values are INSERT, UPDATE and DELETE.
udaValue	Number	This field contains a unique number identifying the User Defined Attribute value for the UDA. A UDA can have multiple values.
udaValueDescription	String	Description of the User Defined Attribute Values.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.

Table 5-727 Elements in JSON Output

Elements	Description
items	The first element is named as items and contains a number of child elements. Each child element corresponds to a row in the result set generated by the query.
hasMore	This is dependent on limit value. If the total rows are more than the limit defined, then hasMore will be set to true else false.
limit	This is used to limit the rows to control the paging of result data. Based on the limit, next and previous links are displayed. For example: If the limit is set to 25, internal it tries to fetch 26 rows. If 26th row exists, then 25 rows are returned along with a "next" link else no links would be added to the JSON response.
links	“self”: This contains URI pointing to current page. “next”: This contains URI pointing to the next page of results.

Example JSON input:

{
  "items": [
    {
      "action": null,
      "udaId": 23,
      "udaDescription": "NEW_UDA_MATERIAL",
      "displayType": "LV",
      "dataType": "ALPHA",
      "dataLength": 250,
      "singleValueInd": "N",
      "createDateTime": "2021-10-04T08:40:53.000Z",
      "updateDateTime": "2021-10-04T08:40:53.000Z",
      "udaListOfValues": [
        {
          "udaValue": 3,
          "udaValueDescription": "AUTO_ADMIN_Nylon",
          "createDateTime": "2021-10-04T08:40:53.000Z",
          "updateDateTime": "2021-10-04T08:40:53.000Z"
        },
        {
          "udaValue": 2,
          "udaValueDescription": "AUTO_ADMIN_Silk_Cotton",
          "createDateTime": "2021-10-04T08:40:53.000Z",
          "updateDateTime": "2021-10-04T08:40:53.000Z"
        },
        {
          "udaValue": 1,
          "udaValueDescription": "AUTO_ADMIN_100_Synthetic",
          "createDateTime": "2021-10-04T08:40:53.000Z",
          "updateDateTime": "2021-10-04T08:40:53.000Z"
        }
      ],
      "cacheTimestamp": "2021-10-04T08:50:56.868Z"
    }
  ],
  "hasMore": false,
  "limit": 1,
  "count": 1,
  "links": null
}

Table Impact

The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
MERCHAPI_EXT_UDA	Yes	Yes	Yes	Yes
V_MERCHAPI_EXT_UDA_JSON	Yes	No	No	No
ICL_RMS_UDA	Yes	No	Yes	Yes