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 publishes organizational hierarchy master data to downstream consuming systems. It publishes the company, chain, area, region, and district nodes used to describe the organizational structure, together with hierarchy name, manager name, currency code, and parent-hierarchy linkage. Functionally, only the five organizational levels COMPANY, CHAIN, AREA, REGION, and DISTRICT are published; store and warehouse nodes are not part of this external API even though the broader org-hierarchy framework also uses those levels elsewhere.

Technical Details

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

Core business tables: COMPHEAD, CHAIN, AREA, REGION, DISTRICT

Additional business tables: SYSTEM_OPTIONS, CODE_DETAIL

JSON cache table: MERCHAPI_EXT_ORGHIER

JSON generation view: V_MERCHAPI_EXT_ORGHIER_JSON

Builds the payload by unioning COMPHEAD, CHAIN, AREA, REGION, and DISTRICT, uses SYSTEM_OPTIONS to supply the company currency code, and uses CODE_DETAIL to translate internal hierarchy codes into the published hierarchy-level values and their numeric sequence order.

The view only publishes the five organizational levels COMPANY, CHAIN, AREA, REGION, and DISTRICT; store and warehouse nodes are not part of this external API even though the broader org-hierarchy framework also uses those levels elsewhere.

Initial refresh supports both truncate-and-load and rebuild behavior, and rebuild marks cache rows deleted when a hierarchy node no longer exists in V_MERCHAPI_EXT_ORGHIER_JSON.

Initial Seeding and post enablement rebuild/repair

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

Mark cache rows deleted when the hierarchy node no longer exists in V_MERCHAPI_EXT_ORGHIER_JSON.

ICL (Integration Change Log) table: ICL_RMS_COMPHEAD, ICL_RMS_CHAIN, ICL_RMS_AREA, ICL_RMS_REGION, ICL_RMS_DISTRICT (ICL consumer name = MERCHAPI)

ICL entries are created using triggers on COMPHEAD, CHAIN, AREA, REGION, DISTRICT.

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

Process configuration name: API_EXT_ORGHIER

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

POM Batch schedule process and job: MERCHAPI_DELTA_EXT_ORG_HIER_ADHOC_PROCESS -> MERCHAPI_EXT_ORG_HIER_ADHOC_JOB

Webhook configuration api name: foundation/orghier

Special handling

Service Type

GET

ReST URL

MerchIntegrations/services/foundation/orghier

MerchIntegrations/services/foundation/orghier/{orgLevel}

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

Input Parameters for MerchIntegrations/services/foundation/orghier

Parameter Name	Required	Data Type	Description
since	No	String	Since Date (Example: 2010-12-31T23:59:59.999Z)
before	No	String	Before Date (Example: 2040-12-31T23:59:59.999Z)
offsetkey	No	String (15)	Offset key ([level order],[hierarchy id] Example: 30,17)
limit	No	String (6)	Pagination limit. Default value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Table 5-1184 Input Parameter for "MerchIntegrations/services/foundation/orghier/{orgLevel}"

Parameter Name	Required	Data Type	Description
orgLevel	Yes	String	Organization level - COMPANY or CHAIN or AREA or REGION or DISTRICT
offsetkey	No	String (15)	Offset key ([level order],[hierarchy id] Example: 30,17)
limit	No	String (6)	Pagination limit. Default value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Table 5-1185 Input Parameter for "MerchIntegrations/services/foundation/orghier/{param1}/{param2}"

Parameter Name	Required	Data Type	Description
param1	Yes	String	Organization level - COMPANY or CHAIN or AREA or REGION or DISTRICT
param2	Yes	String (10)	Hirerachy Id
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Input Parameters for MerchIntegrations/services/foundation/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

Table 5-1186 PageResultsItemsMerchApiOrghier - Object. See list of elements for detail

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

Table 5-1187 MerchApiOrghier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	No	String (6)	Action for organizational hierarchy details.
hierarchyLevel	No	String (10)	This field contains the organizational hierarchy level.
hierarchyId	No	Number(10,0)	This field contains the number that uniquely identifies the hierarchy value.
hierarchyName	No	String (120)	This field contains the description of the hierarchy value.
managerName	No	String (120)	This field contains the manager's name.
currencyCode	No	String (3)	This field contains the currency code for the hierarchy.
parentHierarchyId	No	Number(10,0)	This field contains the identifier of the parent hierarchy value.
parentHierarchyLevel	No	String (10)	This field contains the parent level of the current organizational hierarchy.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).
cacheTimestamp	No	dateTime	This field specifies the date and time when the organization hierarchy record was fetched into the cache for web service publication (UTC).
cacheCreateTimestamp	No	dateTime	This field specifies the date and time when the record was first created for web service publication (UTC).

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

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

Sample Response Message

{
"items": [
{
"action": "INSERT",
"hierarchyLevel": null,
"hierarchyId": 1,
"hierarchyName": "hierDesc",
"managerName": "mgrName",
"currencyCode": "USD",
"parentHierarchyId": 1,
"parentHierarchyLevel": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"cacheTimestamp": "2001-12-31T23:59:59.000Z",
"cacheCreateTimestamp": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1000,
"count": 1000,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000&since=1970-01-01T00:00:00.001Z&before=2024-01-01T00:00:00.001Z&offsetkey=1234,XYZ",
"rel": "next"
}
]
}

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
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

Technical Details

Core business tables: COMPHEAD, CHAIN, AREA, REGION, DISTRICT

Additional business tables: SYSTEM_OPTIONS, CODE_DETAIL

JSON cache table: MERCHAPI_EXT_ORGHIER

JSON generation view: V_MERCHAPI_EXT_ORGHIER_JSON

Initial refresh supports both truncate-and-load and rebuild behavior, and rebuild marks cache rows deleted when a hierarchy node no longer exists in V_MERCHAPI_EXT_ORGHIER_JSON.

Initial Seeding and post enablement rebuild/repair

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

Mark cache rows deleted when the hierarchy node no longer exists in V_MERCHAPI_EXT_ORGHIER_JSON.

ICL (Integration Change Log) table: ICL_RMS_COMPHEAD, ICL_RMS_CHAIN, ICL_RMS_AREA, ICL_RMS_REGION, ICL_RMS_DISTRICT (ICL consumer name = MERCHAPI)

ICL entries are created using triggers on COMPHEAD, CHAIN, AREA, REGION, DISTRICT.

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

Process configuration name: API_EXT_ORGHIER

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

POM Batch schedule process and job: MERCHAPI_DELTA_EXT_ORG_HIER_ADHOC_PROCESS -> MERCHAPI_EXT_ORG_HIER_ADHOC_JOB

Webhook configuration api name: foundation/orghier

Special handling

Service Type

GET

ReST URL

MerchIntegrations/services/foundation/orghier

MerchIntegrations/services/foundation/orghier/{orgLevel}

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

Input Parameters for MerchIntegrations/services/foundation/orghier

Parameter Name	Required	Data Type	Description
since	No	String	Since Date (Example: 2010-12-31T23:59:59.999Z)
before	No	String	Before Date (Example: 2040-12-31T23:59:59.999Z)
offsetkey	No	String (15)	Offset key ([level order],[hierarchy id] Example: 30,17)
limit	No	String (6)	Pagination limit. Default value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Table 5-1189 Input Parameter for "MerchIntegrations/services/foundation/orghier/{orgLevel}"

Parameter Name	Required	Data Type	Description
orgLevel	Yes	String	Organization level - COMPANY or CHAIN or AREA or REGION or DISTRICT
offsetkey	No	String (15)	Offset key ([level order],[hierarchy id] Example: 30,17)
limit	No	String (6)	Pagination limit. Default value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Table 5-1190 Input Parameter for "MerchIntegrations/services/foundation/orghier/{param1}/{param2}"

Parameter Name	Required	Data Type	Description
param1	Yes	String	Organization level - COMPANY or CHAIN or AREA or REGION or DISTRICT
param2	Yes	String (10)	Hirerachy Id
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Input Parameters for MerchIntegrations/services/foundation/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

Table 5-1191 PageResultsItemsMerchApiOrghier - Object. See list of elements for detail

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

Table 5-1192 MerchApiOrghier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	No	String (6)	Action for organizational hierarchy details.
hierarchyLevel	No	String (10)	This field contains the organizational hierarchy level.
hierarchyId	No	Number(10,0)	This field contains the number that uniquely identifies the hierarchy value.
hierarchyName	No	String (120)	This field contains the description of the hierarchy value.
managerName	No	String (120)	This field contains the manager's name.
currencyCode	No	String (3)	This field contains the currency code for the hierarchy.
parentHierarchyId	No	Number(10,0)	This field contains the identifier of the parent hierarchy value.
parentHierarchyLevel	No	String (10)	This field contains the parent level of the current organizational hierarchy.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).
cacheTimestamp	No	dateTime	This field specifies the date and time when the organization hierarchy record was fetched into the cache for web service publication (UTC).
cacheCreateTimestamp	No	dateTime	This field specifies the date and time when the record was first created for web service publication (UTC).

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

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

Sample Response Message

{
"items": [
{
"action": "INSERT",
"hierarchyLevel": null,
"hierarchyId": 1,
"hierarchyName": "hierDesc",
"managerName": "mgrName",
"currencyCode": "USD",
"parentHierarchyId": 1,
"parentHierarchyLevel": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"cacheTimestamp": "2001-12-31T23:59:59.000Z",
"cacheCreateTimestamp": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1000,
"count": 1000,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000&since=1970-01-01T00:00:00.001Z&before=2024-01-01T00:00:00.001Z&offsetkey=1234,XYZ",
"rel": "next"
}
]
}

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
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

Technical Details

Core business tables: COMPHEAD, CHAIN, AREA, REGION, DISTRICT

Additional business tables: SYSTEM_OPTIONS, CODE_DETAIL

JSON cache table: MERCHAPI_EXT_ORGHIER

JSON generation view: V_MERCHAPI_EXT_ORGHIER_JSON

Initial refresh supports both truncate-and-load and rebuild behavior, and rebuild marks cache rows deleted when a hierarchy node no longer exists in V_MERCHAPI_EXT_ORGHIER_JSON.

Initial Seeding and post enablement rebuild/repair

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

Mark cache rows deleted when the hierarchy node no longer exists in V_MERCHAPI_EXT_ORGHIER_JSON.

ICL (Integration Change Log) table: ICL_RMS_COMPHEAD, ICL_RMS_CHAIN, ICL_RMS_AREA, ICL_RMS_REGION, ICL_RMS_DISTRICT (ICL consumer name = MERCHAPI)

ICL entries are created using triggers on COMPHEAD, CHAIN, AREA, REGION, DISTRICT.

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

Process configuration name: API_EXT_ORGHIER

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

POM Batch schedule process and job: MERCHAPI_DELTA_EXT_ORG_HIER_ADHOC_PROCESS -> MERCHAPI_EXT_ORG_HIER_ADHOC_JOB

Webhook configuration api name: foundation/orghier

Special handling

Service Type

GET

ReST URL

MerchIntegrations/services/foundation/orghier

MerchIntegrations/services/foundation/orghier/{orgLevel}

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

Input Parameters for MerchIntegrations/services/foundation/orghier

Parameter Name	Required	Data Type	Description
since	No	String	Since Date (Example: 2010-12-31T23:59:59.999Z)
before	No	String	Before Date (Example: 2040-12-31T23:59:59.999Z)
offsetkey	No	String (15)	Offset key ([level order],[hierarchy id] Example: 30,17)
limit	No	String (6)	Pagination limit. Default value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Table 5-1194 Input Parameter for "MerchIntegrations/services/foundation/orghier/{orgLevel}"

Parameter Name	Required	Data Type	Description
orgLevel	Yes	String	Organization level - COMPANY or CHAIN or AREA or REGION or DISTRICT
offsetkey	No	String (15)	Offset key ([level order],[hierarchy id] Example: 30,17)
limit	No	String (6)	Pagination limit. Default value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Table 5-1195 Input Parameter for "MerchIntegrations/services/foundation/orghier/{param1}/{param2}"

