Items

The following services are included in this functional area:

• Item Definition

  • Item AI Services

    • Item Attribute Extraction Services

      • Get Item Attributes Base
      • Get Item Attributes Customized
      • Update Item Attributes Customized

  • 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 UDA Free Form Translations

    • Create Item UDAs

    • Create Item Up Charges

    • Create Items

    • Create Required Documents

    • Delete Item Description Translations

    • Delete Item Image Translations

    • Delete Item Images

    • Delete Item Seasons

    • Delete Item Tickets

    • Delete Item UDA Free Form Translations

    • Delete Item UDAs

    • Delete Item Up Charges

    • Delete Items

    • Delete Required Documents

    • Update Item Description Translations

    • Update Item Image Translations

    • Update Item Images

    • Update Item Tickets

    • Update Item UDA Free Form Translations

    • Update Item UDAs

    • Update Item Up Charge Details

    • Update Items

  • Related Items Upload Service

    • Create Related Items
    • Create Related Item Translations
    • Delete Related Items
    • Delete Related Item Translations
    • Update Related Items
    • Update Related Item Translations

• 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 AI Services

The following services are included in this functional area:

• Item Attribute Extraction Services

Item Attribute Extraction Services

The following services are included in this functional area:

• Get Item Attributes Base
• Get Item Attributes Customized
• Update Item Attributes Customized

Get Item Attributes Base

Endpoints

/RmsReSTServices/services/private/ai/item/attributes/base

Functional Area

Items Attributes Extraction

Business Overview

Fetches the default (out-of-the-box) set of item attributes that ODA can extract. Use this to see all pre-configured attributes.

Service Type

GET

ReST URL

/RmsReSTServices/services/private/ai/item/attributes/base

Output

Name	Data Type	Description
<CategoryName>	Array of String	Each key in the JSON response is a product category name (e.g., APPAREL, ELECTRONICS). The value is an array of extractable attribute names (Strings) for that category.
attribute	String	Each element within the array is the name of an attribute extractable for the given category (e.g., color, brand, price)

Elements in JSON Output

Elements	Description
CATEGORY_NAME	Product category name (e.g., "APPAREL", "ELECTRONICS")
Attribute	Extractable attribute for the category (e.g., "color", "price")

JSON Schema Overview

{
"CATEGORY_NAME": [
"attribute1",
"attribute2",
"attribute3"
// ...more attributes
],
// ...more categories
}

Example JSON output

{
"APPAREL": [
"productType",
"material",
"color",
"size",
"fit",
"pattern",
"sleeveLength",
"neckStyle",
"gender",
"occasion",
"price"
],
"BAGS": [
"productType",
"material",
"color",
"capacity",
"closureType",
"style",
"price"
],
"COSMETICS": [
"productType",
"brand",
"shade",
"form",
"skinType",
"scent",
"size",
"price"
],
"ELECTRONICS": [
"productType",
"brand",
"model",
"color",
"memory",
"features",
"price"
],
"FOOTWEAR": [
"productType",
"material",
"color",
"size",
"closureType",
"soleMaterial",
"heelType",
"usage",
"price"
],
"FRESH PRODUCE": [
"productType",
"brand",
"weight",
"units",
"packaging",
"expiryDate",
"price"
],
"FURNITURE": [
"productType",
"material",
"color",
"dimensions",
"style",
"roomType",
"price"
],
"GROCERY": [
"productType",
"brand",
"flavor",
"weight",
"packaging",
"expiryDate",
"price"
],
"JEWELRY": [
"productType",
"material",
"stoneType",
"cutShape",
"color",
"sizeDimensions",
"price"
],
"PET SUPPLIES": [
"productType",
"brand",
"packaging",
"weight",
"flavor",
"petCategory",
"expiryDate",
"price"
],
"PHARMA": [
"productType",
"brand",
"flavor",
"packaging",
"expiryDate",
"price"
]
}

Get Item Attributes Customized

Endpoints

/RmsReSTServices/services/private/ai/item/attributes

Functional Area

Items Attributes Extraction

Business Overview

Retrieves only those item attributes that have been customized for extraction. If no customizations have been made, the response will be empty. Use this endpoint to check which product categories and attributes have customized extraction setups in your system.

Service Type

GET

ReST URL

/RmsReSTServices/services/private/ai/item/attributes

Output

Name	Data Type	Description
<CategoryName>	Array of String	Each key in the JSON response is a product category name (e.g., APPAREL, ELECTRONICS). The value is an array of extractable attribute names (Strings) for that category.
attribute	String	Each element within the array is the name of an attribute extractable for the given category (e.g., color, brand, price)

Elements in JSON Output

Elements	Description
CATEGORY_NAME	Product category name (e.g., "APPAREL", "ELECTRONICS")
Attribute	Extractable attribute for the category (e.g., "color", "price")

JSON Schema Overview

{
"CATEGORY_NAME": [
"attribute1",
"attribute2",
"attribute3"
// ...more attributes
],
// ...more categories
}

Example JSON output

{
"APPAREL": [
"productType",
"material",
"color",
"size",
"fit",
"pattern",
"sleeveLength",
"neckStyle",
"gender",
"occasion",
"price"
],
"BAGS": [
"productType",
"material",
"color",
"capacity",
"closureType",
"style",
"price"
],
"COSMETICS": [
"productType",
"brand",
"shade",
"form",
"skinType",
"scent",
"size",
"price"
],
"ELECTRONICS": [
"productType",
"brand",
"model",
"color",
"memory",
"features",
"price"
],
"FOOTWEAR": [
"productType",
"material",
"color",
"size",
"closureType",
"soleMaterial",
"heelType",
"usage",
"price"
],
"FRESH PRODUCE": [
"productType",
"brand",
"weight",
"units",
"packaging",
"expiryDate",
"price"
],
"FURNITURE": [
"productType",
"material",
"color",
"dimensions",
"style",
"roomType",
"price"
],
"GROCERY": [
"productType",
"brand",
"flavor",
"weight",
"packaging",
"expiryDate",
"price"
],
"JEWELRY": [
"productType",
"material",
"stoneType",
"cutShape",
"color",
"sizeDimensions",
"price"
],
"PET SUPPLIES": [
"productType",
"brand",
"packaging",
"weight",
"flavor",
"petCategory",
"expiryDate",
"price"
],
"PHARMA": [
"productType",
"brand",
"flavor",
"packaging",
"expiryDate",
"price"
]
}

Update Item Attributes Customized

Endpoints

/RmsReSTServices/services/private/ai/item/attributes

Functional Area

Items Attributes Extraction

Business Overview

Allows you to add or remove attributes to be extracted through the Oracle Digital Assistant (ODA).

Service Type

POST

ReST URL

/RmsReSTServices/services/private/ai/item/attributes

Input

Name	Data Type	Description
<CategoryName>	Array of String	Each key in the JSON response is a product category name (e.g., APPAREL, ELECTRONICS). The value is an array of extractable attribute names (Strings) for that category.
attribute	String	Each element within the array is the name of an attribute extractable for the given category (e.g., color, brand, price)

Output

Name	Data Type	Description
status	String	Indicates the result of the data override action. The value will confirm successful completion if updates were processed without error.

Elements in JSON Input

Elements	Description
CATEGORY_NAME	Product category name (e.g., "APPAREL", "ELECTRONICS")
Attribute	Extractable attribute for the category (e.g., "color", "price")

Input JSON Schema Overview

{
"CATEGORY_NAME": [
"attribute1",
"attribute2",
"attribute3"
// ...more attributes
],
// ...more categories
}

Example JSON input

{
"APPAREL": [
"productType",
"material",
"color",
"size",
"fit",
"pattern",
"sleeveLength",
"neckStyle",
"gender",
"occasion",
"price"
],
"BAGS": [
"productType",
"material",
"color",
"capacity",
"closureType",
"style",
"price"
],
"COSMETICS": [
"productType",
"brand",
"shade",
"form",
"skinType",
"scent",
"size",
"price"
],
"ELECTRONICS": [
"productType",
"brand",
"model",
"color",
"memory",
"features",
"price"
],
"FOOTWEAR": [
"productType",
"material",
"color",
"size",
"closureType",
"soleMaterial",
"heelType",
"usage",
"price"
],
"FRESH PRODUCE": [
"productType",
"brand",
"weight",
"units",
"packaging",
"expiryDate",
"price"
],
"FURNITURE": [
"productType",
"material",
"color",
"dimensions",
"style",
"roomType",
"price"
],
"GROCERY": [
"productType",
"brand",
"flavor",
"weight",
"packaging",
"expiryDate",
"price"
],
"JEWELRY": [
"productType",
"material",
"stoneType",
"cutShape",
"color",
"sizeDimensions",
"price"
],
"PET SUPPLIES": [
"productType",
"brand",
"packaging",
"weight",
"flavor",
"petCategory",
"expiryDate",
"price"
],
"PHARMA": [
"productType",
"brand",
"flavor",
"packaging",
"expiryDate",
"price"
]
}

Elements in JSON Output

Elements	Description
status	Indicates the result of the customization operation. Returns a message confirming success or providing details in case of failure.

Output JSON Schema Overview

{
"status": "string"
}

Example JSON Output

{
"status": "Data overrides done successfully"
}

Item Definition

The following services are included in this functional area:

• Item Download Service

  • Get Item Attributes Base
  • Get Item Attributes Customized

  • 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 UDA Free Form Translations

  • Create Item UDAs

  • Create Item Up Charges

  • Create Items

  • Create Required Documents

  • Delete Item Description Translations

  • Delete Item Image Translations

  • Delete Item Images

  • Delete Item Seasons

  • Delete Item Tickets

  • Delete Item UDA Free Form Translations

  • Delete Item UDAs

  • Delete Item Up Charges

  • Delete Items

  • Delete Required Documents

  • Update Item Description Translations

  • Update Item Image Translations

  • Update Item Images

  • Update Item Tickets

  • Update Item UDA Free Form Translations

  • Update Item UDAs

  • Update Item Up Charge Details

  • Update Items

• Related Items Upload Service

  • Create Related Items
  • Create Related Item Translations
  • Delete Related Items
  • Delete Related Item Translations
  • Update Related Items
  • Update Related Item Translations

Item Download Service

The following services are included in this functional area:

• Get Item Attributes Base
• Get Item Attributes Customized

• 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 - Item Definition

Business Overview

This service publishes item master data for transaction-level items and higher merchandise hierarchy nodes to downstream consuming systems. The payload combines core item attributes with translations, supplier and sourcing details, UDA values, images, tickets, related items, compliance and import data, and custom flex attributes. End-to-end publication is limited to items that qualify through the refresh and delta flow: refresh seeds items in approved or deleted status, item-master inserts are not queued until the item is approved, and item-master updates in worksheet or submitted status are suppressed. Below-transaction-level reference or UPC items are not published as standalone records; their changes refresh the parent item's referenceItem node.

Technical Details

This service follows the Publish API cache architecture in which the REST service serves pre-generated JSON from an integration cache table that is initially seeded and then maintained through asynchronous delta processing. For overall enablement, scheduling, and guidance on how publish api works and how webhook for this api can be implemented to stream the data out, refer to the white paper Publish APIs - Customer Enablement Overview.

Core business tables: ITEM_MASTER, ITEM_MASTER_TL, ITEM_SUPPLIER, ITEM_SUPP_UOM, ITEM_SUPP_COUNTRY, ITEM_SUPP_COUNTRY_DIM, ITEM_SUPP_MANU_COUNTRY, ITEM_TICKET, UDA_ITEM_DATE, UDA_ITEM_LOV, UDA_ITEM_FF, ITEM_IMAGE, ITEM_SEASONS, ITEM_HTS, ITEM_EXP_HEAD, ITEM_EXP_DETAIL, RELATED_ITEM_HEAD, RELATED_ITEM_DETAIL, REQ_DOC, ITEM_IMPORT_ATTR

Additional business tables: ITEM_MASTER_CFA_EXT, ITEM_SUPPLIER_CFA_EXT, ITEM_SUPP_COUNTRY_CFA_EXT, DEPS, GROUPS, DIVISION, CLASS, SUBCLASS, BRAND, DIFF_IDS, DIFF_GROUP_HEAD, SYSTEM_OPTIONS, SYSTEM_CONFIG_OPTIONS, CODE_DETAIL

JSON cache table: MERCHAPI_EXT_ITEM

JSON generation view: V_MERCHAPI_EXT_ITEM_JSON

Is keyed by ITEM_MASTER rows with ITEM_LEVEL <= TRAN_LEVEL, so the published entity is the transaction-level item or a higher hierarchy node.

The payload combines core item attributes with translations, supplier and sourcing data, UDAs, images, tickets, related items, HTS and expense data, import attributes, custom flex attributes, and supporting hierarchy and lookup values.

Below-transaction-level reference or UPC items are not published as standalone payloads; their data is rolled into the parent item's referenceItem node.

Initial Seeding and post enablement rebuild/repair

Initial seeding selects ITEM_MASTER rows where STATUS IN ('A', 'D') and ITEM_LEVEL <= TRAN_LEVEL, then builds the published JSON through V_MERCHAPI_EXT_ITEM_JSON.

Rebuild marks cache rows deleted when the item no longer exists in ITEM_MASTER.

ICL (Integration Change Log) table: ICL_RMS_ITEM_MASTER, ICL_RMS_ITEM_SUPPLIER, ICL_RMS_ITEM_SUPP_UOM, ICL_RMS_ITEM_SUPP_CTRY, ICL_RMS_ITEM_SUPP_CTRY_DIM, ICL_RMS_ITEM_SUPP_MANU_CTRY, ICL_RMS_ITEM_TICKET, ICL_RMS_UDA_ITEM_DATE, ICL_RMS_UDA_ITEM_LOV, ICL_RMS_UDA_ITEM_FF, ICL_RMS_ITEM_IMAGE, ICL_RMS_ITEM_SEASONS, ICL_RMS_ITEM_HTS, ICL_RMS_ITEM_EXP, ICL_RMS_RELATED_ITEM, ICL_RMS_REQ_DOC, ICL_RMS_ITEM_IMPORT_ATTR (ICL consumer name = MERCHAPI)

Item-master inserts are staged only when the new item is approved, approval transitions are staged as insert-style publishes, and item-master updates in worksheet or submitted status are suppressed.

ITEM_MASTER_TL changes are queued only for items with ITEM_LEVEL <= TRAN_LEVEL, and below-transaction-level item changes are rolled up to ITEM_PARENT so the parent payload is refreshed.

Item Approval Handling

Approval of an item also results in publish of foundation/omnichannel/item/image, foundation/omnichannel/item/relateditem, foundation/item/location, foundation/item/vat, and foundation/taxLocationItem. The item approval flow writes the existing ITEM_IMAGE, RELATED_ITEM_HEAD/DETAIL, ITEM_LOC, and VAT_ITEM source rows for that item into those APIs' ICL tables so dependent approved-item data is queued together with the item.

Batch Configuration. Asynchronous delta processing is supported using Background engine and also via POM scheduling. Choose one.

Process configuration name: API_EXT_ITEM

To enable via Background engine set BACKGROUND_RUN_FLAG to Y and review the BACKGROUND_RUN_INTERVAL_SECOND parameter.

POM Batch schedule process and job: MERCHAPI_DELTA_EXT_ITEM_ADHOC_PROCESS -> MERCHAPI_EXT_ITEM_ADHOC_JOB

Webhook configuration api name: foundation/item

Special handling

Additional GET query parameters: itemLevel, tranLevel, deptId, classId, subclassId, status, itemType, inventoryInd, supplier, referenceItem.

The filters itemLevel, tranLevel, deptId, classId, subclassId, status, and itemType are not backed by dedicated cache-table indexes. At high volume, use them only as additional criteria on top of a small-window delta fetch and not for full downloads.

Performance Considerations

For customers expecting high to very high publish volume from this API, sizing and operational tuning should be addressed early in the implementation lifecycle. Initial cache seeding, ongoing delta processing, full extracts, and incremental downloads or webhook-driven delivery have different runtime characteristics and should be evaluated separately. The available configuration for this service should therefore be reviewed and validated against the customer production data profile, including expected volume, message size, and access pattern, with the key performance-related configuration for this service covering the following:

Multi-threading and commit control

This service supports multi-threaded execution for initial seeding, while delta processing remains a single threaded process. Initial-seeding thread count is controlled through API_REFRESH_OVERRIDE_NO_OF_THREADS, and initial-seeding commit sizing is controlled through API_REFRESH_OVERRIDE_COMMIT_MAX_COUNTER.

For initial seeding, thread and commit settings should be chosen together based on expected row volume, average message size, and the complex SQL query required to build the item message from ITEM_MASTER together with supplier, UDA, image, ticket, related-item, HTS, expense, import, and hierarchy data. Common starting points for large-volume seeding are 8, 16, or 32 threads. Values of 48 or 64 threads should be considered only after testing and with awareness of competing workload in the environment. The delivered refresh override is currently 4 threads.

Refresh commit sizing should be reviewed together with the thread setting. The delivered refresh override commit setting is currently 10000 and that should be used if the thread value is low. If running with higher thread value, the typical value can range from about 100 to 1,000 rows.

Dropping indexes and constraints during seeding

This option applies only to initial seeding, including truncate-and-load execution. Even with refresh-override threading, larger parallel insert volumes can increase index maintenance overhead and slow the load.

To reduce that overhead, DROP_INDEX_ON_REFRESH can be enabled so indexes and constraints are dropped before seeding and rebuilt after the load completes.

This can improve data-load throughput, but the overall refresh plan should also account for the additional time needed for index rebuild after the seeding step finishes. GATHER_STATS_ON_REFRESH should normally remain enabled unless testing shows a need to change it.

REST fetch considerations

Item payloads can be comparatively large, so REST page size should be selected based on average message size so that the average response remains below about 10 MB per call. Common page-limit values for this service should be 500 or 1,000, and very small limits, especially below 100, should generally be avoided.

For full downloads, do not provide the since query parameter so the database can favor the primary-key access path. For delta downloads, use a small time window, typically a few minutes and at most a few hours, so the eligible row set on the LAST_UPDATE_DATETIME index remains small.

Wider delta windows, especially multi-day windows that can arise during outages or data recovery, generally do not perform well. For such scenarios, keeping BUILD_HISTOGRAM enabled allows the service to support recovery through smaller, more selective polling windows using the optimalBefore query parameter.

In this catch-up pattern, for requests up to 30 days in the past, the client provides optimalBefore and leaves before empty. The client then uses the returned before timestamp to continue polling incrementally until the backlog is cleared, and then resumes the normal short-window delta pattern. Hourly histogram processing groups LAST_UPDATE_DATETIME values into buckets of 10,000 rows in MERCHAPI_TIMESTAMP_HISTOGRAM using the shared HISTOGRAM_ROW_COUNT configuration.

Service Type

GET

ReST URL

MerchIntegrations/services/foundation/item

MerchIntegrations/services/foundation/item/{itemId}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date (Example: 2010-12-31T23:59:59.999Z)
before	No	String	Before Date (Example: 2040-12-31T23:59:59.999Z)
itemLevel	No	String	Item Level - 1, 2, or 3
tranLevel	No	String	Transaction Level- 1, 2, or 3
deptId	No	String (4)	Department Id
classId	No	String (4)	Class Id
subclassId	No	String (4)	Sub Class Id
status	No	String	Status
itemType	No	String	Item Type
inventoryInd	No	String	Inventoried
supplier	No	String	Supplier
referenceItem	No	String	Reference Item
offsetkey	No	String	Offset key (Item)
limit	No	String (6)	Pagination limit. Default value is 1000.
optimalBefore	No	String	Enables histogram-based calculation of the before timestamp when before is not provided. Valid values are Y or N. Default value is N.
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-448 Input Parameter for "MerchIntegrations/services/foundation/item/{itemId}"

Parameter Name	Required	Data Type	Description
itemId	Yes	String	Item 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

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

Element Name	Required	Data Type	Description
items	No	Collection of Object	Collection of records
hasMore	No	Boolean	Boolean to signify if there are additional pages of data. This is true if limit = count for pagination supported request
limit	No	Number	Requested page size. If the page size was not defined in the input request, a default page size is used to limit the number of records to fetch
count	No	Number	Number of record in the response object
links	No	Collection of Object	List of Self and/or Next URL

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

