Organizational Hierarchy

The following services are included in this functional area:

Organizational Hierarchy Download Service

The following services are included in this functional area:

Get Organizational Hierarchy for Provided Level

Endpoints

MerchIntegrations/services/foundation/orghier

MerchIntegrations/services/foundation/orghier/{orgLevel}

MerchIntegrations/services/foundation/orghier/{param1}/{param2}

Functional Area

Organizational Hierarchy

Business Overview

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

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/orghier? since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

/MerchIntegrations/services/foundation/orghier/{orgLevel}?offsetkey={offsetkey}&limit={limit}

/MerchIntegrations/services/foundation/orghier/{param1}/{param2}

Input Parameters for MerchIntegrations/services/foundation/orghier

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 10000.
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/orghier/{orgLevel}

Parameter Name	Required	Data Type	Description
orgLevel	Yes	String	Level of the organization hierarchy. Valid values are COMPANY, CHAIN, AREA, REGION, DISTRICT.
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/orghier/{param1}/{param2}

Parameter Name	Required	Data Type	Description
param1	Yes	String	This is the organization hierarchy level. Valid values are COMPANY, CHAIN, AREA, REGION, DISTRICT.
param2	Yes	String	This is the hierarchy 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 ID

Name	Data Type	Description
action	String	Action for Item details. Valid values are INSERT, UPDATE and DELETE.
hierarchyLevel	String	This field contains the Merchandising Hierarchy Level.
hierarchyId	Number	This field contains the number which uniquely identifies Hierarchy Id.
hierarchyName	String	This field contains the description of the hierarchy value.
managerName	String	This field contains the manager’s name.
currencyCode	String	This field contains the currency code for the hierarchy.
parentHierarchyId	String	This field contains the number that identifies the hierarchy level.
parentHierarchyLevel	String	This field contains the parent level of the current organizational hierarchy.
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 org hier record was last maintained.

Table 5-781 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:

Response body
Download