Parameter Name	Required	Data Type	Description
param1	Yes	String	Organization level - COMPANY or CHAIN or AREA or REGION or DISTRICT
param2	Yes	String (10)	Hirerachy Id
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Input Parameters for MerchIntegrations/services/foundation/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

Table 5-1196 PageResultsItemsMerchApiOrghier - Object. See list of elements for detail

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

Table 5-1197 MerchApiOrghier - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	No	String (6)	Action for organizational hierarchy details.
hierarchyLevel	No	String (10)	This field contains the organizational hierarchy level.
hierarchyId	No	Number(10,0)	This field contains the number that uniquely identifies the hierarchy value.
hierarchyName	No	String (120)	This field contains the description of the hierarchy value.
managerName	No	String (120)	This field contains the manager's name.
currencyCode	No	String (3)	This field contains the currency code for the hierarchy.
parentHierarchyId	No	Number(10,0)	This field contains the identifier of the parent hierarchy value.
parentHierarchyLevel	No	String (10)	This field contains the parent level of the current organizational hierarchy.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).
cacheTimestamp	No	dateTime	This field specifies the date and time when the organization hierarchy record was fetched into the cache for web service publication (UTC).
cacheCreateTimestamp	No	dateTime	This field specifies the date and time when the record was first created for web service publication (UTC).

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

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

Sample Response Message

{
"items": [
{
"action": "INSERT",
"hierarchyLevel": null,
"hierarchyId": 1,
"hierarchyName": "hierDesc",
"managerName": "mgrName",
"currencyCode": "USD",
"parentHierarchyId": 1,
"parentHierarchyLevel": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"cacheTimestamp": "2001-12-31T23:59:59.000Z",
"cacheCreateTimestamp": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1000,
"count": 1000,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000&since=1970-01-01T00:00:00.001Z&before=2024-01-01T00:00:00.001Z&offsetkey=1234,XYZ",
"rel": "next"
}
]
}

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
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-1199 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-1200 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-1201 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 publishes store master data to downstream consuming systems. It publishes the store definition together with primary and additional addresses, store hours, store services, store conditions, and related descriptive attributes used to interpret the store record. There is no explicit filter in V_MERCHAPI_EXT_STORE_JSON, so all STORE rows are eligible for publication.

Technical Details

Core business tables: STORE, ADDR

Additional business tables: ADD_TYPE_MODULE, V_ADD_TYPE_TL, STATE, COUNTRY, STORE_HOURS, STORE_SERVICE, STORE_CONDITION, CHANNELS, STORE_FORMAT, DISTRICT, TSFZONE, WH, LANG, CODE_DETAIL, STORE_CFA_EXT, ADDR_CFA_EXT

JSON cache table: MERCHAPI_EXT_STORE

JSON generation view: V_MERCHAPI_EXT_STORE_JSON

Builds the store header from STORE, derives the primary address from ADDR joined to ADD_TYPE_MODULE, V_ADD_TYPE_TL, STATE, and COUNTRY, aggregates all store addresses from ADDR, aggregates store hours from STORE_HOURS, store services from STORE_SERVICE, store conditions from STORE_CONDITION, and enriches descriptive values from CHANNELS, STORE_FORMAT, DISTRICT, TSFZONE, WH, LANG, and CODE_DETAIL.

Store- and address-level custom flex attributes are added from MERCHAPI_EXT_STORE_CFA and MERCHAPI_EXT_STORE_ADDR_CFA.

There is no explicit filter in V_MERCHAPI_EXT_STORE_JSON, so functionally all rows from STORE are eligible for publication.

Initial Seeding and post enablement rebuild/repair

Initial seeding and rebuild use V_MERCHAPI_EXT_STORE_JSON and apply no additional filter criteria; all STORE rows are eligible for publication.

The current REBUILD branch merges changed and new rows only; it does not include a delete-marking pass for stores that disappear from V_MERCHAPI_EXT_STORE_JSON.

ICL (Integration Change Log) table: ICL_RMS_STORE and ICL_RMS_ADDR (ICL consumer name = MERCHAPI)

ICL entries are created using triggers on STORE, and address changes are captured through ICL_RMS_ADDR for ADDR rows on modules ST and WFST.

ICL_RMS_ADDR rows are filtered to MODULE IN ('ST','WFST') and republish the parent store payload.

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

Process configuration name: API_EXT_STORE

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

POM Batch schedule process and job: MERCHAPI_DELTA_EXT_STORE_ADHOC_PROCESS -> MERCHAPI_EXT_STORE_ADHOC_JOB

Webhook configuration api name: foundation/store

Service Type

GET

ReST URL

MerchIntegrations/services/foundation/store

MerchIntegrations/services/foundation/store/{storeId}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date (Example: 2010-12-31T23:59:59.999Z)
before	No	String	Before Date (Example: 2040-12-31T23:59:59.999Z)
offsetkey	No	String	Offset key (Store)
limit	No	String (6)	Pagination limit. Default value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Table 5-1202 Input Parameter for "MerchIntegrations/services/foundation/store/{storeId}"

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

Output

Table 5-1203 PageResultsItemsMerchApiStore - Object. See list of elements for detail

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

Table 5-1204 MerchApiStore - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	No	String (6)	Action for store details.
store	No	Number(10,0)	This field contains the number that uniquely identifies the store.
storeType	No	String (6)	This field indicates whether a particular store is a franchise or company store.
storeName	No	String (150)	This field contains the name of the store which, along with the store number, identifies the store.
storeName10	No	String (10)	This field contains a ten-character abbreviation of the store name.
storeName3	No	String (3)	This field contains a three-character abbreviation of the store name.
storeClass	No	String (1)	This field contains the code letter indicating the class of which the store is a member.
storeClassDescription	No	String (250)	This field contains the description indicating the class of which the store is a member.
managerName	No	String (120)	This field contains the name of the store manager.
openDate	No	date	This field contains the date on which the store opened.
closeDate	No	date	This field contains the date on which the store closed.
acquireDate	No	date	This field contains the date on which the store was acquired.
remodelDate	No	date	This field contains the date on which the store was last remodeled.
faxNumber	No	String (20)	This field contains the fax number for the store.
phoneNumber	No	String (20)	This field contains the phone number for the store.
email	No	String (100)	This field contains the email address for the location.
totalSquareFeet	No	Number(8,0)	This field contains the total square footage of the store.
sellingSquareFeet	No	Number(8,0)	This field contains the total square footage of the store's selling area.
linearDistance	No	Number(8,0)	This field contains the total merchandisable space of the location.
stockholdingInd	No	String (1)	This field indicates whether the store can hold stock.
channelId	No	Number(4,0)	This field contains the channel with which the store is associated.
channelName	No	String (120)	This field contains the channel description with which the store is associated.
storeFormat	No	Number(4,0)	This field contains the number indicating the format of the store. Valid values are found on the store format table.
storeFormatName	No	String (60)	This field contains the description for the format of the store.
mallName	No	String (120)	This field contains the name of the mall in which the store is located.
district	No	Number(10,0)	This field contains the number of the district in which the store is a member.
districtName	No	String (120)	This field contains the name of the district in which the store is a member.
transferZone	No	Number(4,0)	This field contains the transfer zone ID in which the store is located.
transferZoneDescription	No	String (120)	This field contains the transfer zone description in which the store is located.
defaultWarehouse	No	Number(10,0)	This field contains the number of the warehouse that is the primary sourcing warehouse for the store.
stopOrderdays	No	Number(3,0)	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	No	Number(3,0)	This field contains the number of days before the store open date that the store will begin accepting orders.
currencyCode	No	String (3)	This field contains the currency code under which the store operates.
language	No	String (6)	This field contains the ISO code of the language to be used for the given store.
integratedPosInd	No	String (1)	This field indicates whether Sales Audit should expect files from this store for processing.
dunsNumber	No	String (9)	This field contains the Dun and Bradstreet number to identify the store.
dunsLocation	No	String (4)	This field contains the Dun and Bradstreet number to identify the location.
pricingStore	No	Number(10,0)	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	No	String (64)	This field contains the text value of the time zone of the store.
pricingStoreCurrency	No	String (3)	This field contains the currency code of the location from which pricing records will be copied.
orgUnitId	No	Number(15,0)	This field contains the organizational unit ID that this store is associated with.
storeNameSecondary	No	String (150)	This field contains the secondary name of the store.
vatRegion	No	Number(4,0)	This field contains the ID of the tax region the store is associated with.
vatIncludeInd	No	String (1)	This field indicates whether tax will be included in the retail prices for the store.
sisterStore	No	Number(10,0)	This field contains the store number that will be used to relate the current store to the historical data of an existing store. This is used by Allocation.
trasferEntityId	No	Number(10,0)	This field contains the transfer entity ID with which the store is associated.
autoReceiveInd	No	String (1)	This field indicates whether receipts for the store will be made automatically by Merchandising.
remerchandisingInd	No	String (1)	This field is currently not used.
franchiseCustomerId	No	Number(10,0)	This field indicates which franchise customer this store is associated with.
customerOrderLocationInd	No	String (1)	This field indicates whether the location is a customer order location. If the indicator is Y, then the location can be used for sourcing and fulfillment orders; else it cannot be used and inventory information will not be shared with OMS.
giftWrappingInd	No	String (1)	This field indicates if the location will support gift wrapping.
customerOrderShippingInd	No	String (1)	This field indicates if the location will support shipping to a customer for customer orders.
onlineStoreInd	No	String (1)	This field indicates that the store is an online store.
taxId	No	String (20)	This field contains the unique tax identification number of the store.
primaryAddressType	No	String (2)	This field specifies the type for the address. Valid values are: 01 - Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 - Remittance.
primaryAddressTypeDescription	No	String (40)	This field specifies the address type description.
primaryAddressAdd1	No	String (240)	This field contains the first line of the address.
primaryAddressAdd2	No	String (240)	This field contains the second line of the address.
primaryAddressAdd3	No	String (240)	This field contains the third line of the address.
primaryAddressCity	No	String (120)	This field contains the name of the city that is associated with the address.
primaryAddressState	No	String (3)	This field contains the state abbreviation for the address.
primaryAddressStateName	No	String (120)	This field contains the state description for the address.
primaryAddressCountryId	No	String (3)	This field contains the country where the address exists.
primaryAddressCountryName	No	String (120)	This field contains the country description where the address exists.
primaryAddressPost	No	String (30)	This field contains the zip code for the address.
primaryAddressContactName	No	String (120)	This field contains the name of the contact person at this address.
primaryAddressContactPhone	No	String (20)	This field contains the phone number of the contact person at this address.
primaryAddressContactTelex	No	String (20)	This field contains the telex number of the contact person at this address.
primaryAddressContactFax	No	String (20)	This field contains the fax number of the contact person at this address.
primaryAddressContactEmail	No	String (100)	This field contains the email address of the contact person at this address.
primaryAddressPhone2	No	String (20)	This field contains an additional phone number associated with the primary address.
primaryAddressPhone2Type	No	String (6)	This field contains the type of the phone number stored in the primaryAddressPhone2 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
primaryAddressPhone3	No	String (20)	This field contains a second additional phone number associated with the primary address.
primaryAddressPhone3Type	No	String (6)	This field contains the type of the phone number stored in the primaryAddressPhone3 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
primaryAddressLatitude	No	String (30)	This field contains the north-south geographic coordinate of the primary address, represented in decimal degrees.
primaryAddressLongitude	No	String (30)	This field contains the east-west geographic coordinate of the primary address, represented in decimal degrees.
primaryAddressOracleVendorSiteId	No	Number(15,0)	This field contains the Oracle vendor site ID.
primaryAddressCounty	No	String (250)	This field contains the county where the address exists.
primaryAddressJurisdictionCode	No	String (10)	This field contains the ID associated with the tax jurisdiction of the country-state relationship.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).
customFlexAttribute	No	Collection of Object	This List holds custom flex attributes for the Store.
address	No	Collection of Object	This List holds all the Store addresses.
storeHours	No	Collection of Object	This List holds all the Store Hours attributes.
storeServices	No	Collection of Object	This List holds all the Store Services attributes. Each StoreService element contains the code representing the store service provided at the store and its creation datetime.
storeConditions	No	Collection of Object	This List holds all the Store Conditions attributes.
storeTranslations	No	Collection of Object	This List holds all the store translations, providing language-specific store names and details.
cacheTimestamp	No	dateTime	This field specifies the date and time when the store record was fetched into the cache for web service publication (UTC).
cacheCreateTimestamp	No	dateTime	This field specifies the date and time when the record was first created for web service publication (UTC).

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

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

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