Element Name	Required	Data Type	Description
action	No	String (6)	Action for Item details
longtDescription	No	String
item	No	String (25)	This field specifies Unique alphanumeric value that identifies the item.
itemNumberType	No	String (6)	This field holds the type of item number. Valid values are defined by code type UPCT.
status	No	String (1)	This field specifies status of the item.
itemLevel	No	Number(1,0)	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	No	Number(1,0)	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	No	String (250)	This field specifies long description of the item. This description is used through out the system to help online users identify the item. For items that have parents, this description will default to the parents description plus any differentiators. For items without parents this description will default to null.
shortDescription	No	String (120)	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	No	String (250)	This field specifies all upper case description of the item (same as upper(item_desc)). This field is not displayed in the on-line item maintenance dialog, but is used in item list of value search processing through out the system.
itemDescriptionSecondary	No	String (250)	This field specifies secondary descriptions of the item. This field can only be populated when system_options.secondary_desc_ind = Y.
longDescription	No	String (2000)	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	No	String (25)	This field specifies alphanumeric value that uniquely identifies the item/group at the level above the item.
itemGrandparent	No	String (25)	This field specifies alphanumeric value that uniquely identifies the item/group at the level above the item.
sellableInd	No	String (1)	This field indicates if pack item may be sold as a unit. If it is 'Y' then the pack will have its own unique unit retail. If it is 'N' then the pack's unit retail is the sum of each individual item's total retail within the pack. This field will only be available if the item is a pack item. Value values are: Y = Yes, this pack may be sold as a unit; N = No, this pack man not be sold as a unit.
orderableInd	No	String (1)	This field indicates if pack item is orderable. If it is 'Y' then the suppliers of the pack must supply all components in the pack. If it is 'N' then the components may have different suppliers. This field will only be available if the item is a pack item. Valid values are: Y = Yes, this pack may be ordered, N = No, this pack may not be ordered.
inventoryInd	No	String (1)	This field specifies inventory Indicator.
packInd	No	String (1)	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 qtys, etc.) that other items do not. This field is required by the database.
simplePackInd	No	String (1)	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:Y = Yes, this item is a simple pack; N = No if this is not a simple pack.
containsInnerInd	No	String (1)	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	No	Number(4,0)	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). Valid values for this field are located on the deps table.
deptName	No	String (120)	This field contains the name of the department.
class	No	Number
className	No	String (120)	This field contains the name of the class.
uniqueClassId	No	Number(10,0)	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 can not have a composite key in the merchandise hierarchy.
subclass	No	Number(4,0)	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	No	String (120)	This field contains the name of the subclass.
uniqueSubclassId	No	Number(10,0)	This field uniquely identify the subclass which the item belongs to.Sublass is not unique ID the merchandise hierarchy.The combination of Dept/Class/Subclass 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 can not have a composite key in the merchandise hierarchy.
unitRetail	No	Number(20,4)	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	No	String (1)	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	No	Number(2,0)	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 clients responsibility to download this value to their POS system.
diff1	No	String (10)	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	No	String (6)	This field will hold a value of all possible differential types. (for example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). Valid values are stored on the code_detail table with the code_type 'DIFF' and on the diff_type table.
diff2	No	String (10)	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.
diff2Type	No	String (6)	This field will hold a value of all possible differential types. (for example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). Valid values are stored on the code_detail table with the code_type 'DIFF' and on the diff_type table.
diff3	No	String (10)	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.
diff3Type	No	String (6)	This field will hold a value of all possible differential types. (for example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). Valid values are stored on the code_detail table with the code_type 'DIFF' and on the diff_type table.
diff4	No	String (10)	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.
diff4Type	No	String (6)	This field will hold a value of all possible differential types. (for example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). Valid values are stored on the code_detail table with the code_type 'DIFF' and on the diff_type table.
costZoneGroupId	No	Number(4,0)	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	No	String (4)	This field contains unit of measure in which stock of the item is tracked at a corporate level.
uomConversionFactor	No	Number(20,10)	This field contains 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)	This field 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 Retek Price Mangement to determine same sized and different sized items.
packageUom	No	String (4)	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	No	String (1)	This field indicates if the item is a merchandise item (Y, N).
storeOrderMultiple	No	String (1)	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	No	String (1)	This field indicates if this item will be interfaced to an external forecasting system (Y, N).
manufacturerRecommendedRetail	No	Number(20,4)	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	No	String (3)	The field indicates the currency code of the Manufacturer's retail price.
originalRetail	No	Number(20,4)	The field indicated the original retail price of the item per unit. This field is stored in the primary currency.
originalRetailCurrencyCode	No	String (3)	The field indicates the currency code of the original retail price.
retailLabelType	No	String (6)	This field indicates any special label type associated with an item.
retailLabelTypeDescription	No	String (250)	This field holds the description of the retail label type.
retailLabelValue	No	Number(20,4)	This field represents the value associated with the retail label type.
handlingTemperature	No	String (6)	This field holds the temperature information associated with the item.
handlingTemperatureDescription	No	String (250)	This field holds the description of the handling temperature.
handlingSensitivity	No	String (6)	This field holds the sensitivity information associated with the item.
handlingSensitivityDescription	No	String (250)	This field holds the description of the handling sensitivity.
catchWeightInd	No	String (1)	This field indicates whether the item should be weighed when it arrives at a location.
catchWeightType	No	String (1)	The field will hold catch weight type for a simple pack catch weight item. The value is based on the component items order_type and sale_type: 2 - order_type = Variable Weight, sale_type = Loose Weight 4 - order_type = Variable Weight, sale_type = Variable Weight Each.
catchWeightUom	No	String (4)	The field indicates the UOM for Catchweight Items.
orderType	No	String (6)	The field determines how catch weight items are ordered. Valid values are: F - fixed weight V - Variable weight Valid values are held on the CODE_DETAIL table with a code type = ORDT.
saleType	No	String (6)	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. Valid values are held on the CODE_DETAIL table with a code type = STPE.
wasteType	No	String (6)	The field indicates identifies the wastage type as either sales or spoilage wastage. Sales wastage occurs during processes that make an item saleable (i.e. fat is trimmed off at customer request). Spoilage wastage occurs during the products shelf life (i.e. evaporation causes the product to weigh less after a period of time). Valid values are: SP - spoilage; and SL - Sales.
wasteTypeDescription	No	String (250)	The field contains the Waste Type description corresponding to the Waste_Type value in item_master.
averageWastePercentage	No	Number(12,4)	The field indicates average percent of wastage for the item over its shelf life. Used in inflating the retail price for wastage items.
defaultWastePercentage	No	Number(12,4)	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	No	String (1)	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	No	String (1)	The field Indicates if pack item is a vendor pack or a buyer pack. A vendor pack is a pack that the vendor or supplier recognizes and sells to the retailer. If the pack item is a vendor pack, communication with the supplier will use the vendor pack number. A buyer pack is a pack that a buyer created for internal ease of use. If the pack item is a buyer pack communication with the supplier will explode the pack out to its component items. This field will only be used if the item is a pack item. If the pack item is not orderable this field must be null. Valid values are: V = Vendor; B = Buyer.
orderAsType	No	String (1)	This field indicates if pack item is receivable at the component level or at the pack level (for a buyer pack only). This field is required if pack item is an orderable buyer pack. This field must be NULL if the pack is sellable only or a vendor pack. This field will only be available if the item is a pack item. Valid Values are: E = Eaches (component level) P = Pack (buyer pack only)..
comments	No	String (2000)	The field holds any comments associated with the item.
itemServiceLevel	No	String (6)	The field Holds a value that restricts the type of shipment methods that RCOM can select for an item.
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 in a separate package.
brandName	No	String (30)	This field contains the brand associated to an item.
brandDescription	No	String (120)	This field contains the description of the brand associated with the item.
perishableInd	No	String (1)	The field is not used by RMS.
itemTransformInd	No	String (1)	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	No	String (6)	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	No	String (25)	The field holds the container item number for a contents item. This field is only populated and required if the DEPOSIT_ITEM_TYPE = E.
depositInPricePerUom	No	String (6)	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 DEPOSIT_ITEM_TYPE = E. Valid values are I - Include deposit amount E - Exclude deposit amount.
storePackInventoryInd	No	String (1)	This field indicates whether downstream systems should track pack inventory at the pack level.
sohInquiryAtPackInd	No	String (1)	The field indicates to the Store Inventory System if a notional simple pack item's inventory should be displayed in packs.
purchaseType	No	String (1)	The field indicates if an item is a normal, consignment or concession item - 'N' for normal, 'S' for consignment, 'C' for concession.
productClassification	No	String (6)	The field contains item combinability codes (with code type 'PCLA') which provide a way to define which items can be combined (packed or boxed) together.
productClassificationDescription	No	String (250)	This field will hold the description of the product classification.
itemAggregateInd	No	String (1)	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	No	String (1)	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	No	String (1)	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	No	String (1)	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	No	String (1)	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	No	String (6)	This field will contain either ID or GROUP, based on whether the diff_1 is a group diff or a diff id.
diff1Description	No	String (120)	This field will hold the description of differentiator.
diff2Level	No	String (6)	This field will contain either ID or GROUP, based on whether the diff_1 is a group diff or a diff id.
diff2Description	No	String (120)	This field will hold the description of differentiator.
diff3Level	No	String (6)	This field will contain either ID or GROUP, based on whether the diff_1 is a group diff or a diff id.
diff3Description	No	String (120)	This field will hold the description of differentiator.
diff4Level	No	String (6)	This field will contain either ID or GROUP, based on whether the diff_1 is a group diff or a diff id.
diff4Description	No	String (120)	This field will hold the description of differentiator.
primaryImageUrl	No	String (375)	This field will hold the primary item image URL. It is only included for the ItemCre and ItemFulRep message types. Updates to the primary image for an item are published in the Item Image node.
transferAllocUpChargeSourceType	No	String (6)	This field impacts how up charges default to transfers and allocations when an item is added. When set to 'D', department-level up charges are applied if item-level up charges are not defined for the item/from-location/to-location combination. When set to 'I', only item-level up charges are applied; department-level up charges are not inherited.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
customFlexAttribute	No	Collection of Object	This List holds custom flex attributes for the item.
itemTranslation	No	Collection of Object	This List holds translation attributes for the item.
itemSupplier	No	Collection of Object	This List holds supplier's attributes for the item.
itemUda	No	Object	This record holds uda attributes for the item.
itemImage	No	Collection of Object	This List holds image attributes for the item.
itemSeason	No	Collection of Object	This List holds season attributes for the item.
referenceItem	No	Collection of Object	This List holds referenc item's attributes for the item.
itemBOM	No	Collection of Object	This List holds pack attributes for the item.
itemTicket	No	Collection of Object	This List holds ticket attributes for the item.
relatedItem	No	Collection of Object	This List holds related item's attributes for the item.
hts	No	Collection of Object	This List holds hts attributes for the item.
expense	No	Collection of Object	This List holds expense attributes for the item.
requiredDocuments	No	Collection of Object	This List holds the required documents of the item.
itemImportAttributes	No	Collection of Object	This List holds the import specific attributes associated with a given item.
cacheTimestamp	No	dateTime	This field specifies date and time when item record was last maintained.
cacheCreateTimestamp	No	dateTime	This field specifies date and time when the record was first created for web serivce publication.

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