{
  "items": [
    {
      "action": "INSERT",
      "hierarchyLevel": "CHAIN",
      "hierarchyId": 4,
      "hierarchyName": "Chain 1*",
      "managerName": null,
      "currencyCode": null,
      "parentHierarchyId": 1,
      "parentHierarchyLevel": "COMPANY",
      "createDateTime": "2021-08-19T02:32:24.000Z",
      "updateDateTime": "2021-08-19T02:32:24.000Z",
      "cacheTimestamp": "2021-08-19T02:37:00.447Z"
    },
    {
      "action": "INSERT",
      "hierarchyLevel": "AREA",
      "hierarchyId": 6,
      "hierarchyName": "USA*",
      "managerName": null,
      "currencyCode": "USD",
      "parentHierarchyId": 4,
      "parentHierarchyLevel": "CHAIN",
      "createDateTime": "2021-08-19T02:34:27.000Z",
      "updateDateTime": "2021-08-19T02:34:27.000Z",
      "cacheTimestamp": "2021-08-19T02:37:00.447Z"
    },
    {
      "action": "INSERT",
      "hierarchyLevel": "REGION",
      "hierarchyId": 56,
      "hierarchyName": "Singapore",
      "managerName": null,
      "currencyCode": "SGD",
      "parentHierarchyId": 6,
      "parentHierarchyLevel": "AREA",
      "createDateTime": "2021-08-19T02:35:00.000Z",
      "updateDateTime": "2021-08-19T02:35:00.000Z",
      "cacheTimestamp": "2021-08-19T02:37:00.447Z"
    },
    {
      "action": "INSERT",
      "hierarchyLevel": "REGION",
      "hierarchyId": 57,
      "hierarchyName": "Hong Kong",
      "managerName": null,
      "currencyCode": "HKD",
      "parentHierarchyId": 6,
      "parentHierarchyLevel": "AREA",
      "createDateTime": "2021-08-19T02:35:01.000Z",
      "updateDateTime": "2021-08-19T02:35:01.000Z",
      "cacheTimestamp": "2021-08-19T02:37:00.447Z"
    }
  ],
  "hasMore": false,
  "limit": 10000,
  "count": 4,
  "links": [
    {
      "href": "https://rex.retail.us-phoenix-1.ocs.oc-test.com/rgbu-rex-rgbu-dev1-mfcs19-1/MerchIntegrations/services/foundation/orghier?limit=10000&since=2020-01-01T00:00:00.000000000+00:00&before=2025-01-01T00:00:00.000000000+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_CHAIN	Yes	No	Yes	Yes
ICL_RMS_COMPHEAD	Yes	No	Yes	Yes
ICL_RMS_AREA	Yes	No	Yes	Yes
ICL_RMS_REGION	Yes	No	Yes	Yes
ICL_RMS_DISTRICT	Yes	No	Yes	Yes
MERCHAPI_EXT_ORGHIER	Yes	Yes	Yes	Yes
V_ MERCHAPI_EXT_ORGHIER _JSON	Yes	No	No	No

Get Organizational Hierarchy for Provided Level and Hierarchy Identifier

Endpoints

MerchIntegrations/services/foundation/orghier

MerchIntegrations/services/foundation/orghier/{orgLevel}

MerchIntegrations/services/foundation/orghier/{param1}/{param2}

Functional Area

Organizational Hierarchy

Business Overview

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

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/orghier? since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

/MerchIntegrations/services/foundation/orghier/{orgLevel}?offsetkey={offsetkey}&limit={limit}

/MerchIntegrations/services/foundation/orghier/{param1}/{param2}

Input Parameters for MerchIntegrations/services/foundation/orghier

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 10000.
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/orghier/{orgLevel}

Parameter Name	Required	Data Type	Description
orgLevel	Yes	String	Level of the organization hierarchy. Valid values are COMPANY, CHAIN, AREA, REGION, DISTRICT.
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/orghier/{param1}/{param2}

Parameter Name	Required	Data Type	Description
param1	Yes	String	This is the organization hierarchy level. Valid values are COMPANY, CHAIN, AREA, REGION, DISTRICT.
param2	Yes	String	This is the hierarchy 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 ID

Name	Data Type	Description
action	String	Action for Item details. Valid values are INSERT, UPDATE and DELETE.
hierarchyLevel	String	This field contains the Merchandising Hierarchy Level.
hierarchyId	Number	This field contains the number which uniquely identifies Hierarchy Id.
hierarchyName	String	This field contains the description of the hierarchy value.
managerName	String	This field contains the manager’s name.
currencyCode	String	This field contains the currency code for the hierarchy.
parentHierarchyId	String	This field contains the number that identifies the hierarchy level.
parentHierarchyLevel	String	This field contains the parent level of the current organizational hierarchy.
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 org hier record was last maintained.

Table 5-782 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:

Response body
Download

{
  "items": [
    {
      "action": "INSERT",
      "hierarchyLevel": "CHAIN",
      "hierarchyId": 4,
      "hierarchyName": "Chain 1*",
      "managerName": null,
      "currencyCode": null,
      "parentHierarchyId": 1,
      "parentHierarchyLevel": "COMPANY",
      "createDateTime": "2021-08-19T02:32:24.000Z",
      "updateDateTime": "2021-08-19T02:32:24.000Z",
      "cacheTimestamp": "2021-08-19T02:37:00.447Z"
    },
    {
      "action": "INSERT",
      "hierarchyLevel": "AREA",
      "hierarchyId": 6,
      "hierarchyName": "USA*",
      "managerName": null,
      "currencyCode": "USD",
      "parentHierarchyId": 4,
      "parentHierarchyLevel": "CHAIN",
      "createDateTime": "2021-08-19T02:34:27.000Z",
      "updateDateTime": "2021-08-19T02:34:27.000Z",
      "cacheTimestamp": "2021-08-19T02:37:00.447Z"
    },
    {
      "action": "INSERT",
      "hierarchyLevel": "REGION",
      "hierarchyId": 56,
      "hierarchyName": "Singapore",
      "managerName": null,
      "currencyCode": "SGD",
      "parentHierarchyId": 6,
      "parentHierarchyLevel": "AREA",
      "createDateTime": "2021-08-19T02:35:00.000Z",
      "updateDateTime": "2021-08-19T02:35:00.000Z",
      "cacheTimestamp": "2021-08-19T02:37:00.447Z"
    },
    {
      "action": "INSERT",
      "hierarchyLevel": "REGION",
      "hierarchyId": 57,
      "hierarchyName": "Hong Kong",
      "managerName": null,
      "currencyCode": "HKD",
      "parentHierarchyId": 6,
      "parentHierarchyLevel": "AREA",
      "createDateTime": "2021-08-19T02:35:01.000Z",
      "updateDateTime": "2021-08-19T02:35:01.000Z",
      "cacheTimestamp": "2021-08-19T02:37:00.447Z"
    }
  ],
  "hasMore": false,
  "limit": 10000,
  "count": 4,
  "links": [
    {
      "href": "https://rex.retail.us-phoenix-1.ocs.oc-test.com/rgbu-rex-rgbu-dev1-mfcs19-1/MerchIntegrations/services/foundation/orghier?limit=10000&since=2020-01-01T00:00:00.000000000+00:00&before=2025-01-01T00:00:00.000000000+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_CHAIN	Yes	No	Yes	Yes
ICL_RMS_COMPHEAD	Yes	No	Yes	Yes
ICL_RMS_AREA	Yes	No	Yes	Yes
ICL_RMS_REGION	Yes	No	Yes	Yes
ICL_RMS_DISTRICT	Yes	No	Yes	Yes
MERCHAPI_EXT_ORGHIER	Yes	Yes	Yes	Yes
V_ MERCHAPI_EXT_ORGHIER _JSON	Yes	No	No	No

Get Organizational Hierarchy

Endpoints

MerchIntegrations/services/foundation/orghier

MerchIntegrations/services/foundation/orghier/{orgLevel}

MerchIntegrations/services/foundation/orghier/{param1}/{param2}

Functional Area

Organizational Hierarchy

Business Overview

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

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/orghier? since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

/MerchIntegrations/services/foundation/orghier/{orgLevel}?offsetkey={offsetkey}&limit={limit}

/MerchIntegrations/services/foundation/orghier/{param1}/{param2}

Input Parameters for MerchIntegrations/services/foundation/orghier

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 10000.
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/orghier/{orgLevel}

Parameter Name	Required	Data Type	Description
orgLevel	Yes	String	Level of the organization hierarchy. Valid values are COMPANY, CHAIN, AREA, REGION, DISTRICT.
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/orghier/{param1}/{param2}

Parameter Name	Required	Data Type	Description
param1	Yes	String	This is the organization hierarchy level. Valid values are COMPANY, CHAIN, AREA, REGION, DISTRICT.
param2	Yes	String	This is the hierarchy 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 ID

Name	Data Type	Description
action	String	Action for Item details. Valid values are INSERT, UPDATE and DELETE.
hierarchyLevel	String	This field contains the Merchandising Hierarchy Level.
hierarchyId	Number	This field contains the number which uniquely identifies Hierarchy Id.
hierarchyName	String	This field contains the description of the hierarchy value.
managerName	String	This field contains the manager’s name.
currencyCode	String	This field contains the currency code for the hierarchy.
parentHierarchyId	String	This field contains the number that identifies the hierarchy level.
parentHierarchyLevel	String	This field contains the parent level of the current organizational hierarchy.
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 org hier record was last maintained.

Table 5-783 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:

Response body
Download

{
  "items": [
    {
      "action": "INSERT",
      "hierarchyLevel": "CHAIN",
      "hierarchyId": 4,
      "hierarchyName": "Chain 1*",
      "managerName": null,
      "currencyCode": null,
      "parentHierarchyId": 1,
      "parentHierarchyLevel": "COMPANY",
      "createDateTime": "2021-08-19T02:32:24.000Z",
      "updateDateTime": "2021-08-19T02:32:24.000Z",
      "cacheTimestamp": "2021-08-19T02:37:00.447Z"
    },
    {
      "action": "INSERT",
      "hierarchyLevel": "AREA",
      "hierarchyId": 6,
      "hierarchyName": "USA*",
      "managerName": null,
      "currencyCode": "USD",
      "parentHierarchyId": 4,
      "parentHierarchyLevel": "CHAIN",
      "createDateTime": "2021-08-19T02:34:27.000Z",
      "updateDateTime": "2021-08-19T02:34:27.000Z",
      "cacheTimestamp": "2021-08-19T02:37:00.447Z"
    },
    {
      "action": "INSERT",
      "hierarchyLevel": "REGION",
      "hierarchyId": 56,
      "hierarchyName": "Singapore",
      "managerName": null,
      "currencyCode": "SGD",
      "parentHierarchyId": 6,
      "parentHierarchyLevel": "AREA",
      "createDateTime": "2021-08-19T02:35:00.000Z",
      "updateDateTime": "2021-08-19T02:35:00.000Z",
      "cacheTimestamp": "2021-08-19T02:37:00.447Z"
    },
    {
      "action": "INSERT",
      "hierarchyLevel": "REGION",
      "hierarchyId": 57,
      "hierarchyName": "Hong Kong",
      "managerName": null,
      "currencyCode": "HKD",
      "parentHierarchyId": 6,
      "parentHierarchyLevel": "AREA",
      "createDateTime": "2021-08-19T02:35:01.000Z",
      "updateDateTime": "2021-08-19T02:35:01.000Z",
      "cacheTimestamp": "2021-08-19T02:37:00.447Z"
    }
  ],
  "hasMore": false,
  "limit": 10000,
  "count": 4,
  "links": [
    {
      "href": "https://rex.retail.us-phoenix-1.ocs.oc-test.com/rgbu-rex-rgbu-dev1-mfcs19-1/MerchIntegrations/services/foundation/orghier?limit=10000&since=2020-01-01T00:00:00.000000000+00:00&before=2025-01-01T00:00:00.000000000+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_CHAIN	Yes	No	Yes	Yes
ICL_RMS_COMPHEAD	Yes	No	Yes	Yes
ICL_RMS_AREA	Yes	No	Yes	Yes
ICL_RMS_REGION	Yes	No	Yes	Yes
ICL_RMS_DISTRICT	Yes	No	Yes	Yes
MERCHAPI_EXT_ORGHIER	Yes	Yes	Yes	Yes
V_ MERCHAPI_EXT_ORGHIER _JSON	Yes	No	No	No

Organizational Hierarchy Upload Service

The following services are included in this functional area:

Create Organizational Hierarchy

Functional Area

Organizational Hierarchy

Business Overview

If Merchandising is not the system of record for organizational hierarchy information for an implementation, then this service may be used to create hierarchy based on an external system.

The following organizational hierarchy elements can be created using this service: chain, area, region, or district. The organizational hierarchy must be created from the highest level down.

Service Type

POST

ReST URL

MerchIntegrations/services/organizationalHierarchy/create

Input Payload Details

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

Element Name	Required	Data Type	Description
hierarchyValue	Yes	Number (10)	The ID of the specified hierarchy level. This value must be unique among other values of the same hierarchy level.
hierarchyDescription	Yes	String (120)	The description of the hierarchy value.
hierarchyLevel	Yes	String (2)	The hierarchy level of the hierarchy value. This field will indicate the level of the organizational hierarchy to which the cost change applies. Valid values are CH (chain), AR (area), RE (region), DI (district).
parentHierarchyId	No	Number (10)	The ID of the hierarchy value's parent hierarchy value. This value must be predefined on either the CHAIN, AREA or REGION table.
managerName	No	String (120)	The manager name of the hierarchy value.
currencyCode	No	String (3)	The code which identifies the currency under which the hierarchy value operates. This value must be predefined on the CURRENCIES table.

Sample Input Message

{
  "hierarchyValue": 6,
  "hierarchyDescription": "6 South East",
  "hierarchyLevel": "AR",
  "parentHierarchyId": 3,
  "managerName": "McMillan",
  "currencyCode": "USD"
}

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 Organizational Hierarchy

Functional Area

Organizational Hierarchy

Business Overview

If Merchandising is not the system of record for organizational hierarchy information for an implementation, then this service may be used to delete an existing hierarchy in Merchandising based on the request from an external system.

The following organizational hierarchy elements can be deleted using this service: chain, area, region, or district. The organizational hierarchy must be deleted from the lowest level up.

Service Type

DELETE

ReST URL

MerchIntegrations/services/organizationalHierarchy/delete

Input Payload Details

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

Element Name	Required	Data Type	Description
hierarchyValue	Yes	Number (10)	The ID of the specified hierarchy level. This value must be unique among other values of the same hierarchy level.
hierarchyLevel	Yes	String (2)	The hierarchy level of the hierarchy value. This field will indicate the level of the organizational hierarchy to which the cost change applies. Valid values are CH (chain), AR (area), RE (region), DI (district).

Sample Input Message

{
  "hierarchyValue": 4,
  "hierarchyLevel": "CH"
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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 Organizational Hierarchy

Functional Area

Organizational Hierarchy

Business Overview

If Merchandising is not the system of record for organizational hierarchy information for an implementation, then this service may be used to update an existing hierarchy based on the request from an external system.

The following organizational hierarchy elements can be modified using this service: chain, area, region, or district.

Service Type

PUT

ReST URL

MerchIntegrations/services/organizationalHierarchy/update

Input Payload Details

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

Element Name	Required	Data Type	Description
hierarchyValue	Yes	Number (10)	The ID of the specified hierarchy level. This value must be unique among other values of the same hierarchy level.
hierarchyDescription	Yes	String (120)	The description of the hierarchy value.
hierarchyLevel	Yes	String (2)	The hierarchy level of the hierarchy value. This field will indicate the level of the organizational hierarchy to which the cost change applies. Valid values are CH (chain), AR (area), RE (region), DI (district).
parentHierarchyId	No	Number (10)	The ID of the hierarchy value's parent hierarchy value. This value must be predefined on either the CHAIN, AREA or REGION table.
managerName	No	String (120)	The manager name of the hierarchy value.
currencyCode	No	String (3)	The code which identifies the currency under which the hierarchy value operates. This value must be predefined on the CURRENCIES table.

Sample Input Message

{
  "hierarchyValue": 4,
  "hierarchyDescription": "Chain 4 North America",
  "hierarchyLevel": "CH",
  "parentHierarchyId": 117516,
  "managerName": "McCarthy",
  "currencyCode": "USD"
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Stores

The following services are included in this functional area:

Store Download Service

The following services are included in this functional area:

Get Basic Store Details

This section describes the Store Detail service.

Business Overview

Store Detail service allows user to retrieve Store information for a selected store or for all stores.

Service Type

Get

ReST URL

Store/storeDetail?store={storeNumber}

Input Parameters

Parameter Name	Required	Description
Store	No	Store ID. If none is specified, all stores will be retrieved.

Output

RestStoreRecRDO

Parameter Name	Data Type
store	BigDecimal
storeName	String
storeName10	String
storeName3	String
storeNameSecondary	String
storeClass	String
storeOpenDate	Timestamp
storeCloseDate	Timestamp
acquiredDate	Timestamp
remodelDate	Timestamp
vatRegion	BigDecimal
vatIncludeInd	String
stockholdingInd	String
channelId	BigDecimal
transferZone	BigDecimal
defaultWh	BigDecimal
stopOrderDays	BigDecimal
startOrderDays	BigDecimal
currencyCode	String
lang	BigDecimal
dunsNumber	String
dunsLoc	String
sisterStore	BigDecimal
tsfEntityId	BigDecimal
orgUnitId	BigDecimal
storeType	String
wfCustomerId	BigDecimal
timezoneName	String
customerOrderLocInd	String
company	BigDecimal
chain	BigDecimal
area	BigDecimal
region	BigDecimal
district	BigDecimal
add1	String
add2	String
add3	String
city	String
state	String
countryId	String
post	String
contactName	String
contactPhone	String
contactEmail	String

JSON Structure

{
  "store": null,
  "storeName": null,
  "storeName10": null,
  "storeName3": null,
  "storeNameSecondary": null,
  "storeClass": null,
  "storeOpenDate": null,
  "storeCloseDate": null,
  "acquiredDate": null,
  "remodelDate": null,
  "vatRegion": null,
  "vatIncludeInd": null,
  "stockholdingInd": null,
  "channelId": null,
  "transferZone": null,
  "defaultWh": null,
  "stopOrderDays": null,
  "startOrderDays": null,
  "currencyCode": null,
  "lang": null,
  "dunsNumber": null,
  "dunsLoc": null,
  "sisterStore": null,
  "tsfEntityId": null,
  "orgUnitId": null,
  "storeType": null,
  "wfCustomerId": null,
  "timezoneName": null,
  "customerOrderLocInd": null,
  "company": null,
  "chain": null,
  "area": null,
  "region": null,
  "district": null,
  "add1": null,
  "add2": null,
  "add3": null,
  "city": null,
  "state": null,
  "countryId": null,
  "post": null,
  "contactName": null,
  "contactPhone": null,
  "contactEmail": null,
  "links": [],
  "hyperMediaContent": {
    "linkRDO": []
  }
}

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_STORE	Yes	No	No	No
STORE_HIERARCHY	Yes	No	No	No
ADDR	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Get Store Details

Endpoint

MerchIntegrations/services/foundation/store

MerchIntegrations/services/foundation/store/{storeId}

Functional Area

Organizational Hierarchy - Stores

Business Overview

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

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/store? since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

Input Parameters

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 store 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)

Output

Name	Data Type	Description
action	String	Action for store details. Valid Values are INSERT, UPDATE and DELETE.
store	Number	This field uniquely identifies the Store.
storeType	String	This field determine whether a store is a franchise or company store.
storeName	String	This field specifies 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`.`
storeName3	String	This field contains a three-character abbreviation of the store name.
storeClass	String	This field contains the code letter indicating the class of which the store is a member.
storeClassDescription	String	This field contains the description indicating the class of which the store is a member.
managerName	String	This field contains the name of the store manager
openDate	String	This field contains the date on which the store opened.
closeDate	String	This field contains the date on which the store closed.
acquireDate	String	This field contains the date on which the store was acquired.
remodelDate	String	This field contains the date on which the store was last remodeled.
faxNumber	String	This field specifies fax number of the contact person at this location.
phoneNumber	String	This field specifies phone number of the contact person at this location.
email	String	This field contains the email address for the location.
totalSquareFeet	Number	This field contains the total square footage of the store.
sellingSquareFeet	Number	This field contains the total square footage of the stores selling area.
linearDistance	Number	This field contains the total merchandisable space of the location.
stockholdingInd	String	This field indicates whether the store can hold stock.
channelId	Number	This field contains the channel with which the store is associated..
channelName	String	This field contains the channel description with which the store is associated.
storeFormat	Number	This field contains the number indicating the format of the store.
storeFormatName	String	This field contains the description for format of the store.
mallName	String	This field contains the name of the mall in which the store is located.
district	Number	This field contains the number of the district in which the store is a member.
districtName	String	This field contains the name of the district in which the store is a member.
transferZone	Number	This field contains the transfer zone ID in which the store is located.
transferZoneDescription	String	This field contains the transfer zone description in which the store is located.
defaultWarehouse	Number	This field contains the number of the warehouse that is the primary sourcing warehouse for the store. This value will always be a virtual warehouse.
stopOrderdays	Number	This field contains the number of days before a store closing that the store will stop accepting orders. This column will be used when the store close date is defined.
startOrderDays	Number	This field contains the number of days before the store open date that the store will begin accepting orders.
currencyCode	String	This field contains the currency code under which the store operates.
Language	String	This field contains the language code to be used for the given store.
integratedPosInd	String	This field indicates whether Sales Audit should expect files from this store for processing.
dunsNumber	String	This field contains the Dun and Bradstreet number to identify the store.
dunsLocation	String	This field contains the Dun and Bradstreet number to identify the location.
pricingStore	Number	This field contains the location from which pricing records will be copied for a new store or will be used to determine the price for this store if not otherwise defined for an item.
timezoneName	String	This field contains the text value of the time zone of the store.
pricingStoreCurrency	String	This field contains the currency code of the location from which pricing records will be copied.
orgUnitId	Number	This field contains the organizational unit ID that this store is associated with.
storeNameSecondary	String	This field contains the secondary name of the store.
vatRegion	Number	This field contains the ID of the tax region the store is associated with.
vatIncludeInd	String	This field contains whether tax will be included in the retail prices for the store.
sisterStore	Number	This field contains store number which will be used to relate the current store to the historical data of an existing store.
trasferEntityId	Number	This field contains the transfer entity the store is associated with.
autoReceiveInd	String	This field contains whether receipts for the store will have receipts made automatically by Merchandising.
remerchandisingInd	String	This field is used to identify stores that are undergoing a significant remerchandising effort
franchiseCustomerId	String	This field indicates which franchise customer this store is associated with.
customerOrderLocationInd	String	This field indicates whether the location is customer order location.
giftWrappingInd	String	This field indicates if the location will support gift wrapping.
customerOrderShippingInd	String	This field indicates if the location will support shipping to a customer for customer orders.
onlineStoreInd	String	This field indicates that the store is an online store.
taxId	Number	his field contains unique tax identification number of Store.
primaryAddressType	String	This field specifies type for the address. Valid values are: 01 -Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 -Remittance.
primaryAddressTypeDescription	String	This field specifies address type description.
primaryAddressAdd1	String	This field contains the first line of the address.
primaryAddressAdd2	String	This field contains the second line of the address.
primaryAddressAdd3	String	This field contains the third line of the address.
primaryAddressCity	String	This field contains name of the city that is associated with the address.
primaryAddressState	String	This field contains state abbreviation for the address.
primaryAddressStateName	String	This field contains state description for the address.
primaryAddressCountryId	String	This field contains the country where the address exists.
primaryAddressCountryName	String	This field contains the country description where the address exists.
primaryAddressPost	String	This field contains the zip code for the address.
primaryAddressContactName	String	This field contains the name of the contact person at this address.
primaryAddressContactPhone	String	This field contains the phone number of the contact person at this address.
primaryAddressContactTelex	String	This field contains the telex number of the contact person at this address.
primaryAddressContactFax	String	This field contains the fax number of the contact person at this address.
primaryAddressContactEmail	String	This field contains the email address of the store location contact person.
primaryAddressOracleVendorSiteId	String	This field contains the Oracle Vendor Site Id.
primaryAddressCounty	String	This field contains the county where the address exists.
primaryAddressJurisdictionCode	String	This field contains the ID associated to the tax jurisdiction of the country-state relationship.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
customFlexAttribute		This list holds custom flex attributes for the store.
address		This list holds all the store addresses.
storeHours		This list holds all the store hours attributes.
cacheTimestamp	String	This field specifies date and time when the store record was last maintained.

Table 5-787 customFlexAttribute

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

Table 5-788 address

Name	Data Type	Description
addressKey	Number	This field contains the unique address key.
addressType	String	This field specifies type for the address. Valid values are: 01 -Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 -Remittance.
addressTypeDescription	String	This field specifies address type description.
primaryAddressInd	String	This field indicates whether the address is the primary address for the address type.
add1	String	This field contains the first line of the address.
add2	String	This field contains the second line of the address.
add3	String	This field contains the third line of the address.
city	String	This field contains name of the city that is associated with the address.
state	String	This field contains name of the state that is associated with the address.
stateName	String	This field contains name of the state description that is associated with the address.
countryId	String	This field contains name of the country that is associated with the address.
countryName	String	This field contains name of the country description that is associated with the address.
post	String	This field contains the zip code for the address.
jurisdictionCode	String	This field contains the ID associated to the tax jurisdiction of the country-state relationship.
contactName	String	This field contains the name of the contact person at this address.
contactPhone	String	This field contains the phone number of the contact person at this address.
contactTelex	String	This field contains the telex number of the warehouse's representative contact.
contactFax	String	This field contains the fax number of the contact person at this address.
contactEmail	String	This field contains email address of the warehouse's representative contact.
oracleVendorSiteId	String	This field contains the Oracle Vendor Site Id.
county	String	This field contains the county where the address exists .
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
customFlexAttribute		This list holds custom flex attributes for the warehouse's address.

Table 5-789 Store Hours

Name
storeId	Number	This field contains the store number.
dayNo	Number	This field contains the numeric value that indicates the day that the open and close times pertain to. Valid values are 1-Sunday, 2-Monday, 3-Tuesday, 4-Wednesday, 5-Thursday, 6-Friday, or 7-Saturday.
storeOpenTime	String	This column contains the open time for the store for each day of the week. The time format will be in HH:MM AM or HH:MM PM.
storeCloseTime	String	This column contains the close time for the store for each day of the week. The time format will be in HH:MM AM or HH:MM PM.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated

Table 5-790 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 Input

" {
  "items": [
    {
      "action": "INSERT",
      "store": 1000,
      "storeType": "C",
      "storeName": "EIT_Store_Queue",
      "storeName10": "EIT_Store",
      "storeName3": "EIT",
      "storeClass": "A",
      "storeClassDescription": "Class Stores A",
      "managerName": "EIT",
      "openDate": "2021-11-15",
      "closeDate": null,
      "acquireDate": null,
      "remodelDate": null,
      "faxNumber": null,
      "phoneNumber": null,
      "email": null,
      "totalSquareFeet": null,
      "sellingSquareFeet": null,
      "linearDistance": null,
      "stockholdingInd": "Y",
      "channelId": 1,
      "channelName": "EIT_Channel_1",
      "storeFormat": null,
      "storeFormatName": null,
      "mallName": null,
      "district": 1,
      "districtName": "EIT_District",
      "transferZone": 1,
      "transferZoneDescription": "EIT_Transfer_Zone_1",
      "defaultWarehouse": null,
      "stopOrderdays": null,
      "startOrderDays": 2,
      "currencyCode": "USD",
      "language": "AR",
      "integratedPosInd": "Y",
      "dunsNumber": null,
      "dunsLocation": null,
      "pricingStore": 8811,
      "timezoneName": "Africa/Banjul",
      "pricingStoreCurrency": "USD",
      "orgUnitId": 111,
      "storeNameSecondary": null,
      "vatRegion": 1000,
      "vatIncludeInd": "N",
      "sisterStore": null,
      "trasferEntityId": 1111,
      "autoReceiveInd": "D",
      "remerchandisingInd": "N",
      "franchiseCustomerId": null,
      "customerOrderLocationInd": "N",
      "giftWrappingInd": "N",
      "customerOrderShippingInd": "N",
      "onlineStoreInd": "N",
      "taxId": null,
      "primaryAddressType": "01",
      "primaryAddressTypeDescription": "Business",
      "primaryAddressAdd1": "Israel",
      "primaryAddressAdd2": null,
      "primaryAddressAdd3": null,
      "primaryAddressCity": "Israel",
      "primaryAddressState": null,
      "primaryAddressStateName": null,
      "primaryAddressCountryId": "IL",
      "primaryAddressCountryName": "Israel",
      "primaryAddressPost": null,
      "primaryAddressContactName": null,
      "primaryAddressContactPhone": null,
      "primaryAddressContactTelex": null,
      "primaryAddressContactFax": null,
      "primaryAddressContactEmail": null,
      "primaryAddressOracleVendorSiteId": null,
      "primaryAddressCounty": null,
      "primaryAddressJurisdictionCode": null,
      "createDateTime": "2021-11-19T18:14:40.000Z",
      "updateDateTime": "2021-11-19T18:14:40.000Z",
      "customFlexAttribute": null,
      "address": [
        {
          "addressKey": 20002,
          "addressType": "02",
          "addressTypeDescription": "Postal",
          "primaryAddressInd": "Y",
          "add1": "Israel",
          "add2": null,
          "add3": null,
          "city": "Israel",
          "state": null,
          "stateName": null,
          "countryId": "IL",
          "countryName": "Israel",
          "post": null,
          "jurisdictionCode": null,
          "contactName": null,
          "contactPhone": null,
          "contactTelex": null,
          "contactFax": null,
          "contactEmail": null,
          "oracleVendorSiteId": null,
          "county": null,
          "createDateTime": "2021-11-09T16:00:18.000Z",
          "updateDateTime": "2021-11-22T09:18:30.000Z",
          "customFlexAttribute": null
        },
        {
          "addressKey": 20001,
          "addressType": "01",
          "addressTypeDescription": "Business",
          "primaryAddressInd": "Y",
          "add1": "Israel",
          "add2": null,
          "add3": null,
          "city": "Israel",
          "state": null,
          "stateName": null,
          "countryId": "IL",
          "countryName": "Israel",
          "post": null,
          "jurisdictionCode": null,
          "contactName": "EIT",
          "contactPhone": null,
          "contactTelex": null,
          "contactFax": null,
          "contactEmail": null,
          "oracleVendorSiteId": null,
          "county": null,
          "createDateTime": "2021-11-09T16:00:17.000Z",
          "updateDateTime": "2021-11-22T09:18:30.000Z",
          "customFlexAttribute": null
        }
      ],
      "storeHours": null,
      "cacheTimestamp": "2022-02-23T12:41:34.129Z"
    }
  ],
  "hasMore": true,
  "limit": 2,
  "count": 2,
  "links": [
    {
      "href": "https://rex.retail.us-phoenix-1.ocs.oc-test.com/rgbu-rex-rgbu-stg83-mfcs/MerchIntegrations/services/foundation/store?limit=2&since=1970-01-01T00:00:00.001Z&before=2022-04-07T09:00:28.413938+00:00",
      "rel": "self"
    },
    {
      "href": "https://rex.retail.us-phoenix-1.ocs.oc-test.com/rgbu-rex-rgbu-stg83-mfcs/MerchIntegrations/services/foundation/store?offsetkey=1515&limit=2&since=1970-01-01T00:00:00.001Z&before=2022-04-07T09:00:28.413938+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	Yes	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	No	Yes	Yes
ICL_RMS_ADDR	Yes	No	Yes	Yes
ADDR	Yes	No	No	No
STORE_CFA_EXT	Yes	No	No	No
ADDR_CFA_EXT CFA	Yes	No	No	No
MERCHAPI_EXT_STORE_CFA	No	Yes	No	Yes
MERCHAPI_EXT_STORE_ADDR_CFA	No	Yes	No	Yes
MERCHAPI_EXT_STORE	Yes	Yes	Yes	Yes
V_MERCHAPI_EXT_STORE_JSON	Yes	No	No	No
SYSTEM_OPTIONS	Yes	No	No	No

Get Store Details for Provided Store

Endpoint

MerchIntegrations/services/foundation/store

MerchIntegrations/services/foundation/store/{storeId}

Functional Area

Organizational Hierarchy - Stores

Business Overview

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

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/store? since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

Input Parameters

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 store 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)

Output

Name	Data Type	Description
action	String	Action for store details. Valid Values are INSERT, UPDATE and DELETE.
store	Number	This field uniquely identifies the Store.
storeType	String	This field determine whether a store is a franchise or company store.
storeName	String	This field specifies 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`.`
storeName3	String	This field contains a three-character abbreviation of the store name.
storeClass	String	This field contains the code letter indicating the class of which the store is a member.
storeClassDescription	String	This field contains the description indicating the class of which the store is a member.
managerName	String	This field contains the name of the store manager
openDate	String	This field contains the date on which the store opened.
closeDate	String	This field contains the date on which the store closed.
acquireDate	String	This field contains the date on which the store was acquired.
remodelDate	String	This field contains the date on which the store was last remodeled.
faxNumber	String	This field specifies fax number of the contact person at this location.
phoneNumber	String	This field specifies phone number of the contact person at this location.
email	String	This field contains the email address for the location.
totalSquareFeet	Number	This field contains the total square footage of the store.
sellingSquareFeet	Number	This field contains the total square footage of the stores selling area.
linearDistance	Number	This field contains the total merchandisable space of the location.
stockholdingInd	String	This field indicates whether the store can hold stock.
channelId	Number	This field contains the channel with which the store is associated..
channelName	String	This field contains the channel description with which the store is associated.
storeFormat	Number	This field contains the number indicating the format of the store.
storeFormatName	String	This field contains the description for format of the store.
mallName	String	This field contains the name of the mall in which the store is located.
district	Number	This field contains the number of the district in which the store is a member.
districtName	String	This field contains the name of the district in which the store is a member.
transferZone	Number	This field contains the transfer zone ID in which the store is located.
transferZoneDescription	String	This field contains the transfer zone description in which the store is located.
defaultWarehouse	Number	This field contains the number of the warehouse that is the primary sourcing warehouse for the store. This value will always be a virtual warehouse.
stopOrderdays	Number	This field contains the number of days before a store closing that the store will stop accepting orders. This column will be used when the store close date is defined.
startOrderDays	Number	This field contains the number of days before the store open date that the store will begin accepting orders.
currencyCode	String	This field contains the currency code under which the store operates.
Language	String	This field contains the language code to be used for the given store.
integratedPosInd	String	This field indicates whether Sales Audit should expect files from this store for processing.
dunsNumber	String	This field contains the Dun and Bradstreet number to identify the store.
dunsLocation	String	This field contains the Dun and Bradstreet number to identify the location.
pricingStore	Number	This field contains the location from which pricing records will be copied for a new store or will be used to determine the price for this store if not otherwise defined for an item.
timezoneName	String	This field contains the text value of the time zone of the store.
pricingStoreCurrency	String	This field contains the currency code of the location from which pricing records will be copied.
orgUnitId	Number	This field contains the organizational unit ID that this store is associated with.
storeNameSecondary	String	This field contains the secondary name of the store.
vatRegion	Number	This field contains the ID of the tax region the store is associated with.
vatIncludeInd	String	This field contains whether tax will be included in the retail prices for the store.
sisterStore	Number	This field contains store number which will be used to relate the current store to the historical data of an existing store.
trasferEntityId	Number	This field contains the transfer entity the store is associated with.
autoReceiveInd	String	This field contains whether receipts for the store will have receipts made automatically by Merchandising.
remerchandisingInd	String	This field is used to identify stores that are undergoing a significant remerchandising effort
franchiseCustomerId	String	This field indicates which franchise customer this store is associated with.
customerOrderLocationInd	String	This field indicates whether the location is customer order location.
giftWrappingInd	String	This field indicates if the location will support gift wrapping.
customerOrderShippingInd	String	This field indicates if the location will support shipping to a customer for customer orders.
onlineStoreInd	String	This field indicates that the store is an online store.
taxId	Number	his field contains unique tax identification number of Store.
primaryAddressType	String	This field specifies type for the address. Valid values are: 01 -Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 -Remittance.
primaryAddressTypeDescription	String	This field specifies address type description.
primaryAddressAdd1	String	This field contains the first line of the address.
primaryAddressAdd2	String	This field contains the second line of the address.
primaryAddressAdd3	String	This field contains the third line of the address.
primaryAddressCity	String	This field contains name of the city that is associated with the address.
primaryAddressState	String	This field contains state abbreviation for the address.
primaryAddressStateName	String	This field contains state description for the address.
primaryAddressCountryId	String	This field contains the country where the address exists.
primaryAddressCountryName	String	This field contains the country description where the address exists.
primaryAddressPost	String	This field contains the zip code for the address.
primaryAddressContactName	String	This field contains the name of the contact person at this address.
primaryAddressContactPhone	String	This field contains the phone number of the contact person at this address.
primaryAddressContactTelex	String	This field contains the telex number of the contact person at this address.
primaryAddressContactFax	String	This field contains the fax number of the contact person at this address.
primaryAddressContactEmail	String	This field contains the email address of the store location contact person.
primaryAddressOracleVendorSiteId	String	This field contains the Oracle Vendor Site Id.
primaryAddressCounty	String	This field contains the county where the address exists.
primaryAddressJurisdictionCode	String	This field contains the ID associated to the tax jurisdiction of the country-state relationship.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
customFlexAttribute		This list holds custom flex attributes for the store.
address		This list holds all the store addresses.
storeHours		This list holds all the store hours attributes.
cacheTimestamp	String	This field specifies date and time when the store record was last maintained.

Table 5-791 customFlexAttribute

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

Table 5-792 address

Name	Data Type	Description
addressKey	Number	This field contains the unique address key.
addressType	String	This field specifies type for the address. Valid values are: 01 -Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 -Remittance.
addressTypeDescription	String	This field specifies address type description.
primaryAddressInd	String	This field indicates whether the address is the primary address for the address type.
add1	String	This field contains the first line of the address.
add2	String	This field contains the second line of the address.
add3	String	This field contains the third line of the address.
city	String	This field contains name of the city that is associated with the address.
state	String	This field contains name of the state that is associated with the address.
stateName	String	This field contains name of the state description that is associated with the address.
countryId	String	This field contains name of the country that is associated with the address.
countryName	String	This field contains name of the country description that is associated with the address.
post	String	This field contains the zip code for the address.
jurisdictionCode	String	This field contains the ID associated to the tax jurisdiction of the country-state relationship.
contactName	String	This field contains the name of the contact person at this address.
contactPhone	String	This field contains the phone number of the contact person at this address.
contactTelex	String	This field contains the telex number of the warehouse's representative contact.
contactFax	String	This field contains the fax number of the contact person at this address.
contactEmail	String	This field contains email address of the warehouse's representative contact.
oracleVendorSiteId	String	This field contains the Oracle Vendor Site Id.
county	String	This field contains the county where the address exists .
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
customFlexAttribute		This list holds custom flex attributes for the warehouse's address.

Table 5-793 Store Hours

Name
storeId	Number	This field contains the store number.
dayNo	Number	This field contains the numeric value that indicates the day that the open and close times pertain to. Valid values are 1-Sunday, 2-Monday, 3-Tuesday, 4-Wednesday, 5-Thursday, 6-Friday, or 7-Saturday.
storeOpenTime	String	This column contains the open time for the store for each day of the week. The time format will be in HH:MM AM or HH:MM PM.
storeCloseTime	String	This column contains the close time for the store for each day of the week. The time format will be in HH:MM AM or HH:MM PM.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated

Table 5-794 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 Input

" {
  "items": [
    {
      "action": "INSERT",
      "store": 1000,
      "storeType": "C",
      "storeName": "EIT_Store_Queue",
      "storeName10": "EIT_Store",
      "storeName3": "EIT",
      "storeClass": "A",
      "storeClassDescription": "Class Stores A",
      "managerName": "EIT",
      "openDate": "2021-11-15",
      "closeDate": null,
      "acquireDate": null,
      "remodelDate": null,
      "faxNumber": null,
      "phoneNumber": null,
      "email": null,
      "totalSquareFeet": null,
      "sellingSquareFeet": null,
      "linearDistance": null,
      "stockholdingInd": "Y",
      "channelId": 1,
      "channelName": "EIT_Channel_1",
      "storeFormat": null,
      "storeFormatName": null,
      "mallName": null,
      "district": 1,
      "districtName": "EIT_District",
      "transferZone": 1,
      "transferZoneDescription": "EIT_Transfer_Zone_1",
      "defaultWarehouse": null,
      "stopOrderdays": null,
      "startOrderDays": 2,
      "currencyCode": "USD",
      "language": "AR",
      "integratedPosInd": "Y",
      "dunsNumber": null,
      "dunsLocation": null,
      "pricingStore": 8811,
      "timezoneName": "Africa/Banjul",
      "pricingStoreCurrency": "USD",
      "orgUnitId": 111,
      "storeNameSecondary": null,
      "vatRegion": 1000,
      "vatIncludeInd": "N",
      "sisterStore": null,
      "trasferEntityId": 1111,
      "autoReceiveInd": "D",
      "remerchandisingInd": "N",
      "franchiseCustomerId": null,
      "customerOrderLocationInd": "N",
      "giftWrappingInd": "N",
      "customerOrderShippingInd": "N",
      "onlineStoreInd": "N",
      "taxId": null,
      "primaryAddressType": "01",
      "primaryAddressTypeDescription": "Business",
      "primaryAddressAdd1": "Israel",
      "primaryAddressAdd2": null,
      "primaryAddressAdd3": null,
      "primaryAddressCity": "Israel",
      "primaryAddressState": null,
      "primaryAddressStateName": null,
      "primaryAddressCountryId": "IL",
      "primaryAddressCountryName": "Israel",
      "primaryAddressPost": null,
      "primaryAddressContactName": null,
      "primaryAddressContactPhone": null,
      "primaryAddressContactTelex": null,
      "primaryAddressContactFax": null,
      "primaryAddressContactEmail": null,
      "primaryAddressOracleVendorSiteId": null,
      "primaryAddressCounty": null,
      "primaryAddressJurisdictionCode": null,
      "createDateTime": "2021-11-19T18:14:40.000Z",
      "updateDateTime": "2021-11-19T18:14:40.000Z",
      "customFlexAttribute": null,
      "address": [
        {
          "addressKey": 20002,
          "addressType": "02",
          "addressTypeDescription": "Postal",
          "primaryAddressInd": "Y",
          "add1": "Israel",
          "add2": null,
          "add3": null,
          "city": "Israel",
          "state": null,
          "stateName": null,
          "countryId": "IL",
          "countryName": "Israel",
          "post": null,
          "jurisdictionCode": null,
          "contactName": null,
          "contactPhone": null,
          "contactTelex": null,
          "contactFax": null,
          "contactEmail": null,
          "oracleVendorSiteId": null,
          "county": null,
          "createDateTime": "2021-11-09T16:00:18.000Z",
          "updateDateTime": "2021-11-22T09:18:30.000Z",
          "customFlexAttribute": null
        },
        {
          "addressKey": 20001,
          "addressType": "01",
          "addressTypeDescription": "Business",
          "primaryAddressInd": "Y",
          "add1": "Israel",
          "add2": null,
          "add3": null,
          "city": "Israel",
          "state": null,
          "stateName": null,
          "countryId": "IL",
          "countryName": "Israel",
          "post": null,
          "jurisdictionCode": null,
          "contactName": "EIT",
          "contactPhone": null,
          "contactTelex": null,
          "contactFax": null,
          "contactEmail": null,
          "oracleVendorSiteId": null,
          "county": null,
          "createDateTime": "2021-11-09T16:00:17.000Z",
          "updateDateTime": "2021-11-22T09:18:30.000Z",
          "customFlexAttribute": null
        }
      ],
      "storeHours": null,
      "cacheTimestamp": "2022-02-23T12:41:34.129Z"
    }
  ],
  "hasMore": true,
  "limit": 2,
  "count": 2,
  "links": [
    {
      "href": "https://rex.retail.us-phoenix-1.ocs.oc-test.com/rgbu-rex-rgbu-stg83-mfcs/MerchIntegrations/services/foundation/store?limit=2&since=1970-01-01T00:00:00.001Z&before=2022-04-07T09:00:28.413938+00:00",
      "rel": "self"
    },
    {
      "href": "https://rex.retail.us-phoenix-1.ocs.oc-test.com/rgbu-rex-rgbu-stg83-mfcs/MerchIntegrations/services/foundation/store?offsetkey=1515&limit=2&since=1970-01-01T00:00:00.001Z&before=2022-04-07T09:00:28.413938+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	Yes	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	No	Yes	Yes
ICL_RMS_ADDR	Yes	No	Yes	Yes
ADDR	Yes	No	No	No
STORE_CFA_EXT	Yes	No	No	No
ADDR_CFA_EXT CFA	Yes	No	No	No
MERCHAPI_EXT_STORE_CFA	No	Yes	No	Yes
MERCHAPI_EXT_STORE_ADDR_CFA	No	Yes	No	Yes
MERCHAPI_EXT_STORE	Yes	Yes	Yes	Yes
V_MERCHAPI_EXT_STORE_JSON	Yes	No	No	No
SYSTEM_OPTIONS	Yes	No	No	No

Store Upload Service

The following services are included in this functional area:

Create Store

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service provides the ability to keep store data in Merchandising in sync with an external system if Merchandising is not being used as the system of record for organizational hierarchy information. The store data handled by this service includes basic store data in addition to addresses, store hours, up-charges.

Location traits and walkthrough store attributes cannot be attached while creating a store. The store create batch must first process the store before it can have these attributes attached to it. Up-charges, store hours, and addresses can be included for new stores.

The store creation also supports the ability to import custom flex attributes from an external system

When creating a new store in Merchandising via this service, the data is first validated, and then the service will create store in an asynchronous mode.

Service Type

POST

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/create

Input Payload Details

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The unique identifier of the store.
storeName	Yes	String (150)	The name of the store.
storeType	No	String (1)	The one character abbreviation of the store type.
storeNameSecondary	No	String (150)	Secondary name of the store. This field can only be populated when system_options. secondary_desc_ind = Y.
channelId	No	Number (4)	The identifier of the channel. This value must be predefined on the CHANNELS table. In a multichannel environment this field is required.
district	Yes	Number (10)	The number of the district of which the store is a member. This value must be predefined on the DISTRICT table.
transferZone	No	Number (4)	The transfer zone in which the store is located. This value must be predefined on the TSFZONE table.
defaultWarehouse	No	Number (10)	This field contains the default warehouse for the store. This value must be a virtual warehouse predefined on the WH table.
currencyCode	Yes	String (3)	The code of the currency under which the store operates. This value must be predefined on the CURRENCIES table. It cannot be modified.
orgUnitId	No	Number (15)	Column will contain the organizational unit ID value.
stockholdingInd	Yes	String (1)	Indicates if the store can hold stock. This field cannot be modified.
customerOrderLocationInd	No	String (1)	Customer order location indicator. This field can have Y or N.
customerOrderShippingInd	No	String (1)	This field indicates wheather the customer order has been been shipped from Warehouse or not.
giftWrappingInd	No	String (1)	This field indicates weathere a gift wrapping needs to be done or not.
onlineStoreInd	No	String (1)	This field indicates how store day will be managed by ReSA. If the indicator is Y then ReSA will automatically open and close the store day.
storeName10	No	String (10)	The ten character abbreviation of the store name.
storeName3	No	String (3)	The three character abbreviation of the store name.
storeClass	Yes	String (1)	The code of the class of which the store is a member.
storeManagerName	Yes	String (120)	The name of the store manager.
storeOpenDate	Yes	date	The date on which the store opened.
storeCloseDate	No	date	The date on which the store closed.
acquiredDate	No	date	The date on which the store was acquired.
remodelDate	No	date	The date on which the store was remodeled.
faxNo	No	String (20)	Contains the fax number for the store.
phoneNo	No	String (20)	This type can hold a number of digits count number.
email	No	String (100)	The email address of the store.
totalSquareFeet	No	Number (8)	The total square footage of the store.
sellingSquareFeet	No	Number (8)	The total square footage of the store's selling area.
linearDistance	No	Number (8)	The total merchandise space of the store.
storeFormat	No	Number (4)	The code of the store format of the store. This value must be predefined on the STORE_FORMAT table.
mallName	No	String (120)	The name of the mall in which the store is located.
stopOrderDays	No	Number (3)	The number of days before the store close date that the store will stop accepting orders.
startOrderDays	Yes	Number (3)	The number of days before the store open date that the store will begin accepting orders.
language	No	Number (6)	The code of the language used at the store. This value must be predefined on the LANG table.
isoCode	No	String (6)	The character code corresponding to the Language used at the store
integratedPosInd	Yes	String (1)	Indicates whether the store's POS is integrated.
dunsNumber	No	String (9)	Holds the Dun and Bradsteet (DUNS) number
dunsLocation	No	String (4)	The Dun and Bradstreet number to identify the location.
copyDeliveryInd	No	String (1)	Indicates if the like store's delivery schedule information should be copied to the new store. This value cannot be modified. It will only be populated on a store create message.
copyActivityInd	No	String (1)	Indicates if the like store's closing date schedule should be copied to the new store. This value cannot be modified. It will only be populated on a store create message.
priceStore	No	Number (10)	The store from which pricing information will be copied to the new store. The pricing store does not need the same currency as the new store. This value is not required on a create message and should not be populated on a modify message.
costLocation	No	Number (10)	The location from which to copy cost information to the new store. This field should only be populated on store create messages. This value must be predefined on the WH or STORE table. This value cannot be modified.
vatIncludeInd	No	String (1)	Indicates whether retail prices for the store will contain VAT.
vatRegion	No	Number (4)	The vat region of which the store is a part. This value must be predefined on the VAT_REGION table. It is required if VAT is on in the system.
likeStore	No	Number (10)	The store from which the new store will have item locations copied. This value must be predefined on the STORE table. It cannot be modified and will only be populated on a create message.
copyReplenishmentInd	No	String (1)	Indicates whether replenishment information should be copied from the like store to the new store. This field cannot be modified. It will only be populated on a store create message.
transferEntity	Yes	Number (10)	The transfer entity of which the store is a part. This value must be predefined on the TSF_ENTITY table. If the system allows intercompany transfers this field is required.
sisterStore	No	Number (10)	The store which will be used to relate historical data to the new store. This value must be predefined on the STORE table.
transactionNoGenerated	Yes	String (6)	The level at which unique POS transaction numbers are generated.
timezoneName	No	String (64)	TimeZone name.
customerId	No	Number (10)	Customer ID associated with the WF Store.
taxId	No	String (20)	Contains the unique tax identification number of the store.
copyClearanceInd	No	String (1)	Indicates if the like store's clearance items should be copied to the new store. This value cannot be modified. It will only be populated on a store create message.
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes at the order header level. 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.
address	No	Collection of Object	References a collection of store address.
hours	No	Collection of Object	References a collection of store hours details.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-796 Address - Object. See list of elements for detail

Element Name	Required	Data Type	Description
addressType	Yes	String (2)	Indicates the type for the address. Valid values (e. g. 01-business, 02-postal) are in the add_type table.
externalReferenceId	Yes	String (32)	This field holds the unique address ID from the source system. For addresses that are interfaced into Merchandising, it will hold the external system's address ID.
primaryAddressTypeInd	No	String (1)	Indicates whether the address type is the primary address type for the module.
primaryAddressInd	Yes	String (1)	Indicates whether this address is the primary address for this address type.
add1	Yes	String (240)	Contains the first line of the address
add2	No	String (240)	Contains the second line of the address.
add3	No	String (240)	Contains the thirdline of the address.
city	Yes	String (120)	Contains the name of the city that is associated with the address.
state	No	String (3)	Contains the postal abbreviation for the state in which the warehouse is located.
stateName	No	String (120)	Indicates the State name.
country	Yes	String (3)	Contains the country where the address exists.
countryName	No	String (120)	Indicates the Country Name. For e. g Brazil,United States
post	No	String (30)	Contains the zip code for the address.
county	No	String (250)	Contains the county name for the location.
jurisdictionCode	No	String (10)	ID associated to the tax jurisdiction of the country-state relationship.
contactName	No	String (120)	Contains the name of the contact for the supplier at this address.
contactPhone	No	String (20)	Contains the phone number of the contact person at this address.
contactTelex	No	String (20)	Contains the telex number of the partner or suppliers representative contact.
contactFax	No	String (20)	Contains the fax number of the contact person at this address.
contactEmail	No	String (100)	Contains the email address of the partner or suppliers representative contact.
oracleVendorSiteId	No	Number (15)	The unique identifier of this address in the Oracle Financials systems, if used.
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes at the order header level. 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-797 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-798 Hours - Object. See list of elements for detail

Element Name	Required	Data Type	Description
dayNo	Yes	Number (1)	This field indicates the day of the week for which store timing is being stored.
storeOpenTime	No	String (8)	Contains the open time for the store. The time format must be in HH:MM AM or HH:MM PM.
storeCloseTime	No	String (8)	Contains the close time for the store. The time format must be in HH:MM AM or HH:MM PM.

Table 5-799 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-800 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

{
  "store": 6001,
  "storeName": "6001 Retail",
  "storeType": "C",
  "storeNameSecondary": "storeNameSecondary",
  "channelId": 1,
  "district": 121,
  "transferZone": 1000,
  "defaultWarehouse": 5,
  "currencyCode": "USD",
  "orgUnitId": 1111111111,
  "stockholdingInd": "Y",
  "customerOrderLocationInd": "Y",
  "customerOrderShippingInd": "Y",
  "giftWrappingInd": "Y",
  "onlineStoreInd": "N",
  "storeName10": "6001Retail",
  "storeName3": "600",
  "storeClass": "A",
  "storeManagerName": "storeMgrName",
  "storeOpenDate": "2001-12-31",
  "storeCloseDate": "2001-12-31",
  "acquiredDate": "2001-12-31",
  "remodelDate": "2001-12-31",
  "faxNo": null,
  "phoneNo": "1800800800",
  "email": "someone@email.com",
  "totalSquareFeet": 762426,
  "sellingSquareFeet": 570207,
  "linearDistance": 717780,
  "storeFormat": 10,
  "mallName": "mallName",
  "stopOrderDays": 5,
  "startOrderDays": 10,
  "language": 1,
  "isoCode": "en",
  "integratedPosInd": "Y",
  "dunsNumber": null,
  "dunsLocation": null,
  "copyDeliveryInd": "Y",
  "copyActivityInd": "Y",
  "priceStore": 6000,
  "costLocation": 6000,
  "vatIncludeInd": "Y",
  "vatRegion": 1000,
  "likeStore": null,
  "copyReplenishmentInd": "Y",
  "transferEntity": 1000,
  "sisterStore": 1913,
  "transactionNoGenerated": "S",
  "timezoneName": "America/New_York",
  "customerId": 121902,
  "taxId": null,
  "copyClearanceInd": "Y",
  "customFlexAttribute": [
    {
      "name": "REVIEW_DATE",
      "value": null,
      "valueDate": null
    }
  ],
  "address": [
    {
      "addressType": "01",
      "externalReferenceId": "REF6001",
      "primaryAddressTypeInd": "Y",
      "primaryAddressInd": "Y",
      "add1": "101 First Street",
      "add2": "201 Second Street",
      "add3": "301 Third Street",
      "city": "Minneapolis",
      "state": "MN",
      "stateName": "MN",
      "country": "US",
      "countryName": "US",
      "post": "55555-1234",
      "county": null,
      "jurisdictionCode": null,
      "contactName": "contactName",
      "contactPhone": "1800800800",
      "contactTelex": null,
      "contactFax": null,
      "contactEmail": "someone@email.com",
      "oracleVendorSiteId": 625128,
      "customFlexAttribute": [
        {
          "name": "REVIEW_DATE",
          "value": null,
          "valueDate": null
        }
      ]
    }
  ],
  "hours": [
    {
      "dayNo": 1,
      "storeOpenTime": null,
      "storeCloseTime": 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)

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 Store Address

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service is used to create additional address for an existing store in Merchandising.

Service Type

POST

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/address/create

Input Payload Details

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The unique identifier of the store.
storeType	No	String (1)	The one character abbreviation of the store type.
address	No	Collection of Object	References a collection of store address.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-802 Address - Object. See list of elements for detail

Element Name	Required	Data Type	Description
addressType	Yes	String (2)	Indicates the type for the address. Valid values (e. g. 01-business, 02-postal) are in the add_type table.
externalReferenceId	Yes	String (32)	This field holds the unique address ID from the source system. For addresses that are interfaced into Merchandising, it will hold the external system's address ID.
primaryAddressTypeInd	No	String (1)	Indicates whether the address type is the primary address type for the module.
primaryAddressInd	Yes	String (1)	Indicates whether this address is the primary address for this address type.
add1	Yes	String (240)	Contains the first line of the address
add2	No	String (240)	Contains the second line of the address.
add3	No	String (240)	Contains the thirdline of the address.
city	Yes	String (120)	Contains the name of the city that is associated with the address.
state	No	String (3)	Contains the postal abbreviation for the state in which the warehouse is located.
stateName	No	String (120)	Indicates the State name.
country	Yes	String (3)	Contains the country where the address exists.
countryName	No	String (120)	Indicates the Country Name. For e. g Brazil,United States
post	No	String (30)	Contains the zip code for the address.
county	No	String (250)	Contains the county name for the location.
jurisdictionCode	No	String (10)	ID associated to the tax jurisdiction of the country-state relationship.
contactName	No	String (120)	Contains the name of the contact for the supplier at this address.
contactPhone	No	String (20)	Contains the phone number of the contact person at this address.
contactTelex	No	String (20)	Contains the telex number of the partner or suppliers representative contact.
contactFax	No	String (20)	Contains the fax number of the contact person at this address.
contactEmail	No	String (100)	Contains the email address of the partner or suppliers representative contact.
oracleVendorSiteId	No	Number (15)	The unique identifier of this address in the Oracle Financials systems, if used.
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes at the order header level. 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-803 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-804 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-805 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

{
  "store": 6000,
  "storeType": "C",
  "address": [
    {
      "addressType": "01",
      "externalReferenceId": "REF6001",
      "primaryAddressTypeInd": "Y",
      "primaryAddressInd": "Y",
      "add1": "101 First Street",
      "add2": "201 Second Street",
      "add3": "301 Third Street",
      "city": "Minneapolis",
      "state": "MN",
      "stateName": "stateName",
      "country": "US",
      "countryName": "countryName",
      "post": "55555-1234",
      "county": "Some County",
      "jurisdictionCode": null,
      "contactName": "contactName",
      "contactPhone": "1800800800",
      "contactTelex": null,
      "contactFax": null,
      "contactEmail": "someone@email.com",
      "oracleVendorSiteId": 625128,
      "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)

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 Store Department Up Charges

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service is used to include department level up-charges for an existing store in Merchandising.

Service Type

POST

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/departmentUpCharges/create

Input Payload Details

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The unique identifier of the store.
storeType	No	String (1)	The one character abbreviation of the store type.
upcharge	No	Collection of Object	References a collection of store department upcharges.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-807 Upcharge - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hierarchyLevel	Yes	String (6)	The hierarchy level for Up Charges. Valid values are: DI - Division, GR - Group, DE - Department, AD - All Department.
hierarchyValue	No	Number (4)	The value of the hierarchy. This column can contain Division/Group/Department IDs when Hier Level is 'DI', 'GR', or 'DE'. Otherwise, it should be left blank when Hier Level is 'AD'.
fromLocation	No	String (10)	Contains the source location from which goods will be transferred. This column can contain Country/Area/Region IDs when From Location Type is 'C', 'A', or 'R'. It will be a store, virtual warehouse or physical warehouse when From Location Type is 'S', 'W' or 'PW'. Otherwise, it should be left blank when From Location Type is either 'AS' or 'AW'.
toLocation	No	String (10)	Contains the destination location to which goods will be transferred. This column can contain Country/Area/Region IDs when To Location Type is 'C', 'A', or 'R'. It will be a store, virtual warehouse or physical warehouse when To Location Type is 'S', 'W' or 'PW'. Otherwise, it should be left blank when To Location Type is either 'AS' or 'AW'.
fromLocationType	Yes	String (6)	Contains the type of source location from which goods will be transferred. Valid values are defined in code type 'LTPC'. Examples are: C - Country, A - Area, R - Region, S - Store, W - Virtual Warehouse, PW - Physical Warehouse, AS - All Stores, AW - All Warehouses.
toLocationType	Yes	String (6)	Contains the type of source location from which goods will be transferred. Valid values are defined in code type 'LTPC'. Examples are: C - Country, A - Area, R - Region, S - Store, W - Virtual Warehouse, PW - Physical Warehouse, AS - All Stores, AW - All Warehouses.
details	No	Collection of Object	References a collection of store department upcharge details.

Table 5-808 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.
componentRate	Yes	Number (20,4)	This field contains the rate to be charged against the cost of the Item/To Location combinations within the department.
perCount	No	Number (12,4)	This field contains a count indicating the amount of the Per Count Unit of Measure to which the rate applies.
perCountUom	No	String (4)	This field contains the unit of measure in which the Per Count is specified.
upChargeGroup	Yes	String (6)	This field contains the up charge group to which the component ID belongs. Valid values can be found on the codes table with a code type of UCHG. Examples are Admin. Fee (A), Freight (F) and Special K Fees (K).
componentCurrency	Yes	String (3)	This field contains the currency of the Up Charge component.
effectiveDate	No	date	The date from which the new values are effective in the system.
itemDefaultInd	No	String (1)	Indicates if component rate information is updated or not for existing items under the department.
transferAllocationDefaultInd	No	String (1)	Indicates if component rate information is updated or not for existing transfers and allocations under the department.
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), 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). This column will default to the value in the ELC_COMP table but can be updated at the department level.

Table 5-809 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-810 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

{
  "store": 6000,
  "storeType": "C",
  "upcharge": [
    {
      "hierarchyLevel": "DI",
      "hierarchyValue": 1000,
      "fromLocation": "1231",
      "toLocation": "3112",
      "fromLocationType": "S",
      "toLocationType": "S",
      "details": [
        {
          "componentId": "UC1",
          "componentRate": 3.55,
          "perCount": 3,
          "perCountUom": "EA",
          "upChargeGroup": "A",
          "componentCurrency": "USD",
          "effectiveDate": "2001-12-31",
          "itemDefaultInd": "Y",
          "transferAllocationDefaultInd": "Y",
          "computationValueBase": null,
          "costBasis": "S",
          "includeInTotalUpChargeInd": "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)

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 Store Hours

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service is used to define the store hours attribute for an existing store in Merchandising.

Service Type

POST

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/hours/create

Input Payload Details

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The unique identifier of the store.
storeType	No	String (1)	The one character abbreviation of the store type.
hours	No	Collection of Object	References a collection of store hours details.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-812 Hours - Object. See list of elements for detail

Element Name	Required	Data Type	Description
dayNo	Yes	Number (1)	This field indicates the day of the week for which store timing is being stored.
storeOpenTime	No	String (8)	Contains the open time for the store. The time format must be in HH:MM AM or HH:MM PM.
storeCloseTime	No	String (8)	Contains the close time for the store. The time format must be in HH:MM AM or HH:MM PM.

Table 5-813 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-814 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

{
  "store": 6000,
  "storeType": "C",
  "hours": [
    {
      "dayNo": 1,
      "storeOpenTime": null,
      "storeCloseTime": 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)

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 Store Location Trait

Functional Area

Organizational Hierarchy - Stores

Business Overview

The primary role of this service is to assign location trait to an existing store in Merchandising. Location traits must already exist prior to being added to the store.

Service Type

POST

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/locationTrait/create

Input Payload Details

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The unique identifier of the store.
storeType	No	String (1)	The one character abbreviation of the store type.
traits	No	Collection of Object	References a collection of location traits.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-816 Traits - Object. See list of elements for detail

Element Name	Required	Data Type	Description
traitId	Yes	Number (4)	The identifier of the location trait. Though the node is optional, this field is required if the node is included. The node can not be populated on the store create message.

Table 5-817 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-818 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

{
  "store": 6000,
  "storeType": "C",
  "traits": [
    {
      "traitId": 1000
    }
  ],
  "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)

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 Walk-Through Store

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service can be used to assign walk-through store to an existing store in Merchandising. Walk-through stores are used in Merchandising as part of the transfer reconciliation process and are used to indicate two or more stores that have a 'walk through' connection between them - on the sales floor and/or the backroom.

Service Type

POST

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/walkThroughStore/create

Input Payload Details

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The unique identifier of the store.
storeType	No	String (1)	The one character abbreviation of the store type.
walkThrough	No	Collection of Object	References a collection of walkthrough stores.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

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

Element Name	Required	Data Type	Description
walkThroughStore	Yes	Number (10)	A walk through store of the store being modified. Though the node is optional, if it is included this field is required. This node can not be populated on a store create message.

Table 5-821 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-822 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

{
  "store": 6000,
  "storeType": "C",
  "walkThrough": [
    {
      "walkThroughStore": 187308
    }
  ],
  "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)

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 Store

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service provides the ability to delete an existing store data based on the request from an external system if Merchandising is not the system of record for organizational hierarchy information.

After the data has been validated, the service will add the store to the DAILY_PURGE table for processing deletion through a batch process.

Service Type

DELETE

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/delete

Input Payload Details

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The store number being deleted, or for which a location trait or walk through store is being disassociated.

Sample Input Message

{
  "store": 6000
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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 Store Address

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service is used to delete the address from an existing store in Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/address/delete

Input Payload Details

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The store number being deleted, or for which a location trait or walk through store is being disassociated.
address	No	Collection of Object	It's a referenced element. For detailed description, please refer referenced element doc.

Table 5-825 Address - Object. See list of elements for detail

Element Name	Required	Data Type	Description
externalReferenceId	Yes	String (32)	The unique identifier of the address being deleted. For address delete messages that are interfaced into RMS, it will hold the external store system's address ID. For address delete messages published out of RMS, it will hold RMS's address ID.

Sample Input Message

{
  "store": 6000,
  "address": [
    {
      "externalReferenceId": "ADDREF01"
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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 Store Department Up Charges

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service is used to delete department level up-charges from an existing store in Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/departmentUpCharges/delete

Input Payload Details

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The store number being deleted, or for which a location trait or walk through store is being disassociated.
upcharge	No	Collection of Object	Child node.

Table 5-827 Upcharge - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hierarchyLevel	Yes	String (6)	The hierarchy level for Department Up Charges. Valid values are: DI - Division, GR - Group, DE - Department, AD - All Department.
hierarchyValue	No	Number (4)	The value of the hierarchy.
fromLocation	No	String (10)	Contains the source location from which goods will be transferred. This column can contain Country/Area/Region IDs when From Location Type is 'C', 'A', or 'R'. It will be a store, virtual warehouse or physical warehouse when From Location Type is 'S', 'W' or 'PW'. Otherwise, it should be left blank when From Location Type is either 'AS' or 'AW'.
toLocation	No	String (10)	Contains the destination location to which goods will be transferred. This column can contain Country/Area/Region IDs when To Location Type is 'C', 'A', or 'R'. It will be a store, virtual warehouse or physical warehouse when To Location Type is 'S', 'W' or 'PW'. Otherwise, it should be left blank when To Location Type is either 'AS' or 'AW'.
fromLocationType	Yes	String (6)	Contains the type of source location from which goods will be transferred. Valid values are defined in code type 'LTPC'. Examples are: C - Country, A - Area, R - Region, S - Store, W - Virtual Warehouse, PW - Physical Warehouse, AS - All Stores, AW - All Warehouses.
toLocationType	Yes	String (6)	Contains the type of source location from which goods will be transferred. Valid values are defined in code type 'LTPC'. Examples are: C - Country, A - Area, R - Region, S - Store, W - Virtual Warehouse, PW - Physical Warehouse, AS - All Stores, AW - All Warehouses.
details	No	Collection of Object	References a collectiion of store department upcharge details.

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

Element Name	Required	Data Type	Description
componentId	No	String (10)	This field contains the unique identifier of the Up Charge component.

Sample Input Message

{
  "store": 6000,
  "upcharge": [
    {
      "hierarchyLevel": "GR",
      "hierarchyValue": 1000,
      "fromLocation": "1231",
      "toLocation": "100124",
      "fromLocationType": "S",
      "toLocationType": "S",
      "details": [
        {
          "componentId": "UC2"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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 Store Hours

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service is used to delete the store hours from an existing store in Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/hours/delete

Input Payload Details

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The store number being deleted, or for which a location trait or walk through store is being disassociated.
hours	No	Collection of Object	It's a referenced element. For detailed description, please refer referenced element doc.

Table 5-830 Hours - Object. See list of elements for detail

Element Name	Required	Data Type	Description
dayNo	Yes	Number (1)	This field indicates the day of the week for which store timing is being stored.

Sample Input Message

{
  "store": 6000,
  "hours": [
    {
      "dayNo": 4
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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 Store Location Trait

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service is used to delete the location trait from an existing store in Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/locationTrait/delete

Input Payload Details

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The store number being deleted, or for which a location trait or walk through store is being disassociated.
traits	No	Collection of Object	It's a referenced element. For detailed description, please refer referenced element doc.

Table 5-832 Traits - Object. See list of elements for detail

Element Name	Required	Data Type	Description
traitId	Yes	Number (4)	The identifier of the location trait. Though the node is optional, this field is required if the node is included. The node can not be populated on the store create message.

Sample Input Message

{
  "store": 6000,
  "traits": [
    {
      "traitId": 1000
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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 Walk-Through Store

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service can be used to delete the walk-through store from an existing store in Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/walkThroughStore/delete

Input Payload Details

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The store number being deleted, or for which a location trait or walk through store is being disassociated.
walkThrough	No	Collection of Object	It's a referenced element. For detailed description, please refer referenced element doc.

Table 5-834 WalkThrough - Object. See list of elements for detail

Element Name	Required	Data Type	Description
walkThroughStore	Yes	Number (10)	A walk through store of the store being modified. Though the node is optional, if it is included this field is required. This node can not be populated on a store create message.

Sample Input Message

{
  "store": 6000,
  "walkThrough": [
    {
      "walkThroughStore": 187308
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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 Store

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service provides the ability to update an existing store data based on the request from an external system if Merchandising is not the system of record for organizational hierarchy information.

After the data has been validated, unlike store creation or deletion, the update is applied in Merchandising immediately upon message receipt.

For more details on stores, see the Create store service description.

Service Type

PUT

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/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-835 Update - Object. See list of elements for detail

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The unique identifier of the store.
storeName	Yes	String (150)	The name of the store.
storeType	No	String (1)	The one character abbreviation of the store type. This field cannot be modified.
storeNameSecondary	No	String (150)	Secondary name of the store. This field can only be populated when system_options. secondary_desc_ind = Y.
channelId	No	Number (4)	The identifier of the channel. This value must be predefined on the CHANNELS table. In a multichannel environment this field is required.
district	Yes	Number (10)	The number of the district of which the store is a member. This value must be predefined on the DISTRICT table.
transferZone	No	Number (4)	The transfer zone in which the store is located. This value must be predefined on the TSFZONE table.
defaultWarehouse	No	Number (10)	This field contains the default warehouse for the store. This value must be a virtual warehouse predefined on the WH table.
currencyCode	Yes	String (3)	The code of the currency under which the store operates. This value must be predefined on the CURRENCIES table. It cannot be modified.
orgUnitId	No	Number (15)	Column will contain the organizational unit ID value. This field cannot be modified.
stockholdingInd	Yes	String (1)	Indicates if the store can hold stock. This field cannot be modified.
customerOrderLocationInd	No	String (1)	Customer order location indicator. This field can have Y or N.
customerOrderShippingInd	No	String (1)	This field indicates wheather the customer order has been been shipped from Warehouse or not.
giftWrappingInd	No	String (1)	This field indicates weathere a gift wrapping needs to be done or not.
onlineStoreInd	No	String (1)	This field indicates how store day will be managed by ReSA. If the indicator is Y then ReSA will automatically open and close the store day.
storeName10	No	String (10)	The ten character abbreviation of the store name.
storeName3	No	String (3)	The three character abbreviation of the store name.
storeClass	Yes	String (1)	The code of the class of which the store is a member.
storeManagerName	Yes	String (120)	The name of the store manager.
storeOpenDate	Yes	date	The date on which the store opened.
storeCloseDate	No	date	The date on which the store closed.
acquiredDate	No	date	The date on which the store was acquired.
remodelDate	No	date	The date on which the store was remodeled.
faxNo	No	String (20)	Contains the fax number for the store.
phoneNo	No	String (20)	This type can hold a number of digits count number.
email	No	String (100)	The email address of the store.
totalSquareFeet	No	Number (8)	The total square footage of the store.
sellingSquareFeet	No	Number (8)	The total square footage of the store's selling area.
linearDistance	No	Number (8)	The total merchandise space of the store.
storeFormat	No	Number (4)	The code of the store format of the store. This value must be predefined on the STORE_FORMAT table.
mallName	No	String (120)	The name of the mall in which the store is located.
stopOrderDays	No	Number (3)	The number of days before the store close date that the store will stop accepting orders.
startOrderDays	Yes	Number (3)	The number of days before the store open date that the store will begin accepting orders.
language	No	Number (6)	The code of the language used at the store. This value must be predefined on the LANG table.
isoCode	No	String (6)	The character code corresponding to the Language used at the store
integratedPosInd	Yes	String (1)	Indicates whether the store's POS is integrated.
dunsNumber	No	String (9)	Holds the Dun and Bradsteet (DUNS) number
dunsLocation	No	String (4)	The Dun and Bradstreet number to identify the location.
priceStore	No	Number (10)	The store from which pricing information will be copied to the new store. The pricing store does not need the same currency as the new store. This value is not required on a create message and should not be populated on a modify message.
costLocation	No	Number (10)	The location from which to copy cost information to the new store. This field should only be populated on store create messages. This value must be predefined on the WH or STORE table. This value cannot be modified.
vatIncludeInd	No	String (1)	Indicates whether retail prices for the store will contain VAT.
vatRegion	No	Number (4)	The vat region of which the store is a part. This value must be predefined on the VAT_REGION table. It is required if VAT is on in the system.
likeStore	No	Number (10)	The store from which the new store will have item locations copied. This value must be predefined on the STORE table. It cannot be modified and will only be populated on a create message.
transferEntity	Yes	Number (10)	The transfer entity of which the store is a part. This value must be predefined on the TSF_ENTITY table. If the system allows intercompany transfers this field is required.
sisterStore	No	Number (10)	The store which will be used to relate historical data to the new store. This value must be predefined on the STORE table.
transactionNoGenerated	Yes	String (6)	The level at which unique POS transaction numbers are generated.
timezoneName	No	String (64)	TimeZone name.
customerId	No	Number (10)	Customer ID associated with the WF Store.
taxId	No	String (20)	Contains the unique tax identification number of the store.
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.
hours	No	Collection of Object	References a collection of store hours details.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-836 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-837 Hours - Object. See list of elements for detail

Element Name	Required	Data Type	Description
dayNo	Yes	Number (1)	This field indicates the day of the week for which store timing is being stored.
storeOpenTime	No	String (8)	Contains the open time for the store. The time format must be in HH:MM AM or HH:MM PM.
storeCloseTime	No	String (8)	Contains the close time for the store. The time format must be in HH:MM AM or HH:MM PM.

Table 5-838 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-839 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

{
  "store": 6001,
  "storeName": "6001 Retail storeName",
  "storeType": "C",
  "storeNameSecondary": "storeNameSecondary",
  "channelId": 1,
  "district": 121,
  "transferZone": 1000,
  "defaultWarehouse": 5,
  "currencyCode": "USD",
  "orgUnitId": 1111111111,
  "stockholdingInd": "Y",
  "customerOrderLocationInd": "Y",
  "customerOrderShippingInd": "Y",
  "giftWrappingInd": "Y",
  "onlineStoreInd": "N",
  "storeName10": "StoreName",
  "storeName3": "Str",
  "storeClass": "A",
  "storeManagerName": "storeMgrName",
  "storeOpenDate": "2001-12-31",
  "storeCloseDate": "2001-12-31",
  "acquiredDate": "2001-12-31",
  "remodelDate": "2001-12-31",
  "faxNo": null,
  "phoneNo": "1800800800",
  "email": "someone@email.com",
  "totalSquareFeet": 762426,
  "sellingSquareFeet": 570207,
  "linearDistance": 717780,
  "storeFormat": 1000,
  "mallName": "mallName",
  "stopOrderDays": 100,
  "startOrderDays": 6,
  "language": 1,
  "isoCode": "en",
  "integratedPosInd": "Y",
  "dunsNumber": null,
  "dunsLocation": null,
  "priceStore": 6000,
  "costLocation": 6000,
  "vatIncludeInd": "Y",
  "vatRegion": 1000,
  "likeStore": null,
  "transferEntity": 1000,
  "sisterStore": 1913,
  "transactionNoGenerated": "S",
  "timezoneName": "timezoneName",
  "customerId": 121902,
  "taxId": null,
  "customFlexAttribute": [
    {
      "name": "REVIEW_DATE",
      "value": null,
      "valueDate": "2001-12-31"
    }
  ],
  "hours": [
    {
      "dayNo": 1,
      "storeOpenTime": null,
      "storeCloseTime": 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)

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 Store Address

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service is used to update the address of an existing store in Merchandising.

Service Type

PUT

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/address/update

Input Payload Details

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The unique identifier of the store.
storeType	No	String (1)	The one-character abbreviation of the store type.
address	No	Collection of Object	References a collection of store address.
customerId	No	Number (10)	Customer ID associated with the WF Store.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-841 Address - Object. See list of elements for detail

Element Name	Required	Data Type	Description
addressType	Yes	String (2)	Indicates the type for the address. Valid values (for example, 01-business, 02-postal) are in the add_type table.
externalReferenceId	Yes	String (32)	This field holds the unique address ID from the source system. For addresses that are interfaced into Merchandising, it will hold the external system's address ID.
primaryAddressTypeInd	No	String (1)	Indicates whether the address type is the primary address type for the module.
primaryAddressInd	Yes	String (1)	Indicates whether this address is the primary address for this address type.
add1	Yes	String (240)	Contains the first line of the address
add2	No	String (240)	Contains the second line of the address.
add3	No	String (240)	Contains the thirdline of the address.
city	Yes	String (120)	Contains the name of the city that is associated with the address.
state	No	String (3)	Contains the postal abbreviation for the state in which the warehouse is located.
stateName	No	String (120)	Indicates the State name.
country	Yes	String (3)	Contains the country where the address exists.
countryName	No	String (120)	Indicates the Country Name. For e. g Brazil,United States
post	No	String (30)	Contains the zip code for the address.
county	No	String (250)	Contains the county name for the location.
jurisdictionCode	No	String (10)	ID associated to the tax jurisdiction of the country-state relationship.
contactName	No	String (120)	Contains the name of the contact for the supplier at this address.
contactPhone	No	String (20)	Contains the phone number of the contact person at this address.
contactTelex	No	String (20)	Contains the telex number of the partner or suppliers representative contact.
contactFax	No	String (20)	Contains the fax number of the contact person at this address.
contactEmail	No	String (100)	Contains the email address of the partner or suppliers representative contact.
oracleVendorSiteId	No	Number (15)	The unique identifier of this address in the Oracle Financials systems, if used.
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-842 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-843 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-844 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

{
  "store": 6000,
  "storeType": "C",
  "address": [
    {
      "addressType": "01",
      "externalReferenceId": "REF6001",
      "primaryAddressTypeInd": "Y",
      "primaryAddressInd": "Y",
      "add1": "101 First Street",
      "add2": "201 Second Street",
      "add3": "301 Third Street",
      "city": "Minneapolis",
      "state": "MN",
      "stateName": "stateName",
      "country": "US",
      "countryName": "countryName",
      "post": "55555-1234",
      "county": "Some County",
      "jurisdictionCode": null,
      "contactName": "contactName",
      "contactPhone": "1800800800",
      "contactTelex": null,
      "contactFax": null,
      "contactEmail": "someone@email.com",
      "oracleVendorSiteId": 625128,
      "customFlexAttribute": [
        {
          "name": "REVIEW_DATE",
          "value": null,
          "valueDate": "2001-12-31"
        }
      ]
    }
  ],
  "customerId": 121902,
  "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)

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 Store Department Up Charges

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service is used to update department level up-charges for an existing store in Merchandising.

Service Type

PUT

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/departmentUpCharges/update

Input Payload Details

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The unique identifier of the store.
storeType	No	String (1)	The one character abbreviation of the store type.
upcharge	No	Collection of Object	References a collection of store department upcharges.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

Table 5-846 Upcharge - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hierarchyLevel	Yes	String (6)	The hierarchy level for Up Charges. Valid values are: DI - Division, GR - Group, DE - Department, AD - All Department.
hierarchyValue	No	Number (4)	The value of the hierarchy. This column can contain Division/Group/Department IDs when Hier Level is 'DI', 'GR', or 'DE'. Otherwise, it should be left blank when Hier Level is 'AD'.
fromLocation	No	String (10)	Contains the source location from which goods will be transferred. This column can contain Country/Area/Region IDs when From Location Type is 'C', 'A', or 'R'. It will be a store, virtual warehouse or physical warehouse when From Location Type is 'S', 'W' or 'PW'. Otherwise, it should be left blank when From Location Type is either 'AS' or 'AW'.
toLocation	No	String (10)	Contains the destination location to which goods will be transferred. This column can contain Country/Area/Region IDs when To Location Type is 'C', 'A', or 'R'. It will be a store, virtual warehouse or physical warehouse when To Location Type is 'S', 'W' or 'PW'. Otherwise, it should be left blank when To Location Type is either 'AS' or 'AW'.
fromLocationType	Yes	String (6)	Contains the type of source location from which goods will be transferred. Valid values are defined in code type 'LTPC'. Examples are: C - Country, A - Area, R - Region, S - Store, W - Virtual Warehouse, PW - Physical Warehouse, AS - All Stores, AW - All Warehouses.
toLocationType	Yes	String (6)	Contains the type of source location from which goods will be transferred. Valid values are defined in code type 'LTPC'. Examples are: C - Country, A - Area, R - Region, S - Store, W - Virtual Warehouse, PW - Physical Warehouse, AS - All Stores, AW - All Warehouses.
details	No	Collection of Object	References a collection of store department upcharge details.

Table 5-847 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.
componentRate	Yes	Number (20,4)	This field contains the rate to be charged against the cost of the Item/To Location combinations within the department.
perCount	No	Number (12,4)	This field contains a count indicating the amount of the Per Count Unit of Measure to which the rate applies.
perCountUom	No	String (4)	This field contains the unit of measure in which the Per Count is specified.
upChargeGroup	Yes	String (6)	This field contains the up charge group to which the component ID belongs. Valid values can be found on the codes table with a code type of UCHG. Examples are Admin. Fee (A), Freight (F) and Special K Fees (K).
componentCurrency	Yes	String (3)	This field contains the currency of the Up Charge component.
effectiveDate	No	date	The date from which the new values are effective in the system.
itemDefaultInd	No	String (1)	Indicates if component rate information is updated or not for existing items under the department.
transferAllocationDefaultInd	No	String (1)	Indicates if component rate information is updated or not for existing transfers and allocations under the department.
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), 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). This column will default to the value in the ELC_COMP table but can be updated at the department level.

Table 5-848 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-849 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

{
  "store": 6000,
  "storeType": "C",
  "upcharge": [
    {
      "hierarchyLevel": "DI",
      "hierarchyValue": 1000,
      "fromLocation": "1231",
      "toLocation": "3112",
      "fromLocationType": "S",
      "toLocationType": "S",
      "details": [
        {
          "componentId": "UC1",
          "componentRate": 3.55,
          "perCount": 3,
          "perCountUom": "EA",
          "upChargeGroup": "A",
          "componentCurrency": "USD",
          "effectiveDate": "2001-12-31",
          "itemDefaultInd": "Y",
          "transferAllocationDefaultInd": "Y",
          "computationValueBase": null,
          "costBasis": "S",
          "includeInTotalUpChargeInd": "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)

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 Store Hours

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service is used to modify the store hours for an existing store in Merchandising.

Service Type

PUT

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/hours/update

Input Payload Details

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	The unique identifier of the store.
storeType	No	String (1)	The one character abbreviation of the store type.
hours	No	Collection of Object	References a collection of store hours details.
localizationExtensions	No	Collection of Object	Holds optional localization attributes that will be processed by the localization extension module.

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

Element Name	Required	Data Type	Description
dayNo	Yes	Number (1)	This field indicates the day of the week for which store timing is being stored.
storeOpenTime	No	String (8)	Contains the open time for the store. The time format must be in HH:MM AM or HH:MM PM.
storeCloseTime	No	String (8)	Contains the close time for the store. The time format must be in HH:MM AM or HH:MM PM.

Table 5-852 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-853 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

{
  "store": 6000,
  "storeType": "C",
  "hours": [
    {
      "dayNo": 1,
      "storeOpenTime": null,
      "storeCloseTime": 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)

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

Stores by Hierarchy Level Upload Service

The following services are included in this functional area:

Create Store Location Trait by Hierarchy Level

Functional Area

Organizational Hierarchy - Stores

Business Overview

If Merchandising is not the system of record for organizational hierarchy information for an implementation, then this service can be used to assign an existing location trait to stores of a given organization hierarchy level in Merchandising based on the request from an external system.

Service Type

POST

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/locationTraitByHierarchy/create

Input Payload Details

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

Element Name	Required	Data Type	Description
hierarchyValue	Yes	Number (10)	The ID of the specified hierarchy level. This value must be unique among other values of the same hierarchy level.
hierarchyDescription	No	String (120)	The description of the hierarchy value.
hierarchyLevel	Yes	String (2)	The hierarchy level of the hierarchy value. This field will indicate the level of the organizational hierarchy to which the cost change applies. Valid values are CH (chain), AR (area), RE (region), DI (district).
parentHierarchyId	No	Number (10)	The ID of the hierarchy value's parent hierarchy value. This value must be predefined on either the CHAIN, AREA or REGION table.
traits	Yes	Collection of Object	References a collection of traits.

Table 5-855 Traits - Object. See list of elements for detail

Element Name	Required	Data Type	Description
traitId	Yes	Number (4)	The location trait associated to the hierarchy value. This value must be predefined on LOC_TRAITS table. A location trait cannot be associated with (or deleted from) a chain.

Sample Input Message

{
  "hierarchyValue": 2,
  "hierarchyDescription": null,
  "hierarchyLevel": "AR",
  "parentHierarchyId": 117516,
  "traits": [
    {
      "traitId": 1
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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 Store Location Trait by Hierarchy Level

Functional Area

Organizational Hierarchy - Stores

Business Overview

If Merchandising is not the system of record for organizational hierarchy information for an implementation, then this service can be used to delete a location trait from stores of a given organization hierarchy level in Merchandising based on the request from an external system.

Service Type

DELETE

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/locationTraitByHierarchy/delete

Input Payload Details

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

Element Name	Required	Data Type	Description
hierarchyValue	Yes	Number (10)	The ID of the specified hierarchy level. This value must be unique among other values of the same hierarchy level.
hierarchyLevel	Yes	String (2)	The hierarchy level of the hierarchy value. This field will indicate the level of the organizational hierarchy to which the cost change applies. Valid values are CH (chain), AR (area), RE (region), DI (district).
traits	No	Collection of Object	References a collection of traits.

Table 5-857 Traits - Object. See list of elements for detail

Element Name	Required	Data Type	Description
traitId	Yes	Number (4)	The location trait associated to the hierarchy value. This value must be predefined on LOC_TRAITS table. A location trait cannot be associated with (or deleted from) a chain.

Sample Input Message

{
  "hierarchyValue": 571,
  "hierarchyLevel": "DI",
  "traits": [
    {
      "traitId": 1
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Warehouse

The following services are included in this functional area:

Warehouse Download Service

Warehouse Download Service

The following services are included in this functional area:

Get Basic Warehouse Details

This section describes the Warehouse Detail service.

Business Overview

Warehouse Detail service allows user to retrieve Warehouse information for a selected warehouse or for all warehouses.

Service Type

Get

ReST URL

Wh/whDetail?warehouse={whNumber}

Input Parameters

Parameter Name	Required	Description
Warehouse	No	Warehouse Number. If none is specified, all warehouses will be retrieved.

Output

RestWhRecRDO

Parameter Name	Data Type
warehouse	BigDecimal
warehouseName	String
warehouseSecondaryName	String
vatRegion	BigDecimal
organizationHierarchyType	BigDecimal
organizationHierarchyValue	BigDecimal
currencyCode	String
physicalWarehouse	BigDecimal
primaryVirtualWarehouse	BigDecimal
channelId	BigDecimal
stockholdingIndicator	String
breakPackIndicator	String
redistributeWarehouseIndicator	String
restrictedIndicator	String
protectedIndicator	String
transferEntityId	BigDecimal
finisherInd	String
inboundHandlingDays	BigDecimal
organizationalUnitId	BigDecimal
virtualWarehouseType	String
customerOrderLocationIndicator	String
address1	String
address2	String
address3	String
city	String
state	String
countryId	String
post	String
contactName	String
contactPhone	String
contactEmail	String

JSON Structure

  { 
     "warehouse": null,
     "warehouseName": null,
     "warehouseSecondaryName": null,
     "vatRegion": "null,
     "organizationHierarchyType": null,
     "organizationHierarchyValue": null,
     "currencyCode": null,
     "physicalWarehouse": null,
     "primaryVirtualWarehouse": null,
     "channelId": null,
     "stockholdingIndicator": null,
     "breakPackIndicator": null,
     "redistributeWarehouseIndicator": null,
     "restrictedIndicator": null,
     "protectedIndicator": null,
     "transferEntityId": null,
     "finisherIndicator": null,
     "inboundHandlingDays": null,
     "organizationalUnitId" :null,
     "virtualWarehouseType" :null,
     "customerOrderLocationIdicator" :null,
     "address1": null,
     "address2": null,
     "address3": null,
     "city": null,
     "state": null,
     "countryId": null,
     "post": null,
     "contactName": null,
     "contactPhone": null,
     "contactEmail": null,
     "links": [],
     "hyperMediaContent": {
      "linkRDO": []
     }
  }

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_WH	Yes	No	No	No
ADDR	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Get Warehouse Details

Endpoints

MerchIntegrations/services/foundation/warehouse

MerchIntegrations/services/foundation/warehouse/{whId}

Functional Area

Organizational Hierarchy - Warehouses

Business Overview

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

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/warehouse?since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

MerchIntegrations/services/foundation/warehouse/{whId}

Input Parameters

Table 5-858 /MerchIntegrations/services/ foundation/warehouse

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 an Warehouse Number.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Table 5-859 /MerchIntegrations/services/ foundation/warehouse/{whId}

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

Name
action	String	Action for Warehouse details. Valid Values are INSERT, UPDATE and DELETE.
warehouse	Number	This field uniquely identifies the warehouse. This could be either a physical or virtual warehouse.
warehouseName	String	This field contains the warehouse name. This is published for both physical and virtual warehouse.
whNameSecondary	String	This field contains secondary name of the warehouse.
email	String	This field holds the email address for the location. This is published for only the physical warehouse.
stockholdingInd	String	This field indicates if the warehouse is a stock holding location. It will be N for a physical warehouse and Y for a virtual warehouse.
channelId	Number	This field contains channel for which the virtual warehouse has been assigned. This is published for the virtual warehouse.
channelDescription	String	This field contains description of channel for which the virtual warehouse has been assigned.
currencyCode	String	This field contains code for the currency that the warehouse uses. This is published for the physical and virtual warehouse.
physicalWarehouse	Number	This field contains number of the physical warehouse corresponding to this virtual warehouse. For physical warehouses, this field will be null.
primaryVirtualWarehouse	Number	This field holds the virtual warehouse that will used as the basis for all transactions for which only a physical warehouse and not a virtual warehouse has not been specified.
dunsNo	String	This field holds the Dun and Bradstreet number to identify the physical warehouse. This is published for the physical warehouse.
dunsLocation	String	This field holds the Dun and Bradstreet number to identify the physical warehouse. This is published for the physical warehouse.
breakPackInd	String	This field indicates whether the physical warehouse can distribute less than the supplier case quantity. Valid values are Y or N. This is published for both physical and virtual warehouse.
redistributionWarehouseInd	String	This field contains re-distribution warehouse is used to flag purchase orders for review closer to the time of receipt. If this is set to yes (Y) for a physical warehouse, then it indicates that this is a “dummy” location for a purchase order and that the order will have its order quantities redistributed to actual receiving locations close to expected receipt. Valid values are yes (Y) and no (N). This is published for both physical and virtual warehouse
deliveryPolicy	String	This field delivery policy of the physical warehouse. Next Day (NEXT) indicates that if a location is closed, the warehouse will deliver on the next day. Next Valid Delivery Day (NDD) indicates that the warehouse will wait until the next scheduled delivery day.This is published for both physical and virtual warehouse.
pricingLocation	Number	This field contains location for which pricing information was copied for this virtual warehouse. This Is published for virtual warehouse.
pricingLocationCurrency	String	This field contains currency code of the pricing location. This is published for virtual warehouse
orgUnitId	Number	This field holds the org unit ID of the virtual warehouse. This is published for virtual warehouse.
vatRegion	Number	This field holds the VAT region where the physical warehouse belongs. This Is published for physical and virtual warehouse.
orgHierarchyType	Number	This field contains the organization type that will be used for reporting purposes for the physical warehouse. The type comes from the organizational hierarchy.
orgHierarchyValue	Number	This field contains the code associated with the specific organizational hierarchy type. Valid values include the company number, chain number, area number, etc.
restrictedInd	String	This field indicates whether the inventory for this virtual warehouse is restricted, meaning it is impacted last an inbound type of transaction occurring at the physical warehouse level.
protectedInd	String	This field indicates whether the inventory for this virtual warehouse is protected, meaning it is affected last in outbound transactions occurring at the physical warehouse level.
forecastWarehouseInd	String	This field determines if a virtual warehouse should be forecasted.
transferEntityId	String	This field indicates the transfer entity with which this virtual warehouse is associated.
finisherInd	String	This field indicates whether a virtual warehouse is an internal finisher or not.
inboundHandlingDays	Number	This field indicated the number of days that the physical warehouse requires to receive any item and get it to the shelf so that it is ready to pick.
virtualWarehouseType	String	This field contains virtual warehouse type.
orgEntityType	String	This field will specify if the virtual warehouse is a legal entity (Importer, Exporter) or a regular warehouse.
customerOrderLocationInd	String	This field indicates if the virtual warehouse can source or fulfill customer orders.
defaultWarehouse	Number	This field contains the default sourcing warehouse linked to the virtual warehouse.
giftWrappingInd	String	This field indicates whether the warehouse supports gift wrapping.
customerOrderShippingInd	String	This field indicates whether the virtual warehouse supports shipping customer orders.
investmentBuyInd	String	This field indicates investment buy is configured for this warehouse.
investmentBuyWarehouseLink	Number	This field contains the warehouse linked to the investment buy.
replenishableInd	String	This field determines if a warehouse is replenishable.
replenishmentSourceOrder	Number	This field contains the order from which the inventory is sourced from the linked warehouses.
replenishableWarehouseLink	Number	This field holds the replenishable warehouse that is linked to this virtual warehouse. This link implies that the virtual warehouse is included in the net inventory calculations for the replenishable warehouse.
taxId	String	This field contains unique tax identification number of the physical warehouse.
primaryAddressType	String	This field specifies type for the address. Valid values are: 01 -Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 -Remittance.
primaryAddressTypeDescription	String	This field specifies address type description.
primaryAddressAdd1	String	This field contains the first line of the address.
primaryAddressAdd2	String	This field contains the second line of the address.
primaryAddressAdd3	String	This field contains the third line of the address.
primaryAddressCity	String	This field contains name of the city that is associated with the address.
primaryAddressState	String	This field contains state abbreviation for the address.
primaryAddressStateName	String	This field contains state description for the address.
primaryAddressCountryId	String	This field contains the country where the address exists.
primaryAddressCountryName	String	This field contains the country description where the address exists.
primaryAddressPost	String	This field contains the zip code for the address.
primaryAddressContactName	String	This field contains the name of the contact person at this address.
primaryAddressContactPhone	String	This field contains the phone number of the contact person at this address.
primaryAddressContactTelex	String	This field contains the telex number of the contact person at this address.
primaryAddressContactFax	String	This field contains the fax number of the contact person at this address.
primaryAddressContactEmail	String	This field contains the email address of the warehouse location contact person.
primaryAddressCounty	String	This field contains the county where the address exists.
primaryAddrJurisdictionCode	String	This field contains the ID associated to the tax jurisdiction of the country-state relationship.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
customFlexAttribute		This list holds custom flex attributes for the warehouse.
address		This list holds all the warehouse addresses.
cacheTimestamp	String	This field specifies date and time when the warehouse record was last maintained.

Table 5-860 customFlexAttribute

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

Table 5-861 address

Name	Data Type	Description
addressKey	Number	This field contains the unique address key.
addressType	String	This field specifies type for the address. Valid values are: 01 -Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 -Remittance.
addressTypeDescription	String	This field specifies address type description.
primaryAddressInd	String	This field indicates whether the address is the primary address for the address type.
add1	String	This field contains the first line of the address.
add2	String	This field contains the second line of the address.
add3	String	This field contains the third line of the address.
city	String	This field contains name of the city that is associated with the address.
state	String	This field contains name of the state that is associated with the address.
stateName	String	This field contains name of the state description that is associated with the address.
countryId	String	This field contains name of the country that is associated with the address.
countryName	String	This field contains name of the country description that is associated with the address.
post	String	This field contains the zip code for the address.
contactName	String	This field contains the name of the contact person at this address.
contactPhone	String	This field contains the phone number of the contact person at this address.
contactTelex	String	This field contains the telex number of the warehouse's representative contact.
contactFax	String	This field contains the fax number of the contact person at this address.
contactEmail	String	This field contains email address of the warehouse's representative contact.
county	String	This field contains the county where the address exists .
jurisdictionCode	String	This field contains the ID associated to the tax jurisdiction of the country-state relationship.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
customFlexAttribute		This list holds custom flex attributes for the warehouse's address.

Table 5-862 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": "UPDATE",
     "warehouse": 1,
     "warehouseName": "Test100",
     "whNameSecondary": "Test100",
     "email": "someone@gmail.com",
     "stockholdingInd": "N",
     "channelId": null,
     "channelDescription": null,
     "currencyCode": "USD",
     "physicalWarehouse": 1,
     "primaryVirtualWarehouse": 13,
     "dunsNo": "10",
     "dunsLocation": "10",
     "breakPackInd": "Y",
     "redistributionWarehouseInd": "Y",
     "deliveryPolicy": "NEXT",
     "pricingLocation": null,
     "pricingLocationCurrency": null,
     "orgUnitId": null,
     "vatRegion": 1000,
     "orgHierarchyType": 20,
     "orgHierarchyValue": 5,
     "restrictedInd": "N",
     "protectedInd": "N",
     "forecastWarehouseInd": "N",
     "transferEntityId": null,
     "finisherInd": "N",
     "inboundHandlingDays": 0,
     "virtualWarehouseType": null,
     "orgEntityType": "R",
     "customerOrderLocationInd": null,
     "defaultWarehouse": null,
     "giftWrappingInd": "N",
     "customerOrderShippingInd": "N",
     "investmentBuyInd": "N",
     "investmentBuyWarehouseLink": null,
     "replenishableInd": "N",
     "replenishmentSourceOrder": null,
     "replenishableWarehouseLink": null,
     "taxId": "3333",
     "primaryAddressType": "01",
     "primaryAddressTypeDescription": "Business",
     "primaryAddressAdd1": "wh1 business address",
     "primaryAddressAdd2": null,
     "primaryAddressAdd3": null,
     "primaryAddressCity": "MN",
     "primaryAddressState": null,
     "primaryAddressStateName": null,
     "primaryAddressCountryId": "US",
     "primaryAddressCountryName": "United States of America",
     "primaryAddressPost": null,
     "primaryAddressContactName": null,
     "primaryAddressContactPhone": null,
     "primaryAddressContactTelex": null,
     "primaryAddressContactFax": null,
     "primaryAddressContactEmail": null,
     "primaryAddressCounty": null,
     "primaryAddrJurisdictionCode": null,
     "createDateTime": "2021-06-21T07:25:03.000Z",
     "updateDateTime": "2021-11-20T05:52:14.000Z",
     "customFlexAttribute": [
      {
        "name": "ZONE",
        "value": "CZE",
        "valueDate": null,
        "createDateTime": "2021-06-21T17:27:29.000Z",
        "updateDateTime": "2021-06-21T17:27:29.000Z"
      }
     ],
     "address": [
      {
        "addressKey": 50252,
        "addressType": "01",
        "addressTypeDescription": "Business",
        "primaryAddressInd": "Y",
        "add1": "wh1 business address",
        "add2": null,
        "add3": null,
        "city": "MN",
        "state": null,
        "stateName": null,
        "countryId": "US",
        "countryName": "United States of America",
        "post": null,
        "contactName": null,
        "contactPhone": null,
        "contactTelex": null,
        "contactFax": null,
        "contactEmail": null,
        "county": null,
        "jurisdictionCode": null,
        "createDateTime": "2021-06-21T07:27:55.000Z",
        "updateDateTime": "2021-06-29T08:19:30.000Z",
        "customFlexAttribute": [
         {
          "name": "PROVINCIAL",
          "value": "Y",
          "valueDate": null,
          "createDateTime": "2021-06-21T17:30:43.000Z",
          "updateDateTime": "2021-06-21T17:30:43.000Z"
         }
        ]
      },
      {
        "addressKey": 50254,
        "addressType": "02",
        "addressTypeDescription": "Postal",
        "primaryAddressInd": "Y",
        "add1": "wh1 postal address 2",
        "add2": null,
        "add3": null,
        "city": "OH",
        "state": "OH",
        "stateName": "Ohio",
        "countryId": "US",
        "countryName": "United States of America",
        "post": null,
        "contactName": "MM",
        "contactPhone": "79898098",
        "contactTelex": "098098",
        "contactFax": "979898u",
        "contactEmail": "mm@gmail.com",
        "county": null,
        "jurisdictionCode": null,
        "createDateTime": "2021-06-21T07:28:19.000Z",
        "updateDateTime": "2021-06-23T08:05:34.000Z",
        "customFlexAttribute": null
      }
     ],
     "cacheTimestamp": "2022-07-02T00:35:21.715Z"
    }
  ],
  "hasMore": true,
  "limit": 1,
  "count": 1,
  "links": [
    {
     "href": "http://<hostname>:<port>/MerchIntegrations/services/foundation/warehouse?limit=1&since=1970-01-01T00:00:00.001Z&before=2022-07-18T23:51:50.875441+00:00",
     "rel": "self"
    },
    {
     "href": "http://<hostname>:<port>/MerchIntegrations/services/foundation/warehouse?offsetkey=1&limit=1&since=1970-01-01T00:00:00.001Z&before=2022-07-18T23:51:50.875441+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
WH	Yes	No	No	No
WH_CFA_EXT	Yes	No	No	No
MERCHAPI_EXT_WH	Yes	Yes	Yes	Yes
V_MERCHAPI_EXT_WH_JSON	Yes	No	No	No
ICL_RMS_WH	Yes	No	Yes	Yes
ICL_RMS_ADDR	Yes	No	Yes	Yes

Get Warehouse Details for Provided Warehouse

Endpoints

MerchIntegrations/services/foundation/warehouse

MerchIntegrations/services/foundation/warehouse/{whId}

Functional Area

Organizational Hierarchy - Warehouses

Business Overview

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

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/warehouse?since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

MerchIntegrations/services/foundation/warehouse/{whId}

Input Parameters

Table 5-863 /MerchIntegrations/services/ foundation/warehouse

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 an Warehouse Number.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Table 5-864 /MerchIntegrations/services/ foundation/warehouse/{whId}

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

Name
action	String	Action for Warehouse details. Valid Values are INSERT, UPDATE and DELETE.
warehouse	Number	This field uniquely identifies the warehouse. This could be either a physical or virtual warehouse.
warehouseName	String	This field contains the warehouse name. This is published for both physical and virtual warehouse.
whNameSecondary	String	This field contains secondary name of the warehouse.
email	String	This field holds the email address for the location. This is published for only the physical warehouse.
stockholdingInd	String	This field indicates if the warehouse is a stock holding location. It will be N for a physical warehouse and Y for a virtual warehouse.
channelId	Number	This field contains channel for which the virtual warehouse has been assigned. This is published for the virtual warehouse.
channelDescription	String	This field contains description of channel for which the virtual warehouse has been assigned.
currencyCode	String	This field contains code for the currency that the warehouse uses. This is published for the physical and virtual warehouse.
physicalWarehouse	Number	This field contains number of the physical warehouse corresponding to this virtual warehouse. For physical warehouses, this field will be null.
primaryVirtualWarehouse	Number	This field holds the virtual warehouse that will used as the basis for all transactions for which only a physical warehouse and not a virtual warehouse has not been specified.
dunsNo	String	This field holds the Dun and Bradstreet number to identify the physical warehouse. This is published for the physical warehouse.
dunsLocation	String	This field holds the Dun and Bradstreet number to identify the physical warehouse. This is published for the physical warehouse.
breakPackInd	String	This field indicates whether the physical warehouse can distribute less than the supplier case quantity. Valid values are Y or N. This is published for both physical and virtual warehouse.
redistributionWarehouseInd	String	This field contains re-distribution warehouse is used to flag purchase orders for review closer to the time of receipt. If this is set to yes (Y) for a physical warehouse, then it indicates that this is a “dummy” location for a purchase order and that the order will have its order quantities redistributed to actual receiving locations close to expected receipt. Valid values are yes (Y) and no (N). This is published for both physical and virtual warehouse
deliveryPolicy	String	This field delivery policy of the physical warehouse. Next Day (NEXT) indicates that if a location is closed, the warehouse will deliver on the next day. Next Valid Delivery Day (NDD) indicates that the warehouse will wait until the next scheduled delivery day.This is published for both physical and virtual warehouse.
pricingLocation	Number	This field contains location for which pricing information was copied for this virtual warehouse. This Is published for virtual warehouse.
pricingLocationCurrency	String	This field contains currency code of the pricing location. This is published for virtual warehouse
orgUnitId	Number	This field holds the org unit ID of the virtual warehouse. This is published for virtual warehouse.
vatRegion	Number	This field holds the VAT region where the physical warehouse belongs. This Is published for physical and virtual warehouse.
orgHierarchyType	Number	This field contains the organization type that will be used for reporting purposes for the physical warehouse. The type comes from the organizational hierarchy.
orgHierarchyValue	Number	This field contains the code associated with the specific organizational hierarchy type. Valid values include the company number, chain number, area number, etc.
restrictedInd	String	This field indicates whether the inventory for this virtual warehouse is restricted, meaning it is impacted last an inbound type of transaction occurring at the physical warehouse level.
protectedInd	String	This field indicates whether the inventory for this virtual warehouse is protected, meaning it is affected last in outbound transactions occurring at the physical warehouse level.
forecastWarehouseInd	String	This field determines if a virtual warehouse should be forecasted.
transferEntityId	String	This field indicates the transfer entity with which this virtual warehouse is associated.
finisherInd	String	This field indicates whether a virtual warehouse is an internal finisher or not.
inboundHandlingDays	Number	This field indicated the number of days that the physical warehouse requires to receive any item and get it to the shelf so that it is ready to pick.
virtualWarehouseType	String	This field contains virtual warehouse type.
orgEntityType	String	This field will specify if the virtual warehouse is a legal entity (Importer, Exporter) or a regular warehouse.
customerOrderLocationInd	String	This field indicates if the virtual warehouse can source or fulfill customer orders.
defaultWarehouse	Number	This field contains the default sourcing warehouse linked to the virtual warehouse.
giftWrappingInd	String	This field indicates whether the warehouse supports gift wrapping.
customerOrderShippingInd	String	This field indicates whether the virtual warehouse supports shipping customer orders.
investmentBuyInd	String	This field indicates investment buy is configured for this warehouse.
investmentBuyWarehouseLink	Number	This field contains the warehouse linked to the investment buy.
replenishableInd	String	This field determines if a warehouse is replenishable.
replenishmentSourceOrder	Number	This field contains the order from which the inventory is sourced from the linked warehouses.
replenishableWarehouseLink	Number	This field holds the replenishable warehouse that is linked to this virtual warehouse. This link implies that the virtual warehouse is included in the net inventory calculations for the replenishable warehouse.
taxId	String	This field contains unique tax identification number of the physical warehouse.
primaryAddressType	String	This field specifies type for the address. Valid values are: 01 -Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 -Remittance.
primaryAddressTypeDescription	String	This field specifies address type description.
primaryAddressAdd1	String	This field contains the first line of the address.
primaryAddressAdd2	String	This field contains the second line of the address.
primaryAddressAdd3	String	This field contains the third line of the address.
primaryAddressCity	String	This field contains name of the city that is associated with the address.
primaryAddressState	String	This field contains state abbreviation for the address.
primaryAddressStateName	String	This field contains state description for the address.
primaryAddressCountryId	String	This field contains the country where the address exists.
primaryAddressCountryName	String	This field contains the country description where the address exists.
primaryAddressPost	String	This field contains the zip code for the address.
primaryAddressContactName	String	This field contains the name of the contact person at this address.
primaryAddressContactPhone	String	This field contains the phone number of the contact person at this address.
primaryAddressContactTelex	String	This field contains the telex number of the contact person at this address.
primaryAddressContactFax	String	This field contains the fax number of the contact person at this address.
primaryAddressContactEmail	String	This field contains the email address of the warehouse location contact person.
primaryAddressCounty	String	This field contains the county where the address exists.
primaryAddrJurisdictionCode	String	This field contains the ID associated to the tax jurisdiction of the country-state relationship.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
customFlexAttribute		This list holds custom flex attributes for the warehouse.
address		This list holds all the warehouse addresses.
cacheTimestamp	String	This field specifies date and time when the warehouse record was last maintained.

Table 5-865 customFlexAttribute

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

Table 5-866 address

Name	Data Type	Description
addressKey	Number	This field contains the unique address key.
addressType	String	This field specifies type for the address. Valid values are: 01 -Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 -Remittance.
addressTypeDescription	String	This field specifies address type description.
primaryAddressInd	String	This field indicates whether the address is the primary address for the address type.
add1	String	This field contains the first line of the address.
add2	String	This field contains the second line of the address.
add3	String	This field contains the third line of the address.
city	String	This field contains name of the city that is associated with the address.
state	String	This field contains name of the state that is associated with the address.
stateName	String	This field contains name of the state description that is associated with the address.
countryId	String	This field contains name of the country that is associated with the address.
countryName	String	This field contains name of the country description that is associated with the address.
post	String	This field contains the zip code for the address.
contactName	String	This field contains the name of the contact person at this address.
contactPhone	String	This field contains the phone number of the contact person at this address.
contactTelex	String	This field contains the telex number of the warehouse's representative contact.
contactFax	String	This field contains the fax number of the contact person at this address.
contactEmail	String	This field contains email address of the warehouse's representative contact.
county	String	This field contains the county where the address exists .
jurisdictionCode	String	This field contains the ID associated to the tax jurisdiction of the country-state relationship.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
customFlexAttribute		This list holds custom flex attributes for the warehouse's address.

Table 5-867 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": "UPDATE",
     "warehouse": 1,
     "warehouseName": "Test100",
     "whNameSecondary": "Test100",
     "email": "someone@gmail.com",
     "stockholdingInd": "N",
     "channelId": null,
     "channelDescription": null,
     "currencyCode": "USD",
     "physicalWarehouse": 1,
     "primaryVirtualWarehouse": 13,
     "dunsNo": "10",
     "dunsLocation": "10",
     "breakPackInd": "Y",
     "redistributionWarehouseInd": "Y",
     "deliveryPolicy": "NEXT",
     "pricingLocation": null,
     "pricingLocationCurrency": null,
     "orgUnitId": null,
     "vatRegion": 1000,
     "orgHierarchyType": 20,
     "orgHierarchyValue": 5,
     "restrictedInd": "N",
     "protectedInd": "N",
     "forecastWarehouseInd": "N",
     "transferEntityId": null,
     "finisherInd": "N",
     "inboundHandlingDays": 0,
     "virtualWarehouseType": null,
     "orgEntityType": "R",
     "customerOrderLocationInd": null,
     "defaultWarehouse": null,
     "giftWrappingInd": "N",
     "customerOrderShippingInd": "N",
     "investmentBuyInd": "N",
     "investmentBuyWarehouseLink": null,
     "replenishableInd": "N",
     "replenishmentSourceOrder": null,
     "replenishableWarehouseLink": null,
     "taxId": "3333",
     "primaryAddressType": "01",
     "primaryAddressTypeDescription": "Business",
     "primaryAddressAdd1": "wh1 business address",
     "primaryAddressAdd2": null,
     "primaryAddressAdd3": null,
     "primaryAddressCity": "MN",
     "primaryAddressState": null,
     "primaryAddressStateName": null,
     "primaryAddressCountryId": "US",
     "primaryAddressCountryName": "United States of America",
     "primaryAddressPost": null,
     "primaryAddressContactName": null,
     "primaryAddressContactPhone": null,
     "primaryAddressContactTelex": null,
     "primaryAddressContactFax": null,
     "primaryAddressContactEmail": null,
     "primaryAddressCounty": null,
     "primaryAddrJurisdictionCode": null,
     "createDateTime": "2021-06-21T07:25:03.000Z",
     "updateDateTime": "2021-11-20T05:52:14.000Z",
     "customFlexAttribute": [
      {
        "name": "ZONE",
        "value": "CZE",
        "valueDate": null,
        "createDateTime": "2021-06-21T17:27:29.000Z",
        "updateDateTime": "2021-06-21T17:27:29.000Z"
      }
     ],
     "address": [
      {
        "addressKey": 50252,
        "addressType": "01",
        "addressTypeDescription": "Business",
        "primaryAddressInd": "Y",
        "add1": "wh1 business address",
        "add2": null,
        "add3": null,
        "city": "MN",
        "state": null,
        "stateName": null,
        "countryId": "US",
        "countryName": "United States of America",
        "post": null,
        "contactName": null,
        "contactPhone": null,
        "contactTelex": null,
        "contactFax": null,
        "contactEmail": null,
        "county": null,
        "jurisdictionCode": null,
        "createDateTime": "2021-06-21T07:27:55.000Z",
        "updateDateTime": "2021-06-29T08:19:30.000Z",
        "customFlexAttribute": [
         {
          "name": "PROVINCIAL",
          "value": "Y",
          "valueDate": null,
          "createDateTime": "2021-06-21T17:30:43.000Z",
          "updateDateTime": "2021-06-21T17:30:43.000Z"
         }
        ]
      },
      {
        "addressKey": 50254,
        "addressType": "02",
        "addressTypeDescription": "Postal",
        "primaryAddressInd": "Y",
        "add1": "wh1 postal address 2",
        "add2": null,
        "add3": null,
        "city": "OH",
        "state": "OH",
        "stateName": "Ohio",
        "countryId": "US",
        "countryName": "United States of America",
        "post": null,
        "contactName": "MM",
        "contactPhone": "79898098",
        "contactTelex": "098098",
        "contactFax": "979898u",
        "contactEmail": "mm@gmail.com",
        "county": null,
        "jurisdictionCode": null,
        "createDateTime": "2021-06-21T07:28:19.000Z",
        "updateDateTime": "2021-06-23T08:05:34.000Z",
        "customFlexAttribute": null
      }
     ],
     "cacheTimestamp": "2022-07-02T00:35:21.715Z"
    }
  ],
  "hasMore": true,
  "limit": 1,
  "count": 1,
  "links": [
    {
     "href": "http://<hostname>:<port>/MerchIntegrations/services/foundation/warehouse?limit=1&since=1970-01-01T00:00:00.001Z&before=2022-07-18T23:51:50.875441+00:00",
     "rel": "self"
    },
    {
     "href": "http://<hostname>:<port>/MerchIntegrations/services/foundation/warehouse?offsetkey=1&limit=1&since=1970-01-01T00:00:00.001Z&before=2022-07-18T23:51:50.875441+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
WH	Yes	No	No	No
WH_CFA_EXT	Yes	No	No	No
MERCHAPI_EXT_WH	Yes	Yes	Yes	Yes
V_MERCHAPI_EXT_WH_JSON	Yes	No	No	No
ICL_RMS_WH	Yes	No	Yes	Yes
ICL_RMS_ADDR	Yes	No	Yes	Yes

Organizational Hierarchy

Organizational Hierarchy Download Service

Get Organizational Hierarchy for Provided Level

Endpoints

Functional Area

Business Overview

Service Type

ReST URL

Input Parameters for MerchIntegrations/services/foundation/orghier

Input Parameters for MerchIntegrations/services/foundation/orghier/{orgLevel}

Input Parameters for ​MerchIntegrations/services/foundation/orghier/{param1}/{param2}

Output - Diff ID

Table Impact

Get Organizational Hierarchy for Provided Level and Hierarchy Identifier

Endpoints

Functional Area

Business Overview

Service Type

ReST URL

Input Parameters for MerchIntegrations/services/foundation/orghier

Input Parameters for MerchIntegrations/services/foundation/orghier/{orgLevel}

Input Parameters for ​MerchIntegrations/services/foundation/orghier/{param1}/{param2}

Output - Diff ID

Table Impact

Get Organizational Hierarchy

Endpoints

Functional Area

Business Overview

Service Type

ReST URL

Input Parameters for MerchIntegrations/services/foundation/orghier

Input Parameters for MerchIntegrations/services/foundation/orghier/{orgLevel}

Input Parameters for ​MerchIntegrations/services/foundation/orghier/{param1}/{param2}

Output - Diff ID

Table Impact

Organizational Hierarchy Upload Service

Create Organizational Hierarchy

Functional Area

Business Overview

Service Type

ReST URL

Input Payload Details

Response Code: 200 (Success)

Response Code: 400 (Error)

Delete Organizational Hierarchy

Functional Area

Business Overview

Service Type

ReST URL

Input Payload Details

Response Code: 200 (Success)

Response Code: 400 (Error)

Update Organizational Hierarchy

Functional Area

Business Overview

Service Type

ReST URL

Input Payload Details

Response Code: 200 (Success)

Response Code: 400 (Error)

Stores

Store Download Service

Get Basic Store Details

Business Overview

Service Type

ReST URL

Input Parameters

Output

Table Impact

Get Store Details

Endpoint

Functional Area

Business Overview

Service Type

ReST URL

Input Parameters

Output

Table Impact

Get Store Details for Provided Store

Endpoint

Input Parameters for MerchIntegrations/services/foundation/orghier/{param1}/{param2}

Input Parameters for MerchIntegrations/services/foundation/orghier/{param1}/{param2}

Input Parameters for MerchIntegrations/services/foundation/orghier/{param1}/{param2}