Element Name	Required	Data Type	Description
addressKey	No	Number(11,0)	This field contains the unique address key.
addressType	No	String (2)	This field specifies the type for the address. Valid values are: 01 - Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 - Remittance.
addressTypeDescription	No	String (40)	This field specifies the address type description.
primaryAddressInd	No	String (1)	This field indicates whether the address is the primary address for the address type.
add1	No	String (240)	This field contains the first line of the address.
add2	No	String (240)	This field contains the second line of the address.
add3	No	String (240)	This field contains the third line of the address.
city	No	String (120)	This field contains the name of the city that is associated with the address.
state	No	String (3)	This field contains the state abbreviation that is associated with the address.
stateName	No	String (120)	This field contains the state description that is associated with the address.
countryId	No	String (3)	This field contains the country where the address exists.
countryName	No	String (120)	This field contains the country description that is associated with the address.
post	No	String (30)	This field contains the zip code for the address.
contactName	No	String (120)	This field contains the name of the contact person at this address.
contactPhone	No	String (20)	This field contains the phone number of the contact person at this address.
contactTelex	No	String (20)	This field contains the telex number of the contact person at this address.
contactFax	No	String (20)	This field contains the fax number of the contact person at this address.
contactEmail	No	String (100)	This field contains the email address of the contact person at this address.
phone2Type	No	String (6)	This field contains the type of the phone number stored in the phone2 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
phone2	No	String (20)	This field contains an additional phone number associated with the address.
phone3Type	No	String (6)	This field contains the type of the phone number stored in the phone3 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
phone3	No	String (20)	This field contains a second additional phone number associated with the address.
latitude	No	String (30)	This field contains the north-south geographic coordinate of the address, represented in decimal degrees.
longitude	No	String (30)	This field contains the east-west geographic coordinate of the address, represented in decimal degrees.
county	No	String (250)	This field contains the county where the address exists.
jurisdictionCode	No	String (10)	This field contains the ID associated with the tax jurisdiction of the country-state relationship.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).
customFlexAttribute	No	Collection of Object	This List holds custom flex attributes for the warehouse's address.

Table 5-1207 StoreHours - Object. See list of elements for detail

Element Name	Required	Data Type	Description
dayNo	No	Number(1,0)	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	No	String (8)	This field 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	No	String (8)	This field 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	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).

Table 5-1208 StoreService - Object. See list of elements for detail

Element Name	Required	Data Type	Description
storeService	No	String (6)	This field contains the code representing the store service provided at the store.
createDateTime	No	dateTime	This field holds the record creation date and time of the store service (UTC).

Table 5-1209 StoreConditions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
conditionType	No	String (6)	This field holds the condition type configured under code type SCND with the used indicator set to Y.
startDate	No	date	This field holds the start date of the condition.
endDate	No	date	This field holds the end date of the condition.
comments	No	String (250)	This field holds the extra information about the condition setup.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).

Table 5-1210 StoreTranslation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
languageCode	No	String	The short code for the language (e.g. EN, FR).
languageName	No	String	The name of the language (e.g. English, French).
isoCode	No	String	The ISO code for the language (e.g. en_US, fr_FR).
storeName	No	String	The store name in this language.
storeNameSecondary	No	String	The secondary store name in this language.
createDateTime	No	String	Record creation datetime for this translation.
updateDateTime	No	String	Datetime this translation was last updated.

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

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

Sample Response Message

