Merchandising to Omnichannel Services
The following services are included in this functional area:
REST Endpoint for Omni Channel/Diff Group
Business Overview
This service is used by Omni Channel applications to get diff group details from Merchandising.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/diff/group?since={since}&before={before&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
offsetkey |
No |
String |
Offset Key. Valid Value are Combination of valid Differentiator Group ID and a valid
Differentiator IF separated by comma. For example: |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
Action |
String |
Action for Item details. Valid Values
are |
diffgroupid |
String |
This field will hold a unique number (identifier) for the differentiator group. |
diffgroupdesc |
String |
Description of the differentiator group (for example: Mens Shirt Sizes, Womens Shoe Sizes, Girls Dress Sizes, Shower Gel Scents, Yogurt Flavors, and so on). |
difftypeid |
String |
This field will hold a value of
the types of differentiators contained in this differentiator group, such as |
diffid |
String |
Contains the differentiator which
are associated with a differentiator group. This field must be a valid value from the |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
Example JSON input:
" {
"items": [
{
"action": "INSERT",
"diffgroupid": "1177",
"diffgroupdesc": "EIT_Diff_Group_1",
"difftypeid": "CF",
"diffid": "4280"
}
],
"hasMore": true,
"limit": 1,
"count": 1,
"links": [
{
"href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/diff/group?before=2021-05-06T16%3A12%3A02.551757%2B08%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z",
"rel": "self"
},
{
"href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/diff/group?before=2021-05-06T16%3A12%3A02.551757%2B08%3A00&limit=1&offsetkey=1177%2C4280&since=1970-01-01T00%3A00%3A00.001Z",
"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 |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
ICL_RMS_DIFF_GROUP |
Yes |
Yes |
Yes |
Yes |
MERCHAPI_DIFF_GROUP |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_DIFF_GROUP |
Yes |
No |
No |
No |
V_MERCHAPI_DIFF_GROUP_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_ITEM_JSON |
Yes |
No |
No |
No |
MERCHAPI_ITEM_DIFF_TYPE |
Yes |
Yes |
Yes |
Yes |
REST Endpoint for Omni Channel/Diff IDs
Business Overview
This service is used by Omni Channel applications to get diff IDs and its details from Merchandising.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/diff?since={since}&before={before&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
offsetkey |
No |
String |
Offset Key. Valid Value is Differentiator ID. For example: |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
action |
String |
Action for Item details. Valid Values
are |
diffid |
String |
Contains the code to uniquely identify a differentiator. |
diffdesc |
String |
Description of the differentiator (for example, Blueberry, Shower Fresh, Red, and so on). |
difftype |
String |
This field will hold a value of
the types of differentiators contained in this differentiator group, such as |
difftypedesc |
String |
Contains the description of the differentiator type. Contains the description of the differentiator type. |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
Example JSON input:
" { "items": [ { "action": "INSERT", "diffid": "1005", "diffdesc": "EIT_Diff_ID : Black", "difftype": "CF", "difftypedesc": "Cereal Flavour" } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/diff?before=2021-05-05T16%3A18%3A57.100893%2B08%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/diff?before=2021-05-05T16%3A18%3A57.100893%2B08%3A00&limit=1&offsetkey=1005&since=1970-01-01T00%3A00%3A00.001Z", "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_IDS |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_DIFF_TYPE |
Yes |
Yes |
Yes |
Yes |
DIFF_IDS |
Yes |
No |
No |
No |
MERCHAPI_DIFF_IDS |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_DIFF_IDS_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_DIFF_IDS |
Yes |
No |
No |
No |
V_MERCHAPI_ITEM_JSON |
Yes |
No |
No |
No |
MERCHAPI_ITEM_DIFF_TYPE |
Yes |
Yes |
Yes |
Yes |
MERCHAPI_ITEM_DIFF_VALUE |
Yes |
Yes |
Yes |
Yes |
REST Endpoint for Omni Channel/Inventory/Store Details
Business Overview
This service is used by Omni Channel applications to get available inventory for store locations from Merchandising.
ReST URL
/MerchIntegrations/services/inventory/omnichannel/inventory/store?since={since}&before={before}&offsetkey={offsetkey}&limit={limit}&nodelevel={nodelevel}&nodeid={nodeId}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
nodelevel |
No |
String |
Node Level Valid Value
is |
nodeid |
No |
Number |
Node ID Should be a valid
store number if |
offsetkey |
No |
String |
Offset Key. Valid Value is combination of store ID and item in case of entire stores list being pulled or item in case a specific store ID is pulled. |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
action |
String |
Action for Item details. Valid Values
are |
item |
String |
This field contains the unique alphanumeric value that identifies the item. |
location |
Number |
This field contains the numeric identifier of the location in which the item is to be found. |
loctype |
String |
This field contains the Type of location in the location field. |
availablequantity |
Number |
This field represents the available inventory of an item in a particular location. |
stockonhand |
Number |
This field contains current stock on hand for the item. |
standarduom |
String |
This field contains the Unit of measure in which stock of the item is tracked at a corporate level. |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined, then |
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 |
links |
|
Example JSON input:
" {
"items": [
{
"action": "INSERT",
"item": "100000286",
"location": "1341",
"loctype": "S",
"availablequantity": 100,
"stockonhand": 100,
"standarduom": "EA"
}
],
"hasMore": true,
"limit": 1,
"count": 1,
"links": [
{
"href": "http://<hostname>:<portnumber>/MerchIntegrations/services/inventory/omnichannel/inventory/store?before=2021-05-13T18%3A28%3A10.129377%2B05%3A30&limit=1&since=1970-01-01T00%3A00%3A00.001Z",
"rel": "self"
},
{
"href": "http://<hostname>:<portnumber>/MerchIntegrations/services/inventory/omnichannel/inventory/store?before=2021-05-13T18%3A28%3A10.129377%2B05%3A30&limit=1&offsetkey=1341%2C100000286&since=1970-01-01T00%3A00%3A00.001Z",
"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 |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_LOC_SOH |
Yes |
No |
No |
No |
STORE |
Yes |
No |
No |
No |
MERCHAPI_ITEM_LOC |
Yes |
No |
No |
No |
REST Endpoint for Omni Channel/Inventory/Warehouse Details
Business Overview
This service is used by Omni Channel applications to get available inventory for warehouse locations from Merchandising.
ReST URL
/MerchIntegrations/services/inventory/omnichannel/inventory/warehouse?since={since}&before={before}&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
offsetkey |
No |
String |
Offset Key. Valid Value is combination of store ID and item in case of entire warehouses list being pulled or item in case specific warehouse ID is pulled. |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
action |
String |
Action for Item details. Valid Values
are |
item |
String |
This field contains the unique alphanumeric value that identifies the item. |
location |
Number |
This field contains the numeric identifier of the location in which the item is to be found. |
loctype |
String |
This field contains the Type of location in the location field. |
availablequantity |
Number |
This field represents the available inventory of an item in a particular location. |
stockonhand |
Number |
This field contains current stock on hand for the item. |
standarduom |
String |
This field contains the Unit of measure in which stock of the item is tracked at a corporate level. |
physicalwarehouse |
Number |
This field contains the physical warehouse ID of the location field |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
Example JSON input:
" { "items": [ { "action": "INSERT", "item": "100000075", "location": "10001", "loctype": "W", "availablequantity": 0, "stockonhand": 0, "standarduom": "EA", "physicalwarehouse": 2 } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/inventory/omnichannel/inventory/warehouse?before=2021-05-13T19%3A14%3A44.470363%2B05%3A30&limit=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/inventory/omnichannel/inventory/warehouse?before=2021-05-13T19%3A14%3A44.470363%2B05%3A30&limit=1&offsetkey=10001%2C100000075&since=1970-01-01T00%3A00%3A00.001Z", "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 |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_LOC_SOH |
Yes |
No |
No |
No |
WH |
Yes |
No |
No |
No |
MERCHAPI_ITEM_LOC |
Yes |
No |
No |
No |
REST Endpoint for Omni Channel/Item Details
Business Overview
This service is used by Omni Channel applications to get all or location specific items and its details from Merchandising.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/item?since={since}&before={before}}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
nodelevel |
No |
String |
Node Level. Valid Value are |
nodeid |
No |
BigDecimal |
Node ID. Valid Values are Valid stores present in the |
offsetkey |
No |
String |
Offset Key. Valid Value is an Item ID. |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
action |
String |
Action for Item details. Valid Values
are |
item |
String |
This field specifies a unique alphanumeric value that identifies the item. |
itemLocation |
Number |
This field specifies location id associated with item if valid node level value is sent. If Node level is absent then it defaults to ‘ent’ that refers to Enterprise. |
itemparent |
String |
This field specifies an alphanumeric value that uniquely identifies the item/group at the level above the item. |
itemgrandparent |
String |
This field specifies an alphanumeric value that uniquely identifies the item/group two levels above the item. |
itemlevel |
Number |
This field specifies a number indicating in which of the three levels the item resides. The item level determines whether the item stands alone or if it is part of a family of related items. |
tranlevel |
Number |
This field specifies a number indicating in which of the three levels transactions occur for the items group. The transaction level is the level at which the items inventory is tracked in the system. |
inventoryind |
String |
This field determines whether an item holds inventory or not for item transformations. |
diff1level |
String |
This field specifies diff1 level. |
diff1type |
String |
This field specifies diff1 type. |
diff1 |
String |
This field specifies a |
diff2level |
String |
This field specifies diff2 level. |
diff2type |
String |
This field specifies diff2 type. |
diff2 |
String |
This field specifies a |
diff3level |
String |
This field specifies diff3 level. |
diff3type |
String |
This field specifies diff3 type. |
diff3 |
String |
This field specifies a |
division |
Number |
This field specifies a number that uniquely identifies the division of the company. |
groupid |
Number |
This field specifies the group in which the department exists. |
dept |
Number |
This field uniquely identifies the department |
class |
Number |
This field uniquely identifies the class within the system. |
uniqueclass |
Number |
This field uniquely identifies the department/class combination. |
subclass |
Number |
This field uniquely identifies the subclass. |
uniquesubclass |
Number |
This field uniquely identifies the department/class/subclass combination. |
description |
String |
This field specifies the description of the item. For items that have parents, this description will default to the parents description plus any differentiators |
localdescription |
String |
This field specifies local description of item at the node location. This is null if query parameter of node is not used |
localshortdescription |
String |
This field specifies local short description of item at the node location. This is null if query parameter of node is not used |
brandname |
String |
This field specifies the brand associated to an item. |
merchandiseind |
String |
Indicates whether the item is a merchandise item. Merchandise items are generally physical items (things that must be shipped/received and of which there is an inventory). Non-merchandise items are often items that do not have inventory. Common examples include extra fees for service (extended warranties, alterations) or endlessly available items (downloads, in-app purchases of bonus content, or subscriptions) |
uintype |
String |
This field specifies a unique identification number (UIN) used to identify the instances of the item at the location. |
mfgrecretail |
Number |
This field specifies manufacturers recommended retail price for the item. This field is stored in the primary currency. |
orginalunitretail |
Number |
This field specifies retail price for the item. |
catchweightind |
String |
This field specifies whether the item should be weighed when it arrives at a location. |
itemservicelevel |
String |
This field specifies value that restricts the type of shipment methods that RCOM can select for an item. |
giftwrapind |
String |
This field determines whether the location will support gift wrapping or not. |
shipaloneind |
String |
This field indicates if the item should be shipped to the customer in a separate package versus being grouped together in a box. |
standarduom |
String |
This field specifies the unit of measure in which stock of the item is tracked at a corporate level |
productclassification |
String |
Field determines how to pack customer orders: such as to determine products that may not be able to be packaged together. Examples of classifications may include fragile, toxic, heavy, and son on. |
xdiff1desc |
String |
Field specifies diff1 description |
xdiff2desc |
String |
Field specifies diff2 description |
Xdiff3desc |
String |
Field specifies diff3 description |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
Example JSON Input
{
"items": [
{
"item": "100000024",
"action": "INSERT",
"itemlocation": "ent",
"itemparent": null,
"itemgrandparent": null,
"itemlevel": 1,
"tranlevel": 3,
"inventoryind": "Y",
"diff1level": null,
"diff1type": null,
"diff1": null,
"diff2level": null,
"diff2type": null,
"diff2": null,
"diff3level": null,
"diff3type": null,
"diff3": null,
"division": 1000,
"groupid": 108,
"dept": 1117,
"class": 1,
"uniqueclass": 51,
"subclass": 1,
"uniquesubclass": 432,
"description": "Test Item 100000024 ",
"localdescription": null,
"localshortdescription": null,
"brandname": null,
"merchandiseind": "Y",
"uintype": null,
"mfgrecretail": null,
"orginalunitretail": 13.2,
"catchweightind": "N",
"itemservicelevel": null,
"giftwrapind": "N",
"shipaloneind": "N",
"standarduom": "EA",
"productclassification": "APP",
"xdiff1desc": null,
"xdiff2desc": null,
"xdiff3desc": null}
],
"hasMore": true,
"limit": 1,
"count": 1,
"links": [
{
"href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/item?before=2021-05-12T23%3A35%3A49.770127%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&since=1970-01-01T00%3A00%3A00.001Z",
"rel": "self"
},
{
"href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/item?before=2021-05-12T23%3A35%3A49.770127%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&offsetkey=100000024&since=1970-01-01T00%3A00%3A00.001Z ",
"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 |
ICL_RMS_ITEM_MASTER |
Yes |
No |
Yes |
Yes |
MERCHAPI_ITEM_MASTER |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_ITEM_MASTER |
Yes |
No |
No |
No |
ICL_RMS_ITEM_IMAGE |
No |
Yes |
No |
No |
ICL_RMS_RELATED_ITEM |
No |
Yes |
No |
No |
ICL_RMS_ITEM_LOC |
No |
Yes |
No |
No |
SYSTEM_OPTIONS |
Yes |
No |
No |
No |
REST Endpoint for Omni Channel/Item UPC Details
Business Overview
This service is used by Omni Channel applications to get all or location specific item UPCs and its details from Merchandising.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/item/upc?since={since}&before={before}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
nodelevel |
No |
String |
Node Level. Valid Value are |
nodeid |
No |
BigDecimal |
Node ID. Valid Values are Valid stores present in the |
offsetkey |
No |
String |
Offset Key. Valid Value is an Item ID. |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
action |
String |
Action for Item details. Valid Values
are |
item |
String |
This field specifies unique alphanumeric value that identifies the item. |
itemLocation |
Number |
This field specifies
a location ID associated with the item if a valid node level value is sent. If Node level is absent then it defaults to |
itemparent |
String |
This field specifies an alphanumeric value that uniquely identifies the item/group at the level above the item. |
itemgrandparent |
String |
This field specifies an alphanumeric value that uniquely identifies the item/group two levels above the item. |
itemlevel |
Number |
This field specifies a number indicating in which of the three levels the item resides. The item level determines whether the item stands alone or if it is part of a family of related items. |
tranlevel |
Number |
This field specifies a number indicating which of the three levels transactions occur for the items group. The transaction level is the level at which the items inventory is tracked in the system. |
inventoryind |
String |
This field determines whether an item holds inventory or not for item transformations. |
diff1level |
String |
This field specifies diff1 level. |
diff1type |
String |
This field specifies diff1 type. |
diff1 |
String |
This field specifies a |
diff2level |
String |
This field specifies diff2 level. |
diff2type |
String |
This field specifies diff2 type. |
diff2 |
String |
This field specifies a |
diff3level |
String |
This field specifies diff3 level. |
diff3type |
String |
This field specifies diff3 type. |
diff3 |
String |
This field specifies a |
division |
Number |
This field specifies a number that uniquely identifies the division of the company. |
groupid |
Number |
This field specifies the group in which the department exists. |
dept |
Number |
This field uniquely identifies the department |
class |
Number |
This field uniquely identifies the class within the system. |
uniqueclass |
Number |
This field uniquely identifies the department/class combination. |
subclass |
Number |
This field uniquely identifies the subclass. |
uniquesubclass |
Number |
This field uniquely identifies the department/class/subclass combination. |
description |
String |
This field specifies the description of the item. For items that have parents, this description will default to the parent’s description plus any differentiators |
localdescription |
String |
This field is populated as empty for a UPC Item. |
brandname |
String |
This field specifies the brand associated with an item. |
merchandiseind |
String |
Indicates whether the item is a merchandise item. Merchandise items are generally physical items (things that must be shipped/received and of which there is an inventory). Non merchandise items are often items that do not have inventory. Common examples include extra fees for service (extended warranties, alterations) or endlessly available items (downloads, in-app purchases of bonus content, subscriptions) |
uintype |
String |
This field is populated as empty for a UPC Item. |
mfgrecretail |
Number |
This field specifies the manufacturer’s recommended retail price for the item. This field is stored in the primary currency. |
orginalunitretail |
Number |
This field specifies retail price for the item. |
catchweightind |
String |
This field specifies whether the item should be weighed when it arrives at a location. |
itemservicelevel |
String |
This field specifies a value that restricts the type of shipment methods that RCOM can select for an item. |
giftwrapind |
String |
This field determines whether the location will support gift wrapping or not. |
shipaloneind |
String |
This field indicates whether the item should be shipped to the customer in a separate package versus being grouped together in a box. |
standarduom |
String |
This field specifies the unit of measure in which stock of the item is tracked at a corporate level |
productclassification |
String |
This field determines how to pack customer orders: such as to determine products that may not be able to be packaged together. Examples of classifications may include fragile, toxic, heavy, and so on. |
xdiff1desc |
String |
Field specifies diff1 description |
xdiff2desc |
String |
Field specifies diff2 description |
Xdiff3desc |
String |
Field specifies diff3 description |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
Example JSON input:
" { "items": [ { "item": "101100001", "action": "INSERT", "itemlocation": "ent", "itemparent": "100250007", "itemgrandparent": null, "itemlevel": 2, "tranlevel": 1, "inventoryind": "Y", "diff1level": null, "diff1type": null, "diff1": null, "diff2level": null, "diff2type": null, "diff2": null, "diff3level": null, "diff3type": null, "diff3": null, "division": 3000, "groupid": 304, "dept": 3041, "class": 1, "uniqueclass": 139, "subclass": 1, "uniquesubclass": 17, "description": "Something - MK", "localdescription": null, "merchandiseind": "Y", "uintype": null, "mfgrecretail": null, "orginalunitretail": null, "catchweightind": "N", "itemservicelevel": null, "giftwrapind": "N", "shipaloneind": "N", "standarduom": "EA", "productclassification": null, "xdiff1desc": null, "xdiff2desc": null, "xdiff3desc": null } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/item/upc?before=2021-05-13T16%3A38%3A07.284763%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&since=1970-01-01T00%3A00%3A00.001Z ", "rel": "self" }, { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/item/upc?before=2021-05-13T16%3A38%3A07.284763%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&offsetkey=101100001&since=1970-01-01T00%3A00%3A00.001Z ", "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 |
ICL_RMS_ITEM_MASTER |
Yes |
No |
Yes |
Yes |
MERCHAPI_ITEM_MASTER |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_ITEM_MASTER |
Yes |
No |
No |
No |
ICL_RMS_ITEM_IMAGE |
No |
Yes |
No |
No |
ICL_RMS_RELATED_ITEM |
No |
Yes |
No |
No |
ICL_RMS_ITEM_LOC |
No |
Yes |
No |
No |
SYSTEM_OPTIONS |
Yes |
No |
No |
No |
REST Endpoint for Omni Channel/Merchandise Hierarchy Details
Business Overview
This service is used by Omni Channel applications to get merchandise hierarchies and its details from Merchandising.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/merchhier?since={since}&before={before}&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
offsetkey |
No |
String |
Offset Key. Valid Value is combination of |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
action |
String |
Action for Item details. Valid Values
are |
nodeid |
Number |
This field contains the Merchandising Hierarchy ID. |
hierarchylevel |
String |
This field contains the Merchandising Hierarchy Level. |
nodename |
String |
This field contains the name of the Merchandising Hierarchy. |
parentlevel |
String |
This field contains the Parent Merchandising Hierarchy Level. |
parentnodeid |
Number |
This field contains the Parent Merchandising Hierarchy ID. |
merchdisplayid |
Number |
This field contains the merchandising hierarchy display id. |
buyer |
String |
This field contains the number of the buyer associated with the merchandising hierarchy. |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
Example JSON input:
" { "items": [ { "action": "UPDATE", "nodeid": 1, "hierarchylevel": "COMPANY", "nodename": "Retailers Ltd", "parentlevel": null, "parentnodeid": null, "merchdisplayid": 1, "buyer": null } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/merchhier?before=2021-05-12T20%3A43%3A04.296066%2B05%3A30&limit=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/location/warehouse?before=2021-05-12T20%3A15%3A13.253929%2B05%3A30&limit=1&offsetkey=2%2Cvirtual&since=1970-01-01T00%3A00%3A00.001Z ", "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_DIVISION |
Yes |
No |
Yes |
Yes |
ICL_RMS_GROUPS |
Yes |
No |
Yes |
Yes |
ICL_RMS_DEPS |
Yes |
No |
Yes |
Yes |
ICL_RMS_CLASS |
Yes |
No |
Yes |
Yes |
ICL_RMS_SUBCLASS |
Yes |
No |
Yes |
Yes |
COMPHEAD |
Yes |
No |
No |
No |
CODE_DETAIL |
Yes |
No |
No |
No |
MERCHAPI_MERCH_HIER |
Yes |
Yes |
Yes |
Yes |
V_ MERCHAPI_MERCH_HIER |
Yes |
No |
No |
No |
V_ MERCHAPI_MERCH_HIER _JSON |
Yes |
No |
No |
No |
SYSTEM_OPTIONS |
Yes |
No |
No |
No |
REST Endpoint for Omni Channel/Org Hier Descendant’s Details
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Organization Hierarchy Descendants details. Org hierarchy descendants are used by Oracle Retail Xstore Point of Service to retrieve a complete branch of org hierarchy rooted at a specific node – for example, locations under a region.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/orghier/descendant?since={since}&before={before}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
nodelevel |
No |
String |
Node Level. Valid Value are |
nodeid |
No |
BigDecimal |
Node ID. Valid Values are Company, Chain, Area, Region, and District present in respective tables. |
offsetkey |
No |
String |
Offset Key. Valid Value: levelorder. |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
action |
String |
Action for Item details. Valid Values
are |
hierarchylevel |
String |
This field specifies the Organization Hierarchy Level. |
hierarchynodeid |
Number |
This field specifies the Organization Hierarchy ID. |
hierarchynodename |
String |
This field specifies the name of the Organization Hierarchy ID. |
parentlevel |
String |
This field specifies the Parent Organization Hierarchy Level. |
parentid |
Number |
This field specifies the Parent Organization Hierarchy ID. |
levelorder |
Number |
This column contains the hierarchy
level of the Organization Hierarchy. Valid values : |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
Example JSON input:
" { "items": [ { "hierarchylevel": "COMPANY", "hierarchynodeid": 9118, "hierarchynodename": "Retailers Ltd", "parentlevel": null, "parentid": null, "levelorder": 1 } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/orghier/descendant?nodelevel=COMPANY&limit=1&nodeid=9118", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/orghier/descendant?nodelevel=COMPANY&limit=1&nodeid=9118&offsetkey=1%2C9118", "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 |
V_ICL_RMS_ORGHIER |
Yes |
No |
No |
No |
ICL_RMS_CHAIN |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_AREA |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_REGION |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_DISTRICT |
Yes |
Yes |
Yes |
Yes |
ITEM_LOC |
Yes |
No |
No |
No |
MERCHAPI_ORG_HIER |
Yes |
Yes |
Yes |
Yes |
V_ORG_HIER_FULL_VW |
Yes |
No |
No |
No |
V_MERCHAPI_ORG_HIER |
Yes |
No |
No |
No |
REST Endpoint for Omni Channel/Org Hierarchy Details
Business Overview
This service is used by Omni Channel applications to get organizational hierarchies and its details from Merchandising.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/orghier?since={since}&before={before}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
Since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
nodelevel |
No |
String |
Node Level. Valid Value are |
nodeid |
No |
BigDecimal |
Node ID. Valid Values are Company, Chain, Area, Region, District, and Store IDs present in respective tables. |
offsetkey |
No |
String |
Offset Key. Contains combination of valid hierarchy level and a valid hierarchy node id separated by comma. |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
Action |
String |
Action for Item details. Valid Values
are |
hierarchylevel |
String |
This field specifies the Organization Hierarchy Level. |
hierarchynodeid |
Number |
This field specifies the Organization Hierarchy ID. |
hierarchynodename |
String |
This field specifies the name of the Organization Hierarchy ID |
parentlevel |
String |
This field specifies the Parent Organization Hierarchy Level. |
parentid |
Number |
This field specifies the Parent Organization Hierarchy ID. |
mgrname |
String |
This field specifies the name of the store manager. |
stockholding |
String |
This column indicates
whether the store can hold stock. In a non-multichannel environment this will always be |
integratedpos |
String |
This field Indicates whether or not the POS system at the Store is integrated. This field holds value only for stores. |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
Links |
|
Example JSON input:
" { "action": "UPDATE", "hierarchylevel": "AREA", "hierarchynodeid": 1212, "hierarchynodename": "Area 12121", "parentlevel": "CHAIN", "parentid": 1212, "mgrname": "V", "stockholding": null, "integratedpos": null } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/orghier?before=2021-05-11T15%3A20%3A25.711306%2B00%3A00&nodelevel=COMPANY&limit=1&nodeid=9118&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/orghier?before=2021-05-11T15%3A20%3A25.711306%2B00%3A00&nodelevel=COMPANY&limit=1&nodeid=9118&offsetkey=AREA%2C1212&since=1970-01-01T00%3A00%3A00.001Z", "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 |
V_ICL_RMS_ORGHIER |
Yes |
No |
No |
No |
ICL_RMS_CHAIN |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_AREA |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_REGION |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_DISTRICT |
Yes |
Yes |
Yes |
Yes |
ITEM_LOC |
Yes |
No |
No |
No |
MERCHAPI_ORG_HIER |
Yes |
Yes |
Yes |
Yes |
V_ORG_HIER_FULL_VW |
Yes |
No |
No |
No |
V_MERCHAPI_ORG_HIER |
Yes |
No |
No |
No |
REST Endpoint for Omni Channel/Refresh Date
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve metadata related to individual Merch Integrations services. This service returns the timestamp when the data cache table was initially loaded or had a complete data refresh. A change in last refresh date for a service end point is an indication for the consuming system that high volume of data will be interfaced and the consumer can choose to use regular delta integration process or switch to flushing earlier interfaced data and load the data freshly.
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
entitytype |
No |
String |
Entity Type. Merchandising Integration Rest Service name. |
Output
Name | Data Type | Description |
---|---|---|
entity |
String |
This column contains the Merchandising Integration REST Service Name. |
refresh_date |
String |
This column contains the Refresh date of the Merchandising Integration REST Service API. |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
Example JSON input:
" { "items": [ { "entity": "COFutureAvail", "refreshdate": "2020-12-17T10:03:12.324664000-06:00" } ], "hasMore": false, "limit": 10000, "count": 15, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/omnichannel/refreshdate?before=2021-05-06T21%3A00%3A34.238393%2B08%3A00&limit=10000&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" } ] }"
REST Endpoint for Omni Channel/Warehouse Details
Business Overview
This service is used by Omni Channel applications to get warehouses and its details from Merchandising.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/location/warehouse?since={since}&before={before}&offsetkey={offsetkey}&limit={limit}&nodelevel={nodelevel}&nodeid={nodeId}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
nodelevel |
No |
String |
Node Level Valid Value
is |
nodeid |
No |
Number |
Node ID Should be a valid
store number if |
offsetkey |
No |
String |
Offset Key. Valid Value is warehouse id and ware house type. |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
action |
String |
Action for Item details. Valid Values
are |
warehouseid |
Number |
This field uniquely identifies the warehouse. |
type |
String |
This field determine whether the warehouse is physical or virtual. |
warehousename |
String |
This field specifies the name of the warehouse which, along with the warehouse number, identifies the warehouse. |
whnamesecondary |
String |
This field specifies the Secondary name of the warehouse. |
contactname |
String |
This field specifies the name of the contact at this location. |
phonenumber |
Number |
This field specifies the phone number of the contact person at this location. |
faxnumber |
Number |
This field specifies the fax number of the contact person at this location. |
|
String |
This field contains the email address for the location. |
currencycode |
String |
This field specifies the currency code under which the warehouse operates. |
physicalwh |
String |
This field specifies the number of the physical warehouse that are assigned to the virtual warehouse. |
vatregion |
Number |
This field specifies a unique identifying number for the VAT region where this warehouse is located. |
orghiertype |
Number |
Organization type that will be used in reporting purposes for the warehouse. The type comes from the organizational hierarchy. |
orghiervalue |
Number |
This field specifies a code associated with the specific organizational hierarchy type. |
orgentitytype |
String |
This field specifies whether the warehouse is a legal entity (Importer, Exporter) or a regular warehouse. |
channelid |
Number |
This field specifies the channel to which the virtual warehouse will be assigned. |
channelname |
String |
This field specifies the name of the channel for which the virtual warehouse will be assigned. |
address1 |
String |
This field specifies the first line of the address for this location. |
address2 |
String |
This field specifies the second line of the address for this location. |
address3 |
String |
This field specifies the third line of the address for this location. |
city |
String |
This field specifies the name of the city associated with the address for this location. |
State |
String |
This field specifies the state abbreviation for the address for this location. |
Country |
String |
This field specifies the country where the address exists. |
postalcode |
String |
This field specifies the zip code for the address. |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
Example JSON input:
" { "items": [ { "action": "INSERT", "warehouseid": 2, "type": "virtual", "warehousename": "N. America Central", "whnamesecondary": null, "contactname": "Sue Glass", "phonenumber": "3122222473", "faxnumber": null, "email": null, "currencycode": "USD", "physicalwh": 2, "vatregion": 1000, "orghiertype": null, "orghiervalue": null, "orgentitytype": "R", "channelid": null, "channelname": null, "address1": "123 Street", "address2": "Anytown", "address3": null, "city": "Anycity", "state": "MN", "country": "US", "postalcode": "50250" } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/location/warehouse?before=2021-05-12T20%3A15%3A13.253929%2B05%3A30&limit=1&since=1970-01-01T00%3A00%3A00.001Z ", "rel": "self" }, { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/merchhier?before=2021-05-12T21%3A00%3A13.036021%2B05%3A30&limit=1&offsetkey=10%2C1&since=1970-01-01T00%3A00%3A00.001Z ", "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_WH |
Yes |
No |
Yes |
Yes |
ICL_RMS_ADDR |
Yes |
No |
Yes |
Yes |
ADDR |
Yes |
No |
No |
No |
MERCHAPI_WH |
Yes |
Yes |
Yes |
Yes |
MERCHAPI_ORG_HIER |
No |
No |
Yes |
No |
V_MERCHAPI_WH |
Yes |
No |
No |
No |
V_MERCHAPI_WH_JSON |
Yes |
No |
No |
No |
SYSTEM_OPTIONS |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/Related Item
Business Overview
This service is used by Omni Channel applications to get related item details from Merchandising.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/item/relateditem?since={since}&before={before}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
nodelevel |
No |
String |
Node Level. Valid Value is |
nodeid |
No |
BigDecimal |
Node ID. Valid Values are Valid stores present in the |
offsetkey |
No |
String |
Offset Key. Valid Value are Combination of valid Relationship ID and a valid Related Item separated by comma. For example: relid, relitem |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
Action |
String |
Action for Item details. Valid Values
are |
relationshipid |
String |
This column contains unique identifier for each relationship header. |
item |
String |
This column contains item for which the relationships are defined. |
relationshiptype |
String |
This column describes
the type of relationship. Values are configured in |
mandatoryind |
String |
This column indicates whether the relationship is mandatory. |
relateditem |
String |
This column contains the item ID of the related item. |
relateditemaction |
String |
Related Action for Item
details. Valid Values are |
startdate |
String |
This column contains the start date for a related item. Represents the date from which related item can be used on transactions. |
enddate |
String |
This column contains the end date for a related item. Represents the date until which the related item can be used on transactions. A value of null means that it is effective forever. |
priority |
BigDecimal |
This column contains priority which is 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. |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
Example JSON input:
" { "items": [ { "action": "INSERT", "relationshipid": 120001, "item": "111150001", "relationshiptype": "CRSL", "mandatoryind": "N", "relateditem": "111051290", "relateditemaction": "INSERT", "startdate": null, "enddate": null, "priority": null } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/relateditem?before=2021-05-06T18%3A17%3A30.285106%2B08%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://localhost:8080/MerchIntegrations/services/foundation/omnichannel/item/relateditem?before=2021-05-06T18%3A17%3A30.285106%2B08%3A00&limit=1&offsetkey=120001%2C111051290&since=1970-01-01T00%3A00%3A00.001Z", "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_RELATED_ITEM |
Yes |
Yes |
Yes |
Yes |
MERCHAPI_RELATED_ITEM |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_RELATED_ITEM_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_RELATED_ITEM |
Yes |
Yes |
Yes |
Yes |
REST Endpoint for Omnichannel/Retail Store Details
Business Overview
This service is used by Omni Channel applications to get all or hierarchy level specific stores and its details from Merchandising.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/location/retailstore?since={since}&before={before}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
nodelevel |
No |
String |
Node Level. Valid Value are |
nodeid |
No |
BigDecimal |
Node ID. Valid Values are with respect to nodelevel parameter. These are IDs of a particular
node level. For example: If node level is |
offsetkey |
No |
String |
Offset Key. Valid Value is Store ID. |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
action |
String |
Action for Item details. Valid Values
are |
address1 |
String |
This field contains the first line of the store address. |
address2 |
String |
This field contains the second line of the store address. |
address3 |
String |
This field contains the third line of the store address. |
city |
String |
This field contains the name of the city that is associated with the store address. |
contactname |
String |
This field contains the name of the contact for the store at this address. |
country |
String |
This field contains the country where the store address exists. |
currencycode |
String |
This field contains the currency code under which the store operates. |
|
String |
This field contains the email address for the location. |
integratedpos |
String |
This field indicates whether or not the POS system at the Store is integrated. |
manager |
String |
This field contains the name of the store manager |
phonenumber |
String |
This field contains the phone number for the store. |
postalcode |
String |
This field contains the zip code for the store address. |
sellingsqfeet |
Number |
This field contains the total square footage of the stores selling area. |
state |
String |
This field contains the state abbreviation for the store address. |
stockholding |
String |
This field indicates
whether the store can hold stock. In a non-multichannel environment this will always be |
storeid |
Number |
This field contains the number that uniquely identifies the store. |
storename |
String |
This field contains the name of the store which, along with the store number, identifies the store. |
storename10 |
String |
This field contains a ten-character abbreviation of the store name. |
totalsqfeet |
Number |
This column contains the total square footage of the store. |
vatregion |
Number |
This column contains the number of the Value Added Tax region in which this store is located. |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
Example JSON input:
" { "items": [ { "action": "INSERT", "storeid": 1111, "storename": "Rebuild with refresh N NO ICL Charlotte *", "storename10": "Charlotte", "manager": "Don Wright", "phonenumber": "704-555-2121", "faxnumber": null, "email": null, "totalsqfeet": 64400, "sellingsqfeet": 59500, "currencycode": "USD", "vatregion": 1000, "stockholding": "Y", "integratedpos": "Y", "contactname": "Sue Glass", "address1": "123 Street", "address2": "Anytown", "address3": null, "city": "Anycity", "state": "MN", "country": "US", "postalcode": "50250" } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/location/retailstore?before=2021-05-12T17%3A30%3A45.385517%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/location/retailstore?before=2021-05-12T17%3A30%3A45.385517%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&offsetkey=1111&since=1970-01-01T00%3A00%3A00.001Z", "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_STORE |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_ADDR |
Yes |
No |
Yes |
Yes |
ADDR |
Yes |
No |
No |
No |
STORE |
Yes |
No |
No |
No |
MERCHAPI_RETAIL_STORE |
Yes |
Yes |
Yes |
Yes |
MERCHAPI_ORG_HIER |
No |
No |
Yes |
No |
V_MERCHAPI_RETAIL_STORE_JSON |
Yes |
No |
No |
No |
SYSTEM_OPTIONS |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/Dimension Type Details
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Item Dimension Type Details. Dimension Systems are a structure in Oracle Retail Xstore Point of Service for items and supports up to three dimensions of style characteristics, such as color, size, and fabric. Dimension Types are the diff types associated with a style item in Merchandising.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/item/dimensiontype?since={since}&before={before}&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
offsetkey |
No |
String |
Offset Key. Valid Value are Combination of valid Item and a valid Location separated by comma. For example: item number, location number. |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
action |
String |
Action for Item details. Valid Values
are |
itemaction |
String |
Action for Item details. Valid Values
are |
dimensionsystem |
Number |
This column contains the dimension system. This contains the item, item parent or the item grandparent depending on the item level. |
dimension |
String |
This column contains the dimension. This is the differentiator type of the item. |
description |
String |
This field contains the description of the dimension. |
seq |
String |
This column contains the sequence
number of the dimension. Valid values are |
Elements in JSON Output
Elements | Description |
---|---|
Items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
Links |
|
Example JSON input:
"{ "items": [ { "action": "INSERT", "itemaction": null, "dimensionsystem": "1000023212", "dimension": "C_3815", "description": "Smoke Diff Group Clr", "seq": 1 } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/dimensiontype?before=2021-05-11T17%3A41%3A38.052402%2B00%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/dimensiontype?before=2021-05-11T17%3A41%3A38.052402%2B00%3A00&limit=1&offsetkey=0430.PD.1%2C1%2CC_3815&since=1970-01-01T00%3A00%3A00.001Z", "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_ITEM_DIFF_TYPE |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_ITEM_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_DIM_TYPE |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/Dimension Value Details
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Item Dimension Value Details. Dimension Systems are a structure in Oracle Retail Xstore Point of Service for items and supports up to three dimensions of style characteristics such as color, size, and fabric. Dimension Values are the diff values associated with each dimension within a dimension system (parent item).
ReST URL
/MerchIntegrations/services/foundation/omnichannel/item/dimensionvalue?since={since}&before={before}&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
Since |
No |
String |
Since Date. Format: |
Before |
No |
String |
Before Date Format: |
offsetkey |
No |
String |
Offset Key. Valid Value are Combination of valid Item and a valid Location separated by comma. For example: item number, location number. |
Limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
action |
String |
Action for Item details. Valid Values
are |
itemaction |
String |
Action for Item details. Valid Values
are |
dimensionsystem |
String |
This column contains the dimension system. This contains the item, item parent or the item grandparent depending on the item level. |
dimension |
String |
This column contains the dimension. This is the differentiator type of the item. |
value |
String |
This column contains the code to uniquely identify a differentiator. |
description |
String |
This field contains the description of the dimension. |
displayseq |
Number |
This field contains the display sequence for the differentiator. This field is used to determine the order in which differentiators should be displayed for a differentiator group. |
Elements in JSON Output
Elements | Description |
---|---|
Items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
Links |
|
Example JSON input:
" { "items": [ { "action": "INSERT", "itemaction": "NO_CHANGE", "dimensionsystem": "1000012345", "dimension": "C_3815", "value": "BLACK_8742", "description": "Auto Black BLACK_8742", "displayseq": 1 } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/dimensionvalue?before=2021-05-11T17%3A51%3A17.671921%2B00%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/dimensionvalue?before=2021-05-11T17%3A51%3A17.671921%2B00%3A00&limit=1&offsetkey=0430.PD.1%2CC_3815%2CBLACK_8742&since=1970-01-01T00%3A00%3A00.001Z", "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_ITEM_DIFF_VALUE |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_ITEM_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_DIM_VALUE |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/Future Inventory
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Future Inventory aggregated at an item level across customer orderable locations.
ReST URL
/MerchIntegrations/services/inventory/omnichannel/inventory/futureinventory?since={since}&before={before&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
offsetkey |
No |
String |
Offset Key. Valid Value is Item. For example: item |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
action |
String |
Action for Item details. Valid Values
are |
item |
String |
This column contains a sellable and orderable transaction level item whose future inventory position is described. The item must be backorderable. |
onorderquantity |
String |
This column represents the on-order quantity of an item. |
receivedquantity |
String |
This column represents the received quantity of an item. |
backorderquantity |
String |
This column represents the backorder quantity of an item. |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
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_BOOKMARK |
Yes |
Yes |
Yes |
Yes |
V_BDI_CO_FUTURE_AVAIL |
Yes |
No |
No |
No |
MERCHAPI_FUTURE_AVAIL_CO_INV |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_FUTURE_AVAIL_CO_INV |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/Item Image
Business Overview
This service is used by Omni Channel applications to get item images and its details from Merchandising.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/item/image?since={since}&before={before}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
nodelevel |
No |
String |
Node Level. Valid Value are |
nodeid |
No |
BigDecimal |
Node ID. Valid Values are Valid stores present in the |
offsetkey |
No |
String |
Offset Key. Valid Value are Combination of valid Item and a valid Image Name separated by comma. For example: item, imageName |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
Action |
String |
Action for Item details. Valid Values
are |
item |
String |
Unique alphanumeric value that identifies the item. |
imagename |
String |
Description of the differentiator group (for example: Mens Shirt Sizes, Womens Shoe Sizes, Girls Dress Sizes, Shower Gel Scents, Yogurt Flavors, and so on). |
imageaddr |
String |
This field contains the actual path where the file of the image of the item is stored. |
imageuri |
String |
Image URI. |
imagedesc |
String |
This field contains the description associated with the image of the item. |
imagetype |
String |
This field contains the type of the image of the item. Valid values are defined as member of IITD code type. |
primaryind |
String |
This field will indicate whether
this record is the primary image of the item or not. Valid values are |
displaypriority |
BigDecimal |
This field will specify the display sequence order of images associated with the item per priority. |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
Example JSON input:
" { "items": [ { "action": "INSERT", "item": "100200042", "imagename": "image1", "imageaddr": "http://www.oracle.com/", "imageuri": "http://www.oracle.com/image1", "imagedesc": "image1Desc", "imagetype": "T", "primaryind": "Y", "displaypriority": 1 } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/image?before=2021-05-06T17%3A32%3A13.265046%2B08%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/image?before=2021-05-06T17%3A32%3A13.265046%2B08%3A00&limit=1&offsetkey=100200042%2Cimage1&since=1970-01-01T00%3A00%3A00.001Z", "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_BOOKMARK |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_ITEM_IMAGE |
Yes |
Yes |
Yes |
Yes |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_IMAGE |
Yes |
No |
No |
No |
MERCHAPI_ITEM_IMAGE |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_ITEM_IMAGE_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_ITEM_IMAGE |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/Item Initial Price Details
Business Overview
This service is used by Omni Channel applications to get initial price details from Pricing.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/item/initialprice?since={since}&before={before}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
nodelevel |
No |
String |
Node Level. Valid Value are |
nodeid |
No |
BigDecimal |
Node ID. Valid Values are Valid stores present in the |
offsetkey |
No |
String |
Offset Key. Valid Value are Combination of valid Item and a valid Location separated by comma. For example: item number, location number. |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
action |
String |
Action for Item details. Valid Values
are |
loctype |
String |
This field specifies type of location
in the location field. Valid values are |
location |
Number |
This field contains numeric identifier of the location in which the item is to be found. This field may contain a store, warehouse. |
item |
String |
This field specifies a unique alphanumeric value that identifies the item. |
pricetype |
String |
This field specifies Price Type. Valid Values are Initial. |
price |
Number |
This field specifies the initial unit retail price in the standard unit of measure for the item/location combination. This field is stored in the local currency. |
effective |
String |
This field specifies the Date on which the unit retail price became or will become active. |
source |
String |
This field specifies the source of the initial unit retail price of each item. |
eventid |
String |
This field specifies the ID of the event. |
resetind |
String |
This field specifies the reset indicator. |
clearanceind |
String |
This field Indicates whether the item is on clearance at the store. |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
Example JSON input:
" { "items": [ { "action": "INSERT", "loctype": "S", "location": 121, "item": "100000104", "pricetype": "INITIAL", "price": 12.1, "effective": null, "source": "direct", "eventid": null, "resetind": null, "clearanceind": 0 } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/initialprice?before=2021-05-11T17%3A23%3A22.208547%2B00%3A00&nodelevel=COMPANY&limit=1&nodeid=9118&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/initialprice?before=2021-05-11T17%3A23%3A22.208547%2B00%3A00&nodelevel=COMPANY&limit=1&nodeid=9118&offsetkey=S%2C121%2C100000104&since=1970-01-01T00%3A00%3A00.001Z", "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_ITEM_LOC |
Yes |
Yes |
Yes |
Yes |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_LOC |
Yes |
No |
No |
No |
MERCHAPI_ITEM_LOC |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_ITEM_LOC_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_INITIAL_ITEM_PRICE |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/Item Location Details
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Item Location Details. In a VAT environment, this service will also include the VAT details for the item/location. This service supports integration for specific location number or can be used to integrate all item/location combinations.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/item/itemlocation?since={since}&before={before}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}
Input Parameter
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
nodelevel |
No |
String |
Node Level. Valid Value are |
nodeid |
No |
BigDecimal |
Node ID. Valid Values are Valid stores present in the |
offsetkey |
No |
String |
Offset Key. Contains Combination of valid Item and a valid Location separated by comma. For example: item number, location number. |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
action |
String |
Action for Item details. Valid Values
are |
loctype |
String |
This field specifies type of location
in the location field. Valid values are |
location |
Number |
This field contains a numeric identifier of the location in which the item is to be found. This field may contain a store, warehouse. |
item |
String |
This field specifies a unique alphanumeric value that identifies the item |
sellingunitretail |
Number |
This field specifies the unit retail price in the selling unit of measure for the item/location combination. This field is stored in the local currency. |
sellinguom |
String |
This field specifies the selling unit of measure for an items single-unit retail. |
sellinguomdecimalprecision |
String |
This will define the number of decimal places to be considered for the specific selling UOM in XOCS. |
taxableind |
String |
This field Indicates whether the item is taxable at the store. |
localitemdesc |
String |
This field specifies the selling local description of the item. This field defaults to the item’s description but will be over-ridable. This value will be downloaded to the POS |
status |
String |
This field specifies the Current status of item at the store. |
qtykeyoptions |
String |
This field specifies
whether the quantity key on a POS should be used for this item at the location. Valid values are in the |
manualpriceentry |
String |
This field specifies the price can/should be entered manually on a POS for this item at the location. |
foodstampind |
String |
This field specifies whether the item is approved for food stamps at the location. This value will be downloaded to the POS. |
fixedtarevalue |
String |
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 to (that is, if the tare item is bulk candy, this is weight of the bag and twist tie). The only processing Merchandising does involving the fixed tare value is downloading it to the POS. Fixed tare is not subtracted from items sold by weight when sales are uploaded to Merchandising, and so on. This kind of processing is the responsibility of the client and should occur before sales are sent to any Oracle Retail application. |
fixedtareuom |
String |
This field Holds the unit of measure value associated with the tare value. The only processing Merchandising does involving the fixed tare value and UOM is downloading it to the POS. Fixed tare is not subtracted from items sold by weight when sales are uploaded to Merchandising, and so on. This kind of processing is the responsibility of the client and should occur before sales are sent to any Oracle Retail application. |
stopsaleind |
String |
This field specifies whether sale of the item should be stopped immediately at the location (for example, in case of recall). This value will be downloaded to the POS. |
returnableind |
String |
This field will contain
a value of |
backorderind |
String |
This field will contain
a value of |
merchandiseind |
String |
This field indicates whether the item is a merchandise item. |
clearanceind |
String |
This field Indicates whether the item is on clearance at the store. |
crosssell |
String |
This field Indicates whether a substitute item exists for the main item. |
attacheditem |
String |
This field Indicates whether Cross/Up Sell items are attached to the main item. |
vatcodes |
String |
This field contains VAT Code information for the item in a JSON array. This does not follow standard JSON structure due to backward compatibility and the quotes character is escaped by a backslash. |
localshortdescription |
String |
Contains the local short description of the item. This field will default to the items short description but will be over-ridable. This value will be downloaded to the POS. |
sourcemethod |
String |
This value will be used to specify how the ad-hoc PO/TSF creation process should source the item/location request. If the value is Warehouse, the process will attempt to fill the request by creating a transfer from the warehouse mentioned in the source_wh field. If this warehouse doesn't have enough inventory to fill the request, a purchase order will be created for the item/location's primary supplier. For warehouses, it is used by Oracle Retail Allocation to determine the valid sources and destinations for warehouse to warehouse allocations. |
sourcewarehouse |
Number |
This value will be used by the ad-hoc PO/Transfer creation process to determine which warehouse to fill the stores request from. It will also be used by the Allocation process to support warehouse to warehouse allocations. A value will be required in this field if the sourcing method is Warehouse. |
vatcodes JSON Output
Name | Data Type | Description |
---|---|---|
code |
String |
This field contains VAT code that is used to uniquely identify a VAT rate. |
date |
Date |
This filed contains the date on which
the VAT rate become active. Format: |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
Example JSON input:
" {
"items": [
{
"action": "INSERT",
"loctype": "S",
"location": 1111,
"item": "100750001",
"sellingunitretail": "132.13",
"sellinguom": "EA",
"taxableind": "Y",
"localitemdesc": "100750001",
"status": "A",
"qtykeyoptions": null,
"manualpriceentry": null,
"foodstampind": null,
"fixedtarevalue": null,
"fixedtareuom": null,
"stopsaleind": null,
"returnableind": null,
"backorderind": null,
"merchandiseind": "Y",
"clearanceind": "N",
"crosssell": "N",
"attacheditem": "N",
"vatcodes": "[{\"code\":\"S\",\"date\":\"2020-07-25\"}]",
"localshortdescription": "New Component Item",
"sourcemethod": "W",
"sourcewarehouse": 10001
}
],
"hasMore": true,
"limit": 1,
"count": 1,
"links": [
{
"href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/itemlocation?before=2021-05-03T15%3A50%3A19.189562000%2B00%3A00&nodelevel=COMPANY&limit=2&nodeid=1&offsetkey=S%2C1111%2C100550000%26since%3D1970-01-01T00%3A00%3A00.001Z&since=1970-01-01T00%3A00%3A00.001000000%2B00%3A00",
"rel": "self"
},
{
"href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/itemlocation?before=2021-05-03T15%3A50%3A19.189562000%2B00%3A00&nodelevel=COMPANY&limit=2&nodeid=1&offsetkey=S%2C1151%2C100000067%26since%3D1970-01-01T00%3A00%3A00.001Z&since=1970-01-01T00%3A00%3A00.001000000%2B00%3A00",
"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_ITEM_LOC |
Yes |
Yes |
Yes |
Yes |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_LOC |
Yes |
No |
No |
No |
MERCHAPI_ITEM_LOC |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_ITEM_LOC_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_ITEM_LOC |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/VAT
Business Overview
This service is used by Omni Channel applications to get VAT and its details from Merchandising.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/vat?since={since}&before={before&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: |
before |
No |
String |
Before Date Format: |
offsetkey |
No |
String |
Offset Key. Valid Value are Combination of valid VAT Region, valid VAT Code and a valid Active Date separated by comma. For example: vatregion, vatcode, activedate |
limit |
No |
BigDecimal |
Pagination limit. Default Value is |
Output
Name | Data Type | Description |
---|---|---|
action |
String |
Action for Item details. Valid Values
are |
vatregion |
BigDecimal |
This column contains the unique identifying number for the VAT region in the system. |
vatregionname |
String |
This column contains the name associated with the VAT region. |
vatcode |
String |
This column field contains the alphanumeric
identification for the VAT code. Valid values include: |
vatcodedesc |
String |
This column contains a description identifying the VAT code. |
activedate |
String |
This column contains the date on which the VAT rate becomes active. |
vatrate |
BigDecimal |
This column contains the VAT rate associated with a given VAT code. |
enddate |
String |
This column contains the date on which the VAT rate becomes inactive. |
Elements in JSON Output
Elements | Description |
---|---|
items |
The first element is named |
hasMore |
This is dependent on limit value. If the total rows are more than then limit defined then |
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 |
links |
|
Example JSON input:
" { "items": [ { "action": "INSERT", "vatregion": 1000, "vatregionname": "Vat Region 1000", "vatcode": "E", "vatcodedesc": "Exempt", "activedate": "2019-02-10T00:00:00", "vatrate": null, "enddate": "2019-02-18T00:00:00" } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/vat?before=2021-05-06T19%3A34%3A38.158110%2B08%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/vat?before=2021-05-06T19%3A34%3A38.158110%2B08%3A00&limit=1&offsetkey=1000%2CE%2C2019-02-10T00%3A00%3A00&since=1970-01-01T00%3A00%3A00.001Z", "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_CODES |
Yes |
No |
No |
No |
VAT_CODE_RATES |
Yes |
No |
No |
No |
VAT_ITEM |
Yes |
No |
No |
No |
MERCHAPI_VAT |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_VAT_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_VAT |
Yes |
No |
No |
No |