Element Name	Required	Data Type	Description
name	No	String (30)	This field holds the custom flex attribute name.
value	No	String (250)	This field holds the numeric or character value of the custom flex attribute.
valueDate	No	date	This field holds the date value of the custom flex attribute.
createDateTime	No	dateTime	This field holds the date and time when the custom flex attribute was created (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the custom flex attribute was last updated (UTC).

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

Element Name	Required	Data Type	Description
languageCode	No	Number(6,0)	This field contains the language in which the translated text is maintained
languageName	No	String (120)	This field contains description of language code in which the translated text is maintained
isoCode	No	String (6)	This field will hold the ISO code associated with the given language.
itemDescription	No	String (250)	This field will hold the ISO code associated with the given language.
itemDescriptionSecondary	No	String (250)	This field holds long description of the item. This description is used through out the system to help online users identify the item. For items that have parents,this description will default to the parents description plus any differentiators. For items without parents, this description will default to null
shortDescription	No	String (120)	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	No	String (2000)	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	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
supplier	No	Number(10,0)	This field specifies unique identifier for the supplier.
primarySupplierInd	No	String (1)	This field indicates whether this supplier is the primary supplier for the item. An item can have one and only one primary supplier.
vpn	No	String (30)	This field contains the Vendor Product Number for the Item/Supplier.
supplierLabel	No	String (15)	This field contains the supplier label. It will only be populated if item is a parent item.
consignmentRate	No	Number(12,4)	This field contains the consignment rate for this item for the supplier.
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 first 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 first 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 first supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
palletName	No	String (6)	This field specifies code referencing the name used to refer to the pallet.
caseName	No	String (6)	This field specifies code referencing the name used to refer to the case.
innerName	No	String (6)	This field specifies code referencing the name used to refer to the inner.
supplierDiscontinueDate	No	date	This field specifies the date when the supplier discontinues an item.
directShipInd	No	String (1)	This field indicates that any item associated with this supplier is eligible for a direct shipment from the supplier to the customer.
primaryCaseSize	No	String (6)	This field indicates the primary case size for the item supplier when an orderable item is configured for informal case types.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
customFlexAttribute	No	Collection of Object	This List holds custom flex attributes for the item's supplier record.
itemSupplierCountry	No	Collection of Object	This List holds custom flex attributes for the item supplier's country record.
itemSupplierCountryOfManufacture	No	Collection of Object	This List holds custom flex attributes for the item supplier's manufacture record.
itemSupplierUom	No	Collection of Object	This List holds custom flex attributes for the item's supplier UOM record.
translation	No	Collection of Object	List of translations for Item Supplier

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

Element Name	Required	Data Type	Description
originCountry	No	String (3)	This field specifies country where the item was manufactured or significantly altered.
primarySupplierInd	No	String (1)	This field indicates whether this supplier is the primary supplier for the item. Each item can have one and only one primary supplier.
primaryCountryInd	No	String (1)	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	No	Number(20,4)	This field contains the current corporate unit cost for the item from the supplier /origin country. This field is stored in the Supplier's currency..
leadTime	No	Number(4,0)	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	No	Number(4,0)	This field Contains the time that will be taken to get the item from the supplier to the initial receiving location.
supplierPackSize	No	Number(12,4)	This field 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.
roundLevel	No	String (6)	This field is used to determine how order quantities will be rounded to case, layer and pallet.
minimumOrderQuantity	No	Number(12,4)	This field contains the minimum quantity that can be ordered at once from the supplier for the item.
maximumOrderQuantity	No	Number(12,4)	This field contains the maximum quantity that can be ordered at once from the supplier for the item.
packingMethod	No	String (6)	This field indicates whether the packing method for the item in the container is flat or hanging.
defaultUop	No	String (6)	This field contains the default unit of purchase for the item/supplier/country. Valid values include 'C' (Case) and 'P' (Pallet)
ti	No	Number(12,4)	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	No	Number(12,4)	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	No	String (4)	This field contains cost UOM is held to allow costs to be managed in a separate UOM to the standard UOM.
toleranceType	No	String (6)	The unit of tolerance for catch weight simple packs. Valid values are: 'A' - actual 'P' - percent.
maximumTolerance	No	Number(12,4)	The maximum tolerance value for the catch weight simple pack.
minimumTolerance	No	Number(12,4)	The minimum tolerance value for the catch weight simple pack.
roundToInnerPercentage	No	Number(12,4)	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	No	Number(12,4)	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	No	Number(12,4)	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	No	Number(12,4)	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	No	String (6)	This field identifies partner type of supplier hierarchy level 1. This field will always have the partner type S1 which indicates manufacturer.
supplierHierarchyLevel1	No	String (10)	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	No	String (6)	This field identifies partner type of supplier hierarchy level 2. This field will always have the partner type S2 which indicates distributor.
supplierHierarchyLevel2	No	String (10)	This field conatins 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	No	String (6)	This field identifies partner type of supplier hierarchy level 3. This field will always have the partner type S3 which indicates wholesaler.
supplierHierarchyLevel3	No	String (10)	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	No	Number(20,4)	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	No	Number(20,4)	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	No	Number(20,4)	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	No	Number(20,4)	This field will hold the tax exclusive cost of the item.
purchaseType	No	Number(1,0)	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	No	String (1)	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	No	Number(12,4)	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	No	String (1)	This field contains the pricing control of the item which will determine the item price is controlled by Retailer or Supplier. Valid value are R - Managed by Retailer, S - Managed by Supplier, NULL - For Owned Items
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
customFlexAttribute	No	Collection of Object	This List holds custom flex attributes for the item supplier's country record.
itemSupplierCountryDimension	No	Collection of Object	This List holds dimension attributes for the item supplier's country record.

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

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

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

Element Name	Required	Data Type	Description
countryId	No	String (3)	This field holds country ID of manufacturer.
primaryInd	No	String (1)	This field indicates primary country of manufacturer indicator.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
uom	No	String (4)	This field holds unit of measure that the item is being measured in.
value	No	Number(20,4)	This field holds value of measure.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
languageCode	No	Number(6,0)	The code identifying the language.
languageName	No	String (120)	The display name of the language.
isoCode	No	String (6)	The ISO code of the language.
supplierDiff1	No	String (120)	This field contains the first supplier differentiator and/or description.
supplierDiff2	No	String (120)	This field contains the second supplier differentiator and/or description.
supplierDiff3	No	String (120)	This field contains the third supplier differentiator and/or description.
supplierDiff4	No	String (120)	This field contains the fourth supplier differentiator and/or description.
supplierLabel	No	String (15)	The translated supplier label for the item.
createDateTime	No	dateTime	The creation date/time of the translation record.
updateDateTime	No	dateTime	The last update date/time of the translation record.

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

Element Name	Required	Data Type	Description
udaLov	No	Collection of Object	This List attributes for the item's uda list of values.
udaFreeform	No	Collection of Object	This List holds attributes for the item's uda free form .
udaDate	No	Collection of Object	This List holds attributes for the item's uda date.

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

Element Name	Required	Data Type	Description
udaId	No	Number(5,0)	This field contains a number identifying the user-defined attribute.
udaDescription	No	String (120)	This field contains description of user-defined attribute.
udaValue	No	Number(5,0)	This field contains the unique identified of the Attribute Group being added or delete to the item list.
udaValueDescription	No	String (250)	This field contains the value of the Attribute Group.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
udaId	No	Number(5,0)	This field contains a number identifying the user-defined attribute.
udaDescription	No	String (120)	This field contains description of user-defined attribute.
udaText	No	String (250)	This field contains the text value of the user-defined attribute for the item.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
translation	No	Collection of Object	List of translations for UDA free form text.

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

Element Name	Required	Data Type	Description
languageCode	No	Number(6,0)	The code identifying the language.
languageName	No	String (120)	The display name of the language.
isoCode	No	String (6)	The ISO code of the language.
udaTextDesc	No	String (250)	The translated UDA text.
createDateTime	No	dateTime	The creation date/time of the translation record.
updateDateTime	No	dateTime	The last update date/time of the translation record.

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

Element Name	Required	Data Type	Description
udaId	No	Number(5,0)	This field contains a number identifying the user-defined attribute.
udaDescription	No	String (120)	This field contains description of user-defined attribute.
udaDate	No	date	This field contains the effective date for the UDA id.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
imageName	No	String (120)	This field specifies name of the image.
imageAddress	No	String (255)	This field specifies path where the image file is stored.
imageType	No	String (6)	This field contains the type of the image of the item. Valid values are defined as member of IITD code type.
primaryImageInd	No	String (1)	This field specifies display sequence order of images associated to the item per priority.
displayPriority	No	Number(4,0)	This field specifies display sequence order of images associated to the item per priority.
imageDescription	No	String (40)	This field contains the description associated with the image of the item.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
translation	No	Collection of Object	List of translations for Item Image

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

Element Name	Required	Data Type	Description
languageCode	No	Number(6,0)	The code identifying the language.
languageName	No	String (120)	The display name of the language.
isoCode	No	String (6)	The ISO code of the language.
imageDescription	No	String (40)	This field contains the translated description associated with the image of the item.
createDateTime	No	dateTime	The creation date/time of the translation record.
updateDateTime	No	dateTime	The last update date/time of the translation record.

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

Element Name	Required	Data Type	Description
seasonId	No	Number(3,0)	The season identifier.
phaseId	No	Number(3,0)	The phase identifier.
sequenceNo	No	Number(4,0)	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.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
referenceItem	No	String (25)	This field holds Unique identifier for the item.
primaryInd	No	String (1)	This field Indicates if 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'.
formatId	No	String (1)	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	No	Number(2,0)	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	No	String (6)	This field holds 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.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
componentItem	No	String (25)	This field specifies unique identifier for the component item.
packQuantity	No	Number(12,4)	This field specifies contains the quantity of each item in the pack item.

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

Element Name	Required	Data Type	Description
ticketOverPercentage	No	Number
printOnPcInd	No	String
ticketTypeId	No	String (4)	This field uniquely identifies the ticket type which is associated with the item.
ticketTypeDescription	No	String (120)	This field contains a description of the ticket or label type.
shelfEdgeLabelInd	No	String (1)	This field contains a description of the ticket or label type.
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. Valid values are: A and R.
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 in this field are:Y - Yes 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. 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	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
details	No	Collection of Object	This List holds attributes for the item ticket details.

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

Element Name	Required	Data Type	Description
ticketItemId	No	String (4)	This field contains a character string which uniquely identifies an attribute which will appear on a ticket or label such as retail price or price per unit of measure.
ticketItemIdDescription	No	String (250)	This field contains the description of the ticket_item_id.
udaId	No	Number(5,0)	This field contains a number which uniquely defines a user-defined attribute which is to be printed on this ticket type.
sequenceNo	No	Number(4,0)	This field contains sequence number of item's ticket record.

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

Element Name	Required	Data Type	Description
relationshipId	No	Number(20,0)	A system generated numeric field that uniquely identifies the relationship record in related_item_head table.
relationshipName	No	String (255)	This field holds user entered name of the relationshipe.
relationshipType	No	String (6)	This field holds user entered name of the relationshipe.
mandatoryInd	No	String (1)	Indicates whether the relationship is mandatory or not. Valid values: 'Y' (yes), 'N' (no).
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
translation	No	Collection of Object	This List holds translation attributes for the relationship.
details	No	Collection of Object	This List holds attributes for the related item details.

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

Element Name	Required	Data Type	Description
languageCode	No	Number(6,0)	This field contains the language in which the translated text is maintained
languageName	No	String (120)	This field contains description of language code in which the translated text is maintained
isoCode	No	String (6)	This field will hold the ISO code associated with the given language.
relationshipName	No	String (255)	This field holds the translated value of the relationship name
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

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

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

Element Name	Required	Data Type	Description
hts	No	String (25)	The unique identifier for the Harmonized Tariff Schedule code.
importCountry	No	String (3)	The unique identifier for the country that the item will be imported into.
originCountry	No	String (3)	The country where the item was manufactured or significantly altered.
effectFrom	No	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	No	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 (for example, zones within the country where the goods are clearing customs). No locations or cost zones are associated to a clearing zone. 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.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
assessments	No	Collection of Object	References a collection of assessments associated to the item HTS.

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

Element Name	Required	Data Type	Description
componentId	No	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.
componentCurrency	No	String (3)	This field contains component currency.
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.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
supplier	No	Number(10,0)	The unique identifier for the supplier.
countryOfSourcing	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.
dischargePort	No	String (5)	The port where the item will enter the importing country.
costZoneGroupId	No	Number(4,0)	This field holds the items Zone Group, it is stored here for performance reasons.
costZoneId	No	Number(10,0)	The final destination zone of the item if the Expense Type is Zone.
baseExpenseInd	No	String (1)	This field indicates whether or not this Set of Expenses is also the base Set of Expenses.
componentId	No	String (10)	The code representing the specific expense component.
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.
estimatedExpenseValue	No	Number(26,10)	This field contains the calculated value of the Component.
componentCurrency	No	String (3)	This field contains the currency the expense is to be entered in. If the Calculation Basis is V (Value), then the comp_currency will be NULL.
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.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
documentId	No	Number(6,0)	This field contains documents of the items.

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

Element Name	Required	Data Type	Description
importDescription	No	String (2000)	This field contains description of the item used for importing purposes..
commodity	No	String (6)	This field contains the code used to classify the item by their type of merchandise.
tooling	No	Number(20,4)	This field contains the cost associated with a given Tooling/Assist charge.
firstOrderIndicator	No	String (1)	This field contains indicator to determine if duty is to be paid on the total value of the tooling expense the first time the item is shipped
amortizeBase	No	Number(12,4)	This field contains the number of units over which the tooling/assist cost will be amortized.
openBalance	No	Number(12,4)	This field contains the open balance of the number of units yet to be received over which the tooling costs will be amortized.
createDateTime	No	dateTime	This field holds the record creation date.

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

Element Name	Required	Data Type	Description
href	No	String	Service URL
rel	No	String	This can be either 'self' or 'next'. The 'next' link is present if there are more pages to fetch and contains the offsetkey which uniquely identifies the last record of this response.

Sample Response Message

{
"items": [
{
"action": "INSERT",
"longtDescription": "String",
"item": "100100076",
"itemNumberType": "MANL",
"status": "A",
"itemLevel": 1,
"tranLevel": 1,
"itemDescription": "Regular Item 100100076",
"shortDescription": "100100076 Item",
"itemDescriptionUppercase": "100100076 ITEM REGULAR",
"itemDescriptionSecondary": "100100076 Item Regular",
"longDescription": null,
"itemParent": null,
"itemGrandparent": null,
"sellableInd": "Y",
"orderableInd": "Y",
"inventoryInd": "Y",
"packInd": "Y",
"simplePackInd": "N",
"containsInnerInd": "N",
"dept": 3041,
"deptName": null,
"class": 1.0,
"className": null,
"uniqueClassId": 1,
"subclass": 1,
"subclassName": null,
"uniqueSubclassId": 1,
"unitRetail": 1.0,
"variableUpcFormatId": null,
"variableWeightUpcPrefix": 1,
"diff1": null,
"diff1Type": null,
"diff2": null,
"diff2Type": null,
"diff3": null,
"diff3Type": null,
"diff4": null,
"diff4Type": null,
"costZoneGroupId": 1000,
"standardUom": "EA",
"uomConversionFactor": 3,
"packageSize": 1.0,
"packageUom": null,
"merchandiseInd": "Y",
"storeOrderMultiple": "E",
"forecastInd": null,
"manufacturerRecommendedRetail": 12.99,
"manufacturerRetailCurrencyCode": "USD",
"originalRetail": 12.99,
"originalRetailCurrencyCode": "USD",
"retailLabelType": null,
"retailLabelTypeDescription": null,
"retailLabelValue": 1.0,
"handlingTemperature": null,
"handlingTemperatureDescription": null,
"handlingSensitivity": null,
"handlingSensitivityDescription": null,
"catchWeightInd": "Y",
"catchWeightType": null,
"catchWeightUom": "EA",
"orderType": null,
"saleType": null,
"wasteType": null,
"wasteTypeDescription": null,
"averageWastePercentage": 1.0,
"defaultWastePercentage": 1.0,
"constantDimensionInd": "Y",
"packType": null,
"orderAsType": null,
"comments": null,
"itemServiceLevel": null,
"giftWrapInd": "Y",
"shipAloneInd": "Y",
"brandName": null,
"brandDescription": null,
"perishableInd": "Y",
"itemTransformInd": "N",
"depositItemType": null,
"containerItem": null,
"depositInPricePerUom": null,
"storePackInventoryInd": "Y",
"sohInquiryAtPackInd": "Y",
"purchaseType": null,
"productClassification": null,
"productClassificationDescription": null,
"itemAggregateInd": "Y",
"diff1AggregateInd": "Y",
"diff2AggregateInd": "Y",
"diff3AggregateInd": "Y",
"diff4AggregateInd": "Y",
"diff1Level": null,
"diff1Description": null,
"diff2Level": null,
"diff2Description": null,
"diff3Level": null,
"diff3Description": null,
"diff4Level": null,
"diff4Description": null,
"primaryImageUrl": null,
"transferAllocUpChargeSourceType": "D",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"customFlexAttribute": [
{
"name": "attribute1",
"value": "value1",
"valueDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"itemTranslation": [
{
"languageCode": 2,
"languageName": null,
"isoCode": "en-US",
"itemDescription": "itemDesc",
"itemDescriptionSecondary": "itemDescSecondary",
"shortDescription": "shortDesc",
"longDescription": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"itemSupplier": [
{
"supplier": 2400,
"primarySupplierInd": "Y",
"vpn": null,
"supplierLabel": null,
"consignmentRate": 3,
"supplierDiff1": null,
"supplierDiff2": null,
"supplierDiff3": null,
"supplierDiff4": null,
"palletName": "PAL",
"caseName": "CS",
"innerName": "INR",
"supplierDiscontinueDate": "2001-12-31",
"directShipInd": "Y",
"primaryCaseSize": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"customFlexAttribute": [
{
"name": "attribute1",
"value": "value1",
"valueDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"itemSupplierCountry": [
{
"originCountry": null,
"primarySupplierInd": null,
"primaryCountryInd": "Y",
"unitCost": 9.65,
"leadTime": 1,
"pickupLeadTime": 1,
"supplierPackSize": 1,
"innerPackSize": 1,
"roundLevel": "C",
"minimumOrderQuantity": 1.0,
"maximumOrderQuantity": 1,
"packingMethod": "HANG",
"defaultUop": null,
"ti": 1,
"hi": 1,
"costUom": "EA",
"toleranceType": null,
"maximumTolerance": 1.0,
"minimumTolerance": 1.0,
"roundToInnerPercentage": 50,
"roundToCasePercentage": 50,
"roundToLayerPercentage": 50,
"roundToPalletPercentage": 50,
"supplierHierarchyType1": null,
"supplierHierarchyLevel1": null,
"supplierHierarchyType2": null,
"supplierHierarchyLevel2": null,
"supplierHierarchyType3": null,
"supplierHierarchyLevel3": null,
"negotiatedItemCost": 1.0,
"extendedBaseCost": 1.0,
"inclusiveCost": 1.0,
"baseCost": 1.0,
"purchaseType": 0,
"calculationBasis": null,
"purchaseRate": 1.0,
"pricingControl": "R",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"customFlexAttribute": [
{
"name": "attribute1",
"value": "value1",
"valueDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"itemSupplierCountryDimension": [
{
"dimensionObject": null,
"dimensionObjectDescription": null,
"presentationMethod": null,
"presentationMethodDescription": null,
"length": 1.0,
"width": 1.0,
"height": 1.0,
"lwhUom": null,
"weight": 1.0,
"netWeight": 1.0,
"weightUom": null,
"liquidVolume": 1.0,
"liquidVolumeUom": null,
"statisticalCase": 1.0,
"tareWeight": 1.0,
"tareType": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"itemSupplierCountryOfManufacture": [
{
"countryId": "BR",
"primaryInd": "N",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"itemSupplierUom": [
{
"uom": null,
"value": 1.0,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"translation": [
{
"languageCode": 2,
"languageName": null,
"isoCode": "en-US",
"supplierDiff1": null,
"supplierDiff2": null,
"supplierDiff3": null,
"supplierDiff4": null,
"supplierLabel": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"itemUda": {
"udaLov": [
{
"udaId": 1,
"udaDescription": null,
"udaValue": 1,
"udaValueDescription": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"udaFreeform": [
{
"udaId": 1,
"udaDescription": null,
"udaText": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"translation": [
{
"languageCode": 2,
"languageName": null,
"isoCode": "en-US",
"udaTextDesc": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"udaDate": [
{
"udaId": 1,
"udaDescription": null,
"udaDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
},
"itemImage": [
{
"imageName": "imageName1",
"imageAddress": "http://www.oracle.com/",
"imageType": "T",
"primaryImageInd": "Y",
"displayPriority": 1,
"imageDescription": "imageDesc1",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"translation": [
{
"languageCode": 2,
"languageName": null,
"isoCode": "en-US",
"imageDescription": "Item Image",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"itemSeason": [
{
"seasonId": 1,
"phaseId": 1,
"sequenceNo": 1,
"diffId": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"referenceItem": [
{
"referenceItem": null,
"primaryInd": "N",
"formatId": null,
"prefix": 1,
"itemNoType": "MANL",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"itemBOM": [
{
"componentItem": null,
"packQuantity": 1.0
}
],
"itemTicket": [
{
"ticketOverPercentage": 1.0,
"printOnPcInd": "String",
"ticketTypeId": null,
"ticketTypeDescription": null,
"shelfEdgeLabelInd": null,
"poPrintType": null,
"printOnPriceChangeInd": "Y",
"ticketOverPrintPercentage": 3,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"details": [
{
"ticketItemId": null,
"ticketItemIdDescription": null,
"udaId": 1,
"sequenceNo": 1
}
]
}
],
"relatedItem": [
{
"relationshipId": 1,
"relationshipName": null,
"relationshipType": null,
"mandatoryInd": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"translation": [
{
"languageCode": 2,
"languageName": null,
"isoCode": "en-US",
"relationshipName": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"details": [
{
"relatedItem": null,
"priority": 1,
"startDate": "2001-12-31",
"endDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"hts": [
{
"hts": null,
"importCountry": "US",
"originCountry": "US",
"effectFrom": "2001-12-31",
"effectTo": "2001-12-31",
"clearingZoneId": null,
"status": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"assessments": [
{
"componentId": null,
"computationValueBase": null,
"componentRate": 1.0,
"perCount": 1.0,
"perCountUom": null,
"estimatedAssessmentValue": 1.0,
"componentCurrency": null,
"nominationFlag1": null,
"inDuty": null,
"nominationFlag3": null,
"inExpense": null,
"inAlc": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"expense": [
{
"supplier": 2400,
"countryOfSourcing": "US",
"ladingPort": "7",
"dischargePort": "480",
"costZoneGroupId": 1,
"costZoneId": 1,
"baseExpenseInd": "N",
"componentId": "AGCOMM",
"computationValueBase": "TDTYUS",
"componentRate": 3.55,
"perCount": 3,
"perCountUom": "EA",
"estimatedExpenseValue": 1.0,
"componentCurrency": "USD",
"nominationFlag1": null,
"inDuty": null,
"nominationFlag3": null,
"inExpense": null,
"inAlc": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"requiredDocuments": [
{
"documentId": 1
}
],
"itemImportAttributes": [
{
"importDescription": "import desc",
"commodity": "A123",
"tooling": 12,
"firstOrderIndicator": "Y",
"amortizeBase": 12.4568,
"openBalance": 12.4568,
"createDateTime": "2001-12-31T23:59:59.000Z"
}
],
"cacheTimestamp": "2001-12-31T23:59:59.000Z",
"cacheCreateTimestamp": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1000,
"count": 1000,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000&since=1970-01-01T00:00:00.001Z&before=2024-01-01T00:00:00.001Z&offsetkey=1234,XYZ",
"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
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 - Item Definition

Business Overview

This service publishes item master data for transaction-level items and higher merchandise hierarchy nodes to downstream consuming systems. The payload combines core item attributes with translations, supplier and sourcing details, UDA values, images, tickets, related items, compliance and import data, and custom flex attributes. End-to-end publication is limited to items that qualify through the refresh and delta flow: refresh seeds items in approved or deleted status, item-master inserts are not queued until the item is approved, and item-master updates in worksheet or submitted status are suppressed. Below-transaction-level reference or UPC items are not published as standalone records; their changes refresh the parent item's referenceItem node.

Technical Details

This service follows the Publish API cache architecture in which the REST service serves pre-generated JSON from an integration cache table that is initially seeded and then maintained through asynchronous delta processing. For overall enablement, scheduling, and guidance on how publish api works and how webhook for this api can be implemented to stream the data out, refer to the white paper Publish APIs - Customer Enablement Overview.

Core business tables: ITEM_MASTER, ITEM_MASTER_TL, ITEM_SUPPLIER, ITEM_SUPP_UOM, ITEM_SUPP_COUNTRY, ITEM_SUPP_COUNTRY_DIM, ITEM_SUPP_MANU_COUNTRY, ITEM_TICKET, UDA_ITEM_DATE, UDA_ITEM_LOV, UDA_ITEM_FF, ITEM_IMAGE, ITEM_SEASONS, ITEM_HTS, ITEM_EXP_HEAD, ITEM_EXP_DETAIL, RELATED_ITEM_HEAD, RELATED_ITEM_DETAIL, REQ_DOC, ITEM_IMPORT_ATTR

Additional business tables: ITEM_MASTER_CFA_EXT, ITEM_SUPPLIER_CFA_EXT, ITEM_SUPP_COUNTRY_CFA_EXT, DEPS, GROUPS, DIVISION, CLASS, SUBCLASS, BRAND, DIFF_IDS, DIFF_GROUP_HEAD, SYSTEM_OPTIONS, SYSTEM_CONFIG_OPTIONS, CODE_DETAIL

JSON cache table: MERCHAPI_EXT_ITEM

JSON generation view: V_MERCHAPI_EXT_ITEM_JSON

Is keyed by ITEM_MASTER rows with ITEM_LEVEL <= TRAN_LEVEL, so the published entity is the transaction-level item or a higher hierarchy node.

The payload combines core item attributes with translations, supplier and sourcing data, UDAs, images, tickets, related items, HTS and expense data, import attributes, custom flex attributes, and supporting hierarchy and lookup values.

Below-transaction-level reference or UPC items are not published as standalone payloads; their data is rolled into the parent item's referenceItem node.

Initial Seeding and post enablement rebuild/repair

Initial seeding selects ITEM_MASTER rows where STATUS IN ('A', 'D') and ITEM_LEVEL <= TRAN_LEVEL, then builds the published JSON through V_MERCHAPI_EXT_ITEM_JSON.

Rebuild marks cache rows deleted when the item no longer exists in ITEM_MASTER.

ICL (Integration Change Log) table: ICL_RMS_ITEM_MASTER, ICL_RMS_ITEM_SUPPLIER, ICL_RMS_ITEM_SUPP_UOM, ICL_RMS_ITEM_SUPP_CTRY, ICL_RMS_ITEM_SUPP_CTRY_DIM, ICL_RMS_ITEM_SUPP_MANU_CTRY, ICL_RMS_ITEM_TICKET, ICL_RMS_UDA_ITEM_DATE, ICL_RMS_UDA_ITEM_LOV, ICL_RMS_UDA_ITEM_FF, ICL_RMS_ITEM_IMAGE, ICL_RMS_ITEM_SEASONS, ICL_RMS_ITEM_HTS, ICL_RMS_ITEM_EXP, ICL_RMS_RELATED_ITEM, ICL_RMS_REQ_DOC, ICL_RMS_ITEM_IMPORT_ATTR (ICL consumer name = MERCHAPI)

Item-master inserts are staged only when the new item is approved, approval transitions are staged as insert-style publishes, and item-master updates in worksheet or submitted status are suppressed.

ITEM_MASTER_TL changes are queued only for items with ITEM_LEVEL <= TRAN_LEVEL, and below-transaction-level item changes are rolled up to ITEM_PARENT so the parent payload is refreshed.

Item Approval Handling

Approval of an item also results in publish of foundation/omnichannel/item/image, foundation/omnichannel/item/relateditem, foundation/item/location, foundation/item/vat, and foundation/taxLocationItem. The item approval flow writes the existing ITEM_IMAGE, RELATED_ITEM_HEAD/DETAIL, ITEM_LOC, and VAT_ITEM source rows for that item into those APIs' ICL tables so dependent approved-item data is queued together with the item.

Batch Configuration. Asynchronous delta processing is supported using Background engine and also via POM scheduling. Choose one.

Process configuration name: API_EXT_ITEM

To enable via Background engine set BACKGROUND_RUN_FLAG to Y and review the BACKGROUND_RUN_INTERVAL_SECOND parameter.

POM Batch schedule process and job: MERCHAPI_DELTA_EXT_ITEM_ADHOC_PROCESS -> MERCHAPI_EXT_ITEM_ADHOC_JOB

Webhook configuration api name: foundation/item

Special handling

Additional GET query parameters: itemLevel, tranLevel, deptId, classId, subclassId, status, itemType, inventoryInd, supplier, referenceItem.

The filters itemLevel, tranLevel, deptId, classId, subclassId, status, and itemType are not backed by dedicated cache-table indexes. At high volume, use them only as additional criteria on top of a small-window delta fetch and not for full downloads.

Performance Considerations

For customers expecting high to very high publish volume from this API, sizing and operational tuning should be addressed early in the implementation lifecycle. Initial cache seeding, ongoing delta processing, full extracts, and incremental downloads or webhook-driven delivery have different runtime characteristics and should be evaluated separately. The available configuration for this service should therefore be reviewed and validated against the customer production data profile, including expected volume, message size, and access pattern, with the key performance-related configuration for this service covering the following:

Multi-threading and commit control

This service supports multi-threaded execution for initial seeding, while delta processing remains a single threaded process. Initial-seeding thread count is controlled through API_REFRESH_OVERRIDE_NO_OF_THREADS, and initial-seeding commit sizing is controlled through API_REFRESH_OVERRIDE_COMMIT_MAX_COUNTER.

For initial seeding, thread and commit settings should be chosen together based on expected row volume, average message size, and the complex SQL query required to build the item message from ITEM_MASTER together with supplier, UDA, image, ticket, related-item, HTS, expense, import, and hierarchy data. Common starting points for large-volume seeding are 8, 16, or 32 threads. Values of 48 or 64 threads should be considered only after testing and with awareness of competing workload in the environment. The delivered refresh override is currently 4 threads.

Refresh commit sizing should be reviewed together with the thread setting. The delivered refresh override commit setting is currently 10000 and that should be used if the thread value is low. If running with higher thread value, the typical value can range from about 100 to 1,000 rows.

Dropping indexes and constraints during seeding

This option applies only to initial seeding, including truncate-and-load execution. Even with refresh-override threading, larger parallel insert volumes can increase index maintenance overhead and slow the load.

To reduce that overhead, DROP_INDEX_ON_REFRESH can be enabled so indexes and constraints are dropped before seeding and rebuilt after the load completes.

This can improve data-load throughput, but the overall refresh plan should also account for the additional time needed for index rebuild after the seeding step finishes. GATHER_STATS_ON_REFRESH should normally remain enabled unless testing shows a need to change it.

REST fetch considerations

Item payloads can be comparatively large, so REST page size should be selected based on average message size so that the average response remains below about 10 MB per call. Common page-limit values for this service should be 500 or 1,000, and very small limits, especially below 100, should generally be avoided.

For full downloads, do not provide the since query parameter so the database can favor the primary-key access path. For delta downloads, use a small time window, typically a few minutes and at most a few hours, so the eligible row set on the LAST_UPDATE_DATETIME index remains small.

Wider delta windows, especially multi-day windows that can arise during outages or data recovery, generally do not perform well. For such scenarios, keeping BUILD_HISTOGRAM enabled allows the service to support recovery through smaller, more selective polling windows using the optimalBefore query parameter.

In this catch-up pattern, for requests up to 30 days in the past, the client provides optimalBefore and leaves before empty. The client then uses the returned before timestamp to continue polling incrementally until the backlog is cleared, and then resumes the normal short-window delta pattern. Hourly histogram processing groups LAST_UPDATE_DATETIME values into buckets of 10,000 rows in MERCHAPI_TIMESTAMP_HISTOGRAM using the shared HISTOGRAM_ROW_COUNT configuration.

Service Type

GET

ReST URL

MerchIntegrations/services/foundation/item

MerchIntegrations/services/foundation/item/{itemId}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date (Example: 2010-12-31T23:59:59.999Z)
before	No	String	Before Date (Example: 2040-12-31T23:59:59.999Z)
itemLevel	No	String	Item Level - 1, 2, or 3
tranLevel	No	String	Transaction Level- 1, 2, or 3
deptId	No	String (4)	Department Id
classId	No	String (4)	Class Id
subclassId	No	String (4)	Sub Class Id
status	No	String	Status
itemType	No	String	Item Type
inventoryInd	No	String	Inventoried
supplier	No	String	Supplier
referenceItem	No	String	Reference Item
offsetkey	No	String	Offset key (Item)
limit	No	String (6)	Pagination limit. Default value is 1000.
optimalBefore	No	String	Enables histogram-based calculation of the before timestamp when before is not provided. Valid values are Y or N. Default value is N.
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-480 Input Parameter for "MerchIntegrations/services/foundation/item/{itemId}"

Parameter Name	Required	Data Type	Description
itemId	Yes	String	Item 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

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

Element Name	Required	Data Type	Description
items	No	Collection of Object	Collection of records
hasMore	No	Boolean	Boolean to signify if there are additional pages of data. This is true if limit = count for pagination supported request
limit	No	Number	Requested page size. If the page size was not defined in the input request, a default page size is used to limit the number of records to fetch
count	No	Number	Number of record in the response object
links	No	Collection of Object	List of Self and/or Next URL

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

Element Name	Required	Data Type	Description
action	No	String (6)	Action for Item details
longtDescription	No	String
item	No	String (25)	This field specifies Unique alphanumeric value that identifies the item.
itemNumberType	No	String (6)	This field holds the type of item number. Valid values are defined by code type UPCT.
status	No	String (1)	This field specifies status of the item.
itemLevel	No	Number(1,0)	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	No	Number(1,0)	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	No	String (250)	This field specifies long description of the item. This description is used through out the system to help online users identify the item. For items that have parents, this description will default to the parents description plus any differentiators. For items without parents this description will default to null.
shortDescription	No	String (120)	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	No	String (250)	This field specifies all upper case description of the item (same as upper(item_desc)). This field is not displayed in the on-line item maintenance dialog, but is used in item list of value search processing through out the system.
itemDescriptionSecondary	No	String (250)	This field specifies secondary descriptions of the item. This field can only be populated when system_options.secondary_desc_ind = Y.
longDescription	No	String (2000)	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	No	String (25)	This field specifies alphanumeric value that uniquely identifies the item/group at the level above the item.
itemGrandparent	No	String (25)	This field specifies alphanumeric value that uniquely identifies the item/group at the level above the item.
sellableInd	No	String (1)	This field indicates if pack item may be sold as a unit. If it is 'Y' then the pack will have its own unique unit retail. If it is 'N' then the pack's unit retail is the sum of each individual item's total retail within the pack. This field will only be available if the item is a pack item. Value values are: Y = Yes, this pack may be sold as a unit; N = No, this pack man not be sold as a unit.
orderableInd	No	String (1)	This field indicates if pack item is orderable. If it is 'Y' then the suppliers of the pack must supply all components in the pack. If it is 'N' then the components may have different suppliers. This field will only be available if the item is a pack item. Valid values are: Y = Yes, this pack may be ordered, N = No, this pack may not be ordered.
inventoryInd	No	String (1)	This field specifies inventory Indicator.
packInd	No	String (1)	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 qtys, etc.) that other items do not. This field is required by the database.
simplePackInd	No	String (1)	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:Y = Yes, this item is a simple pack; N = No if this is not a simple pack.
containsInnerInd	No	String (1)	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	No	Number(4,0)	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). Valid values for this field are located on the deps table.
deptName	No	String (120)	This field contains the name of the department.
class	No	Number
className	No	String (120)	This field contains the name of the class.
uniqueClassId	No	Number(10,0)	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 can not have a composite key in the merchandise hierarchy.
subclass	No	Number(4,0)	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	No	String (120)	This field contains the name of the subclass.
uniqueSubclassId	No	Number(10,0)	This field uniquely identify the subclass which the item belongs to.Sublass is not unique ID the merchandise hierarchy.The combination of Dept/Class/Subclass 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 can not have a composite key in the merchandise hierarchy.
unitRetail	No	Number(20,4)	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	No	String (1)	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	No	Number(2,0)	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 clients responsibility to download this value to their POS system.
diff1	No	String (10)	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	No	String (6)	This field will hold a value of all possible differential types. (for example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). Valid values are stored on the code_detail table with the code_type 'DIFF' and on the diff_type table.
diff2	No	String (10)	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.
diff2Type	No	String (6)	This field will hold a value of all possible differential types. (for example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). Valid values are stored on the code_detail table with the code_type 'DIFF' and on the diff_type table.
diff3	No	String (10)	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.
diff3Type	No	String (6)	This field will hold a value of all possible differential types. (for example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). Valid values are stored on the code_detail table with the code_type 'DIFF' and on the diff_type table.
diff4	No	String (10)	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.
diff4Type	No	String (6)	This field will hold a value of all possible differential types. (for example, 'S' - size, 'C' - color, 'F' - flavor, 'E' - scent, 'P' - pattern). Valid values are stored on the code_detail table with the code_type 'DIFF' and on the diff_type table.
costZoneGroupId	No	Number(4,0)	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	No	String (4)	This field contains unit of measure in which stock of the item is tracked at a corporate level.
uomConversionFactor	No	Number(20,10)	This field contains 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)	This field 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 Retek Price Mangement to determine same sized and different sized items.
packageUom	No	String (4)	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	No	String (1)	This field indicates if the item is a merchandise item (Y, N).
storeOrderMultiple	No	String (1)	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	No	String (1)	This field indicates if this item will be interfaced to an external forecasting system (Y, N).
manufacturerRecommendedRetail	No	Number(20,4)	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	No	String (3)	The field indicates the currency code of the Manufacturer's retail price.
originalRetail	No	Number(20,4)	The field indicated the original retail price of the item per unit. This field is stored in the primary currency.
originalRetailCurrencyCode	No	String (3)	The field indicates the currency code of the original retail price.
retailLabelType	No	String (6)	This field indicates any special label type associated with an item.
retailLabelTypeDescription	No	String (250)	This field holds the description of the retail label type.
retailLabelValue	No	Number(20,4)	This field represents the value associated with the retail label type.
handlingTemperature	No	String (6)	This field holds the temperature information associated with the item.
handlingTemperatureDescription	No	String (250)	This field holds the description of the handling temperature.
handlingSensitivity	No	String (6)	This field holds the sensitivity information associated with the item.
handlingSensitivityDescription	No	String (250)	This field holds the description of the handling sensitivity.
catchWeightInd	No	String (1)	This field indicates whether the item should be weighed when it arrives at a location.
catchWeightType	No	String (1)	The field will hold catch weight type for a simple pack catch weight item. The value is based on the component items order_type and sale_type: 2 - order_type = Variable Weight, sale_type = Loose Weight 4 - order_type = Variable Weight, sale_type = Variable Weight Each.
catchWeightUom	No	String (4)	The field indicates the UOM for Catchweight Items.
orderType	No	String (6)	The field determines how catch weight items are ordered. Valid values are: F - fixed weight V - Variable weight Valid values are held on the CODE_DETAIL table with a code type = ORDT.
saleType	No	String (6)	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. Valid values are held on the CODE_DETAIL table with a code type = STPE.
wasteType	No	String (6)	The field indicates identifies the wastage type as either sales or spoilage wastage. Sales wastage occurs during processes that make an item saleable (i.e. fat is trimmed off at customer request). Spoilage wastage occurs during the products shelf life (i.e. evaporation causes the product to weigh less after a period of time). Valid values are: SP - spoilage; and SL - Sales.
wasteTypeDescription	No	String (250)	The field contains the Waste Type description corresponding to the Waste_Type value in item_master.
averageWastePercentage	No	Number(12,4)	The field indicates average percent of wastage for the item over its shelf life. Used in inflating the retail price for wastage items.
defaultWastePercentage	No	Number(12,4)	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	No	String (1)	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	No	String (1)	The field Indicates if pack item is a vendor pack or a buyer pack. A vendor pack is a pack that the vendor or supplier recognizes and sells to the retailer. If the pack item is a vendor pack, communication with the supplier will use the vendor pack number. A buyer pack is a pack that a buyer created for internal ease of use. If the pack item is a buyer pack communication with the supplier will explode the pack out to its component items. This field will only be used if the item is a pack item. If the pack item is not orderable this field must be null. Valid values are: V = Vendor; B = Buyer.
orderAsType	No	String (1)	This field indicates if pack item is receivable at the component level or at the pack level (for a buyer pack only). This field is required if pack item is an orderable buyer pack. This field must be NULL if the pack is sellable only or a vendor pack. This field will only be available if the item is a pack item. Valid Values are: E = Eaches (component level) P = Pack (buyer pack only)..
comments	No	String (2000)	The field holds any comments associated with the item.
itemServiceLevel	No	String (6)	The field Holds a value that restricts the type of shipment methods that RCOM can select for an item.
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 in a separate package.
brandName	No	String (30)	This field contains the brand associated to an item.
brandDescription	No	String (120)	This field contains the description of the brand associated with the item.
perishableInd	No	String (1)	The field is not used by RMS.
itemTransformInd	No	String (1)	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	No	String (6)	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	No	String (25)	The field holds the container item number for a contents item. This field is only populated and required if the DEPOSIT_ITEM_TYPE = E.
depositInPricePerUom	No	String (6)	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 DEPOSIT_ITEM_TYPE = E. Valid values are I - Include deposit amount E - Exclude deposit amount.
storePackInventoryInd	No	String (1)	This field indicates whether downstream systems should track pack inventory at the pack level.
sohInquiryAtPackInd	No	String (1)	The field indicates to the Store Inventory System if a notional simple pack item's inventory should be displayed in packs.
purchaseType	No	String (1)	The field indicates if an item is a normal, consignment or concession item - 'N' for normal, 'S' for consignment, 'C' for concession.
productClassification	No	String (6)	The field contains item combinability codes (with code type 'PCLA') which provide a way to define which items can be combined (packed or boxed) together.
productClassificationDescription	No	String (250)	This field will hold the description of the product classification.
itemAggregateInd	No	String (1)	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	No	String (1)	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	No	String (1)	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	No	String (1)	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	No	String (1)	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	No	String (6)	This field will contain either ID or GROUP, based on whether the diff_1 is a group diff or a diff id.
diff1Description	No	String (120)	This field will hold the description of differentiator.
diff2Level	No	String (6)	This field will contain either ID or GROUP, based on whether the diff_1 is a group diff or a diff id.
diff2Description	No	String (120)	This field will hold the description of differentiator.
diff3Level	No	String (6)	This field will contain either ID or GROUP, based on whether the diff_1 is a group diff or a diff id.
diff3Description	No	String (120)	This field will hold the description of differentiator.
diff4Level	No	String (6)	This field will contain either ID or GROUP, based on whether the diff_1 is a group diff or a diff id.
diff4Description	No	String (120)	This field will hold the description of differentiator.
primaryImageUrl	No	String (375)	This field will hold the primary item image URL. It is only included for the ItemCre and ItemFulRep message types. Updates to the primary image for an item are published in the Item Image node.
transferAllocUpChargeSourceType	No	String (6)	This field impacts how up charges default to transfers and allocations when an item is added. When set to 'D', department-level up charges are applied if item-level up charges are not defined for the item/from-location/to-location combination. When set to 'I', only item-level up charges are applied; department-level up charges are not inherited.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
customFlexAttribute	No	Collection of Object	This List holds custom flex attributes for the item.
itemTranslation	No	Collection of Object	This List holds translation attributes for the item.
itemSupplier	No	Collection of Object	This List holds supplier's attributes for the item.
itemUda	No	Object	This record holds uda attributes for the item.
itemImage	No	Collection of Object	This List holds image attributes for the item.
itemSeason	No	Collection of Object	This List holds season attributes for the item.
referenceItem	No	Collection of Object	This List holds referenc item's attributes for the item.
itemBOM	No	Collection of Object	This List holds pack attributes for the item.
itemTicket	No	Collection of Object	This List holds ticket attributes for the item.
relatedItem	No	Collection of Object	This List holds related item's attributes for the item.
hts	No	Collection of Object	This List holds hts attributes for the item.
expense	No	Collection of Object	This List holds expense attributes for the item.
requiredDocuments	No	Collection of Object	This List holds the required documents of the item.
itemImportAttributes	No	Collection of Object	This List holds the import specific attributes associated with a given item.
cacheTimestamp	No	dateTime	This field specifies date and time when item record was last maintained.
cacheCreateTimestamp	No	dateTime	This field specifies date and time when the record was first created for web serivce publication.

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

Element Name	Required	Data Type	Description
name	No	String (30)	This field holds the custom flex attribute name.
value	No	String (250)	This field holds the numeric or character value of the custom flex attribute.
valueDate	No	date	This field holds the date value of the custom flex attribute.
createDateTime	No	dateTime	This field holds the date and time when the custom flex attribute was created (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the custom flex attribute was last updated (UTC).

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

Element Name	Required	Data Type	Description
languageCode	No	Number(6,0)	This field contains the language in which the translated text is maintained
languageName	No	String (120)	This field contains description of language code in which the translated text is maintained
isoCode	No	String (6)	This field will hold the ISO code associated with the given language.
itemDescription	No	String (250)	This field will hold the ISO code associated with the given language.
itemDescriptionSecondary	No	String (250)	This field holds long description of the item. This description is used through out the system to help online users identify the item. For items that have parents,this description will default to the parents description plus any differentiators. For items without parents, this description will default to null
shortDescription	No	String (120)	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	No	String (2000)	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	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
supplier	No	Number(10,0)	This field specifies unique identifier for the supplier.
primarySupplierInd	No	String (1)	This field indicates whether this supplier is the primary supplier for the item. An item can have one and only one primary supplier.
vpn	No	String (30)	This field contains the Vendor Product Number for the Item/Supplier.
supplierLabel	No	String (15)	This field contains the supplier label. It will only be populated if item is a parent item.
consignmentRate	No	Number(12,4)	This field contains the consignment rate for this item for the supplier.
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 first 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 first 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 first supplier differentiator and/or description. This field may only contain a value for items with an item_parent.
palletName	No	String (6)	This field specifies code referencing the name used to refer to the pallet.
caseName	No	String (6)	This field specifies code referencing the name used to refer to the case.
innerName	No	String (6)	This field specifies code referencing the name used to refer to the inner.
supplierDiscontinueDate	No	date	This field specifies the date when the supplier discontinues an item.
directShipInd	No	String (1)	This field indicates that any item associated with this supplier is eligible for a direct shipment from the supplier to the customer.
primaryCaseSize	No	String (6)	This field indicates the primary case size for the item supplier when an orderable item is configured for informal case types.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
customFlexAttribute	No	Collection of Object	This List holds custom flex attributes for the item's supplier record.
itemSupplierCountry	No	Collection of Object	This List holds custom flex attributes for the item supplier's country record.
itemSupplierCountryOfManufacture	No	Collection of Object	This List holds custom flex attributes for the item supplier's manufacture record.
itemSupplierUom	No	Collection of Object	This List holds custom flex attributes for the item's supplier UOM record.
translation	No	Collection of Object	List of translations for Item Supplier

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

Element Name	Required	Data Type	Description
originCountry	No	String (3)	This field specifies country where the item was manufactured or significantly altered.
primarySupplierInd	No	String (1)	This field indicates whether this supplier is the primary supplier for the item. Each item can have one and only one primary supplier.
primaryCountryInd	No	String (1)	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	No	Number(20,4)	This field contains the current corporate unit cost for the item from the supplier /origin country. This field is stored in the Supplier's currency..
leadTime	No	Number(4,0)	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	No	Number(4,0)	This field Contains the time that will be taken to get the item from the supplier to the initial receiving location.
supplierPackSize	No	Number(12,4)	This field 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.
roundLevel	No	String (6)	This field is used to determine how order quantities will be rounded to case, layer and pallet.
minimumOrderQuantity	No	Number(12,4)	This field contains the minimum quantity that can be ordered at once from the supplier for the item.
maximumOrderQuantity	No	Number(12,4)	This field contains the maximum quantity that can be ordered at once from the supplier for the item.
packingMethod	No	String (6)	This field indicates whether the packing method for the item in the container is flat or hanging.
defaultUop	No	String (6)	This field contains the default unit of purchase for the item/supplier/country. Valid values include 'C' (Case) and 'P' (Pallet)
ti	No	Number(12,4)	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	No	Number(12,4)	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	No	String (4)	This field contains cost UOM is held to allow costs to be managed in a separate UOM to the standard UOM.
toleranceType	No	String (6)	The unit of tolerance for catch weight simple packs. Valid values are: 'A' - actual 'P' - percent.
maximumTolerance	No	Number(12,4)	The maximum tolerance value for the catch weight simple pack.
minimumTolerance	No	Number(12,4)	The minimum tolerance value for the catch weight simple pack.
roundToInnerPercentage	No	Number(12,4)	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	No	Number(12,4)	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	No	Number(12,4)	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	No	Number(12,4)	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	No	String (6)	This field identifies partner type of supplier hierarchy level 1. This field will always have the partner type S1 which indicates manufacturer.
supplierHierarchyLevel1	No	String (10)	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	No	String (6)	This field identifies partner type of supplier hierarchy level 2. This field will always have the partner type S2 which indicates distributor.
supplierHierarchyLevel2	No	String (10)	This field conatins 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	No	String (6)	This field identifies partner type of supplier hierarchy level 3. This field will always have the partner type S3 which indicates wholesaler.
supplierHierarchyLevel3	No	String (10)	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	No	Number(20,4)	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	No	Number(20,4)	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	No	Number(20,4)	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	No	Number(20,4)	This field will hold the tax exclusive cost of the item.
purchaseType	No	Number(1,0)	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	No	String (1)	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	No	Number(12,4)	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	No	String (1)	This field contains the pricing control of the item which will determine the item price is controlled by Retailer or Supplier. Valid value are R - Managed by Retailer, S - Managed by Supplier, NULL - For Owned Items
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
customFlexAttribute	No	Collection of Object	This List holds custom flex attributes for the item supplier's country record.
itemSupplierCountryDimension	No	Collection of Object	This List holds dimension attributes for the item supplier's country record.

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

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

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

Element Name	Required	Data Type	Description
countryId	No	String (3)	This field holds country ID of manufacturer.
primaryInd	No	String (1)	This field indicates primary country of manufacturer indicator.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
uom	No	String (4)	This field holds unit of measure that the item is being measured in.
value	No	Number(20,4)	This field holds value of measure.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
languageCode	No	Number(6,0)	The code identifying the language.
languageName	No	String (120)	The display name of the language.
isoCode	No	String (6)	The ISO code of the language.
supplierDiff1	No	String (120)	This field contains the first supplier differentiator and/or description.
supplierDiff2	No	String (120)	This field contains the second supplier differentiator and/or description.
supplierDiff3	No	String (120)	This field contains the third supplier differentiator and/or description.
supplierDiff4	No	String (120)	This field contains the fourth supplier differentiator and/or description.
supplierLabel	No	String (15)	The translated supplier label for the item.
createDateTime	No	dateTime	The creation date/time of the translation record.
updateDateTime	No	dateTime	The last update date/time of the translation record.

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

Element Name	Required	Data Type	Description
udaLov	No	Collection of Object	This List attributes for the item's uda list of values.
udaFreeform	No	Collection of Object	This List holds attributes for the item's uda free form .
udaDate	No	Collection of Object	This List holds attributes for the item's uda date.

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

Element Name	Required	Data Type	Description
udaId	No	Number(5,0)	This field contains a number identifying the user-defined attribute.
udaDescription	No	String (120)	This field contains description of user-defined attribute.
udaValue	No	Number(5,0)	This field contains the unique identified of the Attribute Group being added or delete to the item list.
udaValueDescription	No	String (250)	This field contains the value of the Attribute Group.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
udaId	No	Number(5,0)	This field contains a number identifying the user-defined attribute.
udaDescription	No	String (120)	This field contains description of user-defined attribute.
udaText	No	String (250)	This field contains the text value of the user-defined attribute for the item.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
translation	No	Collection of Object	List of translations for UDA free form text.

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

Element Name	Required	Data Type	Description
languageCode	No	Number(6,0)	The code identifying the language.
languageName	No	String (120)	The display name of the language.
isoCode	No	String (6)	The ISO code of the language.
udaTextDesc	No	String (250)	The translated UDA text.
createDateTime	No	dateTime	The creation date/time of the translation record.
updateDateTime	No	dateTime	The last update date/time of the translation record.

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

Element Name	Required	Data Type	Description
udaId	No	Number(5,0)	This field contains a number identifying the user-defined attribute.
udaDescription	No	String (120)	This field contains description of user-defined attribute.
udaDate	No	date	This field contains the effective date for the UDA id.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
imageName	No	String (120)	This field specifies name of the image.
imageAddress	No	String (255)	This field specifies path where the image file is stored.
imageType	No	String (6)	This field contains the type of the image of the item. Valid values are defined as member of IITD code type.
primaryImageInd	No	String (1)	This field specifies display sequence order of images associated to the item per priority.
displayPriority	No	Number(4,0)	This field specifies display sequence order of images associated to the item per priority.
imageDescription	No	String (40)	This field contains the description associated with the image of the item.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
translation	No	Collection of Object	List of translations for Item Image

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

Element Name	Required	Data Type	Description
languageCode	No	Number(6,0)	The code identifying the language.
languageName	No	String (120)	The display name of the language.
isoCode	No	String (6)	The ISO code of the language.
imageDescription	No	String (40)	This field contains the translated description associated with the image of the item.
createDateTime	No	dateTime	The creation date/time of the translation record.
updateDateTime	No	dateTime	The last update date/time of the translation record.

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

Element Name	Required	Data Type	Description
seasonId	No	Number(3,0)	The season identifier.
phaseId	No	Number(3,0)	The phase identifier.
sequenceNo	No	Number(4,0)	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.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
referenceItem	No	String (25)	This field holds Unique identifier for the item.
primaryInd	No	String (1)	This field Indicates if 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'.
formatId	No	String (1)	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	No	Number(2,0)	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	No	String (6)	This field holds 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.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
componentItem	No	String (25)	This field specifies unique identifier for the component item.
packQuantity	No	Number(12,4)	This field specifies contains the quantity of each item in the pack item.

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

Element Name	Required	Data Type	Description
ticketOverPercentage	No	Number
printOnPcInd	No	String
ticketTypeId	No	String (4)	This field uniquely identifies the ticket type which is associated with the item.
ticketTypeDescription	No	String (120)	This field contains a description of the ticket or label type.
shelfEdgeLabelInd	No	String (1)	This field contains a description of the ticket or label type.
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. Valid values are: A and R.
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 in this field are:Y - Yes 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. 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	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
details	No	Collection of Object	This List holds attributes for the item ticket details.

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

Element Name	Required	Data Type	Description
ticketItemId	No	String (4)	This field contains a character string which uniquely identifies an attribute which will appear on a ticket or label such as retail price or price per unit of measure.
ticketItemIdDescription	No	String (250)	This field contains the description of the ticket_item_id.
udaId	No	Number(5,0)	This field contains a number which uniquely defines a user-defined attribute which is to be printed on this ticket type.
sequenceNo	No	Number(4,0)	This field contains sequence number of item's ticket record.

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

Element Name	Required	Data Type	Description
relationshipId	No	Number(20,0)	A system generated numeric field that uniquely identifies the relationship record in related_item_head table.
relationshipName	No	String (255)	This field holds user entered name of the relationshipe.
relationshipType	No	String (6)	This field holds user entered name of the relationshipe.
mandatoryInd	No	String (1)	Indicates whether the relationship is mandatory or not. Valid values: 'Y' (yes), 'N' (no).
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
translation	No	Collection of Object	This List holds translation attributes for the relationship.
details	No	Collection of Object	This List holds attributes for the related item details.

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

Element Name	Required	Data Type	Description
languageCode	No	Number(6,0)	This field contains the language in which the translated text is maintained
languageName	No	String (120)	This field contains description of language code in which the translated text is maintained
isoCode	No	String (6)	This field will hold the ISO code associated with the given language.
relationshipName	No	String (255)	This field holds the translated value of the relationship name
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

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

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

Element Name	Required	Data Type	Description
hts	No	String (25)	The unique identifier for the Harmonized Tariff Schedule code.
importCountry	No	String (3)	The unique identifier for the country that the item will be imported into.
originCountry	No	String (3)	The country where the item was manufactured or significantly altered.
effectFrom	No	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	No	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 (for example, zones within the country where the goods are clearing customs). No locations or cost zones are associated to a clearing zone. 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.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.
assessments	No	Collection of Object	References a collection of assessments associated to the item HTS.

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

Element Name	Required	Data Type	Description
componentId	No	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.
componentCurrency	No	String (3)	This field contains component currency.
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.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
supplier	No	Number(10,0)	The unique identifier for the supplier.
countryOfSourcing	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.
dischargePort	No	String (5)	The port where the item will enter the importing country.
costZoneGroupId	No	Number(4,0)	This field holds the items Zone Group, it is stored here for performance reasons.
costZoneId	No	Number(10,0)	The final destination zone of the item if the Expense Type is Zone.
baseExpenseInd	No	String (1)	This field indicates whether or not this Set of Expenses is also the base Set of Expenses.
componentId	No	String (10)	The code representing the specific expense component.
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.
estimatedExpenseValue	No	Number(26,10)	This field contains the calculated value of the Component.
componentCurrency	No	String (3)	This field contains the currency the expense is to be entered in. If the Calculation Basis is V (Value), then the comp_currency will be NULL.
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.
createDateTime	No	dateTime	This field holds the record creation date.
updateDateTime	No	dateTime	This field holds the date when the record was last updated.

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

Element Name	Required	Data Type	Description
documentId	No	Number(6,0)	This field contains documents of the items.

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

Element Name	Required	Data Type	Description
importDescription	No	String (2000)	This field contains description of the item used for importing purposes..
commodity	No	String (6)	This field contains the code used to classify the item by their type of merchandise.
tooling	No	Number(20,4)	This field contains the cost associated with a given Tooling/Assist charge.
firstOrderIndicator	No	String (1)	This field contains indicator to determine if duty is to be paid on the total value of the tooling expense the first time the item is shipped
amortizeBase	No	Number(12,4)	This field contains the number of units over which the tooling/assist cost will be amortized.
openBalance	No	Number(12,4)	This field contains the open balance of the number of units yet to be received over which the tooling costs will be amortized.
createDateTime	No	dateTime	This field holds the record creation date.

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

Element Name	Required	Data Type	Description
href	No	String	Service URL
rel	No	String	This can be either 'self' or 'next'. The 'next' link is present if there are more pages to fetch and contains the offsetkey which uniquely identifies the last record of this response.

Sample Response Message

{
"items": [
{
"action": "INSERT",
"longtDescription": "String",
"item": "100100076",
"itemNumberType": "MANL",
"status": "A",
"itemLevel": 1,
"tranLevel": 1,
"itemDescription": "Regular Item 100100076",
"shortDescription": "100100076 Item",
"itemDescriptionUppercase": "100100076 ITEM REGULAR",
"itemDescriptionSecondary": "100100076 Item Regular",
"longDescription": null,
"itemParent": null,
"itemGrandparent": null,
"sellableInd": "Y",
"orderableInd": "Y",
"inventoryInd": "Y",
"packInd": "Y",
"simplePackInd": "N",
"containsInnerInd": "N",
"dept": 3041,
"deptName": null,
"class": 1.0,
"className": null,
"uniqueClassId": 1,
"subclass": 1,
"subclassName": null,
"uniqueSubclassId": 1,
"unitRetail": 1.0,
"variableUpcFormatId": null,
"variableWeightUpcPrefix": 1,
"diff1": null,
"diff1Type": null,
"diff2": null,
"diff2Type": null,
"diff3": null,
"diff3Type": null,
"diff4": null,
"diff4Type": null,
"costZoneGroupId": 1000,
"standardUom": "EA",
"uomConversionFactor": 3,
"packageSize": 1.0,
"packageUom": null,
"merchandiseInd": "Y",
"storeOrderMultiple": "E",
"forecastInd": null,
"manufacturerRecommendedRetail": 12.99,
"manufacturerRetailCurrencyCode": "USD",
"originalRetail": 12.99,
"originalRetailCurrencyCode": "USD",
"retailLabelType": null,
"retailLabelTypeDescription": null,
"retailLabelValue": 1.0,
"handlingTemperature": null,
"handlingTemperatureDescription": null,
"handlingSensitivity": null,
"handlingSensitivityDescription": null,
"catchWeightInd": "Y",
"catchWeightType": null,
"catchWeightUom": "EA",
"orderType": null,
"saleType": null,
"wasteType": null,
"wasteTypeDescription": null,
"averageWastePercentage": 1.0,
"defaultWastePercentage": 1.0,
"constantDimensionInd": "Y",
"packType": null,
"orderAsType": null,
"comments": null,
"itemServiceLevel": null,
"giftWrapInd": "Y",
"shipAloneInd": "Y",
"brandName": null,
"brandDescription": null,
"perishableInd": "Y",
"itemTransformInd": "N",
"depositItemType": null,
"containerItem": null,
"depositInPricePerUom": null,
"storePackInventoryInd": "Y",
"sohInquiryAtPackInd": "Y",
"purchaseType": null,
"productClassification": null,
"productClassificationDescription": null,
"itemAggregateInd": "Y",
"diff1AggregateInd": "Y",
"diff2AggregateInd": "Y",
"diff3AggregateInd": "Y",
"diff4AggregateInd": "Y",
"diff1Level": null,
"diff1Description": null,
"diff2Level": null,
"diff2Description": null,
"diff3Level": null,
"diff3Description": null,
"diff4Level": null,
"diff4Description": null,
"primaryImageUrl": null,
"transferAllocUpChargeSourceType": "D",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"customFlexAttribute": [
{
"name": "attribute1",
"value": "value1",
"valueDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"itemTranslation": [
{
"languageCode": 2,
"languageName": null,
"isoCode": "en-US",
"itemDescription": "itemDesc",
"itemDescriptionSecondary": "itemDescSecondary",
"shortDescription": "shortDesc",
"longDescription": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"itemSupplier": [
{
"supplier": 2400,
"primarySupplierInd": "Y",
"vpn": null,
"supplierLabel": null,
"consignmentRate": 3,
"supplierDiff1": null,
"supplierDiff2": null,
"supplierDiff3": null,
"supplierDiff4": null,
"palletName": "PAL",
"caseName": "CS",
"innerName": "INR",
"supplierDiscontinueDate": "2001-12-31",
"directShipInd": "Y",
"primaryCaseSize": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"customFlexAttribute": [
{
"name": "attribute1",
"value": "value1",
"valueDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"itemSupplierCountry": [
{
"originCountry": null,
"primarySupplierInd": null,
"primaryCountryInd": "Y",
"unitCost": 9.65,
"leadTime": 1,
"pickupLeadTime": 1,
"supplierPackSize": 1,
"innerPackSize": 1,
"roundLevel": "C",
"minimumOrderQuantity": 1.0,
"maximumOrderQuantity": 1,
"packingMethod": "HANG",
"defaultUop": null,
"ti": 1,
"hi": 1,
"costUom": "EA",
"toleranceType": null,
"maximumTolerance": 1.0,
"minimumTolerance": 1.0,
"roundToInnerPercentage": 50,
"roundToCasePercentage": 50,
"roundToLayerPercentage": 50,
"roundToPalletPercentage": 50,
"supplierHierarchyType1": null,
"supplierHierarchyLevel1": null,
"supplierHierarchyType2": null,
"supplierHierarchyLevel2": null,
"supplierHierarchyType3": null,
"supplierHierarchyLevel3": null,
"negotiatedItemCost": 1.0,
"extendedBaseCost": 1.0,
"inclusiveCost": 1.0,
"baseCost": 1.0,
"purchaseType": 0,
"calculationBasis": null,
"purchaseRate": 1.0,
"pricingControl": "R",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"customFlexAttribute": [
{
"name": "attribute1",
"value": "value1",
"valueDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"itemSupplierCountryDimension": [
{
"dimensionObject": null,
"dimensionObjectDescription": null,
"presentationMethod": null,
"presentationMethodDescription": null,
"length": 1.0,
"width": 1.0,
"height": 1.0,
"lwhUom": null,
"weight": 1.0,
"netWeight": 1.0,
"weightUom": null,
"liquidVolume": 1.0,
"liquidVolumeUom": null,
"statisticalCase": 1.0,
"tareWeight": 1.0,
"tareType": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"itemSupplierCountryOfManufacture": [
{
"countryId": "BR",
"primaryInd": "N",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"itemSupplierUom": [
{
"uom": null,
"value": 1.0,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"translation": [
{
"languageCode": 2,
"languageName": null,
"isoCode": "en-US",
"supplierDiff1": null,
"supplierDiff2": null,
"supplierDiff3": null,
"supplierDiff4": null,
"supplierLabel": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"itemUda": {
"udaLov": [
{
"udaId": 1,
"udaDescription": null,
"udaValue": 1,
"udaValueDescription": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"udaFreeform": [
{
"udaId": 1,
"udaDescription": null,
"udaText": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"translation": [
{
"languageCode": 2,
"languageName": null,
"isoCode": "en-US",
"udaTextDesc": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"udaDate": [
{
"udaId": 1,
"udaDescription": null,
"udaDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
},
"itemImage": [
{
"imageName": "imageName1",
"imageAddress": "http://www.oracle.com/",
"imageType": "T",
"primaryImageInd": "Y",
"displayPriority": 1,
"imageDescription": "imageDesc1",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"translation": [
{
"languageCode": 2,
"languageName": null,
"isoCode": "en-US",
"imageDescription": "Item Image",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"itemSeason": [
{
"seasonId": 1,
"phaseId": 1,
"sequenceNo": 1,
"diffId": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"referenceItem": [
{
"referenceItem": null,
"primaryInd": "N",
"formatId": null,
"prefix": 1,
"itemNoType": "MANL",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"itemBOM": [
{
"componentItem": null,
"packQuantity": 1.0
}
],
"itemTicket": [
{
"ticketOverPercentage": 1.0,
"printOnPcInd": "String",
"ticketTypeId": null,
"ticketTypeDescription": null,
"shelfEdgeLabelInd": null,
"poPrintType": null,
"printOnPriceChangeInd": "Y",
"ticketOverPrintPercentage": 3,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"details": [
{
"ticketItemId": null,
"ticketItemIdDescription": null,
"udaId": 1,
"sequenceNo": 1
}
]
}
],
"relatedItem": [
{
"relationshipId": 1,
"relationshipName": null,
"relationshipType": null,
"mandatoryInd": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"translation": [
{
"languageCode": 2,
"languageName": null,
"isoCode": "en-US",
"relationshipName": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"details": [
{
"relatedItem": null,
"priority": 1,
"startDate": "2001-12-31",
"endDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"hts": [
{
"hts": null,
"importCountry": "US",
"originCountry": "US",
"effectFrom": "2001-12-31",
"effectTo": "2001-12-31",
"clearingZoneId": null,
"status": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"assessments": [
{
"componentId": null,
"computationValueBase": null,
"componentRate": 1.0,
"perCount": 1.0,
"perCountUom": null,
"estimatedAssessmentValue": 1.0,
"componentCurrency": null,
"nominationFlag1": null,
"inDuty": null,
"nominationFlag3": null,
"inExpense": null,
"inAlc": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"expense": [
{
"supplier": 2400,
"countryOfSourcing": "US",
"ladingPort": "7",
"dischargePort": "480",
"costZoneGroupId": 1,
"costZoneId": 1,
"baseExpenseInd": "N",
"componentId": "AGCOMM",
"computationValueBase": "TDTYUS",
"componentRate": 3.55,
"perCount": 3,
"perCountUom": "EA",
"estimatedExpenseValue": 1.0,
"componentCurrency": "USD",
"nominationFlag1": null,
"inDuty": null,
"nominationFlag3": null,
"inExpense": null,
"inAlc": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"requiredDocuments": [
{
"documentId": 1
}
],
"itemImportAttributes": [
{
"importDescription": "import desc",
"commodity": "A123",
"tooling": 12,
"firstOrderIndicator": "Y",
"amortizeBase": 12.4568,
"openBalance": 12.4568,
"createDateTime": "2001-12-31T23:59:59.000Z"
}
],
"cacheTimestamp": "2001-12-31T23:59:59.000Z",
"cacheCreateTimestamp": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1000,
"count": 1000,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000&since=1970-01-01T00:00:00.001Z&before=2024-01-01T00:00:00.001Z&offsetkey=1234,XYZ",
"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
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 Location Details

Endpoints

MerchIntegrations/services/foundation/item/location

Functional Area

Items - Item Definition

Business Overview

This service publishes item/location relationships to downstream consuming systems. It covers item/location combinations whose source view still resolves to a store, warehouse, or external finisher and whose item is currently in status A or D. The payload carries the location-specific selling, sourcing, replenishment, VAT, substitute-item, and custom-flex details that downstream commerce and inventory integrations use to interpret item behavior at a location.

This API follows a broader merged-cache pattern than the simpler single-entity publish services. The external foundation/item/location endpoint shares its cache and runtime configuration with foundation/omnichannel/item/itemlocation, and the GET-all query switches between the delta and full access paths based on whether the requested window is 30 days or less or greater than 30 days.

Technical Details

This service follows the Publish API cache architecture in which the REST service serves pre-generated JSON from an integration cache table that is initially seeded and then maintained through asynchronous delta processing. For overall enablement, scheduling, and guidance on how publish api works and how webhook for this api can be implemented to stream the data out, refer to the white paper Publish APIs - Customer Enablement Overview.

Core business tables: ITEM_LOC, ITEM_LOC_TRAITS, REPL_ITEM_LOC, SUB_ITEMS_HEAD, SUB_ITEMS_DETAIL

Additional business tables: ITEM_MASTER, ITEM_SUPP_COUNTRY, ITEM_SUPP_COUNTRY_LOC, VAT_ITEM, RELATED_ITEM_HEAD, SYSTEM_OPTIONS, UOM_CLASS, STORE, WH, PARTNER, ITEM_LOC_CFA_EXT

JSON cache table: MERCHAPI_ITEM_LOC

JSON generation view: V_MERCHAPI_ITEM_LOC_JSON

Builds the payload from ITEM_LOC, optional traits from ITEM_LOC_TRAITS, replenishment attributes from REPL_ITEM_LOC, item hierarchy and search attributes from ITEM_MASTER, supplier/country and location cost fields from ITEM_SUPP_COUNTRY and ITEM_SUPP_COUNTRY_LOC, custom flex attributes from MERCHAPI_EXT_ITEM_LOC_CFA, VAT data from VAT_ITEM, related-item flags from RELATED_ITEM_HEAD, and location enrichment from a loc CTE over STORE, WH, and PARTNER where PARTNER_TYPE = 'E'.

The source view is limited to item/location combinations whose item is currently in status A or D and whose location resolves to a store, warehouse, or external finisher.

The published payload carries the location-specific selling, sourcing, replenishment, VAT, substitute-item, and custom-flex details that downstream commerce and inventory integrations use to interpret item behavior at a location.

Initial Seeding and post enablement rebuild/repair

Initial seeding and rebuild use V_MERCHAPI_ITEM_LOC_JSON and apply ITEM_MASTER.STATUS IN ('A','D'); loc includes stores, warehouses, and partners with PARTNER.PARTNER_TYPE = 'E'.

Rebuild marks cache rows deleted when the item/location no longer exists in V_MERCHAPI_ITEM_LOC_JSON.

ICL (Integration Change Log) table: ICL_RMS_ITEM_LOC, ICL_RMS_REPL_ITEM_LOC (ICL consumer name = MERCHAPI_2)

ICL_RMS_ITEM_LOC is fed by triggers on ITEM_LOC, ITEM_LOC_TRAITS, ITEM_LOC_CFA_EXT, SUB_ITEMS_HEAD, SUB_ITEMS_DETAIL, and ownership-publish updates through OWNERSHIP_PUB_GTT.

ICL_RMS_REPL_ITEM_LOC rows are staged from REPL_ITEM_LOC and are republished as updates to the parent item-location payload.

Item Approval Handling

On item approval, the main item publish flow writes existing store and warehouse ITEM_LOC rows to ICL_RMS_ITEM_LOC so this API is also queued once the parent item becomes approved. ITEM_LOC rows are not backfilled through this path while the item remains in worksheet or submitted status.

Batch-driven bulk rebuild handling for specific events

Store VAT region change and warehouse VAT region change do not rely only on ICL staging. Those source events insert a record into MERCHAPI_ASYNC_REQUEST with REQUEST_TYPE = DATA_REFRESH, REFRESH_TYPE = REBUILD, and REQUEST_PARAMETERS set to the affected location so the rebuild stays scoped to that store or warehouse.

Tomorrow-effective VAT rate activation through VAT code-rate maintenance using batch job VATDLXPL and its prepost (post) can also insert a record into MERCHAPI_ASYNC_REQUEST with REQUEST_TYPE = DATA_REFRESH and REFRESH_TYPE = REBUILD when the VAT change can affect a broad item/location population. This broader rebuild path is handled through the Vat Rate Change Explode (VATDLXPL) flow as part of prepost.pc. Smaller tomorrow-effective item VAT changes are handled through targeted item/location delta staging instead of the broader rebuild path.

These requests are processed through MERCHAPI_DATA_REBUILD_ADHOC_PROCESS -> MERCHAPI_DATA_REBUILD_ADHOC_JOB and refresh the shared MERCHAPI_ITEM_LOC cache used by foundation/item/location and foundation/omnichannel/item/itemlocation.

Batch Configuration. Asynchronous delta processing is supported using Background engine and also via POM scheduling. Choose one.

Process configuration name: API_OMNI_ITEM_LOC

To enable via Background engine set BACKGROUND_RUN_FLAG to Y and review the BACKGROUND_RUN_INTERVAL_SECOND parameter.

POM Batch schedule process and job: MERCHAPI_DELTA_OMNI_ITEM_LOC_ADHOC_PROCESS -> MERCHAPI_OMNI_ITEM_LOC_ADHOC_JOB

Webhook configuration api name: foundation/item/location

Special handling

Additional GET query parameters: item, locationType, location, itemLocationStatus, purchaseType, tranLevelInd, itemNumberType, departmentId, classId, subclassId, inventoried, sellable, orderable, changeType.

The filters itemLocationStatus, purchaseType, tranLevelInd, itemNumberType, departmentId, classId, subclassId, inventoried, sellable, and orderable are not backed by dedicated cache-table indexes. At high volume, use them only as additional criteria on top of a small-window delta fetch and not for full downloads.

Performance Considerations

For customers expecting high to very high publish volume from this API, sizing and operational tuning should be addressed early in the implementation lifecycle. Initial cache seeding, ongoing delta processing, full extracts, and incremental downloads or webhook-driven delivery have different runtime characteristics and should be evaluated separately. Because this service builds a merged item-location cache from multiple base and supporting tables, the available configuration should be validated against the customer production item-location profile, with the key performance-related configuration for this service covering the following:

Multi-threading and commit control

This service supports multi-threaded execution for both initial seeding and delta processing. Thread count is controlled through API_NO_OF_THREADS, and commit sizing is controlled through API_COMMIT_MAX_COUNTER.

Thread and commit settings should be chosen together based on expected row volume, average message size, and the complex SQL query required to build the shared item-location cache from multiple base and supporting tables. Common starting points for large-volume (multi-millions) runs are 16 or 32 threads. Values of 48 or 64 threads should be considered only after testing and with awareness of competing workload in the environment.

API_COMMIT_MAX_COUNTER should be sized together with the thread setting. Typical values range from about 1,000 rows to 10,000.

For delta processing, the same parameters apply. It is advisable to reduce the thread values to 2 or 4 after the seeding is complete.

Dropping indexes and constraints during seeding

This option applies only to initial seeding, including truncate-and-load execution. When thread and commit settings are high, concurrent inserts can increase index maintenance overhead and slow the load.

To reduce that overhead, DROP_INDEX_ON_REFRESH can be enabled so indexes and constraints are dropped before seeding and rebuilt after the load completes. GATHER_STATS_ON_REFRESH should normally remain enabled unless testing shows a specific reason to change it.

REST fetch considerations

Item-location payloads can be comparatively large, so REST page size should be selected based on average message size so the average response remains below about 10 MB per call. Common page-limit values between 1,000 or 10,000 rows can be used.

For full downloads, do not provide the since query parameter so the database can favor the primary-key access path. For delta downloads, use a small time window, typically a few minutes and at most a few hours, so the eligible row set on the LAST_UPDATE_DATETIME index remains small.

Wider delta windows, especially multi-day windows that can arise during outages or data recovery, generally do not perform well. For such scenarios, keeping BUILD_HISTOGRAM enabled allows the service to support recovery through smaller, more selective polling windows using the optimalBefore query parameter.

In this catch-up pattern, for requests up to 30 days in the past, the client provides optimalBefore and leaves before empty. The client then uses the returned before timestamp to continue polling incrementally until the backlog is cleared, and then resumes the normal short-window delta pattern. Hourly histogram processing groups LAST_UPDATE_DATETIME values into buckets of 100,000 rows in MERCHAPI_TIMESTAMP_HISTOGRAM using API specific HISTOGRAM_ROW_COUNT configuration.

Handling Bulk Publish on VAT Rate change event or Store/Warehouse attribute change

This API also uses batch-driven REBUILD handling for store or warehouse VAT-region changes and broader VAT rate events that can materially increase the publish population.

Because the VAT effect must be recalculated for all affected items at affected locations, those changes can expand into a much larger item/location republish set.

A larger VAT code-rate change can result in a very large number of records being published to downstream systems and should be planned with the downstream performance implication of that message volume in mind.

Full-refresh workload balancing and monitoring

This API uses a different full-refresh balancing pattern than the simpler fixed-thread publish services because item/location volume is not evenly distributed by location. A smaller store can contribute only a limited number of rows while a larger store or warehouse can contribute millions, so the refresh balances work by item/location workload rather than by location number alone.

As processing continues, MERCHAPI_BOOKMARK can show newly active entries for individual locations created from that workload balancing while earlier entries complete, and the rebuild remains in progress as long as at least one MERCHAPI_BOOKMARK row is still active.

Service Type

GET

ReST URL

MerchIntegrations/services/foundation/item/location

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date (Example: 2010-12-31T23:59:59.999Z)
before	No	String	Before Date (Example: 2040-12-31T23:59:59.999Z)
item	No	String	Item
locationType	No	String	Location Type - STORE, WAREHOUSE or EXTERNAL_FINISHER
location	No	String (10)	Location
itemLocationStatus	No	String	Item Location Status - A, I, C or D
purchaseType	No	String	Purchase Type - 0, 1 or 2
tranLevelInd	No	String	Transaction Level Indicator - Y or N
itemNumberType	No	String	Item Type
departmentId	No	String (4)	Department
classId	No	String (4)	Class
subclassId	No	String (4)	Subclass
inventoried	No	String	Inventoried - Y or N
sellable	No	String	Sellable - Y or N
orderable	No	String	Orderable - Y or N
offsetkey	No	String	Offset key ([location type],[location],[item] Example: S,120091,Item-35)
limit	No	String (6)	Pagination limit. Default value is 1000.
changeType	No	String	Filter records that were created or deleted within since/before time range. Valid values create or delete
optimalBefore	No	String	Enables histogram-based calculation of the before timestamp when before is not provided. Valid values are Y or N. Default value is N.
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

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

Element Name	Required	Data Type	Description
items	No	Collection of Object	Collection of records
hasMore	No	Boolean	Boolean to signify if there are additional pages of data. This is true if limit = count for pagination supported request
limit	No	Number	Requested page size. If the page size was not defined in the input request, a default page size is used to limit the number of records to fetch
count	No	Number	Number of record in the response object
links	No	Collection of Object	List of Self and/or Next URL

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

Element Name	Required	Data Type	Description
action	No	String (6)	Action for item-location details.
item	No	String (25)	This field specifies the unique alphanumeric value that identifies the item.
itemLevel	No	Number(1,0)	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	No	Number(1,0)	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	No	Number(10,0)	This field contains the numeric identifier of the location in which the item is to be found. This field may contain a store, warehouse, or external finisher.
locationType	No	String (1)	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	No	String (1)	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	No	Number(10,0)	This field contains the numeric identifier of the physical warehouse in which the item is to be found.
storeType	No	String (6)	This field indicates whether a particular store is a franchise or company store.
stockholdingInd	No	String (1)	This field indicates whether or not the location can hold stock.
localItemDescription	No	String (250)	This field specifies selling local description of the item. This field will default to the item's description but will be over-ridable. This value will be downloaded to the POS.
localShortDescription	No	String (120)	Contains the local short description of the item. This field will default to the item's short description but will be over-ridable. This value will be downloaded to the POS.
primarySupplier	No	Number(10,0)	This field contains the primary supplier of the item at the location.
primaryCountry	No	String (3)	This field contains the primary country of the item at the location.
unitCost	No	Number(20,4)	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	No	String (4)	A cost UOM is held to allow costs to be managed in a separate UOM than the standard UOM.
purchaseType	No	Number(1,0)	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	No	String (1)	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	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 field contains the pricing control of the item which will determine whether the item price is controlled by the retailer or supplier. Valid values are R - Managed by Retailer, S - Managed by Supplier, NULL - For Owned Items.
receiveAsType	No	String (1)	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	No	String (1)	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	No	String (1)	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 does not 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	No	Number(10,0)	This field will be used by the ad-hoc PO/Transfer creation process to determine which warehouse to fill the store's 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	No	Number(20,4)	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	No	Number(20,4)	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	No	String (4)	This field contains the selling unit of measure for an item's single-unit retail.
storePriceInd	No	String (1)	This field indicates if an item at a particular store location can have the unit retail marked down by the store.
uinType	No	String (6)	This field contains the unique identification number (UIN) used to identify the instances of the item at the location.
uinLabel	No	String (6)	This field contains the label for the UIN when displayed in the store system.
captureTime	No	String (6)	This field indicates when the UIN should be captured for an item during transaction processing.
externalUinInd	No	String (1)	This Yes/No indicator indicates if UIN is being generated in the external system.
rangedInd	No	String (1)	This field determines if the location is ranged intentionally by the user for replenishment/selling or incidentally ranged by the Merchandising programs when the item is not ranged to a specific location on the transaction.
itemParent	No	String (25)	This field contains the alphanumeric value that uniquely identifies the item/group at the level above the item.
itemGrandparent	No	String (25)	This field contains the alphanumeric value that uniquely identifies the item/group two levels above the item.
ti	No	Number(12,4)	This field contains the number of shipping units (cases) that make up one tier of a pallet. Multiply TI x HI to get the total number of cases for a pallet.
hi	No	Number(12,4)	This field contains the number of tiers that make up a complete pallet (height). Multiply TI x HI to get the total number of cases for a pallet.
storeOrderMultiple	No	String (1)	This field contains the multiple in which the item needs to be shipped from a warehouse to the location.
dailyWastePercent	No	Number(12,4)	This field contains the average percentage lost from inventory on a daily basis due to natural wastage.
measureOfEach	No	Number(12,4)	This field contains the size of an each in terms of the uom_of_price. For example, 12 oz. Used in ticketing.
measureOfPrice	No	Number(12,4)	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	No	String (4)	This field contains the 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. 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-transaction-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	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,0)	This field indicates the number of inbound handling days for an item at a warehouse type location.
regularUnitRetail	No	Number(20,4)	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	No	Number(12,4)	This field contains the multi-units for the item/location (zone) combination.
multiUnitRetail	No	Number(20,4)	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	No	String (4)	This field holds the selling unit of measure for this item/location (zone) combination's multi-unit retail.
clearanceInd	No	String (1)	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	No	Number(10,0)	This field contains the identifier of the costing location for the franchise store. This field may contain a store or a warehouse.
costingLocationType	No	String (1)	This field holds the type of costing location in the costing location field.
currencyCode	No	String (3)	This field contains the currency code under which the location operates.
pickupLeadTime	No	Number(4,0)	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	No	String (1)	This field allows the retailer to specify if the item should be RFID tagged or not.
primaryReplenishmentSupplier	No	Number(10,0)	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	No	String (6)	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	No	String (1)	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	No	date	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 Thursday's date.
multipleReplenishmentsPerDayInd	No	String (1)	This field indicates if an item can be replenished multiple times per day at the location. Default value is N.
launchDate	No	date	This field holds the date that the item should first be sold at the location. This value will be downloaded to the POS.
quantityKeyOptions	No	String (6)	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	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 or removed as needed. This value will be downloaded to the POS.
depositCode	No	String (6)	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	No	String (1)	This field indicates whether the item is approved for food stamps at the location. This value will be downloaded to the POS.
wicInd	No	String (1)	This field indicates whether the item is approved for WIC at the location. This value will be downloaded to the POS.
proportionalTarePercent	No	Number(12,4)	This field holds the value associated with 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 proportion 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	No	Number(12,4)	This field holds the value associated with the packaging in items sold by weight at the location. Fixed tare is the tare of the packaging used (i.e. if the tare item is bulk candy, this is the 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	No	String (4)	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	No	String (1)	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	No	String (25)	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	No	String (6)	This field contains the return policy for the item at the location.
stopSaleInd	No	String (1)	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	No	String (6)	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	No	String (6)	This field contains the code to determine which reports the location should run. Valid values are defined in the code type REPC. Values may be added and removed as necessary. This field is not required. No Merchandising processing is based on the value in this field. It is the client's responsibility to communicate this value to external systems that may need it for processing.
requiredShelfLifeOnSelection	No	Number(4,0)	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 the client's responsibility to communicate this value to external systems that may need it for processing.
requiredShelfLifeOnReceipt	No	Number(4,0)	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 the client's responsibility to communicate this value to external systems that may need it for processing.
storeReorderableInd	No	String (1)	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 the client's responsibility to communicate this value to external systems that may need it for processing.
rackSize	No	String (6)	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 the client's responsibility to communicate this value to external systems that may need it for processing.
fullPalletItem	No	String (1)	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. No Merchandising processing is based on the value in this field. It is the client's responsibility to communicate this value to external systems that may need it for processing.
inStoreMarketBasket	No	String (6)	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 the client's responsibility to communicate this value to external systems that may need it for processing.
storageLocation	No	String (7)	This field 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 the client's responsibility to communicate this value to external systems that may need it for processing.
alternateStorageLocation	No	String (7)	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 the client's responsibility to communicate this value to external systems that may need it for processing.
returnableInd	No	String (1)	This field contains a value of Yes when the item can be returned to the location.
refundableInd	No	String (1)	This field contains a value of Yes when the item is refundable at the location.
backOrderInd	No	String (1)	This field contains a value of Yes when the item can be back ordered to the location.
promotableInd	No	String (1)	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	No	dateTime	This field holds the record creation date and time.
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated.
customFlexAttribute	No	Collection of Object	This List holds custom flex attributes for the item-location.
cacheTimestamp	No	dateTime	This field specifies the date and time when the item-location record was last maintained.
cacheCreateTimestamp	No	dateTime	This field specifies the date and time when the record was first created for web service publication.

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

Element Name	Required	Data Type	Description
name	No	String (30)	This field holds the custom flex attribute name.
value	No	String (250)	This field holds the numeric or character value of the custom flex attribute.
valueDate	No	date	This field holds the date value of the custom flex attribute.
createDateTime	No	dateTime	This field holds the date and time when the custom flex attribute was created (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the custom flex attribute was last updated (UTC).

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

Element Name	Required	Data Type	Description
href	No	String	Service URL
rel	No	String	This can be either 'self' or 'next'. The 'next' link is present if there are more pages to fetch and contains the offsetkey which uniquely identifies the last record of this response.

Sample Response Message

{
"items": [
{
"action": "INSERT",
"item": "100100076",
"itemLevel": 1,
"tranLevel": 1,
"location": 1,
"locationType": null,
"status": null,
"physicalWarehouse": 1,
"storeType": null,
"stockholdingInd": null,
"localItemDescription": "localItemDesc",
"localShortDescription": "localShortDesc",
"primarySupplier": 2400,
"primaryCountry": null,
"unitCost": 9.65,
"costUom": "EA",
"purchaseType": 1,
"calculationBasis": null,
"purchaseRate": 3,
"pricingControl": "R",
"receiveAsType": null,
"taxableInd": "Y",
"sourceMethod": null,
"sourceWarehouse": 1,
"unitRetail": 1.0,
"sellingUnitRetail": 1.0,
"sellingUom": null,
"storePriceInd": null,
"uinType": null,
"uinLabel": null,
"captureTime": null,
"externalUinInd": "Y",
"rangedInd": "Y",
"itemParent": null,
"itemGrandparent": null,
"ti": 3,
"hi": 3,
"storeOrderMultiple": null,
"dailyWastePercent": 3,
"measureOfEach": 2,
"measureOfPrice": 1,
"uomOfPrice": "EA",
"primaryVariant": "100100090",
"primaryCostPack": "100100080",
"inboundHandlingDays": 1,
"regularUnitRetail": 1.0,
"multiUnits": 1.0,
"multiUnitRetail": 1.0,
"multiSellingUom": null,
"clearanceInd": null,
"costingLocation": 199,
"costingLocationType": null,
"currencyCode": null,
"pickupLeadTime": 1,
"rfidInd": "Y",
"primaryReplenishmentSupplier": 1,
"replenishmentMethod": null,
"rejectStoreOrderInd": null,
"nextDeliveryDate": "2001-12-31",
"multipleReplenishmentsPerDayInd": null,
"launchDate": "2001-12-31",
"quantityKeyOptions": null,
"manualPriceEntry": null,
"depositCode": null,
"foodStampInd": "Y",
"wicInd": "Y",
"proportionalTarePercent": 3,
"fixedTareValue": 3,
"fixedTareUom": "EA",
"rewardEligibleInd": "Y",
"nationalBrandCompetitorItem": null,
"returnPolicy": null,
"stopSaleInd": "Y",
"electronicMarketClubs": null,
"reportCode": null,
"requiredShelfLifeOnSelection": 1,
"requiredShelfLifeOnReceipt": 1,
"storeReorderableInd": "Y",
"rackSize": null,
"fullPalletItem": null,
"inStoreMarketBasket": null,
"storageLocation": null,
"alternateStorageLocation": null,
"returnableInd": "Y",
"refundableInd": "Y",
"backOrderInd": "Y",
"promotableInd": "Y",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"customFlexAttribute": [
{
"name": "attribute1",
"value": "value1",
"valueDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"cacheTimestamp": "2001-12-31T23:59:59.000Z",
"cacheCreateTimestamp": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1000,
"count": 1000,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000&since=1970-01-01T00:00:00.001Z&before=2024-01-01T00:00:00.001Z&offsetkey=1234,XYZ",
"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
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 Location Basic Details

Functional Area

Items

Business Overview

Retrieves basic item-location details for the specified items and locations. Provide a comma-separated list of up to 10 item IDs and a comma-separated list of up to 10 location IDs. The service returns the matching records from ITEM_LOC table. If no matching item-location combinations are found, the request succeeds and the response contains no records.

Service Type

GET

ReST URL

RmsReSTServices/services/private/Item/itemLocationDetail

Input Parameters

Parameter Name	Required	Data Type	Description
items	Yes	String	Up to 10 comma-separated item IDs. No whitespace.
locations	Yes	String	Up to 10 comma-separated numeric location IDs. No whitespace.

Response Code: 200 (Success)

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

Element Name	Required	Data Type	Description
item	No	String (25)	Unique alphanumeric value that identifies the item.
location	No	Number(10,0)	Numeric identifier of the location where the item is ranged. The location can be a store, warehouse, or external finisher.
locationType	No	String (1)	Type of location in the location field. Valid values are S (Store), W (Warehouse), and E (External Finisher).
status	No	String (1)	Current status of the item at the location. Valid values are A (Active), I (Inactive), C (Discontinued), and D (Deleted).
unitRetail	No	Number(20,4)	Unit retail price for the item-location combination in the standard unit of measure. The value is stored in the local currency.
sellingUnitRetail	No	Number(20,4)	Unit retail price for the item-location combination in the selling unit of measure. The value is stored in the local currency.
sellingUom	No	String (4)	Selling unit of measure used for the item's single-unit retail.
clearanceInd	No	String (1)	Indicates whether the item is on clearance at the location. Valid values are Y (Yes) and N (No).
localItemDescription	No	String (250)	Local description of the item. This value defaults to the item description and can be overridden for the location.

Sample Response Message

[
{
"item": "211001211",
"location": 10000089,
"locationType": "S",
"status": "A",
"unitRetail": 19.95,
"sellingUnitRetail": 19.95,
"sellingUom": "EA",
"clearanceInd": "N",
"localItemDescription": "Graphic T-shirt - Red"
}
]

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.

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"
}
]
}

Get Item VAT Details

Endpoints

MerchIntegrations/services/foundation/item/vat

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

Functional Area

Items - Item Definition

Business Overview

This service publishes item VAT data to downstream consuming systems. The payload includes the item, VAT region, active date, VAT type, VAT code, VAT rate, reverse-VAT indicator, and audit timestamps. Functionally, the JSON view publishes only approved transaction-level items because it requires ITEM_MASTER.STATUS = 'A' and ITEM_MASTER.ITEM_LEVEL = ITEM_MASTER.TRAN_LEVEL.

Technical Details

This service follows the Publish API cache architecture in which the REST service serves pre-generated JSON from an integration cache table that is initially seeded and then maintained through asynchronous delta processing. For overall enablement, scheduling, and guidance on how publish api works and how webhook for this api can be implemented to stream the data out, refer to the white paper Publish APIs - Customer Enablement Overview.

Core business tables: VAT_ITEM, ITEM_MASTER

Additional business tables: none

JSON cache table: MERCHAPI_EXT_ITEM_VAT

JSON generation view: V_MERCHAPI_EXT_ITEM_VAT_JSON

The JSON view is built from VAT_ITEM joined to ITEM_MASTER, and it publishes the item key, VAT region, active date, VAT type, VAT code, VAT rate, reverse-VAT indicator, and audit timestamps.

The view only publishes rows where the item is approved and transaction-level because it requires ITEM_MASTER.STATUS = 'A' and ITEM_MASTER.ITEM_LEVEL = ITEM_MASTER.TRAN_LEVEL.

Initial refresh supports both truncate-and-load and rebuild behavior, and rebuild marks cache rows deleted when an item no longer resolves in the JSON view.

Initial Seeding and post enablement rebuild/repair

Initial seeding and rebuild use V_MERCHAPI_EXT_ITEM_VAT_JSON and apply ITEM_MASTER.STATUS = 'A' and ITEM_MASTER.ITEM_LEVEL = ITEM_MASTER.TRAN_LEVEL.

Mark cache rows deleted when the item no longer exists in V_MERCHAPI_EXT_ITEM_VAT_JSON for the current thread.

ICL (Integration Change Log) table: ICL_RMS_VAT_ITEM (ICL consumer name = MERCHAPI)

ICL entries are created using triggers on VAT_ITEM, ITEM_MASTER.

Item Approval Handling

On item approval, the main item publish flow writes existing VAT_ITEM rows for the item to ICL_RMS_VAT_ITEM so this API is also queued when the item becomes approved. VAT rows are not staged through this path while the item remains in worksheet or submitted status.

Batch Configuration. Asynchronous delta processing is supported using Background engine and also via POM scheduling. Choose one.

Process configuration name: API_EXT_ITEM_VAT

To enable via Background engine set BACKGROUND_RUN_FLAG to Y and review the BACKGROUND_RUN_INTERVAL_SECOND parameter.

POM Batch schedule process and job: MERCHAPI_DELTA_EXT_ITEM_VAT_ADHOC_PROCESS -> MERCHAPI_EXT_ITEM_VAT_ADHOC_JOB

Webhook configuration api name: foundation/item/vat

Special handling

Additional GET query parameters: item, vatRegion, activeDate, vatType.

Performance Considerations

For customers expecting high to very high publish volume from this API, sizing and operational tuning should be addressed early in the implementation lifecycle. Initial cache seeding, ongoing delta processing, full extracts, and incremental downloads or webhook-driven delivery have different runtime characteristics and should be evaluated separately. The available configuration for this service should therefore be reviewed and validated against the customer production data profile, including expected volume, message size, and access pattern, with the key performance-related configuration for this service covering the following:

Multi-threading and commit control

This service supports multi-threaded execution for initial seeding, while delta processing remains single-threaded. Initial-seeding thread count is controlled through API_REFRESH_OVERRIDE_NO_OF_THREADS, and initial-seeding commit sizing is controlled through API_REFRESH_OVERRIDE_COMMIT_MAX_COUNTER.

For initial seeding, thread and commit settings should be chosen together based on expected row volume, average message size, and the simpler VAT_ITEM and ITEM_MASTER join used to build the payload. Common starting points for large-volume seeding are 8, 16, or 32 threads. The delivered refresh override is currently 4 threads.

Refresh commit sizing should be reviewed together with the thread setting. Typical values can range from 1,000 rows or higher values such as 10,000. The delivered refresh override commit setting is currently 5000.

Dropping indexes and constraints during seeding

This option applies only to initial seeding, including truncate-and-load execution. Even with refresh-override threading, larger parallel insert volumes can increase index maintenance overhead and slow the load.

To reduce that overhead, DROP_INDEX_ON_REFRESH can be enabled so indexes and constraints are dropped before seeding and rebuilt after the load completes.

This can improve data-load throughput, but the overall refresh plan should also account for the additional time needed for index rebuild after the seeding step finishes. GATHER_STATS_ON_REFRESH should normally remain enabled unless testing shows a need to change it.

REST fetch considerations

Because the payload is relatively narrow, larger page-limit values are often practical after testing. REST page size should still be selected so that the average response remains below about 10 MB per call, using common page-limit values such as 1,000, 5,000, or 10,000 rows.

For full downloads, do not provide the since query parameter so the database can favor the primary-key access path. For delta downloads, use a small time window, typically a few minutes and at most a few hours, so the eligible row set on the LAST_UPDATE_DATETIME index remains small.

Wider delta windows, especially multi-day windows that can arise during outages or data recovery, generally do not perform well. For such scenarios, keeping BUILD_HISTOGRAM enabled allows the service to support recovery through smaller, more selective polling windows using the optimalBefore query parameter.

In this catch-up pattern, for requests up to 30 days in the past, the client provides optimalBefore and leaves before empty. The client then uses the returned before timestamp to continue polling incrementally until the backlog is cleared, and then resumes the normal short-window delta pattern. Hourly histogram processing groups LAST_UPDATE_DATETIME values into buckets of 10,000 rows in MERCHAPI_TIMESTAMP_HISTOGRAM using the shared HISTOGRAM_ROW_COUNT configuration.

Service Type

GET

ReST URL

MerchIntegrations/services/foundation/item/vat

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

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date (Example: 2010-12-31T23:59:59.999Z)
before	No	String	Before Date (Example: 2040-12-31T23:59:59.999Z)
item	No	String	Item
vatRegion	No	String (4)	VAT Region
activeDate	No	String	Active Date format required: YYYY-MM-DD
vatType	No	String	VAT Type
offsetkey	No	String	Offset key ([item],[vat region],[active date],[vat type] Example: Cross_1001,1000,2020-10-22,R)
limit	No	String (6)	Pagination limit. Default value is 1000.
optimalBefore	No	String	Enables histogram-based calculation of the before timestamp when before is not provided. Valid values are Y or N. Default value is N.
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-517 Input Parameter for "MerchIntegrations/services/foundation/item/vat/{item}"

Parameter Name	Required	Data Type	Description
item	Yes	String
offsetkey	No	String	Offset key ([item],[vat region],[active date],[vat type] Example: Cross_1001,1000,2020-10-22,R)
limit	No	String (6)	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

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

Element Name	Required	Data Type	Description
items	No	Collection of Object	Collection of records
hasMore	No	Boolean	Boolean to signify if there are additional pages of data. This is true if limit = count for pagination supported request
limit	No	Number	Requested page size. If the page size was not defined in the input request, a default page size is used to limit the number of records to fetch
count	No	Number	Number of record in the response object
links	No	Collection of Object	List of Self and/or Next URL

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

Element Name	Required	Data Type	Description
action	No	String (6)	Action for item VAT details.
item	No	String (25)	This field contains the unique number that identifies an item.
vatRegion	No	Number(4,0)	This field contains the number of the Value Added Tax region a location belongs to.
activeDate	No	date	This field contains the date that the VAT rate became active for the item/VAT region combination.
vatType	No	String (1)	This field indicates the type of VAT. Valid values include R (Retail), C (Cost), B (Both).
vatCode	No	String (6)	This field contains the alphanumeric identification for the VAT code.
vatRate	No	Number(20,10)	This field contains the VAT rate for the item/location.
reverseVatInd	No	String (1)	This field indicates if the item is subject to reverse charge VAT at the VAT region. Valid values are Y and N.
createDateTime	No	dateTime	This field holds the record creation date and time.
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated.
cacheTimestamp	No	dateTime	This field specifies the date and time when the item VAT record was fetched into the cache for web service publication (UTC).
cacheCreateTimestamp	No	dateTime	This field specifies the date and time when the record was first created for web service publication (UTC).

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

Element Name	Required	Data Type	Description
href	No	String	Service URL
rel	No	String	This can be either 'self' or 'next'. The 'next' link is present if there are more pages to fetch and contains the offsetkey which uniquely identifies the last record of this response.

Sample Response Message

{
"items": [
{
"action": "INSERT",
"item": "100100076",
"vatRegion": 1000,
"activeDate": "2001-12-31",
"vatType": "R",
"vatCode": "S",
"vatRate": 1.0,
"reverseVatInd": "N",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"cacheTimestamp": "2001-12-31T23:59:59.000Z",
"cacheCreateTimestamp": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1000,
"count": 1000,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000&since=1970-01-01T00:00:00.001Z&before=2024-01-01T00:00:00.001Z&offsetkey=1234,XYZ",
"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
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-521 /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-522 /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 that affect costs are in-progress.

Input Payload Details

Table 5-523 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-524 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-525 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 that affect costs are in-progress.

Input Payload Details

Table 5-526 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-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.
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-528 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-529 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-530 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 that affect costs are in-progress.

Input Payload Details

Table 5-531 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-532 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-533 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-534 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-535 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-536 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 that affect costs are in-progress.

Input Payload Details

Table 5-537 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-538 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-539 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-540 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-541 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-542 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 that affect costs are in-progress.

Input Payload Details

Table 5-543 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-544 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-545 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

Input Payload Details

Table 5-546 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-547 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-548 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 that affect costs are in-progress.

Input Payload Details

Table 5-549 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-550 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-551 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 that affect costs are in-progress.

Input Payload Details

Table 5-552 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-553 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-554 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-555 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 that affect costs are in-progress.

Input Payload Details

Table 5-556 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-557 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-558 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-559 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-560 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 that affect costs are in-progress.

Input Payload Details

Table 5-561 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-562 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-563 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-564 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-565 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

Input Payload Details

Table 5-566 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-567 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-568 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-569 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-570 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-571 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-572 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-573 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-574 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 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	It is 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/loc 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/loc 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/loc 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 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 item’s standard UOM. It is used when default_tax_type is SALES.
postingClassifier	No	String (6)	'Contains a classifier that will be used to segregate the sales posting of the item-loc combination to various GL accounts. Valid values are user-definable on the RMS code tables under code_type 'POCL'.
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-575 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-576 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-577 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-578 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,
"postingClassifier": "String",
"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 are not as per the schema definition of 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-579 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-580 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-581 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-582 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-583 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-584 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-585 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-586 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-587 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	It is 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/loc 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/loc 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/loc 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 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 item’s standard UOM. It is used when default_tax_type is SALES.
postingClassifier	No	String (6)	'Contains a classifier that will be used to segregate the sales posting of the item-loc combination to various GL accounts. Valid values are user-definable on the RMS code tables under code_type 'POCL'.
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-588 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-589 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-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": "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,
"postingClassifier": "String",
"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 are not as per the schema definition of 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-592 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-593 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-594 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-595 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-596 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-597 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-598 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-599 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-600 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-601 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-602 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-603 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-604 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-605 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-606 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-607 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-608 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-609 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-610 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-611 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-612 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-613 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-614 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-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.

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-617 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-618 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-619 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-620 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-621 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-622 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-623 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-624 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-625 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-626 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-627 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-628 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-629 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-630 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-631 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-632 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-633 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-634 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-635 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-636 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-637 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-638 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-639 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-640 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.
uom	No	Collection of Object	Child node holding miscellaneous units of measure (UOM) for an item/supplier combination.

Table 5-641 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-642 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-643 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-644 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-645 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-646 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-647 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-648 Uom - Object. See list of elements for detail

Element Name	Required	Data Type	Description
uom	Yes	String (4)	Contains the unit of measure that the item is being measured in.
value	Yes	Number (20,4)	Contains the equivalent value of the Item/Suppliers shipping carton in the associated unit of measure.

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"
}
],
"uom": [
{
"uom": "STK",
"value": 10
}
]
}
],
"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 are not as per the schema definition of 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 UOM

Functional Area

Items - Item Definition

Business Overview

Service to create miscellaneous units of measure (UOM) for an item/supplier combination. Supplier UOM can also be added together with the creation of a new item. This UOM indicates the equivalent of one unit of the item in the specified UOM.

For example, if the item is a single package of cigars, and the single package sold in stores contains 10 cigar 'sticks'. The standard UOM of the item will be EA, and one Each of the item is a package of 10 cigar sticks. The retailer can create a MISC UOM of 'Sticks' and in Item Supplier UOM, the UOM would be set to 'Sticks' and a Value = 10 because there are 10 sticks in a single unit of the item. This definition will allow expense, assessment and/or up charge components to be created to calculate a tax. So, if the tax is 0.13 USD per stick, then the system will use the item supplier UOM record for Sticks to determine that 1 unit of the item is 10 sticks and will therefore calculate the cost component as 0.13 x 10 sticks = 1.30 USD for one package of cigars.

Service Type

POST

ReST URL

MerchIntegrations/services/item/supplier/uom/create

Input Payload Details

Table 5-649 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-650 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.

Table 5-651 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.
uom	No	Collection of Object	Child node holding miscellaneous units of measure (UOM) for an item/supplier combination.

Table 5-652 Uom - Object. See list of elements for detail

Element Name	Required	Data Type	Description
uom	Yes	String (4)	Contains the unit of measure that the item is being measured in.
value	Yes	Number (20,4)	Contains the equivalent value of the Item/Suppliers shipping carton in the associated unit of measure.

Sample Input Message

{
"collectionSize": 1,
"items": [
{
"item": "100100076",
"dataLoadingDestination": "RMS",
"supplier": [
{
"supplier": "2400",
"uom": [
{
"uom": "STK",
"value": 10
}
]
}
]
}
]
}

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 are not as per the schema definition of 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-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.
supplier	No	Collection of Object	References a collection of item supplier.

Table 5-655 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-656 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-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.
supplier	No	Collection of Object	References a collection of item supplier.

Table 5-659 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-660 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-661 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-662 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-663 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-664 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-665 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-666 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-667 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-668 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-669 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-670 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-671 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-672 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-673 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-674 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-675 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-676 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-677 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"
    }
  ]
}

Delete Item Supplier UOM

Functional Area

Items - Item Definition

Business Overview

Service to delete miscellaneous units of measure (UOM) for an item/supplier combination.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/supplier/uom/delete

Input Payload Details

Table 5-678 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-679 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	Yes	Collection of Object	References a collection of item supplier.

Table 5-680 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.
uom	Yes	Collection of Object	Child node.

Table 5-681 Uom - Object. See list of elements for detail

Element Name	Required	Data Type	Description
uom	Yes	String (4)	Contains the unit of measure that the item is being measured in.

Sample Input Message

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

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 are not as per the schema definition of 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 that affect costs are in-progress.

Input Payload Details

Table 5-682 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-683 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-684 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-685 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-686 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-687 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-688 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-689 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

Input Payload Details

Table 5-690 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-691 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-692 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-693 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-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": "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

Input Payload Details

Table 5-696 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-697 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-698 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-699 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-700 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-701 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-702 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 that affect costs are in-progress.

Input Payload Details

Table 5-703 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-704 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-705 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-706 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-707 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-708 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-709 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-710 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-711 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-712 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-713 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-714 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-715 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-716 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-717 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-718 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-719 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-720 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-721 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-722 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"
    }
  ]
}

Update Item Supplier UOM

Functional Area

Items - Item Definition

Business Overview

Service to update miscellaneous units of measure (UOM) for an item/supplier combination. This UOM indicates the equivalent of one unit of the item in the specified UOM.

For example, if the item is a single package of cigars, and the single package sold in stores contains 10 cigar 'sticks'. The standard UOM of the item will be EA, and one Each of the item is a package of 10 cigar sticks. The retailer can create a MISC UOM of 'Sticks' and in Item Supplier UOM, the UOM would be set to 'Sticks' and a Value = 10 because there are 10 sticks in a single unit of the item. This definition will allow expense, assessment and/or up charge components to be created to calculate a tax. So, if the tax is 0.13 USD per stick, then the system will use the item supplier UOM record for Sticks to determine that 1 unit of the item is 10 sticks and will therefore calculate the cost component as 0.13 x 10 sticks = 1.30 USD for one package of cigars.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/supplier/uom/update

Input Payload Details

Table 5-723 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-724 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.

Table 5-725 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.
uom	No	Collection of Object	Child node holding miscellaneous units of measure (UOM) for an item/supplier combination.

Table 5-726 Uom - Object. See list of elements for detail

Element Name	Required	Data Type	Description
uom	Yes	String (4)	Contains the unit of measure that the item is being measured in.
value	Yes	Number (20,4)	Contains the equivalent value of the Item/Suppliers shipping carton in the associated unit of measure.

Sample Input Message

{
"collectionSize": 1,
"items": [
{
"item": "100100076",
"dataLoadingDestination": "RMS",
"supplier": [
{
"supplier": "2400",
"uom": [
{
"uom": "STK",
"value": 10
}
]
}
]
}
]
}

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 are not as per the schema definition of 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-727 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-728 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-729 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-730 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-731 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-732 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-733 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-734 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-735 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-736 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-737 GetError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
errors	Yes	Collection of Object

Table 5-738 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-739 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-740 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-741 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.
upChargeLevel	No	String (1)	This field contains the level at which the up charge is defined. Valid values are: 'D' (up charge is derived from the department level), 'I' (up charge is derived from the item level), and 'F' (up charge is tied to a Franchise store).

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,
"upChargeLevel": "I"
}
]
}
]
}

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-742 GetError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
errors	Yes	Collection of Object

Table 5-743 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 UDA Free Form Translations

• Create Item UDAs

• Create Item Up Charges

• Create Items

• Create Required Documents

• Delete Item Description Translations

• Delete Item Image Translations

• Delete Item Images

• Delete Item Seasons

• Delete Item Tickets

• Delete Item UDA Free Form Translations

• Delete Item UDAs

• Delete Item Up Charges

• Delete Items

• Delete Required Documents
• Update Item Attributes Customized

• Update Item Description Translations

• Update Item Image Translations

• Update Item Images

• Update Item Tickets

• Update Item UDA Free Form Translations

• 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-744 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-745 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-746 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-747 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-748 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-749 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-750 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-751 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-752 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-753 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-754 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-755 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-756 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-757 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-758 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-759 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-760 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-761 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-762 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-763 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-764 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-765 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-766 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-767 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-768 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-769 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-770 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 UDA Free Form Translations

Functional Area

Items - Item Definition

Business Overview

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/uda/translations/create

Input Payload Details

Table 5-771 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-772 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 localization attributes, including Brazil fiscal attributes.

Table 5-773 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.
udaText	No	String (250)	This field contains the text value of the Used Defined attribute for the item.
translation	No	Collection of Object	Child node holding translated UDA text values by language for the item.

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

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This field represents the language in which the translated text is maintained. The language should be from the installed language pack.
udaTextDesc	Yes	String (250)	This contains the translated value for the UDA text in the selected language.

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

Element Name	Required	Data Type	Description
countryId	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-776 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",
"udaText": null,
"translation": [
{
"language": 2,
"udaTextDesc": null
}
]
}
],
"localizationExtensions": [
{
"countryId": "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 are not as per the schema definition of 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-777 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-778 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-779 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.
translation	No	Collection of Object	Child node holding translated UDA text values by language for the item.

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

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This field represents the language in which the translated text is maintained. The language should be from the installed language pack.
udaTextDesc	Yes	String (250)	This contains the translated value for the UDA text in the selected language.

Table 5-781 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-782 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",
"translation": [
{
"language": 2,
"udaTextDesc": 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 are not as per the schema definition of 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 that affect costs are in-progress.

Input Payload Details

Table 5-783 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-784 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-785 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-786 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-787 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-788 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.

Item request payload include 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-789 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-790 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.
longDesc	No	String (2000)	Long description 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.
primaryReferenceItemInd	No	String (1)	This filed indicates if the sub-transation level item is designated as the primary sub-transaction level item. For transaction level items and above the value in this field will be No.
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.
transferAllocUpChargeSourceType	No	String (6)	This field impacts how up charges default to transfers and allocations when an item is added. When set to 'D', department-level up charges are applied if item-level up charges are not defined for the item/from-location/to-location combination. When set to 'I', only item-level up charges are applied; department-level up charges are not inherited.
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.
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.
requiredDocuments	No	Collection of Object	Child node holding documents information of the item.
relatedItems	No	Collection of Object	Child node holding related-item information for the item.
itemImportAttributes	No	Collection of Object	Child node holding import specific attributes associated with a given item.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-791 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.
uom	No	Collection of Object	Child node holding miscellaneous units of measure (UOM) for an item/supplier combination.

Table 5-792 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-793 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-794 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-795 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-796 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-797 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-798 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-799 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-800 Uom - Object. See list of elements for detail

Element Name	Required	Data Type	Description
uom	Yes	String (4)	Contains the unit of measure that the item is being measured in.
value	Yes	Number (20,4)	Contains the equivalent value of the Item/Suppliers shipping carton in the associated unit of measure.

Table 5-801 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-802 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-803 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-804 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.
translation	No	Collection of Object	Child node holding translated UDA text values by language for the item.

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

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This field represents the language in which the translated text is maintained. The language should be from the installed language pack.
udaTextDesc	Yes	String (250)	This contains the translated value for the UDA text in the selected language.

Table 5-806 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-807 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-808 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-809 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-810 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-811 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-812 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-813 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-814 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-815 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-816 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 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.

Table 5-817 RelatedItems - Object. See list of elements for detail

Element Name	Required	Data Type	Description
relationshipId	No	Number (20)	Unique identifier for each relationship header.
relationshipName	Yes	String (255)	Name given to the relationship.
relationshipType	Yes	String (6)	Describes the type of relationship. Values are configured in code_detail table under code_type IREL.
mandatoryInd	No	String (1)	Indicates whether the relationship is mandatory.
translation	No	Collection of Object	Child node containing the translated value of the relationship name.
details	Yes	Collection of Object	Child node containing the details for related item.

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

Element Name	Required	Data Type	Description
lang	Yes	Number (6)	This field contains the language in which the translated text is maintained.
relationshipName	Yes	String (255)	The translated text of the relationship name.

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

Element Name	Required	Data Type	Description
relatedItem	Yes	String (25)	Item id of the related item.
priority	No	Number (4)	Applicable only in case of relationship type SUBS. In case of multiple related substitute items, this column could be used (optional) to define relative priority.
startDate	No	date	From this date related item can be used on transactions.
endDate	No	date	Till this date related item can be used on transactions. A value of null means that it is effective forever.

Table 5-820 RequiredDocuments - Object. See list of elements for detail

Element Name	Required	Data Type	Description
documentId	Yes	Number (6)	Unique number used to distinguish the different documents.

Table 5-821 ItemImportAttributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
importDescription	No	String (2000)	Contains description of the item used for importing purposes.
commodity	No	String (6)	Contains the code used to classify the item by their type of merchandise.
tooling	No	Number (20,4)	Represents the cost associated with a specific Tooling/Assist charge. The value will be provided in the system’s primary currency.
firstOrder	No	String (1)	Used to determine if duty is to be paid on the total value of the tooling expense the first time the item is shipped.
amortizeBase	No	Number (12,4)	Contains the number of units over which the tooling/assist cost will be amortized.
openBalance	No	Number (12,4)	Contains the open balance of the number of units yet to be received over which the tooling costs will be amortized.

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",
"longDesc": "100100076 Item Regular",
"standardUom": "EA",
"sellableInd": "Y",
"orderableInd": "Y",
"simplePackInd": "N",
"packInd": "N",
"containsInnerInd": "N",
"packType": null,
"orderAsType": null,
"primaryReferenceItemInd": "N",
"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",
"transferAllocUpChargeSourceType": "D",
"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"
}
],
"uom": [
{
"uom": "STK",
"value": 10
}
]
}
],
"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,
"translation": [
{
"language": 2,
"udaTextDesc": 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"
}
]
}
],
"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"
}
],
"requiredDocuments": [
{
"documentId": 1
}
],
"relatedItems": [
{
"relationshipId": 10001,
"relationshipName": "Related Item Test",
"relationshipType": "SUBS",
"mandatoryInd": "Y",
"translation": [
{
"lang": 1,
"relationshipName": "Related Item Test - English"
}
],
"details": [
{
"relatedItem": "100100141",
"priority": 1,
"startDate": "2001-12-31",
"endDate": "2001-12-31"
}
]
}
],
"itemImportAttributes": [
{
"importDescription": "import desc",
"commodity": "A123",
"tooling": 12,
"firstOrder": "Y",
"amortizeBase": 12.4568,
"openBalance": 12.4568
}
],
"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 are not as per the schema definition of 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 Import Attributes

Functional Area

Items - Item Definition

Business Overview

New service endpoints to create the import specific attributes associated with a given item.

Service Type

POST

ReST URL

MerchIntegrations/services/item/importAttributes/create

Input Payload Details

Table 5-822 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-823 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.
itemImportAttributes	No	Collection of Object	Child node holding import specific attributes associated with a given item.
localizationExtensions	No	Collection of Object	Holds localization attributes, including Brazil fiscal attributes.

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

Element Name	Required	Data Type	Description
countryId	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-825 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-826 ItemImportAttributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
importDescription	No	String (2000)	Contains description of the item used for importing purposes.
commodity	No	String (6)	Contains the code used to classify the item by their type of merchandise.
tooling	No	Number (20,4)	Represents the cost associated with a specific Tooling/Assist charge. The value will be provided in the system’s primary currency.
firstOrder	No	String (1)	Used to determine if duty is to be paid on the total value of the tooling expense the first time the item is shipped.
amortizeBase	No	Number (12,4)	Contains the number of units over which the tooling/assist cost will be amortized.
openBalance	No	Number (12,4)	Contains the open balance of the number of units yet to be received over which the tooling costs will be amortized.

Sample Input Message

{
"collectionSize": 1,
"items": [
{
"item": "100100076",
"dataLoadingDestination": "RMS",
"itemImportAttributes": [
{
"importDescription": "import desc",
"commodity": "A123",
"tooling": 12,
"firstOrder": "Y",
"amortizeBase": 12.4568,
"openBalance": 12.4568
}
],
"localizationExtensions": [
{
"countryId": "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 are not as per the schema definition of 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 Required Documents

Functional Area

Items - Item Definition

Business Overview

This service is used to add required documents to an existing item in Merchandising. Required documents may be added 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/requiredDocuments/create

Input Payload Details

Table 5-827 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-828 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.
requiredDocuments	No	Collection of Object	Child node holding documents information of the item.
localizationExtensions	No	Collection of Object	Holds localization attributes, including Brazil fiscal attributes.

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

Element Name	Required	Data Type	Description
countryId	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-830 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-831 RequiredDocuments - Object. See list of elements for detail

Element Name	Required	Data Type	Description
documentId	Yes	Number (6)	Unique number used to distinguish the different documents.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "requiredDocuments": [
        {
          "documentId": 1
        }
      ],
      "localizationExtensions": [
        {
          "countryId": "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 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-832 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-833 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-834 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-835 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-836 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-837 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-838 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-839 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-840 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-841 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-842 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-843 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-844 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-845 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-846 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-847 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 UDA Free Form Translations

Functional Area

Items - Item Definition

Business Overview

This service is used to delete freeform UDA translation from an existing item in Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/uda/translations/delete

Input Payload Details

Table 5-848 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-849 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-850 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.
udaValue	No	String (250)	This field contains value of the Used Defined attribute for the item
translation	No	Collection of Object	Child node.

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

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This field represents the language for which the translation needs to be deleted.

Sample Input Message

{
"collectionSize": 1,
"items": [
{
"item": "100100076",
"uda": [
{
"udaId": 201,
"displayType": "FF",
"udaValue": null,
"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 are not as per the schema definition of 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-852 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-853 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-854 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 are not as per the schema definition of 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 that affect costs are in-progress.

Input Payload Details

Table 5-855 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-856 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-857 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-858 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-859 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-860 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"
    }
  ]
}

Delete Required Documents

Functional Area

Items - Item Definition

Business Overview

This service is used to delete required document data from an existing item in Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/requiredDocuments/delete

Input Payload Details

Table 5-861 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-862 Items - Object. See list of elements for detail

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

Table 5-863 RequiredDocuments - Object. See list of elements for detail

Element Name	Required	Data Type	Description
documentId	Yes	Number (6)	Unique number used to distinguish the different documents.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "requiredDocuments": [
        {
          "documentId": 1
        }
      ]
    }
  ]
}

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-864 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-865 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-866 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-867 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-868 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-869 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-870 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-871 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-872 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-873 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-874 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-875 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-876 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-877 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-878 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-879 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-880 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-881 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-882 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-883 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-884 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 UDA Free Form Translations

Functional Area

Items - Item Definition

Business Overview

This service is used to update freeform item UDA level translations of an existing item within Merchandising.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/uda/translations/update

Input Payload Details

Table 5-885 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-886 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 localization attributes, including Brazil fiscal attributes.

Table 5-887 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.
udaText	No	String (250)	This field contains the text value of the Used Defined attribute for the item.
translation	No	Collection of Object	Child node holding translated UDA text values by language for the item.

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

Element Name	Required	Data Type	Description
language	Yes	Number (6)	This field represents the language in which the translated text is maintained. The language should be from the installed language pack.
udaTextDesc	Yes	String (250)	This contains the translated value for the UDA text in the selected language.

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

Element Name	Required	Data Type	Description
countryId	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-890 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",
"udaText": null,
"translation": [
{
"language": 2,
"udaTextDesc": null
}
]
}
],
"localizationExtensions": [
{
"countryId": "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 are not as per the schema definition of 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-891 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-892 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-893 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-894 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-895 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 are not as per the schema definition of 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 that affect costs are in-progress.

Input Payload Details

Table 5-896 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-897 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-898 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-899 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-900 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-901 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-902 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-903 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.
longDesc	No	String (2000)	Long description 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.
primaryReferenceItemInd	No	String (1)	This field indicates whether the sub-transation level item is designated as the primary sub-transaction level item. For transaction level items and above the value in this field will be No.
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.
transferAllocUpChargeSourceType	No	String (6)	This field impacts how up charges default to transfers and allocations when an item is added. When set to 'D', department-level up charges are applied if item-level up charges are not defined for the item/from-location/to-location combination. When set to 'I', only item-level up charges are applied; department-level up charges are not inherited.
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.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-904 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-905 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-906 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",
      "longDesc": "100100076 Item Regular",
      "standardUom": "EA",
      "primaryReferenceItemInd": "N",
      "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,
      "transferAllocUpChargeSourceType": "D",
      "comments": null,
      "dataLoadingDestination": "RMS",
      "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"
    }
  ]
}

Update Item Import Attributes

Functional Area

Items - Item Definition

Business Overview

New service endpoints will be added to modify the import specific attributes associated with a given item.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/importAttributes/update

Input Payload Details

Table 5-907 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-908 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.
itemImportAttributes	No	Collection of Object	Child node holding import specific attributes associated with a given item.
localizationExtensions	No	Collection of Object	Holds localization attributes, including Brazil fiscal attributes.

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

Element Name	Required	Data Type	Description
countryId	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-910 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-911 ItemImportAttributes - Object. See list of elements for detail

Element Name	Required	Data Type	Description
importDescription	No	String (2000)	Contains description of the item used for importing purposes.
commodity	No	String (6)	Contains the code used to classify the item by their type of merchandise.
tooling	No	Number (20,4)	Represents the cost associated with a specific Tooling/Assist charge. The value will be provided in the system’s primary currency.
firstOrder	No	String (1)	Used to determine if duty is to be paid on the total value of the tooling expense the first time the item is shipped.
amortizeBase	No	Number (12,4)	Contains the number of units over which the tooling/assist cost will be amortized.
openBalance	No	Number (12,4)	Contains the open balance of the number of units yet to be received over which the tooling costs will be amortized.

Sample Input Message

{
"collectionSize": 1,
"items": [
{
"item": "100100076",
"dataLoadingDestination": "RMS",
"itemImportAttributes": [
{
"importDescription": "import desc",
"commodity": "A123",
"tooling": 12,
"firstOrder": "Y",
"amortizeBase": 12.4568,
"openBalance": 12.4568
}
],
"localizationExtensions": [
{
"countryId": "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 are not as per the schema definition of 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 Substitute Items

Functional Area

Items - Item Definition

Business Overview

Service endpoint to create, update or delete substitute items for an item.

Service Type

POST

ReST URL

MerchIntegrations/services/item/location/substituteItems/manage

Input Payload Details

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

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)
items	Yes	Collection of Object

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

Element Name	Required	Data Type	Description
action	Yes	String (10)	Describes type of action.
item	Yes	String (25)	Alphanumeric identifier for the main item. This item must exist as a main sku on the sub_items_head table.
locationHierarchyLevel	Yes	String (5)	The corresponding ID based on the specified level of the organizational hierarchy. Valied values are codes from code_type 'GRTA'.
hierarchy	No	String (20)	The level of the organizational hierarchy used for item-location relationships to add substitute item.
fillPriority	No	String (1)	This contains the fill priority for the main item. This field applies only to Warehouses.
useSales	No	String (1)	This indicates whether substitute items will be used in calculating the maximum stock for the floating-point replenishment method.
useStock	No	String (1)	This indicates whether the substitute items will be used in calculating the net inventory at a location when determining the locations need for the main item. When set Yes (‘Y’), the substitute item stock can be used to fulfil a locations warehouse demands for the main item.
useForecastSales	No	String (1)	This indicates whether the substitute item be used to determine the required stock at a given location when a forecasting replenishment method is used for the main item.
details	No	Collection of Object	Child node containing the details of substitute items.

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

Element Name	Required	Data Type	Description
substituteItem	Yes	String (25)	This contains unique identifier for the substitute item.
primaryReplenishmentPack	No	String (25)	This contains the replenishment pack, which will be used to fulfill the demand of the associated item.
pickPriority	No	Number (3)	Contains the pick priority for the substitute item. If there are multiple substitute items for a main item, then the pick priority will determine the order in which the substitute items will fulfill the store's demand.

Sample Input Message

{
"collectionSize": 1,
"items": [
{
"action": "CREATE",
"item": "100100050",
"locationHierarchyLevel": "S",
"hierarchy": "1010",
"fillPriority": "M",
"useSales": "Y",
"useStock": "Y",
"useForecastSales": "Y",
"details": [
{
"substituteItem": "100100068",
"primaryReplenishmentPack": "100100092",
"pickPriority": 1
}
]
}
]
}

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.

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"
}
]
}

Related Items Upload Service

The following services are included in this functional area:

• Create Related Items
• Create Related Item Translations
• Delete Related Items
• Delete Related Item Translations
• Update Related Items
• Update Related Item Translations

Create Related Items

Functional Area

Items - Related Items

Business Overview

This service is used to add related items to an existing item in Merchandising. Related items can also be added 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/relatedItems/create

Input Payload Details

Table 5-915 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-916 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	Yes	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.
relatedItems	Yes	Collection of Object	Child node holding related-item information for the item.
localizationExtensions	No	Collection of Object	Holds localization attributes, including Brazil fiscal attributes.

Table 5-917 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-918 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-919 RelatedItems - Object. See list of elements for detail

Element Name	Required	Data Type	Description
relationshipId	No	Number (20)	Unique identifier for each relationship header.
relationshipName	Yes	String (255)	Name given to the relationship.
relationshipType	Yes	String (6)	Describes the type of relationship. Values are configured in code_detail table under code_type IREL.
mandatoryInd	No	String (1)	Indicates whether the relationship is mandatory.
details	Yes	Collection of Object	Child node containing the details for related item.

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

Element Name	Required	Data Type	Description
relatedItem	Yes	String (25)	Item id of the related item.
priority	No	Number (4)	Applicable only in case of relationship type SUBS. In case of multiple related substitute items, this column could be used (optional) to define relative priority.
startDate	No	date	From this date related item can be used on transactions.
endDate	No	date	Till this date related item can be used on transactions. A value of null means that it is effective forever.

Sample Input Message

{
"collectionSize": 1,
"items": [
{
"item": "100100076",
"dataLoadingDestination": "RMS",
"relatedItems": [
{
"relationshipId": 10001,
"relationshipName": "Related Item Test",
"relationshipType": "SUBS",
"mandatoryInd": "Y",
"details": [
{
"relatedItem": "100100141",
"priority": 1,
"startDate": "2001-12-31",
"endDate": "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 are not as per the schema definition of 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 Related Item Translations

Functional Area

Items - Related Items

Business Overview

If translations have been defined for items, at related item 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 related item translations to an existing item in Merchandising.

Service Type

POST

ReST URL

MerchIntegrations/services/item/relatedItem/translations/create

Input Payload Details

Table 5-921 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-922 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	Yes	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.
relateditem	Yes	Collection of Object	Child node holding related-item information for the item.

Table 5-923 Relateditem - Object. See list of elements for detail

Element Name	Required	Data Type	Description
relationshipId	Yes	Number (20)	Unique identifier for each relationship header.
translation	Yes	Collection of Object	Child node containing the translated value of the relationship name.

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

Element Name	Required	Data Type	Description
lang	Yes	Number (6)	This field contains the language in which the translated text is maintained.
relationshipName	Yes	String (255)	The translated text of the relationship name.

Sample Input Message

{
"collectionSize": 1,
"items": [
{
"item": "100100076",
"dataLoadingDestination": "RMS",
"relateditem": [
{
"relationshipId": 10041,
"translation": [
{
"lang": 2,
"relationshipName": "Descripción de la relación"
}
]
}
]
}
]
}

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 are not as per the schema definition of 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 Related Items

Functional Area

Items - Related Items

Business Overview

This service is used to delete existing item relationship from Merchandising. In order to perform this deletion, the relationship ID must exist within Merchandising, else an error will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/relatedItems/delete

Input Payload Details

Table 5-925 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-926 Items - Object. See list of elements for detail

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

Table 5-927 RelatedItem - Object. See list of elements for detail

Element Name	Required	Data Type	Description
relationshipId	Yes	Number (20)	Unique identifier for the relationship.
details	No	Collection of Object	Child node.

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

Element Name	Required	Data Type	Description
relatedItem	No	String (25)	Item id of the related item.

Sample Input Message

{
"collectionSize": 1,
"items": [
{
"item": "100100076",
"relatedItem": [
{
"relationshipId": 10001,
"details": [
{
"relatedItem": "100100141"
}
]
}
]
}
]
}

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 are not as per the schema definition of 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 Related Item Translations

Functional Area

Items - Related Items

Business Overview

This service is used to delete an existing translation record of a related item relationship in Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/relatedItem/translations/delete

Input Payload Details

Table 5-929 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-930 Items - Object. See list of elements for detail

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

Table 5-931 RelatedItem - Object. See list of elements for detail

Element Name	Required	Data Type	Description
relationshipId	Yes	Number (20)	Unique identifier for the relationship.
translation	No	Collection of Object	Child node.

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

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

Sample Input Message

{
"collectionSize": 1,
"items": [
{
"item": "100100076",
"relatedItem": [
{
"relationshipId": 10001,
"translation": [
{
"lang": 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 are not as per the schema definition of 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 Related Items

Functional Area

Items - Related Items

Business Overview

This service is used to update item relationships of an existing item within Merchandising. In order to update an item relationship, the specified relationship ID must exist for the item in Merchandising, else an error will be returned.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/relatedItems/update

Input Payload Details

Table 5-933 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-934 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	Yes	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.
relatedItems	Yes	Collection of Object	Child node holding related-item information for the item.

Table 5-935 RelatedItems - Object. See list of elements for detail

Element Name	Required	Data Type	Description
relationshipId	Yes	Number (20)	Unique identifier for each relationship header.
relationshipName	Yes	String (255)	Name given to the relationship.
relationshipType	Yes	String (6)	Describes the type of relationship. Values are configured in code_detail table under code_type IREL.
mandatoryInd	Yes	String (1)	Indicates whether the relationship is mandatory.
details	No	Collection of Object	Child node containing the details for related item.

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

Element Name	Required	Data Type	Description
relatedItem	No	String (25)	Item id of the related item.
priority	No	Number (4)	Applicable only in case of relationship type SUBS. In case of multiple related substitute items, this column could be used (optional) to define relative priority.
startDate	No	date	From this date related item can be used on transactions.
endDate	No	date	Till this date related item can be used on transactions. A value of null means that it is effective forever.

Sample Input Message

{
"collectionSize": 1,
"items": [
{
"item": "100100076",
"dataLoadingDestination": "RMS",
"relatedItems": [
{
"relationshipId": 10001,
"relationshipName": "Related Item Test - Updated",
"relationshipType": "SUBS",
"mandatoryInd": "N",
"details": [
{
"relatedItem": "100100141",
"priority": 2,
"startDate": "2001-12-31",
"endDate": "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 are not as per the schema definition of 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 Related Item Translations

Functional Area

Items - Related Items

Business Overview

This service is used to update related item level translations of an existing item within Merchandising.

Service Type

PUT

ReST URL

MerchIntegrations/services/item/relatedItem/translations/update

Input Payload Details

Table 5-937 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-938 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	Yes	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.
relatedItem	Yes	Collection of Object	Child node holding related-item information for the item.

Table 5-939 RelatedItem - Object. See list of elements for detail

Element Name	Required	Data Type	Description
relationshipId	Yes	Number (20)	Unique identifier for each relationship header.
translation	Yes	Collection of Object	Child node containing the translated value of the relationship name.

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

Element Name	Required	Data Type	Description
lang	Yes	Number (6)	This field contains the language in which the translated text is maintained.
relationshipName	Yes	String (255)	The translated text of the relationship name.

Sample Input Message

{
"collectionSize": 1,
"items": [
{
"item": "100100076",
"dataLoadingDestination": "RMS",
"relatedItem": [
{
"relationshipId": 10041,
"translation": [
{
"lang": 20,
"relationshipName": "ενημερωμένη περιγραφή της σχέσης"
}
]
}
]
}
]
}

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 are not as per the schema definition of 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

Input Parameters

Parameter Name	Required	Data Type	Description
limit	No	String (6)	Pagination limit. Default value is 1000.
offsetkey	No	String	Offset key (Brand Name)
brandName	No	String	Brand Name
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)

Response Code: 200 (Success)

Table 5-941 PageResultItemsBrand - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	Collection of records
hasMore	No	Boolean	Boolean to signify if there are additional pages of data. This is true if limit = count
limit	No	Number	Requested page size. If the page size was not defined in the input request, a default page size is used to limit the number of records to fetch
count	No	Number	Number of record in the response object
links	No	Collection of Object	List of Self and/or Next URL

Table 5-942 Brand - Object. See list of elements for detail

Element Name	Required	Data Type	Description
brandName	Yes	String (30)	This field contains the brand name.
brandDescription	Yes	String (120)	This field contains the brand description.
createDatetime	Yes	dateTime	This field contains the date-time in UTC when this record was created.
lastUpdateDatetime	Yes	dateTime	This field contains the date-time in UTC when this record was updated.

Table 5-943 LinkItem - Object. See list of elements for detail

Element Name	Required	Data Type	Description
href	No	String	Service URL
rel	No	String	This can be either 'self' or 'next'. The 'next' link is present if there are more pages to fetches and contains the offsetkey which unique identifies the last record of this response.

Sample Response Message

{
"items": [
{
"brandName": "ORCL",
"brandDescription": "Oracle",
"createDatetime": "2001-12-31T23:59:59.000Z",
"lastUpdateDatetime": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1,
"count": 1,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000",
"rel": "self"
}
]
}

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.

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"
}
]
}

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-944 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-945 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-946 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-947 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-948 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 publishes differentiator master data to downstream consuming systems. It publishes only differentiators whose DIFF_TYPE still resolves to a valid row in DIFF_TYPE.

Technical Details

This service follows the Publish API cache architecture in which the REST service serves pre-generated JSON from an integration cache table that is initially seeded and then maintained through asynchronous delta processing. For overall enablement, scheduling, and guidance on how publish api works and how webhook for this api can be implemented to stream the data out, refer to the white paper Publish APIs - Customer Enablement Overview.

Core business tables: DIFF_IDS

Additional business tables: DIFF_TYPE

JSON cache table: MERCHAPI_EXT_DIFF_IDS

JSON generation view: V_MERCHAPI_EXT_DIFF_IDS_JSON

Builds the payload from DIFF_IDS and joins DIFF_TYPE to add the differentiator type description.

Functionally, that means only differentiators whose DIFF_TYPE still resolves to a valid row in DIFF_TYPE are published.

Initial refresh supports both truncate-and-load and rebuild behavior, and rebuild marks cache rows deleted when the differentiator no longer exists in V_MERCHAPI_EXT_DIFF_IDS_JSON.

Initial Seeding and post enablement rebuild/repair

Initial seeding and rebuild use V_MERCHAPI_EXT_DIFF_IDS_JSON and apply only DIFF_IDS rows with a matching DIFF_TYPE row are published.

Mark cache rows deleted when the differentiator no longer exists in V_MERCHAPI_EXT_DIFF_IDS_JSON.

ICL (Integration Change Log) table: ICL_RMS_DIFF_IDS (ICL consumer name = MERCHAPI)

ICL entries are created using triggers on DIFF_IDS.

Batch Configuration. Asynchronous delta processing is supported using Background engine and also via POM scheduling. Choose one.

Process configuration name: API_EXT_DIFF_ID

To enable via Background engine set BACKGROUND_RUN_FLAG to Y and review the BACKGROUND_RUN_INTERVAL_SECOND parameter.

POM Batch schedule process and job: MERCHAPI_DELTA_EXT_DIFF_IDS_ADHOC_PROCESS -> MERCHAPI_EXT_DIFF_IDS_ADHOC_JOB

Webhook configuration api name: foundation/diffid

Special handling

Service Type

GET

ReST URL

MerchIntegrations/services/foundation/diffid

MerchIntegrations/services/foundation/diffid/{diffId}

Input Parameters for MerchIntegrations/services/foundation/diffId

Parameter Name	Required	Data Type	Description
since	No	String	Since Date (Example: 2010-12-31T23:59:59.999Z)
before	No	String	Before Date (Example: 2040-12-31T23:59:59.999Z)
offsetkey	No	String	Offset key (Diff ID)
limit	No	String (6)	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-949 Input Parameter for "MerchIntegrations/services/foundation/diffid/{diffId}"

Parameter Name	Required	Data Type	Description
diffId	Yes	String	Differentiator 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)

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

Table 5-950 PageResultsItemsMerchApiDiffId - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	Collection of records
hasMore	No	Boolean	Boolean to signify if there are additional pages of data. This is true if limit = count for pagination supported request
limit	No	Number	Requested page size. If the page size was not defined in the input request, a default page size is used to limit the number of records to fetch
count	No	Number	Number of record in the response object
links	No	Collection of Object	List of Self and/or Next URL

Table 5-951 MerchApiDiffId - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	No	String (6)	Action for differentiator ID details.
diffId	No	String (10)	This field contains a unique identifier of the differentiator.
diffDescription	No	String (120)	This field contains the description of the differentiator.
diffType	No	String (6)	This field contains a code indicating the type of differentiator, for example C for Color.
diffTypeDescription	No	String (120)	This field contains the description of the differentiator type.
industryCode	No	String (10)	This field is used to hold the unique code used by industry standards to identify the differentiator.
industrySubgroup	No	String (10)	This field is used to hold a sub-grouping code used by industry standards to further identify the differentiator.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).
cacheTimestamp	No	dateTime	This field specifies the date and time when the diff ID record was fetched into the cache for web service publication (UTC).
cacheCreateTimestamp	No	dateTime	This field specifies the date and time when the record was first created for web service publication (UTC).

Table 5-952 LinkItems - Object. See list of elements for detail

Element Name	Required	Data Type	Description
href	No	String	Service URL
rel	No	String	This can be either 'self' or 'next'. The 'next' link is present if there are more pages to fetch and contains the offsetkey which uniquely identifies the last record of this response.

Sample Response Message

{
"items": [
{
"action": "INSERT",
"diffId": "XYZ01",
"diffDescription": "diffDesc",
"diffType": "C",
"diffTypeDescription": null,
"industryCode": null,
"industrySubgroup": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"cacheTimestamp": "2001-12-31T23:59:59.000Z",
"cacheCreateTimestamp": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1000,
"count": 1000,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000&since=1970-01-01T00:00:00.001Z&before=2024-01-01T00:00:00.001Z&offsetkey=1234,XYZ",
"rel": "next"
}
]
}

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 publishes differentiator group master data to downstream consuming systems. The payload includes the differentiator group definition together with its member differentiator IDs and display sequence. This service only publishes differentiator groups that currently have at least one detail row.

Technical Details

This service follows the Publish API cache architecture in which the REST service serves pre-generated JSON from an integration cache table that is initially seeded and then maintained through asynchronous delta processing. For overall enablement, scheduling, and guidance on how publish api works and how webhook for this api can be implemented to stream the data out, refer to the white paper Publish APIs - Customer Enablement Overview.

Core business tables: DIFF_GROUP_HEAD, DIFF_GROUP_DETAIL

Additional business tables: none

JSON cache table: MERCHAPI_EXT_DIFF_GROUP

JSON generation view: V_MERCHAPI_EXT_DIFF_GROUP_JSON

Builds the header from DIFF_GROUP_HEAD and the detail array from DIFF_GROUP_DETAIL.

The view uses an inner join between the header and aggregated detail rows, so only differentiator groups that currently have at least one detail row are published.

Detail-level changes from DIFF_GROUP_DETAIL are treated as updates to the parent differentiator group, so adds, updates, and deletes on detail rows republish the full group payload.

Initial Seeding and post enablement rebuild/repair

Initial seeding and rebuild apply the same publication rule used by V_MERCHAPI_EXT_DIFF_GROUP_JSON: groups publish only when DIFF_GROUP_HEAD has at least one matching DIFF_GROUP_DETAIL row.

Mark cache rows deleted when the diff group no longer exists in V_MERCHAPI_EXT_DIFF_GROUP_JSON.

ICL (Integration Change Log) table: ICL_RMS_DIFF_GROUP (ICL consumer name = MERCHAPI)

ICL entries are created using triggers on DIFF_GROUP_HEAD, DIFF_GROUP_DETAIL.

DIFF_GROUP_DETAIL inserts, updates, and deletes are treated as updates to the parent diff group.

Batch Configuration. Asynchronous delta processing is supported using Background engine and also via POM scheduling. Choose one.

Process configuration name: API_EXT_DIFF_GROUP

To enable via Background engine set BACKGROUND_RUN_FLAG to Y and review the BACKGROUND_RUN_INTERVAL_SECOND parameter.

POM Batch schedule process and job: MERCHAPI_DELTA_EXT_DIFF_GROUP_ADHOC_PROCESS -> MERCHAPI_EXT_DIFF_GROUP_ADHOC_JOB

Webhook configuration api name: foundation/diffgroup

Special handling

Service Type

GET

ReST URL

MerchIntegrations/services/foundation/diffgroup

MerchIntegrations/services/foundation/diffgroup/{diffGroupId}

Input Parameters for MerchIntegrations/services/foundation/diffgroup

Parameter Name	Required	Data Type	Description
since	No	String	Since Date (Example: 2010-12-31T23:59:59.999Z)
before	No	String	Before Date (Example: 2040-12-31T23:59:59.999Z)
offsetkey	No	String	Offset key (Diff Group ID)
limit	No	String (6)	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-953 Input Parameter 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)

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

Table 5-954 PageResultsItemsMerchApiDiffGroup - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	Collection of records
hasMore	No	Boolean	Boolean to signify if there are additional pages of data. This is true if limit = count for pagination supported request
limit	No	Number	Requested page size. If the page size was not defined in the input request, a default page size is used to limit the number of records to fetch
count	No	Number	Number of record in the response object
links	No	Collection of Object	List of Self and/or Next URL

Table 5-955 MerchApiDiffGroup - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	No	String (6)	Action for differentiator group details.
diffGroupId	No	String (10)	This field contains the ID of the diff group being added or updated.
diffGroupDescription	No	String (120)	This field contains the description of the diff group.
diffType	No	String (6)	This field contains the code for the type of diff contained in this group, such as S for size.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).
details	No	Collection of Object	This list holds attributes for diff group details.
cacheTimestamp	No	dateTime	This field specifies the date and time when the diff group record was fetched into the cache for web service publication (UTC).
cacheCreateTimestamp	No	dateTime	This field specifies the date and time when the record was first created for web service publication (UTC).

Table 5-956 DiffGroupDetail - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffId	No	String (10)	This field contains the ID of the diff that is included in the group.
displaySequence	No	Number(4,0)	This field contains the display sequence for the diff in the group.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).

Table 5-957 LinkItems - Object. See list of elements for detail

Element Name	Required	Data Type	Description
href	No	String	Service URL
rel	No	String	This can be either 'self' or 'next'. The 'next' link is present if there are more pages to fetch and contains the offsetkey which uniquely identifies the last record of this response.

Sample Response Message

{
"items": [
{
"action": "INSERT",
"diffGroupId": "Y21 Colors",
"diffGroupDescription": "Year 2021 Colors",
"diffType": "C",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"details": [
{
"diffId": "BLACK",
"displaySequence": 1,
"createDateTime": "2001-12-31T23:59:59.000Z"
}
],
"cacheTimestamp": "2001-12-31T23:59:59.000Z",
"cacheCreateTimestamp": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1000,
"count": 1000,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000&since=1970-01-01T00:00:00.001Z&before=2024-01-01T00:00:00.001Z&offsetkey=1234,XYZ",
"rel": "next"
}
]
}

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-958 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-959 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-960 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-961 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-962 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-963 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-964 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-965 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-966 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-967 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-968 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-969 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-970 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-971 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 publishes all differentiator type master data to downstream consuming systems. Diff Types are used to qualify the diff IDs included in other integration. Examples of diff types are size, color, flavor, etc.

Technical Details

This service follows the Publish API cache architecture in which the REST service serves pre-generated JSON from an integration cache table that is initially seeded and then maintained through asynchronous delta processing. For overall enablement, scheduling, and guidance on how publish api works and how webhook for this api can be implemented to stream the data out, refer to the white paper Publish APIs - Customer Enablement Overview.

Core business tables: DIFF_TYPE

Additional business tables: none

JSON cache table: MERCHAPI_EXT_DIFF_TYPE

JSON generation view: V_MERCHAPI_EXT_DIFF_TYPE_JSON

The JSON view is intentionally simple: it reads directly from DIFF_TYPE and publishes the differentiator type code, description, and audit timestamps.

There is no additional functional filter in the view, so every row in DIFF_TYPE is eligible for publication.

Initial refresh reads the full V_MERCHAPI_EXT_DIFF_TYPE_JSON view, supports both truncate-and-load and rebuild modes, and marks cache rows deleted when a diff type no longer exists in the view.

Initial Seeding and post enablement rebuild/repair

Initial seeding and rebuild use V_MERCHAPI_EXT_DIFF_TYPE_JSON and apply none; all DIFF_TYPE rows are eligible.

Mark cache rows deleted when the diff type no longer exists in V_MERCHAPI_EXT_DIFF_TYPE_JSON.

ICL (Integration Change Log) table: ICL_RMS_DIFF_TYPE (ICL consumer name = MERCHAPI)

ICL entries are created using triggers on DIFF_TYPE.

Batch Configuration. Asynchronous delta processing is supported using Background engine and also via POM scheduling. Choose one.

Process configuration name: API_EXT_DIFF_TYPE

To enable via Background engine set BACKGROUND_RUN_FLAG to Y and review the BACKGROUND_RUN_INTERVAL_SECOND parameter.

POM Batch schedule process and job: MERCHAPI_DELTA_EXT_DIFF_TYPE_ADHOC_PROCESS -> MERCHAPI_EXT_DIFF_TYPE_ADHOC_JOB

Webhook configuration api name: foundation/difftype

Special handling

Service Type

GET

ReST URL

MerchIntegrations/services/foundation/difftype

MerchIntegrations/services/foundation/difftype/{diffType}

Input Parameters for Merchintegrations/services/foundation/difftype

Parameter Name	Required	Data Type	Description
since	No	String	Since Date (Example: 2010-12-31T23:59:59.999Z)
before	No	String	Before Date (Example: 2040-12-31T23:59:59.999Z)
offsetkey	No	String	Offset key (Diff Type)
limit	No	String (6)	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-972 Input Parameter 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)

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

Table 5-973 PageResultsItemsMerchApiDiffType - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	Collection of records
hasMore	No	Boolean	Boolean to signify if there are additional pages of data. This is true if limit = count for pagination supported request
limit	No	Number	Requested page size. If the page size was not defined in the input request, a default page size is used to limit the number of records to fetch
count	No	Number	Number of record in the response object
links	No	Collection of Object	List of Self and/or Next URL

Table 5-974 MerchApiDiffType - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	No	String (6)	Action for differentiator type details.
diffType	No	String (6)	This field contains a code indicating the type of differentiator, for example C for Color.
diffTypeDescription	No	String (120)	This field holds the description of the diff type (e.g., Color, Size, and so on).
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).
cacheTimestamp	No	dateTime	This field specifies the date and time when the record was fetched into the cache for web service publication (UTC).
cacheCreateTimestamp	No	dateTime	This field specifies the date and time when the record was first created for web service publication (UTC).

Table 5-975 LinkItems - Object. See list of elements for detail

Element Name	Required	Data Type	Description
href	No	String	Service URL
rel	No	String	This can be either 'self' or 'next'. The 'next' link is present if there are more pages to fetch and contains the offsetkey which uniquely identifies the last record of this response.

Sample Response Message

{
"items": [
{
"action": "INSERT",
"diffType": "C",
"diffTypeDescription": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"cacheTimestamp": "2001-12-31T23:59:59.000Z",
"cacheCreateTimestamp": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1000,
"count": 1000,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000&since=1970-01-01T00:00:00.001Z&before=2024-01-01T00:00:00.001Z&offsetkey=1234,XYZ",
"rel": "next"
}
]
}

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-976 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-977 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-978 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-979 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.

season - Include season id as a query parameter to restrict the response to a specific season.

status - This optional parameter allows filtering the response based on season start and/or end date. The comparison uses current server date. Following values are supported.

OLD - Retrieves seasons having end date less than system date

ACTIVE - Retrieves seasons having system date between start date (inclusive) and end date (inclusive)

FUTURE - Retrieves seasons having start date greater than system date

ACTIVE_FUTURE - Retrieves seasons having end date greater than or equal to system date

OLD_ACTIVE - Retrieves seasons where start date is less than or equal to system date

Service Type

GET

ReST URL

MerchIntegrations/services/item/foundation/seasons

Input Parameters for MerchIntegrations/services/foundation/seasons

Parameter Name	Required	Data Type	Description
limit	No	String (6)	Pagination limit. Default value is 1000.
offsetkey	No	String	Offset key
season	No	String (3)	Season Id
status	No	String	Status
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 – Season

Table 5-980 PageResultItemsSeason - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	Collection of records
hasMore	No	Boolean	Boolean to signify if there are additional pages of data. This is true if limit = count
limit	No	Number	Requested page size. If the page size was not defined in the input request, a default page size is used to limit the number of records to fetch
count	No	Number	Number of record in the response object
links	No	Collection of Object	List of Self and/or Next URL

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

Element Name	Required	Data Type	Description
season	No	Number	This field contains the unique identifier for season
description	No	String	This field contains the description associated with the season
startDate	No	date	This field contains the starting date for the season
endDate	No	date	This field contains the ending date for the season
phases	No	Collection of Object	List of Phases associated with the season

Table 5-982 Phases - Object. See list of elements for detail

Element Name	Required	Data Type	Description
phase	No	Number	This field contains the identifier for phase that is associated to a season. The combination of season id and phase id makes a phase unique.
description	No	String	This field holds the description of the phase
startDate	No	date	This field contains the starting date for the phase
endDate	No	date	This field contains the ending date for the phase

Table 5-983 LinkItem - Object. See list of elements for detail

Element Name	Required	Data Type	Description
href	No	String	Service URL
rel	No	String	This can be either 'self' or 'next'. The 'next' link is present if there are more pages to fetches and contains the offsetkey which unique identifies the last record of this response.

Sample Response Message

{
"items": [
{
"season": 10,
"description": "Spring 2023 Collections",
"startDate": "2001-12-31",
"endDate": "2001-12-31",
"phases": [
{
"phase": 2,
"description": "Spring Break/Easter 2023",
"startDate": "2001-12-31",
"endDate": "2001-12-31"
}
]
}
],
"hasMore": true,
"limit": 1,
"count": 1,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000",
"rel": "self"
}
]
}

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 publishes user-defined attribute master data to downstream consuming systems. It publishes the UDA definition for date, free-form, and list-of-values UDAs, and list-of-values UDAs also include their configured value list. Functionally, there is no additional filter in the view, so every row in UDA is eligible for publication.

Technical Details

This service follows the Publish API cache architecture in which the REST service serves pre-generated JSON from an integration cache table that is initially seeded and then maintained through asynchronous delta processing. For overall enablement, scheduling, and guidance on how publish api works and how webhook for this api can be implemented to stream the data out, refer to the white paper Publish APIs - Customer Enablement Overview.

Core business tables: UDA

Additional business tables: UDA_VALUES

JSON cache table: MERCHAPI_EXT_UDA

JSON generation view: V_MERCHAPI_EXT_UDA_JSON

The JSON view reads the UDA header from UDA and left-joins an aggregated UDA_VALUES array to populate udaListOfValues for list-of-values UDAs.

Functionally, there is no additional filter in the view, so every row in UDA is eligible for publication.

Date, free-form, and list-of-values UDAs are all included; only the LOV-style UDAs contribute rows to the udaListOfValues array.

Initial Seeding and post enablement rebuild/repair

Initial seeding and rebuild pull published rows from V_MERCHAPI_EXT_UDA_JSON. No additional filter criteria were identified beyond the cache-build logic.

Mark cache rows deleted when the UDA no longer exists in V_MERCHAPI_EXT_UDA_JSON.

ICL (Integration Change Log) table: ICL_RMS_UDA (ICL consumer name = MERCHAPI)

ICL entries are created using triggers on UDA.

Queue logic distinguishes UDA versus UDA_VALUES changes through ICL_TABLE_NAME.

Batch Configuration. Asynchronous delta processing is supported using Background engine and also via POM scheduling. Choose one.

Process configuration name: API_EXT_UDA

To enable via Background engine set BACKGROUND_RUN_FLAG to Y and review the BACKGROUND_RUN_INTERVAL_SECOND parameter.

POM Batch schedule process and job: MERCHAPI_DELTA_EXT_UDA_ADHOC_PROCESS -> MERCHAPI_EXT_UDA_ADHOC_JOB

Webhook configuration api name: foundation/uda

Service Type

GET

ReST URL

MerchIntegrations/services/foundation/uda

MerchIntegrations/services/foundation/uda/{udaId}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date (Example: 2010-12-31T23:59:59.999Z)
before	No	String	Before Date (Example: 2040-12-31T23:59:59.999Z)
offsetkey	No	String	Offset key (UDA Id)
limit	No	String (6)	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-984 Input Parameter for "MerchIntegrations/services/foundation/uda/{udaId}"

Parameter Name	Required	Data Type	Description
udaId	Yes	Number	UDA 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

Table 5-985 PageResultsItemsMerchApiUda - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	Collection of records
hasMore	No	Boolean	Boolean to signify if there are additional pages of data. This is true if limit = count for pagination supported request
limit	No	Number	Requested page size. If the page size was not defined in the input request, a default page size is used to limit the number of records to fetch
count	No	Number	Number of record in the response object
links	No	Collection of Object	List of Self and/or Next URL

Table 5-986 MerchApiUda - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	No	String (6)	Action for UDA details.
udaId	No	Number(5,0)	This field contains a unique number identifying the user-defined attribute.
udaDescription	No	String (120)	This field contains a description of the user-defined attribute.
displayType	No	String (2)	This field contains the display type, which is how the UDA values will be displayed to the user. Valid values are DT - Date, FF - Free Form, and LV - List of Values.
dataType	No	String (12)	This field contains the data type of any valid values for the UDA. Valid values are Number, Alphanumeric, and Date.
dataLength	No	Number(3,0)	This field contains the data length of any valid values for the UDA.
singleValueInd	No	String (1)	This field indicates whether or not the UDA should be constrained to having at most one value. Valid values are Y and N.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).
udaListOfValues	No	Collection of Object	This list holds the UDA list of values.
cacheTimestamp	No	dateTime	This field specifies the date and time when the UDA record was fetched into the cache for web service publication (UTC).
cacheCreateTimestamp	No	dateTime	This field specifies the date and time when the record was first created for web service publication (UTC).

Table 5-987 UdaValues - Object. See list of elements for detail

Element Name	Required	Data Type	Description
udaValue	No	Number(5,0)	This field contains a unique number identifying the user-defined attribute value for the UDA. A UDA can have multiple values.
udaValueDescription	No	String (250)	This field contains a description of the user-defined attribute value.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).

Table 5-988 LinkItems - Object. See list of elements for detail

Element Name	Required	Data Type	Description
href	No	String	Service URL
rel	No	String	This can be either 'self' or 'next'. The 'next' link is present if there are more pages to fetch and contains the offsetkey which uniquely identifies the last record of this response.

Sample Response Message

{
"items": [
{
"action": "INSERT",
"udaId": 201,
"udaDescription": null,
"displayType": "FF",
"dataType": null,
"dataLength": 1,
"singleValueInd": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"udaListOfValues": [
{
"udaValue": 1,
"udaValueDescription": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"cacheTimestamp": "2001-12-31T23:59:59.000Z",
"cacheCreateTimestamp": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1000,
"count": 1000,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000&since=1970-01-01T00:00:00.001Z&before=2024-01-01T00:00:00.001Z&offsetkey=1234,XYZ",
"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
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-989 /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-990 /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-991 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-992 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