{
"items": [
{
"action": "INSERT",
"store": 6000,
"storeType": null,
"storeName": "storeName",
"storeName10": null,
"storeName3": null,
"storeClass": null,
"storeClassDescription": null,
"managerName": "storeMgrName",
"openDate": "2001-12-31",
"closeDate": "2001-12-31",
"acquireDate": "2001-12-31",
"remodelDate": "2001-12-31",
"faxNumber": null,
"phoneNumber": "1800800800",
"email": "someone@email.com",
"totalSquareFeet": 1,
"sellingSquareFeet": 1,
"linearDistance": 1,
"stockholdingInd": "Y",
"channelId": 1,
"channelName": null,
"storeFormat": 1,
"storeFormatName": null,
"mallName": "mallName",
"district": 1,
"districtName": null,
"transferZone": 1,
"transferZoneDescription": null,
"defaultWarehouse": 1,
"stopOrderdays": 1,
"startOrderDays": 1,
"currencyCode": "USD",
"language": null,
"integratedPosInd": "Y",
"dunsNumber": null,
"dunsLocation": null,
"pricingStore": 1,
"timezoneName": "timezoneName",
"pricingStoreCurrency": null,
"orgUnitId": 1,
"storeNameSecondary": "storeNameSecondary",
"vatRegion": 1,
"vatIncludeInd": "Y",
"sisterStore": 1,
"trasferEntityId": 1,
"autoReceiveInd": null,
"remerchandisingInd": null,
"franchiseCustomerId": 1,
"customerOrderLocationInd": "Y",
"giftWrappingInd": "Y",
"customerOrderShippingInd": "Y",
"onlineStoreInd": "Y",
"taxId": null,
"primaryAddressType": "01",
"primaryAddressTypeDescription": null,
"primaryAddressAdd1": "101 First Street",
"primaryAddressAdd2": "201 Second Street",
"primaryAddressAdd3": null,
"primaryAddressCity": "Minneapolis",
"primaryAddressState": "MN",
"primaryAddressStateName": "stateName",
"primaryAddressCountryId": "US",
"primaryAddressCountryName": "countryName",
"primaryAddressPost": "55555-1234",
"primaryAddressContactName": "contactName",
"primaryAddressContactPhone": "1800800800",
"primaryAddressContactTelex": null,
"primaryAddressContactFax": "617-897-0902",
"primaryAddressContactEmail": "someone@email.com",
"primaryAddressPhone2": "5551234567",
"primaryAddressPhone2Type": "WO",
"primaryAddressPhone3": "5551234567",
"primaryAddressPhone3Type": "WO",
"primaryAddressLatitude": "44.38129",
"primaryAddressLongitude": "-92.03521",
"primaryAddressOracleVendorSiteId": 1,
"primaryAddressCounty": "Some County",
"primaryAddressJurisdictionCode": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"customFlexAttribute": [
{
"name": "attribute1",
"value": "value1",
"valueDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"address": [
{
"addressKey": 114772,
"addressType": "01",
"addressTypeDescription": null,
"primaryAddressInd": "Y",
"add1": "101 First Street",
"add2": "201 Second Street",
"add3": null,
"city": "Minneapolis",
"state": "MN",
"stateName": "MN",
"countryId": "US",
"countryName": "US",
"post": "55555-1234",
"contactName": "Laura Johnson",
"contactPhone": "1800800800",
"contactTelex": null,
"contactFax": "617-897-0902",
"contactEmail": "someone@email.com",
"phone2Type": "WO",
"phone2": "5551234567",
"phone3Type": "WO",
"phone3": "5551234567",
"latitude": "44.38129",
"longitude": "-92.03521",
"county": null,
"jurisdictionCode": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"customFlexAttribute": [
{
"name": "attribute1",
"value": "value1",
"valueDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"storeHours": [
{
"dayNo": 1,
"storeOpenTime": null,
"storeCloseTime": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"storeServices": [
{
"storeService": null,
"createDateTime": "2001-12-31T23:59:59.000Z"
}
],
"storeConditions": [
{
"conditionType": null,
"startDate": "2001-12-31",
"endDate": "2001-12-31",
"comments": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"storeTranslations": [
{
"languageCode": "String",
"languageName": "String",
"isoCode": "String",
"storeName": "String",
"storeNameSecondary": "String",
"createDateTime": "String",
"updateDateTime": "String"
}
],
"cacheTimestamp": "2001-12-31T23:59:59.000Z",
"cacheCreateTimestamp": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1000,
"count": 1000,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000&since=1970-01-01T00:00:00.001Z&before=2024-01-01T00:00:00.001Z&offsetkey=1234,XYZ",
"rel": "next"
}
]
}

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	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

Technical Details

Core business tables: STORE, ADDR

JSON cache table: MERCHAPI_EXT_STORE

JSON generation view: V_MERCHAPI_EXT_STORE_JSON

Store- and address-level custom flex attributes are added from MERCHAPI_EXT_STORE_CFA and MERCHAPI_EXT_STORE_ADDR_CFA.

There is no explicit filter in V_MERCHAPI_EXT_STORE_JSON, so functionally all rows from STORE are eligible for publication.

Initial Seeding and post enablement rebuild/repair

Initial seeding and rebuild use V_MERCHAPI_EXT_STORE_JSON and apply no additional filter criteria; all STORE rows are eligible for publication.

The current REBUILD branch merges changed and new rows only; it does not include a delete-marking pass for stores that disappear from V_MERCHAPI_EXT_STORE_JSON.

ICL (Integration Change Log) table: ICL_RMS_STORE and ICL_RMS_ADDR (ICL consumer name = MERCHAPI)

ICL entries are created using triggers on STORE, and address changes are captured through ICL_RMS_ADDR for ADDR rows on modules ST and WFST.

ICL_RMS_ADDR rows are filtered to MODULE IN ('ST','WFST') and republish the parent store payload.

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

Process configuration name: API_EXT_STORE

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

POM Batch schedule process and job: MERCHAPI_DELTA_EXT_STORE_ADHOC_PROCESS -> MERCHAPI_EXT_STORE_ADHOC_JOB

Webhook configuration api name: foundation/store

Service Type

GET

ReST URL

MerchIntegrations/services/foundation/store

MerchIntegrations/services/foundation/store/{storeId}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date (Example: 2010-12-31T23:59:59.999Z)
before	No	String	Before Date (Example: 2040-12-31T23:59:59.999Z)
offsetkey	No	String	Offset key (Store)
limit	No	String (6)	Pagination limit. Default value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Table 5-1212 Input Parameter for "MerchIntegrations/services/foundation/store/{storeId}"

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

Output

Table 5-1213 PageResultsItemsMerchApiStore - Object. See list of elements for detail

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

Table 5-1214 MerchApiStore - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	No	String (6)	Action for store details.
store	No	Number(10,0)	This field contains the number that uniquely identifies the store.
storeType	No	String (6)	This field indicates whether a particular store is a franchise or company store.
storeName	No	String (150)	This field contains the name of the store which, along with the store number, identifies the store.
storeName10	No	String (10)	This field contains a ten-character abbreviation of the store name.
storeName3	No	String (3)	This field contains a three-character abbreviation of the store name.
storeClass	No	String (1)	This field contains the code letter indicating the class of which the store is a member.
storeClassDescription	No	String (250)	This field contains the description indicating the class of which the store is a member.
managerName	No	String (120)	This field contains the name of the store manager.
openDate	No	date	This field contains the date on which the store opened.
closeDate	No	date	This field contains the date on which the store closed.
acquireDate	No	date	This field contains the date on which the store was acquired.
remodelDate	No	date	This field contains the date on which the store was last remodeled.
faxNumber	No	String (20)	This field contains the fax number for the store.
phoneNumber	No	String (20)	This field contains the phone number for the store.
email	No	String (100)	This field contains the email address for the location.
totalSquareFeet	No	Number(8,0)	This field contains the total square footage of the store.
sellingSquareFeet	No	Number(8,0)	This field contains the total square footage of the store's selling area.
linearDistance	No	Number(8,0)	This field contains the total merchandisable space of the location.
stockholdingInd	No	String (1)	This field indicates whether the store can hold stock.
channelId	No	Number(4,0)	This field contains the channel with which the store is associated.
channelName	No	String (120)	This field contains the channel description with which the store is associated.
storeFormat	No	Number(4,0)	This field contains the number indicating the format of the store. Valid values are found on the store format table.
storeFormatName	No	String (60)	This field contains the description for the format of the store.
mallName	No	String (120)	This field contains the name of the mall in which the store is located.
district	No	Number(10,0)	This field contains the number of the district in which the store is a member.
districtName	No	String (120)	This field contains the name of the district in which the store is a member.
transferZone	No	Number(4,0)	This field contains the transfer zone ID in which the store is located.
transferZoneDescription	No	String (120)	This field contains the transfer zone description in which the store is located.
defaultWarehouse	No	Number(10,0)	This field contains the number of the warehouse that is the primary sourcing warehouse for the store.
stopOrderdays	No	Number(3,0)	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	No	Number(3,0)	This field contains the number of days before the store open date that the store will begin accepting orders.
currencyCode	No	String (3)	This field contains the currency code under which the store operates.
language	No	String (6)	This field contains the ISO code of the language to be used for the given store.
integratedPosInd	No	String (1)	This field indicates whether Sales Audit should expect files from this store for processing.
dunsNumber	No	String (9)	This field contains the Dun and Bradstreet number to identify the store.
dunsLocation	No	String (4)	This field contains the Dun and Bradstreet number to identify the location.
pricingStore	No	Number(10,0)	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	No	String (64)	This field contains the text value of the time zone of the store.
pricingStoreCurrency	No	String (3)	This field contains the currency code of the location from which pricing records will be copied.
orgUnitId	No	Number(15,0)	This field contains the organizational unit ID that this store is associated with.
storeNameSecondary	No	String (150)	This field contains the secondary name of the store.
vatRegion	No	Number(4,0)	This field contains the ID of the tax region the store is associated with.
vatIncludeInd	No	String (1)	This field indicates whether tax will be included in the retail prices for the store.
sisterStore	No	Number(10,0)	This field contains the store number that will be used to relate the current store to the historical data of an existing store. This is used by Allocation.
trasferEntityId	No	Number(10,0)	This field contains the transfer entity ID with which the store is associated.
autoReceiveInd	No	String (1)	This field indicates whether receipts for the store will be made automatically by Merchandising.
remerchandisingInd	No	String (1)	This field is currently not used.
franchiseCustomerId	No	Number(10,0)	This field indicates which franchise customer this store is associated with.
customerOrderLocationInd	No	String (1)	This field indicates whether the location is a customer order location. If the indicator is Y, then the location can be used for sourcing and fulfillment orders; else it cannot be used and inventory information will not be shared with OMS.
giftWrappingInd	No	String (1)	This field indicates if the location will support gift wrapping.
customerOrderShippingInd	No	String (1)	This field indicates if the location will support shipping to a customer for customer orders.
onlineStoreInd	No	String (1)	This field indicates that the store is an online store.
taxId	No	String (20)	This field contains the unique tax identification number of the store.
primaryAddressType	No	String (2)	This field specifies the type for the address. Valid values are: 01 - Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 - Remittance.
primaryAddressTypeDescription	No	String (40)	This field specifies the address type description.
primaryAddressAdd1	No	String (240)	This field contains the first line of the address.
primaryAddressAdd2	No	String (240)	This field contains the second line of the address.
primaryAddressAdd3	No	String (240)	This field contains the third line of the address.
primaryAddressCity	No	String (120)	This field contains the name of the city that is associated with the address.
primaryAddressState	No	String (3)	This field contains the state abbreviation for the address.
primaryAddressStateName	No	String (120)	This field contains the state description for the address.
primaryAddressCountryId	No	String (3)	This field contains the country where the address exists.
primaryAddressCountryName	No	String (120)	This field contains the country description where the address exists.
primaryAddressPost	No	String (30)	This field contains the zip code for the address.
primaryAddressContactName	No	String (120)	This field contains the name of the contact person at this address.
primaryAddressContactPhone	No	String (20)	This field contains the phone number of the contact person at this address.
primaryAddressContactTelex	No	String (20)	This field contains the telex number of the contact person at this address.
primaryAddressContactFax	No	String (20)	This field contains the fax number of the contact person at this address.
primaryAddressContactEmail	No	String (100)	This field contains the email address of the contact person at this address.
primaryAddressPhone2	No	String (20)	This field contains an additional phone number associated with the primary address.
primaryAddressPhone2Type	No	String (6)	This field contains the type of the phone number stored in the primaryAddressPhone2 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
primaryAddressPhone3	No	String (20)	This field contains a second additional phone number associated with the primary address.
primaryAddressPhone3Type	No	String (6)	This field contains the type of the phone number stored in the primaryAddressPhone3 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
primaryAddressLatitude	No	String (30)	This field contains the north-south geographic coordinate of the primary address, represented in decimal degrees.
primaryAddressLongitude	No	String (30)	This field contains the east-west geographic coordinate of the primary address, represented in decimal degrees.
primaryAddressOracleVendorSiteId	No	Number(15,0)	This field contains the Oracle vendor site ID.
primaryAddressCounty	No	String (250)	This field contains the county where the address exists.
primaryAddressJurisdictionCode	No	String (10)	This field contains the ID associated with the tax jurisdiction of the country-state relationship.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).
customFlexAttribute	No	Collection of Object	This List holds custom flex attributes for the Store.
address	No	Collection of Object	This List holds all the Store addresses.
storeHours	No	Collection of Object	This List holds all the Store Hours attributes.
storeServices	No	Collection of Object	This List holds all the Store Services attributes. Each StoreService element contains the code representing the store service provided at the store and its creation datetime.
storeConditions	No	Collection of Object	This List holds all the Store Conditions attributes.
storeTranslations	No	Collection of Object	This List holds all the store translations, providing language-specific store names and details.
cacheTimestamp	No	dateTime	This field specifies the date and time when the store record was fetched into the cache for web service publication (UTC).
cacheCreateTimestamp	No	dateTime	This field specifies the date and time when the record was first created for web service publication (UTC).

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

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

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

Element Name	Required	Data Type	Description
addressKey	No	Number(11,0)	This field contains the unique address key.
addressType	No	String (2)	This field specifies the type for the address. Valid values are: 01 - Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 - Remittance.
addressTypeDescription	No	String (40)	This field specifies the address type description.
primaryAddressInd	No	String (1)	This field indicates whether the address is the primary address for the address type.
add1	No	String (240)	This field contains the first line of the address.
add2	No	String (240)	This field contains the second line of the address.
add3	No	String (240)	This field contains the third line of the address.
city	No	String (120)	This field contains the name of the city that is associated with the address.
state	No	String (3)	This field contains the state abbreviation that is associated with the address.
stateName	No	String (120)	This field contains the state description that is associated with the address.
countryId	No	String (3)	This field contains the country where the address exists.
countryName	No	String (120)	This field contains the country description that is associated with the address.
post	No	String (30)	This field contains the zip code for the address.
contactName	No	String (120)	This field contains the name of the contact person at this address.
contactPhone	No	String (20)	This field contains the phone number of the contact person at this address.
contactTelex	No	String (20)	This field contains the telex number of the contact person at this address.
contactFax	No	String (20)	This field contains the fax number of the contact person at this address.
contactEmail	No	String (100)	This field contains the email address of the contact person at this address.
phone2Type	No	String (6)	This field contains the type of the phone number stored in the phone2 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
phone2	No	String (20)	This field contains an additional phone number associated with the address.
phone3Type	No	String (6)	This field contains the type of the phone number stored in the phone3 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
phone3	No	String (20)	This field contains a second additional phone number associated with the address.
latitude	No	String (30)	This field contains the north-south geographic coordinate of the address, represented in decimal degrees.
longitude	No	String (30)	This field contains the east-west geographic coordinate of the address, represented in decimal degrees.
county	No	String (250)	This field contains the county where the address exists.
jurisdictionCode	No	String (10)	This field contains the ID associated with the tax jurisdiction of the country-state relationship.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).
customFlexAttribute	No	Collection of Object	This List holds custom flex attributes for the warehouse's address.

Table 5-1217 StoreHours - Object. See list of elements for detail

Element Name	Required	Data Type	Description
dayNo	No	Number(1,0)	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	No	String (8)	This field 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	No	String (8)	This field 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	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).

Table 5-1218 StoreService - Object. See list of elements for detail

Element Name	Required	Data Type	Description
storeService	No	String (6)	This field contains the code representing the store service provided at the store.
createDateTime	No	dateTime	This field holds the record creation date and time of the store service (UTC).

Table 5-1219 StoreConditions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
conditionType	No	String (6)	This field holds the condition type configured under code type SCND with the used indicator set to Y.
startDate	No	date	This field holds the start date of the condition.
endDate	No	date	This field holds the end date of the condition.
comments	No	String (250)	This field holds the extra information about the condition setup.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).

Table 5-1220 StoreTranslation - Object. See list of elements for detail

Element Name	Required	Data Type	Description
languageCode	No	String	The short code for the language (e.g. EN, FR).
languageName	No	String	The name of the language (e.g. English, French).
isoCode	No	String	The ISO code for the language (e.g. en_US, fr_FR).
storeName	No	String	The store name in this language.
storeNameSecondary	No	String	The secondary store name in this language.
createDateTime	No	String	Record creation datetime for this translation.
updateDateTime	No	String	Datetime this translation was last updated.

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

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

Sample Response Message

{
"items": [
{
"action": "INSERT",
"store": 6000,
"storeType": null,
"storeName": "storeName",
"storeName10": null,
"storeName3": null,
"storeClass": null,
"storeClassDescription": null,
"managerName": "storeMgrName",
"openDate": "2001-12-31",
"closeDate": "2001-12-31",
"acquireDate": "2001-12-31",
"remodelDate": "2001-12-31",
"faxNumber": null,
"phoneNumber": "1800800800",
"email": "someone@email.com",
"totalSquareFeet": 1,
"sellingSquareFeet": 1,
"linearDistance": 1,
"stockholdingInd": "Y",
"channelId": 1,
"channelName": null,
"storeFormat": 1,
"storeFormatName": null,
"mallName": "mallName",
"district": 1,
"districtName": null,
"transferZone": 1,
"transferZoneDescription": null,
"defaultWarehouse": 1,
"stopOrderdays": 1,
"startOrderDays": 1,
"currencyCode": "USD",
"language": null,
"integratedPosInd": "Y",
"dunsNumber": null,
"dunsLocation": null,
"pricingStore": 1,
"timezoneName": "timezoneName",
"pricingStoreCurrency": null,
"orgUnitId": 1,
"storeNameSecondary": "storeNameSecondary",
"vatRegion": 1,
"vatIncludeInd": "Y",
"sisterStore": 1,
"trasferEntityId": 1,
"autoReceiveInd": null,
"remerchandisingInd": null,
"franchiseCustomerId": 1,
"customerOrderLocationInd": "Y",
"giftWrappingInd": "Y",
"customerOrderShippingInd": "Y",
"onlineStoreInd": "Y",
"taxId": null,
"primaryAddressType": "01",
"primaryAddressTypeDescription": null,
"primaryAddressAdd1": "101 First Street",
"primaryAddressAdd2": "201 Second Street",
"primaryAddressAdd3": null,
"primaryAddressCity": "Minneapolis",
"primaryAddressState": "MN",
"primaryAddressStateName": "stateName",
"primaryAddressCountryId": "US",
"primaryAddressCountryName": "countryName",
"primaryAddressPost": "55555-1234",
"primaryAddressContactName": "contactName",
"primaryAddressContactPhone": "1800800800",
"primaryAddressContactTelex": null,
"primaryAddressContactFax": "617-897-0902",
"primaryAddressContactEmail": "someone@email.com",
"primaryAddressPhone2": "5551234567",
"primaryAddressPhone2Type": "WO",
"primaryAddressPhone3": "5551234567",
"primaryAddressPhone3Type": "WO",
"primaryAddressLatitude": "44.38129",
"primaryAddressLongitude": "-92.03521",
"primaryAddressOracleVendorSiteId": 1,
"primaryAddressCounty": "Some County",
"primaryAddressJurisdictionCode": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"customFlexAttribute": [
{
"name": "attribute1",
"value": "value1",
"valueDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"address": [
{
"addressKey": 114772,
"addressType": "01",
"addressTypeDescription": null,
"primaryAddressInd": "Y",
"add1": "101 First Street",
"add2": "201 Second Street",
"add3": null,
"city": "Minneapolis",
"state": "MN",
"stateName": "MN",
"countryId": "US",
"countryName": "US",
"post": "55555-1234",
"contactName": "Laura Johnson",
"contactPhone": "1800800800",
"contactTelex": null,
"contactFax": "617-897-0902",
"contactEmail": "someone@email.com",
"phone2Type": "WO",
"phone2": "5551234567",
"phone3Type": "WO",
"phone3": "5551234567",
"latitude": "44.38129",
"longitude": "-92.03521",
"county": null,
"jurisdictionCode": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"customFlexAttribute": [
{
"name": "attribute1",
"value": "value1",
"valueDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"storeHours": [
{
"dayNo": 1,
"storeOpenTime": null,
"storeCloseTime": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"storeServices": [
{
"storeService": null,
"createDateTime": "2001-12-31T23:59:59.000Z"
}
],
"storeConditions": [
{
"conditionType": null,
"startDate": "2001-12-31",
"endDate": "2001-12-31",
"comments": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"storeTranslations": [
{
"languageCode": "String",
"languageName": "String",
"isoCode": "String",
"storeName": "String",
"storeNameSecondary": "String",
"createDateTime": "String",
"updateDateTime": "String"
}
],
"cacheTimestamp": "2001-12-31T23:59:59.000Z",
"cacheCreateTimestamp": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1000,
"count": 1000,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000&since=1970-01-01T00:00:00.001Z&before=2024-01-01T00:00:00.001Z&offsetkey=1234,XYZ",
"rel": "next"
}
]
}

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	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-1222 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.
autoReceive	No	String (1)	This column will indicate whether the client is allowing automatic receipt for the store. Valid Values are Y (Yes), N (No).
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL
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-1223 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.
phone2Type	No	String (6)	This column contains the type of the phone number stored in Phone2 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work also can be found on the codes table with a code type of PHTP.
phone2	No	String (20)	This column contains an additional phone number associated with the address.
phone3Type	No	String (6)	This column contains the type of the phone number stored in Phone3 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work also can be found on the codes table with a code type of PHTP.
phone3	No	String (20)	This column contains a second additional phone number associated with the address.
latitude	No	String (30)	This column contains the north-south geographic coordinate of the address, represented in decimal degrees (e. g. , 37. 7749).
longitude	No	String (30)	This column contains the east-west geographic coordinate of the address, represented in decimal degrees (e. g. , -122. 4194).
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-1224 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-1225 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-1226 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-1227 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",
"autoReceive": "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,
"phone2Type": "WO",
"phone2": "5551234567",
"phone3Type": "WO",
"phone3": "5551234567",
"latitude": "44.38129",
"longitude": "-92.03521",
"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-1228 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.
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-1229 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.
phone2Type	No	String (6)	This column contains the type of the phone number stored in Phone2 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work also can be found on the codes table with a code type of PHTP.
phone2	No	String (20)	This column contains an additional phone number associated with the address.
phone3Type	No	String (6)	This column contains the type of the phone number stored in Phone3 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work also can be found on the codes table with a code type of PHTP.
phone3	No	String (20)	This column contains a second additional phone number associated with the address.
latitude	No	String (30)	This column contains the north-south geographic coordinate of the address, represented in decimal degrees (e. g. , 37. 7749).
longitude	No	String (30)	This column contains the east-west geographic coordinate of the address, represented in decimal degrees (e. g. , -122. 4194).
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-1230 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-1231 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-1232 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,
"phone2Type": "WO",
"phone2": "5551234567",
"phone3Type": "WO",
"phone3": "5551234567",
"latitude": "44.38129",
"longitude": "-92.03521",
"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"
}
]
}

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-1233 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-1234 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-1235 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-1236 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-1237 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-1238 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-1239 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-1240 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-1241 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-1242 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-1243 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-1244 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-1245 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-1246 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-1247 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-1248 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-1249 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-1250 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-1251 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-1252 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-1253 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-1254 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-1255 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.
itemDefaultInd	No	String (1)	Indicates whether component rate information is deleted or not for existing items under the department.

Sample Input Message

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

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-1256 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-1257 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-1258 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-1259 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-1260 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-1261 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-1262 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.
autoReceive	No	String (1)	This column will indicate whether the client is allowing automatic receipt for the store. Valid Values are Y (Yes), N (No).
customFlexAttribute	No	Collection of Object	References a collection of custom flexible attributes. This collection is treated as a single group and should include all named flexible attributes for the business entity. If any configured named attribute is missing from the input collection, its value will be set to NULL
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-1263 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-1264 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-1265 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-1266 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,
"autoReceive": "Y",
"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-1267 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-1268 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.
phone2Type	No	String (6)	This column contains the type of the phone number stored in Phone2 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work also can be found on the codes table with a code type of PHTP.
phone2	No	String (20)	This column contains an additional phone number associated with the address.
phone3Type	No	String (6)	This column contains the type of the phone number stored in Phone3 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work also can be found on the codes table with a code type of PHTP.
phone3	No	String (20)	This column contains a second additional phone number associated with the address.
latitude	No	String (30)	This column contains the north-south geographic coordinate of the address, represented in decimal degrees (e. g. , 37. 7749).
longitude	No	String (30)	This column contains the east-west geographic coordinate of the address, represented in decimal degrees (e. g. , -122. 4194).
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-1269 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-1270 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-1271 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,
"phone2Type": "WO",
"phone2": "5551234567",
"phone3Type": "WO",
"phone3": "5551234567",
"latitude": "44.38129",
"longitude": "-92.03521",
"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-1272 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-1273 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-1274 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-1275 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-1276 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-1277 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-1278 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-1279 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-1280 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"
    }
  ]
}

Manage Store Conditions

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service allows user to add, update or delete store conditions at a given store location. Store conditions are events that may have had an impact on store traffic and sales such as power outages, weather conditions, states of emergency, road construction, or community events.

Store condition types are defined and maintained under the Store Conditions (SCND) code type. The condition code under this code type which have the used indicator set to Yes (‘Y’) will be applicable for set up. A store condition will have a start date and may or may not have an end date such as an ongoing condition. Conditions that occurred on a single day should have an end date equal to the start date. Extra details about the condition can be provided in the comments.

In case of error, the 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.

Service Type

POST

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/conditions/manage

Input Payload Details

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

Element Name	Required	Data Type	Description
collectionSize	No	Number (4)	Number of condition records included in request
items	No	Collection of Object	Container for store condition records.

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

Element Name	Required	Data Type	Description
action	Yes	String (10)	Contains the action for the request. Valid values are CREATE, UPDATE, DELETE.
store	Yes	Number (10)	This column contains the number which uniquely identifies the store.
conditionType	Yes	String (6)	This will hold the condition types configured under code type ''SCND'' with Used indicator as ''Y''.
startDate	Yes	date	This will hold the start date of the condition.
endDate	No	date	This will hold the end date of the condition.
clearEndDate	No	String (1)	Indicates whether to clear the end date. Valid values are Y (clear) or N (do not clear) or null.
comments	No	String (250)	This will hold the extra information about the condition set up.
clearComments	No	String (1)	Indicates whether to clear the comments. Valid values are Y (clear) or N (do not clear) or null.

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	This column contains the number which uniquely identifies the store.
conditionType	Yes	String (6)	This will hold the condition types configured under code type ''SCND'' with Used indicator as ''Y''.
startDate	Yes	date	This will hold the start date of the condition.
errorMessages	Yes	Array of String	Contains all the errors because of which the store condition processing in Merchandising failed.

Sample Input Message

{
"collectionSize": 1,
"items": [
{
"action": "CREATE",
"store": 10080,
"conditionType": "PO",
"startDate": "2001-12-31",
"endDate": "2001-12-31",
"clearEndDate": "Y",
"comments": "Power outage due to maintenance",
"clearComments": "Y"
}
]
}

Response Code: 200 (Success)

Table 5-1284 ManageResponse - Object. See list of elements for detail

Element Name	Required	Data Type	Description
storeConditions	Yes	Collection of Object	Collection of successfully processed store condition records returned in response.

Table 5-1285 StoreConditions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
store	Yes	Number (10)	This column contains the number which uniquely identifies the store.
conditionType	Yes	String (6)	This will hold the condition types configured under code type ''SCND'' with Used indicator as ''Y''.
startDate	Yes	date	This will hold the start date of the condition.

Sample Response Message

{
"storeConditions": [
{
"store": 10080,
"conditionType": "PO",
"startDate": "2001-12-31"
}
]
}

Response Code: 400 (Error)

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

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	This column contains the number which uniquely identifies the store.
conditionType	Yes	String (6)	This will hold the condition types configured under code type ''SCND'' with Used indicator as ''Y''.
startDate	Yes	date	This will hold the start date of the condition.
errorMessages	Yes	Array of String	Contains all the errors because of which the store condition processing in Merchandising failed.

Sample Error Message

{
"status": "ERROR",
"message": "Error found in validation of input payload",
"validationErrors": [
{
"error": "must be one of Y, N",
"field": "createRecord.arg0.approveInd",
"inputValue": "X"
}
],
"businessError": [
{
"store": 10080,
"conditionType": "PO",
"startDate": "2001-12-31",
"errorMessages": [
"A condition with the same type and start date already exists"
]
}
]
}

Manage Store Services

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service allows user to specify /add which services are provided to customers at a given store location, such as Gift Wrapping, Embroidery, Engraving, or Curbside Pickup. The list of possible store services are defined under the Store Services (STSV) code type. The services under this code type which have the used indicator set to Yes (‘Y’) will be applicable for set up.

The only modification that can be performed via this service is to indicate that the store service is no longer available at the provided store. This can be done by passing in a store and a store service which is currently available at the store, and the delete flag set to Yes (Y) indicating that the service should be removed.

Service Type

POST

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/services/manage

Input Payload Details

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

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Total number of store service records included in the request payload.
items	Yes	Collection of Object	Child node holding the collection of store service records to be processed.

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

Element Name	Required	Data Type	Description
action	Yes	String (10)	Specifies the action to be performed on the store service record (CREATE, UPDATE, DELETE).
store	Yes	Number (10)	This column contains the number which uniquely identifies the store.
storeService	Yes	String (6)	Code representing the type of service being assigned, modified, or removed for the store.

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

Element Name	Required	Data Type	Description
store	No	Number (10)	Store number for which the service request failed validation or processing.
storeService	No	String (6)	Service type associated with the failed store service transaction.
errorMessages	No	Array of String	Child node holding one or more validation or processing error messages for the store service request.

Sample Input Message

{
"collectionSize": 1,
"items": [
{
"action": "CREATE",
"store": 1810,
"storeService": "EN"
}
]
}

Response Code: 200 (Success)

Table 5-1290 ManageResponse - Object. See list of elements for detail

Element Name	Required	Data Type	Description
storeServices	No	Collection of Object	Child node holding successfully processed store service records returned in the response.

Table 5-1291 StoreServices - Object. See list of elements for detail

Element Name	Required	Data Type	Description
store	No	Number (10)	Store number for which the service request has been successfully processed.
storeService	No	String (6)	Type of the service that the store offers. Valid values are available under code type ''STSV''.

Sample Response Message

{
"storeServices": [
{
"store": 1810,
"storeService": "EN"
}
]
}

Response Code: 400 (Error)

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

Element Name	Required	Data Type	Description
store	No	Number (10)	Store number for which the service request failed validation or processing.
storeService	No	String (6)	Service type associated with the failed store service transaction.
errorMessages	No	Array of String	Child node holding one or more validation or processing error messages for the store service request.

Sample Error Message

{
"status": "ERROR",
"message": "Error found in validation of input payload",
"validationErrors": [
{
"error": "must be one of Y, N",
"field": "createRecord.arg0.approveInd",
"inputValue": "X"
}
],
"businessError": [
{
"store": 1810,
"storeService": "EN",
"errorMessages": [
"Invalid service type for store 1810"
]
}
]
}

Manage Store Translations

Functional Area

Organizational Hierarchy - Stores

Business Overview

This service allows for the creation, update, and deletion of translations of a store’s name and secondary name.

In case of error, the 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.

Service Type

POST

ReST URL

MerchIntegrations/services/organizationalHierarchy/store/translations/manage

Input Payload Details

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

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Contains the total number of records in the request payload.
items	Yes	Collection of Object	Container for store name translation records.

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

Element Name	Required	Data Type	Description
action	Yes	String (10)	Contains the action for the request. Valid values are CREATE, UPDATE, DELETE.
store	Yes	Number (10)	This column contains the number which uniquely identifies the store.
language	Yes	Number (6)	This will hold the language identifier for which the translation is being maintained.
storeName	No	String (150)	This will hold the translated name of the store for the given language. Mandatory for CREATE and UPDATE actions.
storeSecondaryName	No	String (150)	This will hold the translated secondary name of the store. No validation apart from datatype/length.
clearStoreNameSecondary	No	String (1)	Indicates whether to clear the secondary store name. Valid values are Y (clear) or N (do not clear) or null.

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	This column contains the store identifier associated with the error.
lang	Yes	Number (6)	This column contains the language identifier associated with the error.
errorMessages	Yes	Array of String	Contains the list of validation or processing errors for the given store and language.

Sample Input Message

{
"collectionSize": 1,
"items": [
{
"action": "CREATE",
"store": 1111,
"language": 3,
"storeName": "MONTAGNE BLEUE DU NORD",
"storeSecondaryName": "MER ROUGE DE L\u0027OUEST",
"clearStoreNameSecondary": "Y"
}
]
}

Response Code: 200 (Success)

Table 5-1296 ManageResponse - Object. See list of elements for detail

Element Name	Required	Data Type	Description
responses	Yes	Collection of Object	Container for store name translation response records.

Table 5-1297 Responses - Object. See list of elements for detail

Element Name	Required	Data Type	Description
store	Yes	Number (10)	This column contains the store identifier for which the response is returned.
language	Yes	Number (6)	This column contains the language identifier for which the response is returned.
warning	Yes	String (100)	This column contains the warning for which the response is returned.

Sample Response Message

{
"responses": [
{
"store": 1111,
"language": 3,
"warning": null
}
]
}

Response Code: 400 (Error)

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	This column contains the store identifier associated with the error.
lang	Yes	Number (6)	This column contains the language identifier associated with the error.
errorMessages	Yes	Array of String	Contains the list of validation or processing errors for the given store and language.

Sample Error Message

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

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-1299 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-1300 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-1301 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-1302 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 publishes warehouse master data to downstream consuming systems. It publishes only regular warehouse entities, including finisher warehouses, and excludes importer and exporter legal-entity warehouses. The payload includes warehouse setup details together with primary-address information, all published warehouse addresses, virtual-warehouse channel information, and warehouse and address custom flex attributes.

Technical Details

Core business tables: WH, ADDR

Additional business tables: ADD_TYPE_MODULE, V_ADD_TYPE_TL, STATE, COUNTRY, CHANNELS, WH_CFA_EXT, ADDR_CFA_EXT

JSON cache table: MERCHAPI_EXT_WH

JSON generation view: V_MERCHAPI_EXT_WH_JSON

Builds the warehouse header from WH, derives the primary address from ADDR joined to ADD_TYPE_MODULE and V_ADD_TYPE_TL, enriches address geography from STATE and COUNTRY, and resolves virtual-warehouse channel text from CHANNELS.

Warehouse- and address-level custom flex attributes are added from MERCHAPI_EXT_WH_CFA and MERCHAPI_EXT_WH_ADDR_CFA.

Functionally, the JSON view filters to WH.ORG_ENTITY_TYPE = 'R', so only regular warehouses, including finishers, are published; importer and exporter legal-entity warehouses are excluded from this API.

Initial Seeding and post enablement rebuild/repair

Initial seeding and rebuild use V_MERCHAPI_EXT_WH_JSON and apply WH.ORG_ENTITY_TYPE = 'R'.

Mark cache rows deleted when the warehouse no longer exists in V_MERCHAPI_EXT_WH_JSON.

ICL (Integration Change Log) table: ICL_RMS_WH and ICL_RMS_ADDR (ICL consumer name = MERCHAPI)

ICL entries are created using triggers on WH, and address changes are captured through ICL_RMS_ADDR for ADDR rows where MODULE = 'WH'.

ICL_RMS_ADDR rows are filtered to MODULE = 'WH' and republish the parent warehouse payload.

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

Process configuration name: API_EXT_WH

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

POM Batch schedule process and job: MERCHAPI_DELTA_EXT_WAREHOUSE_ADHOC_PROCESS -> MERCHAPI_EXT_WAREHOUSE_ADHOC_JOB

Webhook configuration api name: foundation/warehouse

Service Type

GET

ReST URL

MerchIntegrations/services/foundation/warehouse

MerchIntegrations/services/foundation/warehouse/{whId}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date (Example: 2010-12-31T23:59:59.999Z)
before	No	String	Before Date (Example: 2040-12-31T23:59:59.999Z)
offsetkey	No	String	Offset key (Warehouse)
limit	No	String (6)	Pagination limit. Default value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Table 5-1303 Input Parameter for "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

Table 5-1304 PageResultsItemsMerchApiWarehouse - Object. See list of elements for detail

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

Table 5-1305 MerchApiWarehouse - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	No	String (6)	Action for warehouse details.
warehouse	No	Number(10,0)	This field contains the unique number that identifies the warehouse.
warehouseName	No	String (150)	This field contains the warehouse name. This is published for both physical and virtual warehouses.
whNameSecondary	No	String (150)	This field contains the secondary name of the warehouse.
email	No	String (100)	This field holds the email address for the location. This is published only for the physical warehouse.
stockholdingInd	No	String (1)	This field indicates whether the warehouse is a stockholding location. In a multichannel environment, it will be N for a physical warehouse and Y for a virtual warehouse.
channelId	No	Number(4,0)	This field contains the channel for which the virtual warehouse has been assigned. This is published for the virtual warehouse.
channelDescription	No	String (120)	This field contains the description of the channel for which the virtual warehouse has been assigned.
currencyCode	No	String (3)	This field contains the code for the currency that the warehouse uses. This is published for physical and virtual warehouses.
physicalWarehouse	No	Number(10,0)	This field contains the number of the physical warehouse corresponding to this virtual warehouse. For physical warehouses, this field will be null.
primaryVirtualWarehouse	No	Number(10,0)	This field holds the virtual warehouse that will be used as the basis for all transactions for which only a physical warehouse, and not a virtual warehouse, has been specified.
dunsNo	No	String (9)	This field holds the Dun and Bradstreet number to identify the physical warehouse. This is published for the physical warehouse.
dunsLocation	No	String (4)	This field holds the Dun and Bradstreet location number to identify the physical warehouse. This is published for the physical warehouse.
breakPackInd	No	String (1)	This field indicates whether the warehouse can distribute less than the supplier case quantity. Valid values are Y or N. This is published for both physical and virtual warehouses.
redistributionWarehouseInd	No	String (1)	This field indicates whether the warehouse is a redistribution warehouse, which 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 quantities redistributed to actual receiving locations closer to expected receipt. Valid values are yes (Y) and no (N). This is published for both physical and virtual warehouses.
deliveryPolicy	No	String (6)	This field contains the delivery policy of the 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 warehouses.
pricingLocation	No	Number(10,0)	This field contains the location from which pricing information was copied for this virtual warehouse. This is published for the virtual warehouse.
pricingLocationCurrency	No	String (3)	This field contains the currency code of the pricing location. This is published for the virtual warehouse.
orgUnitId	No	Number(15,0)	This field holds the org unit ID of the virtual warehouse. This is published for the virtual warehouse.
vatRegion	No	Number(4,0)	This field holds the VAT region where the warehouse belongs. This is published for both physical and virtual warehouses.
orgHierarchyType	No	Number(4,0)	This field contains the organization type that will be used for reporting purposes for the warehouse. The type comes from the organizational hierarchy.
orgHierarchyValue	No	Number(10,0)	This field contains the code associated with the specific organizational hierarchy type. Valid values include the company number, chain number, area number, and so on.
restrictedInd	No	String (1)	This field indicates whether the inventory for this virtual warehouse is restricted, meaning it is impacted last in an inbound type of transaction occurring at the physical warehouse level.
protectedInd	No	String (1)	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	No	String (1)	This field determines if a virtual warehouse should be forecasted.
transferEntityId	No	Number(10,0)	This field indicates the transfer entity with which this virtual warehouse is associated.
finisherInd	No	String (1)	This field indicates whether a virtual warehouse is an internal finisher.
inboundHandlingDays	No	Number(2,0)	This field indicates the number of days that the warehouse requires to receive any item and get it to the shelf so that it is ready to pick.
virtualWarehouseType	No	String (6)	This field contains the virtual warehouse type. Valid values are CS_NT - Non-traditional,CS_RG - CSC,XD_GS - Global Sourcing,XD_RG - Cross Dock
orgEntityType	No	String (1)	This field specifies if the warehouse is a legal entity (Importer, Exporter) or a regular warehouse.
customerOrderLocationInd	No	String (1)	This field indicates if the virtual warehouse can source or fulfill customer orders.
defaultWarehouse	No	Number(10,0)	This field contains the default sourcing warehouse linked to the virtual warehouse.
giftWrappingInd	No	String (1)	This field indicates whether the warehouse supports gift wrapping.
customerOrderShippingInd	No	String (1)	This field indicates whether the virtual warehouse supports shipping customer orders.
investmentBuyInd	No	String (1)	This field indicates whether investment buy is configured for this warehouse.
investmentBuyWarehouseLink	No	Number(10,0)	This field contains the warehouse linked to the investment buy.
replenishableInd	No	String (1)	This field determines if a warehouse is replenishable.
replenishmentSourceOrder	No	Number(1,0)	This field contains the order from which the inventory is sourced for the linked warehouses.
replenishableWarehouseLink	No	Number(10,0)	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	No	String (20)	This field contains the unique tax identification number of the physical warehouse.
primaryAddressType	No	String (2)	This field specifies the type for the address. Valid values are: 01 - Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 - Remittance.
primaryAddressTypeDescription	No	String (40)	This field specifies the address type description.
primaryAddressAdd1	No	String (240)	This field contains the first line of the address.
primaryAddressAdd2	No	String (240)	This field contains the second line of the address.
primaryAddressAdd3	No	String (240)	This field contains the third line of the address.
primaryAddressCity	No	String (120)	This field contains the name of the city that is associated with the address.
primaryAddressState	No	String (3)	This field contains the state abbreviation for the address.
primaryAddressStateName	No	String (120)	This field contains the state description for the address.
primaryAddressCountryId	No	String (3)	This field contains the country where the address exists.
primaryAddressCountryName	No	String (120)	This field contains the country description where the address exists.
primaryAddressPost	No	String (30)	This field contains the zip code for the address.
primaryAddressContactName	No	String (120)	This field contains the name of the contact person at this address.
primaryAddressContactPhone	No	String (20)	This field contains the phone number of the contact person at this address.
primaryAddressContactTelex	No	String (20)	This field contains the telex number of the contact person at this address.
primaryAddressContactFax	No	String (20)	This field contains the fax number of the contact person at this address.
primaryAddressContactEmail	No	String (100)	This field contains the email address of the warehouse location contact person.
primaryAddressPhone2	No	String (20)	This field contains an additional phone number associated with the primary address.
primaryAddressPhone2Type	No	String (6)	This field contains the type of the phone number stored in the primaryAddressPhone2 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
primaryAddressPhone3	No	String (20)	This field contains a second additional phone number associated with the primary address.
primaryAddressPhone3Type	No	String (6)	This field contains the type of the phone number stored in the primaryAddressPhone3 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
primaryAddressLatitude	No	String (30)	This field contains the north-south geographic coordinate of the primary address, represented in decimal degrees.
primaryAddressLongitude	No	String (30)	This field contains the east-west geographic coordinate of the primary address, represented in decimal degrees.
primaryAddressCounty	No	String (250)	This field contains the county where the address exists.
primaryAddrJurisdictionCode	No	String (10)	This field contains the ID associated with the tax jurisdiction of the country-state relationship.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).
customFlexAttribute	No	Collection of Object	This List holds custom flex attributes for the warehouse.
address	No	Collection of Object	This List holds all the warehouse addresses.
cacheTimestamp	No	dateTime	This field specifies the date and time when the warehouse record was fetched into the cache for web service publication (UTC).
cacheCreateTimestamp	No	dateTime	This field specifies the date and time when the record was first created for web service publication (UTC).

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

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

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

Element Name	Required	Data Type	Description
addressKey	No	Number(11,0)	This field contains the unique address key.
addressType	No	String (2)	This field specifies the type for the address. Valid values are: 01 - Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 - Remittance.
addressTypeDescription	No	String (40)	This field specifies the address type description.
primaryAddressInd	No	String (1)	This field indicates whether the address is the primary address for the address type.
add1	No	String (240)	This field contains the first line of the address.
add2	No	String (240)	This field contains the second line of the address.
add3	No	String (240)	This field contains the third line of the address.
city	No	String (120)	This field contains the name of the city that is associated with the address.
state	No	String (3)	This field contains the state abbreviation that is associated with the address.
stateName	No	String (120)	This field contains the state description that is associated with the address.
countryId	No	String (3)	This field contains the country where the address exists.
countryName	No	String (120)	This field contains the country description that is associated with the address.
post	No	String (30)	This field contains the zip code for the address.
contactName	No	String (120)	This field contains the name of the contact person at this address.
contactPhone	No	String (20)	This field contains the phone number of the contact person at this address.
contactTelex	No	String (20)	This field contains the telex number of the contact person at this address.
contactFax	No	String (20)	This field contains the fax number of the contact person at this address.
contactEmail	No	String (100)	This field contains the email address of the contact person at this address.
phone2Type	No	String (6)	This field contains the type of the phone number stored in the phone2 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
phone2	No	String (20)	This field contains an additional phone number associated with the address.
phone3Type	No	String (6)	This field contains the type of the phone number stored in the phone3 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
phone3	No	String (20)	This field contains a second additional phone number associated with the address.
latitude	No	String (30)	This field contains the north-south geographic coordinate of the address, represented in decimal degrees.
longitude	No	String (30)	This field contains the east-west geographic coordinate of the address, represented in decimal degrees.
county	No	String (250)	This field contains the county where the address exists.
jurisdictionCode	No	String (10)	This field contains the ID associated with the tax jurisdiction of the country-state relationship.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).
customFlexAttribute	No	Collection of Object	This List holds custom flex attributes for the warehouse's address.

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

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

Sample Response Message

{
"items": [
{
"action": "INSERT",
"warehouse": 6000,
"warehouseName": null,
"whNameSecondary": null,
"email": null,
"stockholdingInd": "Y",
"channelId": 1,
"channelDescription": null,
"currencyCode": "USD",
"physicalWarehouse": 6000,
"primaryVirtualWarehouse": 1,
"dunsNo": null,
"dunsLocation": "1055",
"breakPackInd": null,
"redistributionWarehouseInd": null,
"deliveryPolicy": "NEXT",
"pricingLocation": 1,
"pricingLocationCurrency": null,
"orgUnitId": 1111111111,
"vatRegion": 1000,
"orgHierarchyType": 1,
"orgHierarchyValue": 1,
"restrictedInd": null,
"protectedInd": null,
"forecastWarehouseInd": null,
"transferEntityId": 1,
"finisherInd": null,
"inboundHandlingDays": 1,
"virtualWarehouseType": null,
"orgEntityType": null,
"customerOrderLocationInd": "Y",
"defaultWarehouse": 5,
"giftWrappingInd": "Y",
"customerOrderShippingInd": "Y",
"investmentBuyInd": null,
"investmentBuyWarehouseLink": 1,
"replenishableInd": null,
"replenishmentSourceOrder": 1,
"replenishableWarehouseLink": 1,
"taxId": null,
"primaryAddressType": "01",
"primaryAddressTypeDescription": null,
"primaryAddressAdd1": "101 First Street",
"primaryAddressAdd2": "201 Second Street",
"primaryAddressAdd3": null,
"primaryAddressCity": "Minneapolis",
"primaryAddressState": "MN",
"primaryAddressStateName": "MN",
"primaryAddressCountryId": "US",
"primaryAddressCountryName": "US",
"primaryAddressPost": "55555-1234",
"primaryAddressContactName": "Laura Johnson",
"primaryAddressContactPhone": "1800800800",
"primaryAddressContactTelex": null,
"primaryAddressContactFax": "617-897-0902",
"primaryAddressContactEmail": "someone@email.com",
"primaryAddressPhone2": "5551234567",
"primaryAddressPhone2Type": "WO",
"primaryAddressPhone3": "5551234567",
"primaryAddressPhone3Type": "WO",
"primaryAddressLatitude": "44.38129",
"primaryAddressLongitude": "-92.03521",
"primaryAddressCounty": null,
"primaryAddrJurisdictionCode": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"customFlexAttribute": [
{
"name": "attribute1",
"value": "value1",
"valueDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"address": [
{
"addressKey": 114772,
"addressType": "01",
"addressTypeDescription": null,
"primaryAddressInd": "Y",
"add1": "101 First Street",
"add2": "201 Second Street",
"add3": null,
"city": "Minneapolis",
"state": "MN",
"stateName": "MN",
"countryId": "US",
"countryName": "US",
"post": "55555-1234",
"contactName": "Laura Johnson",
"contactPhone": "1800800800",
"contactTelex": null,
"contactFax": "617-897-0902",
"contactEmail": "someone@email.com",
"phone2Type": "WO",
"phone2": "5551234567",
"phone3Type": "WO",
"phone3": "5551234567",
"latitude": "44.38129",
"longitude": "-92.03521",
"county": null,
"jurisdictionCode": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"customFlexAttribute": [
{
"name": "attribute1",
"value": "value1",
"valueDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"cacheTimestamp": "2001-12-31T23:59:59.000Z",
"cacheCreateTimestamp": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1000,
"count": 1000,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000&since=1970-01-01T00:00:00.001Z&before=2024-01-01T00:00:00.001Z&offsetkey=1234,XYZ",
"rel": "next"
}
]
}

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
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

Technical Details

Core business tables: WH, ADDR

Additional business tables: ADD_TYPE_MODULE, V_ADD_TYPE_TL, STATE, COUNTRY, CHANNELS, WH_CFA_EXT, ADDR_CFA_EXT

JSON cache table: MERCHAPI_EXT_WH

JSON generation view: V_MERCHAPI_EXT_WH_JSON

Warehouse- and address-level custom flex attributes are added from MERCHAPI_EXT_WH_CFA and MERCHAPI_EXT_WH_ADDR_CFA.

Initial Seeding and post enablement rebuild/repair

Initial seeding and rebuild use V_MERCHAPI_EXT_WH_JSON and apply WH.ORG_ENTITY_TYPE = 'R'.

Mark cache rows deleted when the warehouse no longer exists in V_MERCHAPI_EXT_WH_JSON.

ICL (Integration Change Log) table: ICL_RMS_WH and ICL_RMS_ADDR (ICL consumer name = MERCHAPI)

ICL entries are created using triggers on WH, and address changes are captured through ICL_RMS_ADDR for ADDR rows where MODULE = 'WH'.

ICL_RMS_ADDR rows are filtered to MODULE = 'WH' and republish the parent warehouse payload.

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

Process configuration name: API_EXT_WH

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

POM Batch schedule process and job: MERCHAPI_DELTA_EXT_WAREHOUSE_ADHOC_PROCESS -> MERCHAPI_EXT_WAREHOUSE_ADHOC_JOB

Webhook configuration api name: foundation/warehouse

Service Type

GET

ReST URL

MerchIntegrations/services/foundation/warehouse

MerchIntegrations/services/foundation/warehouse/{whId}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date (Example: 2010-12-31T23:59:59.999Z)
before	No	String	Before Date (Example: 2040-12-31T23:59:59.999Z)
offsetkey	No	String	Offset key (Warehouse)
limit	No	String (6)	Pagination limit. Default value is 1000.
include	No	String	Fields to include - comma separated (Example items.name,items.address.city)
exclude	No	String	Fields to exclude - comma separated (Example items.address.contactFax,items.customFlexAttribute)

Table 5-1309 Input Parameter for "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

Table 5-1310 PageResultsItemsMerchApiWarehouse - Object. See list of elements for detail

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

Table 5-1311 MerchApiWarehouse - Object. See list of elements for detail

Element Name	Required	Data Type	Description
action	No	String (6)	Action for warehouse details.
warehouse	No	Number(10,0)	This field contains the unique number that identifies the warehouse.
warehouseName	No	String (150)	This field contains the warehouse name. This is published for both physical and virtual warehouses.
whNameSecondary	No	String (150)	This field contains the secondary name of the warehouse.
email	No	String (100)	This field holds the email address for the location. This is published only for the physical warehouse.
stockholdingInd	No	String (1)	This field indicates whether the warehouse is a stockholding location. In a multichannel environment, it will be N for a physical warehouse and Y for a virtual warehouse.
channelId	No	Number(4,0)	This field contains the channel for which the virtual warehouse has been assigned. This is published for the virtual warehouse.
channelDescription	No	String (120)	This field contains the description of the channel for which the virtual warehouse has been assigned.
currencyCode	No	String (3)	This field contains the code for the currency that the warehouse uses. This is published for physical and virtual warehouses.
physicalWarehouse	No	Number(10,0)	This field contains the number of the physical warehouse corresponding to this virtual warehouse. For physical warehouses, this field will be null.
primaryVirtualWarehouse	No	Number(10,0)	This field holds the virtual warehouse that will be used as the basis for all transactions for which only a physical warehouse, and not a virtual warehouse, has been specified.
dunsNo	No	String (9)	This field holds the Dun and Bradstreet number to identify the physical warehouse. This is published for the physical warehouse.
dunsLocation	No	String (4)	This field holds the Dun and Bradstreet location number to identify the physical warehouse. This is published for the physical warehouse.
breakPackInd	No	String (1)	This field indicates whether the warehouse can distribute less than the supplier case quantity. Valid values are Y or N. This is published for both physical and virtual warehouses.
redistributionWarehouseInd	No	String (1)	This field indicates whether the warehouse is a redistribution warehouse, which 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 quantities redistributed to actual receiving locations closer to expected receipt. Valid values are yes (Y) and no (N). This is published for both physical and virtual warehouses.
deliveryPolicy	No	String (6)	This field contains the delivery policy of the 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 warehouses.
pricingLocation	No	Number(10,0)	This field contains the location from which pricing information was copied for this virtual warehouse. This is published for the virtual warehouse.
pricingLocationCurrency	No	String (3)	This field contains the currency code of the pricing location. This is published for the virtual warehouse.
orgUnitId	No	Number(15,0)	This field holds the org unit ID of the virtual warehouse. This is published for the virtual warehouse.
vatRegion	No	Number(4,0)	This field holds the VAT region where the warehouse belongs. This is published for both physical and virtual warehouses.
orgHierarchyType	No	Number(4,0)	This field contains the organization type that will be used for reporting purposes for the warehouse. The type comes from the organizational hierarchy.
orgHierarchyValue	No	Number(10,0)	This field contains the code associated with the specific organizational hierarchy type. Valid values include the company number, chain number, area number, and so on.
restrictedInd	No	String (1)	This field indicates whether the inventory for this virtual warehouse is restricted, meaning it is impacted last in an inbound type of transaction occurring at the physical warehouse level.
protectedInd	No	String (1)	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	No	String (1)	This field determines if a virtual warehouse should be forecasted.
transferEntityId	No	Number(10,0)	This field indicates the transfer entity with which this virtual warehouse is associated.
finisherInd	No	String (1)	This field indicates whether a virtual warehouse is an internal finisher.
inboundHandlingDays	No	Number(2,0)	This field indicates the number of days that the warehouse requires to receive any item and get it to the shelf so that it is ready to pick.
virtualWarehouseType	No	String (6)	This field contains the virtual warehouse type. Valid values are CS_NT - Non-traditional,CS_RG - CSC,XD_GS - Global Sourcing,XD_RG - Cross Dock
orgEntityType	No	String (1)	This field specifies if the warehouse is a legal entity (Importer, Exporter) or a regular warehouse.
customerOrderLocationInd	No	String (1)	This field indicates if the virtual warehouse can source or fulfill customer orders.
defaultWarehouse	No	Number(10,0)	This field contains the default sourcing warehouse linked to the virtual warehouse.
giftWrappingInd	No	String (1)	This field indicates whether the warehouse supports gift wrapping.
customerOrderShippingInd	No	String (1)	This field indicates whether the virtual warehouse supports shipping customer orders.
investmentBuyInd	No	String (1)	This field indicates whether investment buy is configured for this warehouse.
investmentBuyWarehouseLink	No	Number(10,0)	This field contains the warehouse linked to the investment buy.
replenishableInd	No	String (1)	This field determines if a warehouse is replenishable.
replenishmentSourceOrder	No	Number(1,0)	This field contains the order from which the inventory is sourced for the linked warehouses.
replenishableWarehouseLink	No	Number(10,0)	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	No	String (20)	This field contains the unique tax identification number of the physical warehouse.
primaryAddressType	No	String (2)	This field specifies the type for the address. Valid values are: 01 - Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 - Remittance.
primaryAddressTypeDescription	No	String (40)	This field specifies the address type description.
primaryAddressAdd1	No	String (240)	This field contains the first line of the address.
primaryAddressAdd2	No	String (240)	This field contains the second line of the address.
primaryAddressAdd3	No	String (240)	This field contains the third line of the address.
primaryAddressCity	No	String (120)	This field contains the name of the city that is associated with the address.
primaryAddressState	No	String (3)	This field contains the state abbreviation for the address.
primaryAddressStateName	No	String (120)	This field contains the state description for the address.
primaryAddressCountryId	No	String (3)	This field contains the country where the address exists.
primaryAddressCountryName	No	String (120)	This field contains the country description where the address exists.
primaryAddressPost	No	String (30)	This field contains the zip code for the address.
primaryAddressContactName	No	String (120)	This field contains the name of the contact person at this address.
primaryAddressContactPhone	No	String (20)	This field contains the phone number of the contact person at this address.
primaryAddressContactTelex	No	String (20)	This field contains the telex number of the contact person at this address.
primaryAddressContactFax	No	String (20)	This field contains the fax number of the contact person at this address.
primaryAddressContactEmail	No	String (100)	This field contains the email address of the warehouse location contact person.
primaryAddressPhone2	No	String (20)	This field contains an additional phone number associated with the primary address.
primaryAddressPhone2Type	No	String (6)	This field contains the type of the phone number stored in the primaryAddressPhone2 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
primaryAddressPhone3	No	String (20)	This field contains a second additional phone number associated with the primary address.
primaryAddressPhone3Type	No	String (6)	This field contains the type of the phone number stored in the primaryAddressPhone3 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
primaryAddressLatitude	No	String (30)	This field contains the north-south geographic coordinate of the primary address, represented in decimal degrees.
primaryAddressLongitude	No	String (30)	This field contains the east-west geographic coordinate of the primary address, represented in decimal degrees.
primaryAddressCounty	No	String (250)	This field contains the county where the address exists.
primaryAddrJurisdictionCode	No	String (10)	This field contains the ID associated with the tax jurisdiction of the country-state relationship.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).
customFlexAttribute	No	Collection of Object	This List holds custom flex attributes for the warehouse.
address	No	Collection of Object	This List holds all the warehouse addresses.
cacheTimestamp	No	dateTime	This field specifies the date and time when the warehouse record was fetched into the cache for web service publication (UTC).
cacheCreateTimestamp	No	dateTime	This field specifies the date and time when the record was first created for web service publication (UTC).

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

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

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

Element Name	Required	Data Type	Description
addressKey	No	Number(11,0)	This field contains the unique address key.
addressType	No	String (2)	This field specifies the type for the address. Valid values are: 01 - Business, 02 - Postal, 03 - Returns, 04 - Order, 05 - Invoice, 06 - Remittance.
addressTypeDescription	No	String (40)	This field specifies the address type description.
primaryAddressInd	No	String (1)	This field indicates whether the address is the primary address for the address type.
add1	No	String (240)	This field contains the first line of the address.
add2	No	String (240)	This field contains the second line of the address.
add3	No	String (240)	This field contains the third line of the address.
city	No	String (120)	This field contains the name of the city that is associated with the address.
state	No	String (3)	This field contains the state abbreviation that is associated with the address.
stateName	No	String (120)	This field contains the state description that is associated with the address.
countryId	No	String (3)	This field contains the country where the address exists.
countryName	No	String (120)	This field contains the country description that is associated with the address.
post	No	String (30)	This field contains the zip code for the address.
contactName	No	String (120)	This field contains the name of the contact person at this address.
contactPhone	No	String (20)	This field contains the phone number of the contact person at this address.
contactTelex	No	String (20)	This field contains the telex number of the contact person at this address.
contactFax	No	String (20)	This field contains the fax number of the contact person at this address.
contactEmail	No	String (100)	This field contains the email address of the contact person at this address.
phone2Type	No	String (6)	This field contains the type of the phone number stored in the phone2 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
phone2	No	String (20)	This field contains an additional phone number associated with the address.
phone3Type	No	String (6)	This field contains the type of the phone number stored in the phone3 field. Valid values are AS - Assistant, CM - Company Main, HF - Home Fax, HO - Home, MA - Main, PA - Pager, WF - Work Fax, WO - Work, and can also be found on the codes table with a code type of PHTP.
phone3	No	String (20)	This field contains a second additional phone number associated with the address.
latitude	No	String (30)	This field contains the north-south geographic coordinate of the address, represented in decimal degrees.
longitude	No	String (30)	This field contains the east-west geographic coordinate of the address, represented in decimal degrees.
county	No	String (250)	This field contains the county where the address exists.
jurisdictionCode	No	String (10)	This field contains the ID associated with the tax jurisdiction of the country-state relationship.
createDateTime	No	dateTime	This field holds the record creation date and time (UTC).
updateDateTime	No	dateTime	This field holds the date and time when the record was last updated (UTC).
customFlexAttribute	No	Collection of Object	This List holds custom flex attributes for the warehouse's address.

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

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

Sample Response Message

{
"items": [
{
"action": "INSERT",
"warehouse": 6000,
"warehouseName": null,
"whNameSecondary": null,
"email": null,
"stockholdingInd": "Y",
"channelId": 1,
"channelDescription": null,
"currencyCode": "USD",
"physicalWarehouse": 6000,
"primaryVirtualWarehouse": 1,
"dunsNo": null,
"dunsLocation": "1055",
"breakPackInd": null,
"redistributionWarehouseInd": null,
"deliveryPolicy": "NEXT",
"pricingLocation": 1,
"pricingLocationCurrency": null,
"orgUnitId": 1111111111,
"vatRegion": 1000,
"orgHierarchyType": 1,
"orgHierarchyValue": 1,
"restrictedInd": null,
"protectedInd": null,
"forecastWarehouseInd": null,
"transferEntityId": 1,
"finisherInd": null,
"inboundHandlingDays": 1,
"virtualWarehouseType": null,
"orgEntityType": null,
"customerOrderLocationInd": "Y",
"defaultWarehouse": 5,
"giftWrappingInd": "Y",
"customerOrderShippingInd": "Y",
"investmentBuyInd": null,
"investmentBuyWarehouseLink": 1,
"replenishableInd": null,
"replenishmentSourceOrder": 1,
"replenishableWarehouseLink": 1,
"taxId": null,
"primaryAddressType": "01",
"primaryAddressTypeDescription": null,
"primaryAddressAdd1": "101 First Street",
"primaryAddressAdd2": "201 Second Street",
"primaryAddressAdd3": null,
"primaryAddressCity": "Minneapolis",
"primaryAddressState": "MN",
"primaryAddressStateName": "MN",
"primaryAddressCountryId": "US",
"primaryAddressCountryName": "US",
"primaryAddressPost": "55555-1234",
"primaryAddressContactName": "Laura Johnson",
"primaryAddressContactPhone": "1800800800",
"primaryAddressContactTelex": null,
"primaryAddressContactFax": "617-897-0902",
"primaryAddressContactEmail": "someone@email.com",
"primaryAddressPhone2": "5551234567",
"primaryAddressPhone2Type": "WO",
"primaryAddressPhone3": "5551234567",
"primaryAddressPhone3Type": "WO",
"primaryAddressLatitude": "44.38129",
"primaryAddressLongitude": "-92.03521",
"primaryAddressCounty": null,
"primaryAddrJurisdictionCode": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"customFlexAttribute": [
{
"name": "attribute1",
"value": "value1",
"valueDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
],
"address": [
{
"addressKey": 114772,
"addressType": "01",
"addressTypeDescription": null,
"primaryAddressInd": "Y",
"add1": "101 First Street",
"add2": "201 Second Street",
"add3": null,
"city": "Minneapolis",
"state": "MN",
"stateName": "MN",
"countryId": "US",
"countryName": "US",
"post": "55555-1234",
"contactName": "Laura Johnson",
"contactPhone": "1800800800",
"contactTelex": null,
"contactFax": "617-897-0902",
"contactEmail": "someone@email.com",
"phone2Type": "WO",
"phone2": "5551234567",
"phone3Type": "WO",
"phone3": "5551234567",
"latitude": "44.38129",
"longitude": "-92.03521",
"county": null,
"jurisdictionCode": null,
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z",
"customFlexAttribute": [
{
"name": "attribute1",
"value": "value1",
"valueDate": "2001-12-31",
"createDateTime": "2001-12-31T23:59:59.000Z",
"updateDateTime": "2001-12-31T23:59:59.000Z"
}
]
}
],
"cacheTimestamp": "2001-12-31T23:59:59.000Z",
"cacheCreateTimestamp": "2001-12-31T23:59:59.000Z"
}
],
"hasMore": true,
"limit": 1000,
"count": 1000,
"links": [
{
"href": "https://<server>:<port>/Application/services/resources?limit=1000&since=1970-01-01T00:00:00.001Z&before=2024-01-01T00:00:00.001Z&offsetkey=1234,XYZ",
"rel": "next"
}
]
}

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
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}