5 ReSTful Web Services

This chapter gives an overview about the Merchandising and Sales Audit ReSTful Web service implementation and the APIs used in Merchandising and Sales Audit. For more information on ReST architectural style applied for building Web services, access the following URL:

http://www.oracle.com/technetwork/articles/javase/index-137171.html

To provide visibility to the background processing that's occurring, services write to the JOB_AUDIT_LOGS table in the database. Reports can be built based on this to provide visibility to what is happening in the background. Additionally, to assist users and developers in troubleshooting any error that may arise, the payload that was processed is also stored in the JOB_AUDIT_PAYLOAD table in the database.

Once the nightly batch run has started, web service execution will be halted, and users will receive a warning message that the nightly batch run has commenced.

Introduction

Merchandising and Sales Audit ReST support several web services, including the ability to query data and the ability to create and update data within the solutions. The ReSTful Web services Java code cannot be customized. The diagram below shows how the services are intended to interact with an external application which is a mobile client.

Figure 5-1 Mobile Client and Web Services Integration through Javascript

Note:

Several of the ReST services that may impact inventory or conflicts with data processing happening during nightly batch should not be used during the restricted nightly batch window.

Common Characteristics

Security

Services are secured using J2EE-based security model.

• Realm-based User Authentication: This verifies users through an underlying Realm. The username and password are passed using HTTP basic authentication.

• Role-based Authorization: This assigns users to roles; authenticated users can access the services with Merchandising or Sales Audit application roles or custom roles that are assigned to:

  • For Merchandising MERCH_SERVICE_ACCESS_PRIV

  • For Sales Audit MERCH_SERVICE_ACCESS_PRIV

• The communication between the server and client is encrypted using one-way SSL. In non-SSL environments the encoding defaults to BASE-64 so it is highly recommended that these ReST services are configured to be used in production environments secured with SSL connections.

• If you are using Merchandising data filtering, that will apply to the services as well. The user ID used for the calling the service should be added to the Merchandising SEC_USER table (APP_USER_ID), and then associated to the appropriate group in SEC_USER _GROUP table. For more information on this see the Merchandising Security Guide - Volume 2.

Standard Request and Response Headers

Merchandising and Sales Audit ReSTful web services have the following standard HTTP headers:

   Accept: application/xml or application/JSON
   Accept-Version: 16.0 (service version number)
   Accept-Language: en-US,en;q=0.8

Note:

Accept-Language is not mandatory, and defaults to en-US. The user can change it though; in case they need content in a specific language. The language support in the response payload is limited to a selective service which was created for the mobile client use case.

Depending on the type of the operation or HTTP method, the corresponding response header is updated in the HTTP response with the following codes:

• GET/READ : 200

• PUT/CREATE : 201 (Created) or 200 (Success)

• POST/UPDATE : 204 or 200 (Success)

• DELETE : 204 or 200 (Success)

Standard Error Response

Example response payload in case of service error is depicted below:

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <messagesRDOes>
     <messagesRDO>
        <message>REST Service Version Mismatch</message>
        <messageType>ERROR</messageType>
        <status>BAD_REQUEST</status> 
    </messagesRDO>
   </messagesRDOes>

• Message: The error message - translated.

• Message Type: Value of 'ERROR' is returned.

• Status: For a bad request or error, the status is BAD_REQUEST.

• The http error code for an error response is 400.

Merchandising URL Paths

Based on your implementation you will need to prefix the end point with just the deployment hostname. The format that should be used for the hostname is rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/, where <Region Name> will be the region for your data center and <Customer Subnamespace> will be specific to your company’s name and environment (production, stage, and so on).

The Merchandising services are hosted on two separate application servers. The application server named MerchIntegrations contains new Integration web services for data publishing and subscription. The RmsReSTServices contains other, legacy web services.

The following links provide access to the Merchandising services:

• The ReSTful Web services swagger URL is available at:

  https://<hostname/namespace>/RmsReSTServices/swagger-ui/

  https://<hostname/namespace>/MerchIntegrations/swagger-ui/

• The ReSTful Web services openapi.yaml is available at:

  https://<hostname/namespace>/RmsReSTServices/services/openapi.yaml

  https://<hostname/namespace>/MerchIntegrations/services/openapi.yaml

• The ReSTful Web services’s WADL file is available at:

  https://<hostname/namespace>/RmsReSTServices/services/private/application.wadl

  https://<hostname/namespace>/MerchIntegrations/services/application.wadl

• The ReSTful Web services are available at:

  https://<hostname/namespace>/RmsReSTServices/services/private/<service>

  https://<hostname/namespace>/MerchIntegrations/services/<service>

Sales Audit URL Paths

Based on the Implementation you may need to prefix the end point with just the deployment hostname or hostname plus access port.

The following links provide access to the Sales Audit services:

• The ReSTful Web services swagger URL is available at:

  https://<hostname/namespace>/ResaReSTServices/swagger-ui/

• The ReSTful Web services openapi.yaml is available at:

  https://<hostname/namespace>/ResaReSTServices/services/openapi.yaml

• The ReSTful Web services’s WADL file is available at:

  https://<hostname/namespace>/ResaReSTServices/services/private/application.wadl

• To access the ReSTful web services:

  https://<hostname/namespace>/ResaReSTServices/services/private/<ResaService>

OAuth for REST Service Authentication

OAuth 2.0 is the industry standard protocol for authorization. Merchandising cloud services REST Services now supports OAuth 2.0. To invoke these services, you need to obtain and access token and use it as a bearer token.

Note:

Basic Authentication access is no longer supported for these services. Allocation Cloud Service will still use Basic Authentication with this release.

Steps to Enable

To obtain a token and call the services, use the following steps:

1. This step should be performed one time for a given environment. Generate OAuth Client App with the environment-specific scope.

   Each environment has a different scope that is available after the provisioning of the environment.  Use this scope to generate the OAuth Client App using the Retail Home UI. For details, refer to the ”Creating OAuth Client Apps” section of the Retail Home Administration Guide, which can be found under Common Cloud Services Solutions in the Oracle Retail Help Center. Once the OAuth Client App is generated, note the client ID and secret. This information will be required for an access token to call REST services.

2. Get an access token using the OAuth client ID and secret from IDCS.

   export ACCESS_TOKEN="$(curl -u <Client ID>:<Secret> -H 'Content-Type: application/x-www-form-urlencoded;charset=UTF-8' --request POST https://<IDCS_BASE_URL>/oauth2/v1/token -d 'grant_type=client_credentials&scope=<Customer Environment Specific Scope>' | jq -r '.access_token')"

   The token is generally valid for 1 hour.

3. REST clients that need to call Merchandising REST service end points should use the client ID and secret of the OAuth client generated in the previous step to get an access token.

OAuth tokens can also be obtained by REST client tools like Postman for testing purposes by filling in the necessary details like client ID/secret and scope. Use the below information in such cases:

• Authorization: OAuth 2.0

• Access Token URL: https://<IDCS_BASE_URL>/oauth2/v1/token

• Client ID: <Client id of OAuth client app>

• Client Secret: <Client secret of OAuth client app>

• Scope: <Custom environment specific scope>

  • The scope pattern that is used in the MFCS IDCS app creation template is rgbu:merch:<SERVICETYPE>-<ENVIRONMENT>  where SERVICETYPE is MFCS and ENVIRONMENT is the environment type (STG, PRD, UAT, DEV1, DEV2, and so on).

    For example:

    • "scope": "rgbu:merch:MFCS-PRD"

    • "scope": "rgbu:merch:MFCS-STG"

Example using the access token as a bearer token:

curl --location --request GET 'http://<hostname or IP address>:<port number>/ RmsReSTServices/services/private/Common/vDate' \ --header 'Authorization: Bearer $ACCESS_TOKEN'

Date Format

Few input date and output date fields are in long format. The others are in SQL Date format. The new MerchIntegrations service supports dates in the yyyy-mm-dd format and datetimes in the yyyy-mm-ddTHH24:Mi:SS.SSSZ format.

Paging

Some of the Merchandising and Sales Audit ReSTful web services have the potential to bring back a significant number of records, and therefore these services are equipped to segment the result into pages. The page number to retrieve and the size of the page are added as input parameters to all the paged services.

Each paged result includes the following information:

• Total Record Count: Displays the number of all records matching the service input criteria.

• Next Page URL: Shows the service URL with same input parameters, but with the pageNumber plus 1, when more records exist.

• Previous Page URL: Shows the service URL with same input parameters and the pageNumber input value minus 1, when page number is not 1.

Next or previous page URL is not provided when:

• No records are returned

• Previous page is not returned, when the page number is 1.

• Next page is not returned, when the record reaches the last page.

Figure 5-2 Javascript for Paging Information in RMS Web Services

Web Service APIs Process Flow

The diagram shows the Web Service API process flow.

Figure 5-3 Web Service APIs Process Flow

Configuring ReSTful Web Services for Integration with External Systems

Based on your implementation, you will need to enable the Merchandising ReSTful publishing services for data replication between Merchandising and external systems. Additionally, the Omnichannel integration ReSTful services may also be enabled for external consumers. These two enablements are performed through the Web Service Configuration Screen in Merchandising. After a service is enabled, the table triggers will start writing data to respective change log tables and the corresponding background job will start populating JSON cache tables. When a service is disabled, the ReST service will be unavailable, triggers will stop capturing new changes, and background process will clean up the JSON cache table. For more details on how to enable a web service, see the Merchandising Administration Guide.

The below listed services can be enabled or disabled using the Merchandising UI,

• Allocation Publish Services

• Diff Group Publish Services

• Diff ID Publish Services

• Diff Type Publish Services

• Get Available Inventory Details Service

• Item Publish Services

• Item VAT Publish Services

• Merchandise Hierarchy Publication Services

• Order Publish Services

• Organizational Hierarchy Publish Services

• Partner Publish Services

• Purchase Order Work Order Publish Services

• RTV Publish Services

• RUA Publish Services

• Store Publish Services

• Supplier Publish Services

• Transfer Publish Services

• Transfer Work Order Publish Services

• UDA Publish Services

• Warehouse Publish Services

• REST Endpoint for Omni Channel/Diff Group

• REST Endpoint for Omni Channel/Diff IDs

• REST Endpoint for Omnichannel/Dimension Type details

• REST Endpoint for Omnichannel/Dimension Value details

• REST Endpoint for Omnichannel/Future Inventory

• REST Endpoint for Omni Channel/Inventory/Store Details

• REST Endpoint for Omni Channel/Inventory/Warehouse Details

• REST Endpoint for Omnichannel/Item Image

• REST Endpoint for Omnichannel/Item Initial Price Details

• REST Endpoint for Omnichannel/Item Location Details

• REST Endpoint for Omni Channel/Item Details

• REST Endpoint for Omni Channel/Item UPC Details

• REST Endpoint for Omni Channel/Merchandise Hierarchy Details

• REST Endpoint for Omni Channel/Org Hier Descendant’s Details

• REST Endpoint for Omni Channel/Org Hierarchy Details

• REST Endpoint for Omni Channel/Refresh Date

• REST Endpoint for Omnichannel/Related Item

• REST Endpoint for Omnichannel/Retail Store Details

• REST Endpoint for Omnichannel/VAT

• REST Endpoint for Omni Channel/Warehouse Details

File Transfer Services (FTS)

Business Overview

File Transfer Services (FTS) provide an endpoint for the customer to be used when working with files that are uploaded to and downloaded from the Merchandising Cloud Service Suite. These services are used by Merchandising and Sales Audit (RMFCS), Pricing (RPCS), Invoice Matching (ReIMCS), Allocation (RACS) and the Data Conversion tool. They allow you to manage uploading and downloading files to Oracle Cloud Infrastructure Object Storage, which is an internet-scale, high-performance storage platform that offers reliable and cost-efficient data durability.

For each customer environment, buckets, which are logical containers for storing objects, will be created in Object Storage. Any type of data, regardless of content type, is stored as an object. An object is composed of the object itself and metadata about the object.

The services use OAUTH 2.0 client credential authentication. Once authentication passes, the internal file transfer services that retrieve a pre-authenticated request (PAR) are called to upload and download files to Object Storage. The primary role of these services is to ensure that only valid external users can call the service by enforcing authorization policies.

List of services:

• List Storage Prefixes
• Register a New Storage Prefix
• Unregister a Storage Prefix
• Retrieve PAR for Uploading Files
• Retrieve PAR for Downloading Files
• Delete Files
• List Files
• Move Files
• FTS Health Check

URL Prefix: https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/RmsPlatformServices/services/private

The final URL will be the URL Prefix followed by the ReST URL path mentioned in each service description below.

To start uploading or downloading the files to/from Object Storage, storage prefixes should be registered first.

The table below shows the prefixes used by each of the solutions when calling the above listed services. By default, all the storage prefixes below will be registered automatically.

	RMFCS	RPCS	ReIMCS	RACS	Data Conversion
Incoming	/incoming		/incoming/reim	/incoming/alloc	/dataconversion/incoming
Outgoing	/outgoing				/dataconversion/outgoing
Reject	/reject			n/a	n/a
Downloaded	/downloaded		/downloaded/reim	/downloaded/alloc	n/a
Archive		n/a	n/a	n/a	n/a

Table 5-1 Administrative Processes

Storage Prefix	Service	File Name
AdminProcess	Dynamic Hierarchy	dynamic_hierarchy/dynamic_hierarchy_mapping_tl.csv

List Storage Prefixes

Business Overview

This service is used for retrieving Object Storage prefixes.

Service Type

Get

ReST URL

/FTSWrapper/listprefixes

Headers

Key	Value
Accept-Language	String (Ex: en-US)

Output

The output metadata contains the prefix details of the request including validation error, if any.

For Success:

[
 		 "downloaded",
  		 "incoming",
]

For Failure:

{
 		 "error_message": "string"
}

Register a New Storage Prefix

Business Overview

This service is used to register a new storage prefix.

Service Type

Put

ReST URL

/FTSWrapper/register/{prefix}

• {prefix} - The Storage prefix to use

Headers

Key	Value
Accept-Language	String (Ex: en-US)

Responses

Code	Description
200	Successfully registered.
500	Failed registration.

Unregister a Storage Prefix

Business Overview

This service unregisters a storage prefix.

Service Type

Delete

ReST URL

/FTSWrapper/unregister/{prefix}

• {prefix} - The storage prefix to be unregistered.

Headers

Key	Value
Accept-Language	String (Ex: en-US)

Responses

Code	Description
200	Successfully unregistered.
500	Failed unregistering.

Retrieve PAR for Uploading Files

Business Overview

This service is used for retrieving an Object Storage pre-authenticated request (PAR) for uploading files. The response from the service is then used to upload the files in the user specified prefix from Object Storage using curl. The specified prefix is the staging location for input file that is processed by one of the Merchandising cloud service upload batches.

Service Type

Post

ReST URL

/FTSWrapper/upload

Headers

Key	Value
Accept-Language	String (Ex: en-US)

Request body

{
   "listOfFiles": [
      {
         "storagePrefix": "string",
         "fileName": "string"
      }
   ]
}

Output

Parameter Name	Data Type
id	String
name	String
accessUri	String
objectNames	<List> String
access	String
timeExpires	Timestamp
timeCreated	Timestamp

The output metadata contains the PAR details of the request including validation error, if any

For Success:

 {
     "id": "string",
     "name": "string",
     "accessUri": "string",
     "objectNames": [
          "string"
     ],
     "accessType": "string",
     "timeExpires": "timestamp",
     "timeCreated": "timestamp"
}

For Failure:

{
    "error_message": "string"
}

Uploading the Batch Incoming File

To upload the file, use a curl command as shown below in the example, including the accessUri returned from the ReST service call. Provide the location of the file to be uploaded. The file must be uploaded before the expiration time. Below is an format of the curl command structure. The specified prefix is the staging location for input files that is processed by one of the Merchandising cloud service upload batches.

Example

curl https://<objectstorage_hostname/p/<pre authenticated request>/n/<namespace>/b/<bucketname>/o/<prefixname>/<filename> --upload-file <filename>

Retrieve PAR for Downloading Files

Business Overview

This service is used for retrieving an Object Storage pre-authenticated request (PAR) for downloading files. The response from the service is then used to download the files in the user specified prefix from Object Storage using curl. The specified prefix is the staging location for file that is processed by one of the Merchandising cloud service batches.

Service Type

Post

ReST URL

/FTSWrapper/download

Headers

Key	Value
Accept-Language	String (Ex: en-US)

Request Body

{
    "listOfFiles": [
        {
            "storagePrefix": "string",
            "fileName": "string"
        }
    ]
}

Output

Parameter Name	Data Type
id	String
name	String
accessUri	String
objectNames	<List> String
access	String
timeExpires	Timestamp
timeCreated	Timestamp

The output metadata contains the PAR details of the request including validation error, if any.

For Success:

 {
     "id": "string",
     "name": "string",
     "accessUri": "string",
     "objectNames": [
          "string"
     ],
     "accessType": "string",
     "timeExpires": "timestamp",
     "timeCreated": "timestamp"
}

For Failure:

{
    "error_message": "string"
}

Downloading the File

To download the file, use the curl command to the accessUri returned from the output metadata. You can download the file before the expiration time. The specified prefix is the staging location for file that is processed by one of the Merchandising cloud service batches.

Example

curl https://<objectstorage_hostname>/p/<pre authenticated request>/n/<namespace>/b/<bucketname>/o/<prefixname>/<filename> -O

Delete Files

Business Overview

This service is used for deleting files in Object Storage based on the provided prefix.

Service Type

Delete

ReST URL

/FTSWrapper/delete

Headers

Key	Value
Accept-Language	String (Ex: en-US)

Request body

{
    "listOfFiles": [
        {
            "storagePrefix": "string",
            "fileName": "string"
        }
    ]
}

Output

The output metadata contains the output of the FTS service for deletion. Validation error will be output, if any.

For Success:

{
    "filesDeleted": [
        {
            "filePath": {
                "storagePrefix": "incoming",
                "fileName": "testFile.txt"
            },
            "responseMessage": "File successfully deleted incoming/testFile.txt"
        }
    ],
    "filesFailedDeletion": []
}

For Failure:

{
    "error_message": "string"
}

List Files

Business Overview

This service provides a list of Object Storage files under the specified directory/prefix.

Service Type

Get

ReST URL

/FTSWrapper/listfiles

Headers

Key	Value
Accept-Language	String (Ex: en-US)

Input Parameters

Parameter Name	Data Type
prefix	String
contains	String
scanStatus	String
Limit	String
Offset	String
Sort	String

Output

Parameter Name	Data Type
name	String
size	String
md5	String
version	String
etag	String
createdDate	Timestamp
modifiedDate	Timestamp
scanStatus	String
scanDate	Timestamp
scanMessage	String

The output metadata contains the file detail of the request.

For Success:

{
 		 "name": "string",
  		 "size": "string",
 		 "md5": "string",
  		 "version":”string",
 		 "etag": "string",
 		 "createdDate": "timestamp",
  	 	 "modifiedDate": "timestamp",
  	 	 "scanStatus": "string",
  	 	 "scanDate": "timestamp",
  	 	 "scanMessage": "string",
}

Move Files

Business Overview

This service is used to move files from one location to other in Object Storage.

Service Type

Post

ReST URL

/FTSWrapper/movefiles

Headers

Key	Value
Accept-Language	String (Ex: en-US)

Request body

{
    "listOfFiles": [
        {
            "currentPath": {
                "storagePrefix": "string",
                "fileName": "string"
            },
            "newPath": {
                "storagePrefix": "string",
                "fileName": "string"
            }
        }
    ]
}

Output

The output metadata contains the output of the FTS service for file movement. Validation error will be output, if any.

For Success:

{
    "failedMove": [],
    "successfulMove": [
        {
            "moveFile": {
                "currentPath: {
                    "storagePrefix": "downloaded",
                    "fileName": "RTLOG_STOREXXX_20210405122426384.DAT"
                },
                "newPath: {
                    "storagePrefix": "incoming",
                    "fileName": "RTLOG_STOREXXX_20210405122426384.DAT"
                },
                "responseMessage": "Successfully moved"
            }
        }
    ]
}

For Failure:

{
   "error_message": "string"
}

FTS Health Check

Business Overview

This service checks the status of the File Transfer Service (FTS).

Service Type

Get

ReST URL

/FTSWrapper/ping

Headers

Key	Value
Accept-Language	String (Ex: en-US)

Output

The output metadata contains output of the FTS service for Health check which shows the status. Validation error will be output, if any.

For Success:

{
    "appStatus": 200
}

For Failure:

{
    "error_message": "string"
}

Merchandising Omni Integration

REST Endpoint for Omni Channel/Diff Group

Endpoint

MerchIntegrations/services/foundation/omnichannel/diff/group

Functional Area

Foundation

Business Overview

This service is used by Omni Channel applications to get diff group details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/omnichannel/diff/group?since={since}&before={before&offsetkey={offsetkey}&limit={limit}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value are Combination of valid Differentiator Group ID and a valid Differentiator IF separated by comma. For example: diffGroupId, diffId
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
Action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT, and DELETE.
diffgroupid	String	This field will hold a unique number (identifier) for the differentiator group.
diffgroupdesc	String	Description of the differentiator group (for example: Mens Shirt Sizes, Womens Shoe Sizes, Girls Dress Sizes, Shower Gel Scents, Yogurt Flavors, and so on).
difftypeid	String	This field will hold a value of the types of differentiators contained in this differentiator group, such as S - size, C - color, F - flavor, E - scent, P - pattern. Valid values are stored in the DIFF_TYPE table.
diffid	String	Contains the differentiator which are associated with a differentiator group. This field must be a valid value from the DIFF_IDS table.

Elements in JSON Output

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

Example JSON input:

" {
  "items": [
    {
      "action": "INSERT",
      "diffgroupid": "1177",
      "diffgroupdesc": "EIT_Diff_Group_1",
      "difftypeid": "CF",
      "diffid": "4280"
    }
  ],
  "hasMore": true,
  "limit": 1,
  "count": 1,
  "links": [
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/diff/group?before=2021-05-06T16%3A12%3A02.551757%2B08%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "self"
    },
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/diff/group?before=2021-05-06T16%3A12%3A02.551757%2B08%3A00&limit=1&offsetkey=1177%2C4280&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "next"
    }
  ]
} "

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ICL_RMS_DIFF_GROUP	Yes	Yes	Yes	Yes
MERCHAPI_DIFF_GROUP	Yes	Yes	Yes	Yes
V_MERCHAPI_DIFF_GROUP	Yes	No	No	No
V_MERCHAPI_DIFF_GROUP_JSON	Yes	No	No	No
V_MERCHAPI_ITEM_JSON	Yes	No	No	No
MERCHAPI_ITEM_DIFF_TYPE	Yes	Yes	Yes	Yes

REST Endpoint for Omni Channel/Diff IDs

Endpoint

MerchIntegrations/services/foundation/omnichannel/diff

Functional Area

Foundation

Business Overview

This service is used by Omni Channel applications to get diff IDs and its details from Merchandising.

Service Type

GET

ReST URL

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

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value is Differentiator ID. For example: diffid.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT, and DELETE.
diffid	String	Contains the code to uniquely identify a differentiator.
diffdesc	String	Description of the differentiator (for example, Blueberry, Shower Fresh, Red, and so on).
difftype	String	This field will hold a value of the types of differentiators contained in this differentiator group, such as S - size, C - color, F - flavor, E - scent, P - pattern. Valid values are stored in the DIFF_TYPE table.
difftypedesc	String	Contains the description of the differentiator type. Contains the description of the differentiator type.

Elements in JSON Output

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

Example JSON input:

" {
  "items": [
    {
      "action": "INSERT",
      "diffid": "1005",
      "diffdesc": "EIT_Diff_ID : Black",
      "difftype": "CF",
      "difftypedesc": "Cereal Flavour"
    }
  ],
  "hasMore": true,
  "limit": 1,
  "count": 1,
  "links": [
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/diff?before=2021-05-05T16%3A18%3A57.100893%2B08%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "self"
    },
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/diff?before=2021-05-05T16%3A18%3A57.100893%2B08%3A00&limit=1&offsetkey=1005&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "next"
    }
  ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ICL_RMS_DIFF_IDS	Yes	Yes	Yes	Yes
ICL_RMS_DIFF_TYPE	Yes	Yes	Yes	Yes
DIFF_IDS	Yes	No	No	No
MERCHAPI_DIFF_IDS	Yes	Yes	Yes	Yes
V_MERCHAPI_DIFF_IDS_JSON	Yes	No	No	No
V_MERCHAPI_DIFF_IDS	Yes	No	No	No
V_MERCHAPI_ITEM_JSON	Yes	No	No	No
MERCHAPI_ITEM_DIFF_TYPE	Yes	Yes	Yes	Yes
MERCHAPI_ITEM_DIFF_VALUE	Yes	Yes	Yes	Yes

REST Endpoint for Omni Channel/Inventory/Store Details

Endpoint

MerchIntegrations/services/inventory/omnichannel/inventory/store

Functional Area

Inventory

Business Overview

This service is used by Omni Channel applications to get available inventory for store locations from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/inventory/omnichannel/inventory/store?since={since}&before={before}&offsetkey={offsetkey}&limit={limit}&nodelevel={nodelevel}&nodeid={nodeId}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
nodelevel	No	String	Node Level Valid Value is STORE. If node level is provided, node ID should also be provided
nodeid	No	Number	Node ID Should be a valid store number if nodelevel is defined as STORE.
offsetkey	No	String	Offset Key. Valid Value is combination of store ID and item in case of entire stores list being pulled or item in case a specific store ID is pulled.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT and DELETE.
item	String	This field contains the unique alphanumeric value that identifies the item.
location	Number	This field contains the numeric identifier of the location in which the item is to be found.
loctype	String	This field contains the Type of location in the location field.
availablequantity	Number	This field represents the available inventory of an item in a particular location.
stockonhand	Number	This field contains current stock on hand for the item.
standarduom	String	This field contains the Unit of measure in which stock of the item is tracked at a corporate level.

Elements in JSON Output

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

Example JSON input:

" {
    "items": [
        {
            "action": "INSERT",
            "item": "100000286",
            "location": "1341",
            "loctype": "S",
            "availablequantity": 100,
            "stockonhand": 100,
            "standarduom": "EA"
        }
    ],
    "hasMore": true,
    "limit": 1,
    "count": 1,
    "links": [
        {
            "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/inventory/omnichannel/inventory/store?before=2021-05-13T18%3A28%3A10.129377%2B05%3A30&limit=1&since=1970-01-01T00%3A00%3A00.001Z",
            "rel": "self"
        },
        {
            "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/inventory/omnichannel/inventory/store?before=2021-05-13T18%3A28%3A10.129377%2B05%3A30&limit=1&offsetkey=1341%2C100000286&since=1970-01-01T00%3A00%3A00.001Z",
            "rel": "next"
        }
    ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
ITEM_LOC_SOH	Yes	No	No	No
STORE	Yes	No	No	No
MERCHAPI_ITEM_LOC	Yes	No	No	No

REST Endpoint for Omni Channel/Inventory/Warehouse Details

Endpoint

MerchIntegrations/services/inventory/omnichannel/inventory/warehouse

Functional Area

Inventory

Business Overview

This service is used by Omni Channel applications to get available inventory for warehouse locations from Merchandising.

Service Type

GET

ReST URL

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

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value is combination of store ID and item in case of entire warehouses list being pulled or item in case specific warehouse ID is pulled.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT and DELETE.
item	String	This field contains the unique alphanumeric value that identifies the item.
location	Number	This field contains the numeric identifier of the location in which the item is to be found.
loctype	String	This field contains the Type of location in the location field.
availablequantity	Number	This field represents the available inventory of an item in a particular location.
stockonhand	Number	This field contains current stock on hand for the item.
standarduom	String	This field contains the Unit of measure in which stock of the item is tracked at a corporate level.
physicalwarehouse	Number	This field contains the physical warehouse ID of the location field

Elements in JSON Output

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

Example JSON input:

" {
    "items": [
        {
            "action": "INSERT",
            "item": "100000075",
            "location": "10001",
            "loctype": "W",
            "availablequantity": 0,
            "stockonhand": 0,
            "standarduom": "EA",
            "physicalwarehouse": 2
        }
    ],
    "hasMore": true,
    "limit": 1,
    "count": 1,
    "links": [
        {
            "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/inventory/omnichannel/inventory/warehouse?before=2021-05-13T19%3A14%3A44.470363%2B05%3A30&limit=1&since=1970-01-01T00%3A00%3A00.001Z",
            "rel": "self"
        },
        {
            "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/inventory/omnichannel/inventory/warehouse?before=2021-05-13T19%3A14%3A44.470363%2B05%3A30&limit=1&offsetkey=10001%2C100000075&since=1970-01-01T00%3A00%3A00.001Z",
            "rel": "next"
        }
    ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
ITEM_LOC_SOH	Yes	No	No	No
WH	Yes	No	No	No
MERCHAPI_ITEM_LOC	Yes	No	No	No

REST Endpoint for Omni Channel/Item Details

Endpoint

MerchIntegrations/services/foundation/omnichannel/item

Functional Area

Foundation

Business Overview

This service is used by Omni Channel applications to get all or location specific items and its details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/omnichannel/item?since={since}&before={before}}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
nodelevel	No	String	Node Level. Valid Value are STORE or WAREHOUSE.
nodeid	No	BigDecimal	Node ID. Valid Values are Valid stores present in the STORE table or Valid Warehouse from WH table.
offsetkey	No	String	Offset Key. Valid Value is an Item ID.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT and DELETE.
item	String	This field specifies a unique alphanumeric value that identifies the item.
itemLocation	Number	This field specifies location id associated with item if valid node level value is sent. If Node level is absent then it defaults to ‘ent’ that refers to Enterprise.
itemparent	String	This field specifies an alphanumeric value that uniquely identifies the item/group at the level above the item.
itemgrandparent	String	This field specifies an alphanumeric value that uniquely identifies the item/group two levels above the item.
itemlevel	Number	This field specifies a number indicating in which of the three levels the item resides. The item level determines whether the item stands alone or if it is part of a family of related items.
tranlevel	Number	This field specifies a number indicating in which of the three levels transactions occur for the items group. The transaction level is the level at which the items inventory is tracked in the system.
inventoryind	String	This field determines whether an item holds inventory or not for item transformations.
diff1level	String	This field specifies diff1 level.
diff1type	String	This field specifies diff1 type.
diff1	String	This field specifies a diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group or value. For an item that is not a parent, this field may contain a value.
diff2level	String	This field specifies diff2 level.
diff2type	String	This field specifies diff2 type.
diff2	String	This field specifies a diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group or value. For an item that is not a parent, this field may contain a value.
diff3level	String	This field specifies diff3 level.
diff3type	String	This field specifies diff3 type.
diff3	String	This field specifies a diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group or value. For an item that is not a parent, this field may contain a value.
division	Number	This field specifies a number that uniquely identifies the division of the company.
groupid	Number	This field specifies the group in which the department exists.
dept	Number	This field uniquely identifies the department
class	Number	This field uniquely identifies the class within the system.
uniqueclass	Number	This field uniquely identifies the department/class combination.
subclass	Number	This field uniquely identifies the subclass.
uniquesubclass	Number	This field uniquely identifies the department/class/subclass combination.
description	String	This field specifies the description of the item. For items that have parents, this description will default to the parents description plus any differentiators
localdescription	String	This field specifies local description of item.
brandname	String	This field specifies the brand associated to an item.
merchandiseind	String	Indicates whether the item is a merchandise item. Merchandise items are generally physical items (things that must be shipped/received and of which there is an inventory). Non-merchandise items are often items that do not have inventory. Common examples include extra fees for service (extended warranties, alterations) or endlessly available items (downloads, in-app purchases of bonus content, or subscriptions)
uintype	String	This field specifies a unique identification number (UIN) used to identify the instances of the item at the location.
mfgrecretail	Number	This field specifies manufacturers recommended retail price for the item. This field is stored in the primary currency.
orginalunitretail	Number	This field specifies retail price for the item.
catchweightind	String	This field specifies whether the item should be weighed when it arrives at a location.
itemservicelevel	String	This field specifies value that restricts the type of shipment methods that RCOM can select for an item.
giftwrapind	String	This field determines whether the location will support gift wrapping or not.
shipaloneind	String	This field indicates if the item should be shipped to the customer in a separate package versus being grouped together in a box.
standarduom	String	This field specifies the unit of measure in which stock of the item is tracked at a corporate level
productclassification	String	Field determines how to pack customer orders: such as to determine products that may not be able to be packaged together. Examples of classifications may include fragile, toxic, heavy, and son on.
xdiff1desc	String	Field specifies diff1 description
xdiff2desc	String	Field specifies diff2 description
Xdiff3desc	String	Field specifies diff3 description

Elements in JSON Output

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

Example JSON Input

{
    "items": [
        {
            "item": "100000024",
            "action": "INSERT",
            "itemlocation": "ent",
            "itemparent": null,
            "itemgrandparent": null,
            "itemlevel": 1,
            "tranlevel": 3,
            "inventoryind": "Y",
            "diff1level": null,
            "diff1type": null,
            "diff1": null,
            "diff2level": null,
            "diff2type": null,
            "diff2": null,
            "diff3level": null,
            "diff3type": null,
            "diff3": null,
            "division": 1000,
            "groupid": 108,
            "dept": 1117,
            "class": 1,
            "uniqueclass": 51,
            "subclass": 1,
            "uniquesubclass": 432,
            "description": "Test Item 100000024 ",
            "localdescription": null,
            "brandname": null,
            "merchandiseind": "Y",
            "uintype": null,
            "mfgrecretail": null,
            "orginalunitretail": 13.2,
            "catchweightind": "N",
            "itemservicelevel": null,
            "giftwrapind": "N",
            "shipaloneind": "N",
            "standarduom": "EA",
            "productclassification": "APP",
            "xdiff1desc": null,
            "xdiff2desc": null,
            "xdiff3desc": null}
    ],
    "hasMore": true,
    "limit": 1,
    "count": 1,
    "links": [
        {
            "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/item?before=2021-05-12T23%3A35%3A49.770127%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&since=1970-01-01T00%3A00%3A00.001Z",
            "rel": "self"
        },
        {
            "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/item?before=2021-05-12T23%3A35%3A49.770127%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&offsetkey=100000024&since=1970-01-01T00%3A00%3A00.001Z ",
            "rel": "next"
        }
    ]
}

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
ICL_RMS_ITEM_MASTER	Yes	No	Yes	Yes
MERCHAPI_ITEM_MASTER	Yes	Yes	Yes	Yes
V_MERCHAPI_ITEM_MASTER	Yes	No	No	No
ICL_RMS_ITEM_IMAGE	No	Yes	No	No
ICL_RMS_RELATED_ITEM	No	Yes	No	No
ICL_RMS_ITEM_LOC	No	Yes	No	No
SYSTEM_OPTIONS	Yes	No	No	No

REST Endpoint for Omni Channel/Item UPC Details

Endpoint

MerchIntegrations/services/foundation/omnichannel/item/upc

Functional Area

Foundation

Business Overview

This service is used by Omni Channel applications to get all or location specific item UPCs and its details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/omnichannel/item/upc?since={since}&before={before}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
nodelevel	No	String	Node Level. Valid Value are STORE or WAREHOUSE.
nodeid	No	BigDecimal	Node ID. Valid Values are Valid stores present in the STORE table or Valid Warehouse from the WH table.
offsetkey	No	String	Offset Key. Valid Value is an Item ID.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT and DELETE.
item	String	This field specifies unique alphanumeric value that identifies the item.
itemLocation	Number	This field specifies a location ID associated with the item if a valid node level value is sent. If Node level is absent then it defaults to ent which refers to enterprise.
itemparent	String	This field specifies an alphanumeric value that uniquely identifies the item/group at the level above the item.
itemgrandparent	String	This field specifies an alphanumeric value that uniquely identifies the item/group two levels above the item.
itemlevel	Number	This field specifies a number indicating in which of the three levels the item resides. The item level determines whether the item stands alone or if it is part of a family of related items.
tranlevel	Number	This field specifies a number indicating which of the three levels transactions occur for the items group. The transaction level is the level at which the items inventory is tracked in the system.
inventoryind	String	This field determines whether an item holds inventory or not for item transformations.
diff1level	String	This field specifies diff1 level.
diff1type	String	This field specifies diff1 type.
diff1	String	This field specifies a diff_group or a diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group or value. For an item that is not a parent, this field may contain a value.
diff2level	String	This field specifies diff2 level.
diff2type	String	This field specifies diff2 type.
diff2	String	This field specifies a diff_group or a diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group or value. For an item that is not a parent, this field may contain a value.
diff3level	String	This field specifies diff3 level.
diff3type	String	This field specifies diff3 type.
diff3	String	This field specifies a diff_group or a diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group or value. For an item that is not a parent, this field may contain a value.
division	Number	This field specifies a number that uniquely identifies the division of the company.
groupid	Number	This field specifies the group in which the department exists.
dept	Number	This field uniquely identifies the department
class	Number	This field uniquely identifies the class within the system.
uniqueclass	Number	This field uniquely identifies the department/class combination.
subclass	Number	This field uniquely identifies the subclass.
uniquesubclass	Number	This field uniquely identifies the department/class/subclass combination.
description	String	This field specifies the description of the item. For items that have parents, this description will default to the parent’s description plus any differentiators
localdescription	String	This field is populated as empty for a UPC Item.
brandname	String	This field specifies the brand associated with an item.
merchandiseind	String	Indicates whether the item is a merchandise item. Merchandise items are generally physical items (things that must be shipped/received and of which there is an inventory). Non merchandise items are often items that do not have inventory. Common examples include extra fees for service (extended warranties, alterations) or endlessly available items (downloads, in-app purchases of bonus content, subscriptions)
uintype	String	This field is populated as empty for a UPC Item.
mfgrecretail	Number	This field specifies the manufacturer’s recommended retail price for the item. This field is stored in the primary currency.
orginalunitretail	Number	This field specifies retail price for the item.
catchweightind	String	This field specifies whether the item should be weighed when it arrives at a location.
itemservicelevel	String	This field specifies a value that restricts the type of shipment methods that RCOM can select for an item.
giftwrapind	String	This field determines whether the location will support gift wrapping or not.
shipaloneind	String	This field indicates whether the item should be shipped to the customer in a separate package versus being grouped together in a box.
standarduom	String	This field specifies the unit of measure in which stock of the item is tracked at a corporate level
productclassification	String	This field determines how to pack customer orders: such as to determine products that may not be able to be packaged together. Examples of classifications may include fragile, toxic, heavy, and so on.
xdiff1desc	String	Field specifies diff1 description
xdiff2desc	String	Field specifies diff2 description
Xdiff3desc	String	Field specifies diff3 description

Elements in JSON Output

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

Example JSON input:

" {
    "items": [
        {
            "item": "101100001",
            "action": "INSERT",
            "itemlocation": "ent",
            "itemparent": "100250007",
            "itemgrandparent": null,
            "itemlevel": 2,
            "tranlevel": 1,
            "inventoryind": "Y",
            "diff1level": null,
            "diff1type": null,
            "diff1": null,
            "diff2level": null,
            "diff2type": null,
            "diff2": null,
            "diff3level": null,
            "diff3type": null,
            "diff3": null,
            "division": 3000,
            "groupid": 304,
            "dept": 3041,
            "class": 1,
            "uniqueclass": 139,
            "subclass": 1,
            "uniquesubclass": 17,
            "description": "Something - MK",
            "localdescription": null,
            "merchandiseind": "Y",
            "uintype": null,
            "mfgrecretail": null,
            "orginalunitretail": null,
            "catchweightind": "N",
            "itemservicelevel": null,
            "giftwrapind": "N",
            "shipaloneind": "N",
            "standarduom": "EA",
            "productclassification": null,
            "xdiff1desc": null,
            "xdiff2desc": null,
            "xdiff3desc": null 
       }
    ],
    "hasMore": true,
    "limit": 1,
    "count": 1,
    "links": [
        {
            "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/item/upc?before=2021-05-13T16%3A38%3A07.284763%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&since=1970-01-01T00%3A00%3A00.001Z ",
            "rel": "self"
        },
        {
            "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/item/upc?before=2021-05-13T16%3A38%3A07.284763%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&offsetkey=101100001&since=1970-01-01T00%3A00%3A00.001Z ",
            "rel": "next"
        }
    ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
ICL_RMS_ITEM_MASTER	Yes	No	Yes	Yes
MERCHAPI_ITEM_MASTER	Yes	Yes	Yes	Yes
V_MERCHAPI_ITEM_MASTER	Yes	No	No	No
ICL_RMS_ITEM_IMAGE	No	Yes	No	No
ICL_RMS_RELATED_ITEM	No	Yes	No	No
ICL_RMS_ITEM_LOC	No	Yes	No	No
SYSTEM_OPTIONS	Yes	No	No	No

REST Endpoint for Omni Channel/Merchandise Hierarchy Details

Endpoint

MerchIntegrations/services/foundation/omnichannel/merchhier

Functional Area

Foundation

Business Overview

This service is used by Omni Channel applications to get merchandise hierarchies and its details from Merchandising.

Service Type

GET

ReST URL

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

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value is combination of sort_order_seq and node ID.
limit	No	BigDecimal	Pagination limit. Default Value is 10000.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT and DELETE.
nodeid	Number	This field contains the Merchandising Hierarchy ID.
hierarchylevel	String	This field contains the Merchandising Hierarchy Level.
nodename	String	This field contains the name of the Merchandising Hierarchy.
parentlevel	String	This field contains the Parent Merchandising Hierarchy Level.
parentnodeid	Number	This field contains the Parent Merchandising Hierarchy ID.
merchdisplayid	Number	This field contains the merchandising hierarchy display id.
buyer	String	This field contains the number of the buyer associated with the merchandising hierarchy.

Elements in JSON Output

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

Example JSON input:

" {
    "items": [
        {
            "action": "UPDATE",
            "nodeid": 1,
            "hierarchylevel": "COMPANY",
            "nodename": "Retailers Ltd",
            "parentlevel": null,
            "parentnodeid": null,
            "merchdisplayid": 1,
            "buyer": null
}
    ],
    "hasMore": true,
    "limit": 1,
    "count": 1,
    "links": [
        {
            "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/merchhier?before=2021-05-12T20%3A43%3A04.296066%2B05%3A30&limit=1&since=1970-01-01T00%3A00%3A00.001Z",
            "rel": "self"
        },
        {
            "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/location/warehouse?before=2021-05-12T20%3A15%3A13.253929%2B05%3A30&limit=1&offsetkey=2%2Cvirtual&since=1970-01-01T00%3A00%3A00.001Z ",
            "rel": "next"
        }
    ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ICL_RMS_DIVISION	Yes	No	Yes	Yes
ICL_RMS_GROUPS	Yes	No	Yes	Yes
ICL_RMS_DEPS	Yes	No	Yes	Yes
ICL_RMS_CLASS	Yes	No	Yes	Yes
ICL_RMS_SUBCLASS	Yes	No	Yes	Yes
COMPHEAD	Yes	No	No	No
CODE_DETAIL	Yes	No	No	No
MERCHAPI_MERCH_HIER	Yes	Yes	Yes	Yes
V_ MERCHAPI_MERCH_HIER	Yes	No	No	No
V_ MERCHAPI_MERCH_HIER _JSON	Yes	No	No	No
SYSTEM_OPTIONS	Yes	No	No	No

REST Endpoint for Omni Channel/Org Hier Descendant’s Details

Endpoint

MerchIntegrations/services/foundation/omnichannel/orghier/descendant

Functional Area

Foundation

Business Overview

This ReST service will be used by Omni Channel Applications to retrieve Organization Hierarchy Descendants details. Org hierarchy descendants are used by Oracle Retail Xstore Point of Service to retrieve a complete branch of org hierarchy rooted at a specific node – for example, locations under a region.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/omnichannel/orghier/descendant?since={since}&before={before}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
nodelevel	No	String	Node Level. Valid Value are COMPANY,CHAIN, AREA, REGION, and DISTRICT.
nodeid	No	BigDecimal	Node ID. Valid Values are Company, Chain, Area, Region, and District present in respective tables.
offsetkey	No	String	Offset Key. Valid Value: levelorder.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT, DELETE, and NO_CHANGE.
hierarchylevel	String	This field specifies the Organization Hierarchy Level.
hierarchynodeid	Number	This field specifies the Organization Hierarchy ID.
hierarchynodename	String	This field specifies the name of the Organization Hierarchy ID.
parentlevel	String	This field specifies the Parent Organization Hierarchy Level.
parentid	Number	This field specifies the Parent Organization Hierarchy ID.
levelorder	Number	This column contains the hierarchy level of the Organization Hierarchy. Valid values : 1 - COMPANY, 10 - CHAIN, 20 - AREA, 30 - REGION, 40 - DISTRICT, 50 - STORE and 2000 - WAREHOUSE.

Elements in JSON Output

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

Example JSON input:

" {
  "items": [
    {
      "hierarchylevel": "COMPANY",
      "hierarchynodeid": 9118,
      "hierarchynodename": "Retailers Ltd",
      "parentlevel": null,
      "parentid": null,
      "levelorder": 1
    }
  ],
  "hasMore": true,
  "limit": 1,
  "count": 1,
  "links": [
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/orghier/descendant?nodelevel=COMPANY&limit=1&nodeid=9118",
      "rel": "self"
    },
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/orghier/descendant?nodelevel=COMPANY&limit=1&nodeid=9118&offsetkey=1%2C9118",
      "rel": "next"
    }
  ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
V_ICL_RMS_ORGHIER	Yes	No	No	No
ICL_RMS_CHAIN	Yes	Yes	Yes	Yes
ICL_RMS_AREA	Yes	Yes	Yes	Yes
ICL_RMS_REGION	Yes	Yes	Yes	Yes
ICL_RMS_DISTRICT	Yes	Yes	Yes	Yes
ITEM_LOC	Yes	No	No	No
MERCHAPI_ORG_HIER	Yes	Yes	Yes	Yes
V_ORG_HIER_FULL_VW	Yes	No	No	No
V_MERCHAPI_ORG_HIER	Yes	No	No	No

REST Endpoint for Omni Channel/Org Hierarchy Details

Endpoint

MerchIntegrations/services/foundation/omnichannel/orghier

Functional Area

Foundation

Business Overview

This service is used by Omni Channel applications to get organizational hierarchies and its details from Merchandising.

Service Type

GET

ReST URL

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

Input Parameters

Parameter Name	Required	Data Type	Description
Since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
nodelevel	No	String	Node Level. Valid Value are COMPANY, CHAIN, AREA, REGION, DISTRICT, and STORE.
nodeid	No	BigDecimal	Node ID. Valid Values are Company, Chain, Area, Region, District, and Store IDs present in respective tables.
offsetkey	No	String	Offset Key. Contains combination of valid hierarchy level and a valid hierarchy node id separated by comma.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
Action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT, DELETE, and NO_CHANGE.
hierarchylevel	String	This field specifies the Organization Hierarchy Level.
hierarchynodeid	Number	This field specifies the Organization Hierarchy ID.
hierarchynodename	String	This field specifies the name of the Organization Hierarchy ID
parentlevel	String	This field specifies the Parent Organization Hierarchy Level.
parentid	Number	This field specifies the Parent Organization Hierarchy ID.
mgrname	String	This field specifies the name of the store manager.
stockholding	String	This column indicates whether the store can hold stock. In a non-multichannel environment this will always be Y. Value will be populated. This field holds value only for stores.
integratedpos	String	This field Indicates whether or not the POS system at the Store is integrated. This field holds value only for stores.

Elements in JSON Output

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

Example JSON input:

" {
      "action": "UPDATE",
      "hierarchylevel": "AREA",
      "hierarchynodeid": 1212,
      "hierarchynodename": "Area 12121",
      "parentlevel": "CHAIN",
      "parentid": 1212,
      "mgrname": "V",
      "stockholding": null,
      "integratedpos": null
    }
  ],
  "hasMore": true,
  "limit": 1,
  "count": 1,
  "links": [
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/orghier?before=2021-05-11T15%3A20%3A25.711306%2B00%3A00&nodelevel=COMPANY&limit=1&nodeid=9118&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "self"
    },
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/orghier?before=2021-05-11T15%3A20%3A25.711306%2B00%3A00&nodelevel=COMPANY&limit=1&nodeid=9118&offsetkey=AREA%2C1212&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "next"
    }
  ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
V_ICL_RMS_ORGHIER	Yes	No	No	No
ICL_RMS_CHAIN	Yes	Yes	Yes	Yes
ICL_RMS_AREA	Yes	Yes	Yes	Yes
ICL_RMS_REGION	Yes	Yes	Yes	Yes
ICL_RMS_DISTRICT	Yes	Yes	Yes	Yes
ITEM_LOC	Yes	No	No	No
MERCHAPI_ORG_HIER	Yes	Yes	Yes	Yes
V_ORG_HIER_FULL_VW	Yes	No	No	No
V_MERCHAPI_ORG_HIER	Yes	No	No	No

REST Endpoint for Omni Channel/Refresh Date

Endpoint

MerchIntegrations/services/omnichannel/refreshdate

Functional Area

Inventory

Business Overview

This ReST service will be used by Omni Channel Applications to retrieve metadata related to individual Merch Integrations services. This service returns the timestamp when the data cache table was initially loaded or had a complete data refresh. A change in last refresh date for a service end point is an indication for the consuming system that high volume of data will be interfaced and the consumer can choose to use regular delta integration process or switch to flushing earlier interfaced data and load the data freshly.

Service Type

GET

ReST URL

/MerchIntegrations/services/omnichannel/refreshdate?entitytype={entitytype}

Input Parameters

Parameter Name	Required	Data Type	Description
entitytype	No	String	Entity Type. Merchandising Integration Rest Service name.

Output

Name	Data Type	Description
entity	String	This column contains the Merchandising Integration REST Service Name.
refresh_date	String	This column contains the Refresh date of the Merchandising Integration REST Service API.

Elements in JSON Output

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

Example JSON input:

" {
  "items": [
    {
      "entity": "COFutureAvail",
      "refreshdate": "2020-12-17T10:03:12.324664000-06:00"
    }
  ],
  "hasMore": false,
  "limit": 10000,
  "count": 15,
  "links": [
    {
      "href": "http://<hostname>/MerchIntegrations/services/omnichannel/refreshdate?before=2021-05-06T21%3A00%3A34.238393%2B08%3A00&limit=10000&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "self"
    }
  ]
}"

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
V_CACHE_REFRESH_DATE	Yes	No	No	No

REST Endpoint for Omni Channel/Warehouse Details

Endpoint

MerchIntegrations/services/foundation/omnichannel/location/warehouse

Functional Area

Foundation

Business Overview

This service is used by Omni Channel applications to get warehouses and its details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/omnichannel/location/warehouse?since={since}&before={before}&offsetkey={offsetkey}&limit={limit}&nodelevel={nodelevel}&nodeid={nodeId}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
nodelevel	No	String	Node Level Valid Value is WAREHOUSE. If a node level is provided, a node ID should also be provided.
nodeid	No	Number	Node ID Should be a valid store number if nodelevel is defined as WAREHOUSE.
offsetkey	No	String	Offset Key. Valid Value is warehouse id and ware house type.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT and DELETE.
warehouseid	Number	This field uniquely identifies the warehouse.
type	String	This field determine whether the warehouse is physical or virtual.
warehousename	String	This field specifies the name of the warehouse which, along with the warehouse number, identifies the warehouse.
whnamesecondary	String	This field specifies the Secondary name of the warehouse.
contactname	String	This field specifies the name of the contact at this location.
phonenumber	Number	This field specifies the phone number of the contact person at this location.
faxnumber	Number	This field specifies the fax number of the contact person at this location.
email	String	This field contains the email address for the location.
currencycode	String	This field specifies the currency code under which the warehouse operates.
physicalwh	String	This field specifies the number of the physical warehouse that are assigned to the virtual warehouse.
vatregion	Number	This field specifies a unique identifying number for the VAT region where this warehouse is located.
orghiertype	Number	Organization type that will be used in reporting purposes for the warehouse. The type comes from the organizational hierarchy.
orghiervalue	Number	This field specifies a code associated with the specific organizational hierarchy type.
orgentitytype	String	This field specifies whether the warehouse is a legal entity (Importer, Exporter) or a regular warehouse.
channelid	Number	This field specifies the channel to which the virtual warehouse will be assigned.
channelname	String	This field specifies the name of the channel for which the virtual warehouse will be assigned.
address1	String	This field specifies the first line of the address for this location.
address2	String	This field specifies the second line of the address for this location.
address3	String	This field specifies the third line of the address for this location.
city	String	This field specifies the name of the city associated with the address for this location.
State	String	This field specifies the state abbreviation for the address for this location.
Country	String	This field specifies the country where the address exists.
postalcode	String	This field specifies the zip code for the address.

Elements in JSON Output

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

Example JSON input:

" {
    "items": [
        {
            "action": "INSERT",
            "warehouseid": 2,
            "type": "virtual",
            "warehousename": "N. America Central",
            "whnamesecondary": null,
            "contactname": "Sue Glass",
            "phonenumber": "3122222473",
            "faxnumber": null,
            "email": null,
            "currencycode": "USD",
            "physicalwh": 2,
            "vatregion": 1000,
            "orghiertype": null,
            "orghiervalue": null,
            "orgentitytype": "R",
            "channelid": null,
            "channelname": null,
            "address1": "123 Street",
            "address2": "Anytown",
            "address3": null,
            "city": "Anycity",
            "state": "MN",
            "country": "US",
            "postalcode": "50250"        }
    ],
    "hasMore": true,
    "limit": 1,
    "count": 1,
    "links": [
        {
            "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/location/warehouse?before=2021-05-12T20%3A15%3A13.253929%2B05%3A30&limit=1&since=1970-01-01T00%3A00%3A00.001Z ",
            "rel": "self"
        },
        {
            "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/merchhier?before=2021-05-12T21%3A00%3A13.036021%2B05%3A30&limit=1&offsetkey=10%2C1&since=1970-01-01T00%3A00%3A00.001Z ",
            "rel": "next"
        }
    ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ICL_RMS_WH	Yes	No	Yes	Yes
ICL_RMS_ADDR	Yes	No	Yes	Yes
ADDR	Yes	No	No	No
MERCHAPI_WH	Yes	Yes	Yes	Yes
MERCHAPI_ORG_HIER	No	No	Yes	No
V_MERCHAPI_WH	Yes	No	No	No
V_MERCHAPI_WH_JSON	Yes	No	No	No
SYSTEM_OPTIONS	Yes	No	No	No

REST Endpoint for Omnichannel/Related Item

Endpoint

MerchIntegrations/services/foundation/omnichannel/item/relateditem

Functional Area

Foundation

Business Overview

This service is used by Omni Channel applications to get related item details from Merchandising.

Service Types

GET

ReST URL

/MerchIntegrations/services/foundation/omnichannel/item/relateditem?since={since}&before={before}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
nodelevel	No	String	Node Level. Valid Value is STORE.
nodeid	No	BigDecimal	Node ID. Valid Values are Valid stores present in the STORE table.
offsetkey	No	String	Offset Key. Valid Value are Combination of valid Relationship ID and a valid Related Item separated by comma. For example: relid, relitem
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
Action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT and DELETE.
relationshipid	String	This column contains unique identifier for each relationship header.
item	String	This column contains item for which the relationships are defined.
relationshiptype	String	This column describes the type of relationship. Values are configured in code_detail table under code_type IREL.
mandatoryind	String	This column indicates whether the relationship is mandatory.
relateditem	String	This column contains the item ID of the related item.
relateditemaction	String	Related Action for Item details. Valid Values are INSERT, UPDATE, UPSERT and DELETE.
startdate	String	This column contains the start date for a related item. Represents the date from which related item can be used on transactions.
enddate	String	This column contains the end date for a related item. Represents the date until which the related item can be used on transactions. A value of null means that it is effective forever.
priority	BigDecimal	This column contains priority which is applicable only in case of relationship type SUBS. In case of multiple related substitute items, this column could be used (optional) to define relative priority.

Elements in JSON Output

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

Example JSON input:

" {
  "items": [
    {
      "action": "INSERT",
      "relationshipid": 120001,
      "item": "111150001",
      "relationshiptype": "CRSL",
      "mandatoryind": "N",
      "relateditem": "111051290",
      "relateditemaction": "INSERT",
      "startdate": null,
      "enddate": null,
      "priority": null
    }
  ],
  "hasMore": true,
  "limit": 1,
  "count": 1,
  "links": [
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/relateditem?before=2021-05-06T18%3A17%3A30.285106%2B08%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "self"
    },
    {
      "href": "http://localhost:8080/MerchIntegrations/services/foundation/omnichannel/item/relateditem?before=2021-05-06T18%3A17%3A30.285106%2B08%3A00&limit=1&offsetkey=120001%2C111051290&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "next"
    }
  ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ICL_RMS_RELATED_ITEM	Yes	Yes	Yes	Yes
MERCHAPI_RELATED_ITEM	Yes	Yes	Yes	Yes
V_MERCHAPI_RELATED_ITEM_JSON	Yes	No	No	No
V_MERCHAPI_RELATED_ITEM	Yes	Yes	Yes	Yes

REST Endpoint for Omnichannel/Retail Store Details

Endpoint

MerchIntegrations/services/foundation/omnichannel/location/retailstore

Functional Area

Foundation

Business Overview

This service is used by Omni Channel applications to get all or hierarchy level specific stores and its details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/omnichannel/location/retailstore?since={since}&before={before}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
nodelevel	No	String	Node Level. Valid Value are COMPANY, CHAIN, AREA, REGION, DISTRICT, and STORE.
nodeid	No	BigDecimal	Node ID. Valid Values are with respect to nodelevel parameter. These are IDs of a particular node level. For example: If node level is STORE then node is a valid Store ID.
offsetkey	No	String	Offset Key. Valid Value is Store ID.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT and DELETE.
address1	String	This field contains the first line of the store address.
address2	String	This field contains the second line of the store address.
address3	String	This field contains the third line of the store address.
city	String	This field contains the name of the city that is associated with the store address.
contactname	String	This field contains the name of the contact for the store at this address.
country	String	This field contains the country where the store address exists.
currencycode	String	This field contains the currency code under which the store operates.
email	String	This field contains the email address for the location.
integratedpos	String	This field indicates whether or not the POS system at the Store is integrated.
manager	String	This field contains the name of the store manager
phonenumber	String	This field contains the phone number for the store.
postalcode	String	This field contains the zip code for the store address.
sellingsqfeet	Number	This field contains the total square footage of the stores selling area.
state	String	This field contains the state abbreviation for the store address.
stockholding	String	This field indicates whether the store can hold stock. In a non-multichannel environment this will always be Y.
storeid	Number	This field contains the number that uniquely identifies the store.
storename	String	This field contains the name of the store which, along with the store number, identifies the store.
storename10	String	This field contains a ten-character abbreviation of the store name.
totalsqfeet	Number	This column contains the total square footage of the store.
vatregion	Number	This column contains the number of the Value Added Tax region in which this store is located.

Elements in JSON Output

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

Example JSON input:

" {
    "items": [
        {
            "action": "INSERT",
            "storeid": 1111,
            "storename": "Rebuild with refresh N NO ICL Charlotte *",
            "storename10": "Charlotte",
            "manager": "Don Wright",
            "phonenumber": "704-555-2121",
            "faxnumber": null,
            "email": null,
            "totalsqfeet": 64400,
            "sellingsqfeet": 59500,
            "currencycode": "USD",
            "vatregion": 1000,
            "stockholding": "Y",
            "integratedpos": "Y",
            "contactname": "Sue Glass",
            "address1": "123 Street",
            "address2": "Anytown",
            "address3": null,
            "city": "Anycity",
            "state": "MN",
            "country": "US",
            "postalcode": "50250"
        }
    ],
    "hasMore": true,
    "limit": 1,
    "count": 1,
    "links": [
        {
            "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/location/retailstore?before=2021-05-12T17%3A30%3A45.385517%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&since=1970-01-01T00%3A00%3A00.001Z",
            "rel": "self"
        },
        {
            "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/location/retailstore?before=2021-05-12T17%3A30%3A45.385517%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&offsetkey=1111&since=1970-01-01T00%3A00%3A00.001Z",
            "rel": "next"
        }
    ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ICL_RMS_STORE	Yes	Yes	Yes	Yes
ICL_RMS_ADDR	Yes	No	Yes	Yes
ADDR	Yes	No	No	No
STORE	Yes	No	No	No
MERCHAPI_RETAIL_STORE	Yes	Yes	Yes	Yes
MERCHAPI_ORG_HIER	No	No	Yes	No
V_MERCHAPI_RETAIL_STORE_JSON	Yes	No	No	No
SYSTEM_OPTIONS	Yes	No	No	No

REST Endpoint for Omnichannel/Dimension Type details

Endpoint

MerchIntegrations/services/foundation/omnichannel/item/dimensiontype

Functional Area

Foundation

Business Overview

This ReST service will be used by Omni Channel Applications to retrieve Item Dimension Type Details. Dimension Systems are a structure in Oracle Retail Xstore Point of Service for items and supports up to three dimensions of style characteristics, such as color, size, and fabric. Dimension Types are the diff types associated with a style item in Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/omnichannel/item/dimensiontype?since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value are Combination of valid Item and a valid Location separated by comma. For example: item number, location number.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT, DELETE, and NO_CHANGE.
itemaction	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT, DELETE, and NO_CHANGE.
dimensionsystem	Number	This column contains the dimension system. This contains the item, item parent or the item grandparent depending on the item level.
dimension	String	This column contains the dimension. This is the differentiator type of the item.
description	String	This field contains the description of the dimension.
seq	String	This column contains the sequence number of the dimension. Valid values are 1 for Diff 1, 2 for Diff 2 and 3 for Diff 3.

Elements in JSON Output

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

Example JSON input:

"{
  "items": [
    {
      "action": "INSERT",
      "itemaction": null,
      "dimensionsystem": "1000023212",
      "dimension": "C_3815",
      "description": "Smoke Diff Group Clr",
      "seq": 1
    }
  ],
  "hasMore": true,
  "limit": 1,
  "count": 1,
  "links": [
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/dimensiontype?before=2021-05-11T17%3A41%3A38.052402%2B00%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "self"
    },
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/dimensiontype?before=2021-05-11T17%3A41%3A38.052402%2B00%3A00&limit=1&offsetkey=0430.PD.1%2C1%2CC_3815&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "next"
    }
  ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
MERCHAPI_ITEM_DIFF_TYPE	Yes	Yes	Yes	Yes
V_MERCHAPI_ITEM_JSON	Yes	No	No	No
V_MERCHAPI_DIM_TYPE	Yes	No	No	No

REST Endpoint for Omnichannel/Dimension Value details

Endpoint

MerchIntegrations/services/foundation/omnichannel/item/dimensionvalue

Functional Area

Foundation

Business Overview

This ReST service will be used by Omni Channel Applications to retrieve Item Dimension Value Details. Dimension Systems are a structure in Oracle Retail Xstore Point of Service for items and supports up to three dimensions of style characteristics such as color, size, and fabric. Dimension Values are the diff values associated with each dimension within a dimension system (parent item).

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/omnichannel/item/dimensionvalue?since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

Input Parameters

Parameter Name	Required	Data Type	Description
Since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
Before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value are Combination of valid Item and a valid Location separated by comma. For example: item number, location number.
Limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT, DELETE, and NO_CHANGE.
itemaction	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT, DELETE, and NO_CHANGE.
dimensionsystem	String	This column contains the dimension system. This contains the item, item parent or the item grandparent depending on the item level.
dimension	String	This column contains the dimension. This is the differentiator type of the item.
value	String	This column contains the code to uniquely identify a differentiator.
description	String	This field contains the description of the dimension.
displayseq	Number	This field contains the display sequence for the differentiator. This field is used to determine the order in which differentiators should be displayed for a differentiator group.

Elements in JSON Output

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

Example JSON input:

" {
  "items": [
    {
      "action": "INSERT",
      "itemaction": "NO_CHANGE",
      "dimensionsystem": "1000012345",
      "dimension": "C_3815",
      "value": "BLACK_8742",
      "description": "Auto Black BLACK_8742",
      "displayseq": 1
    }
  ],
  "hasMore": true,
  "limit": 1,
  "count": 1,
  "links": [
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/dimensionvalue?before=2021-05-11T17%3A51%3A17.671921%2B00%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "self"
    },
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/dimensionvalue?before=2021-05-11T17%3A51%3A17.671921%2B00%3A00&limit=1&offsetkey=0430.PD.1%2CC_3815%2CBLACK_8742&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "next"
    }
  ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
MERCHAPI_ITEM_DIFF_VALUE	Yes	Yes	Yes	Yes
V_MERCHAPI_ITEM_JSON	Yes	No	No	No
V_MERCHAPI_DIM_VALUE	Yes	No	No	No

REST Endpoint for Omnichannel/Future Inventory

Endpoint

MerchIntegrations/services/inventory/omnichannel/inventory/futureinventory

Functional Area

Inventory

Business Overview

This ReST service will be used by Omni Channel Applications to retrieve Future Inventory aggregated at an item level across customer orderable locations.

Service Type

GET

ReST URL

/MerchIntegrations/services/inventory/omnichannel/inventory/futureinventory?since={since}&before={before&offsetkey={offsetkey}&limit={limit}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value is Item. For example: item
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT and DELETE.
item	String	This column contains a sellable and orderable transaction level item whose future inventory position is described. The item must be backorderable.
onorderquantity	String	This column represents the on-order quantity of an item.
receivedquantity	String	This column represents the received quantity of an item.
backorderquantity	String	This column represents the backorder quantity of an item.

Elements in JSON Output

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

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
MERCHAPI_BOOKMARK	Yes	Yes	Yes	Yes
V_BDI_CO_FUTURE_AVAIL	Yes	No	No	No
MERCHAPI_FUTURE_AVAIL_CO_INV	Yes	Yes	Yes	Yes
V_MERCHAPI_FUTURE_AVAIL_CO_INV	Yes	No	No	No

REST Endpoint for Omnichannel/Item Image

Endpoint

Functional Area

Business Overview

This service is used by Omni Channel applications to get item images and its details from Merchandising.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/omnichannel/item/image?since={since}&before={before}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
nodelevel	No	String	Node Level. Valid Value are STORE or WAREHOUSE.
nodeid	No	BigDecimal	Node ID. Valid Values are Valid stores present in the STORE table or a Valid Warehouse from the WH table. If anodelevel or nodeid is provided, the other should also be provided.
offsetkey	No	String	Offset Key. Valid Value are Combination of valid Item and a valid Image Name separated by comma. For example: item, imageName
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
Action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT and DELETE.
item	String	Unique alphanumeric value that identifies the item.
imagename	String	Description of the differentiator group (for example: Mens Shirt Sizes, Womens Shoe Sizes, Girls Dress Sizes, Shower Gel Scents, Yogurt Flavors, and so on).
imageaddr	String	This field contains the actual path where the file of the image of the item is stored.
imageuri	String	Image URI.
imagedesc	String	This field contains the description associated with the image of the item.
imagetype	String	This field contains the type of the image of the item. Valid values are defined as member of IITD code type.
primaryind	String	This field will indicate whether this record is the primary image of the item or not. Valid values are Y-Yes and N-No only. Default to N value if left blank or set as NULL.
displaypriority	BigDecimal	This field will specify the display sequence order of images associated with the item per priority.

Elements in JSON Output

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

Example JSON input:

" {
  "items": [
    {
      "action": "INSERT",
      "item": "100200042",
      "imagename": "image1",
      "imageaddr": "http://www.oracle.com/",
      "imageuri": "http://www.oracle.com/image1",
      "imagedesc": "image1Desc",
      "imagetype": "T",
      "primaryind": "Y",
      "displaypriority": 1
    }
  ],
  "hasMore": true,
  "limit": 1,
  "count": 1,
  "links": [
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/image?before=2021-05-06T17%3A32%3A13.265046%2B08%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "self"
    },
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/image?before=2021-05-06T17%3A32%3A13.265046%2B08%3A00&limit=1&offsetkey=100200042%2Cimage1&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "next"
    }
  ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
MERCHAPI_BOOKMARK	Yes	Yes	Yes	Yes
ICL_RMS_ITEM_IMAGE	Yes	Yes	Yes	Yes
ITEM_MASTER	Yes	No	No	No
ITEM_IMAGE	Yes	No	No	No
MERCHAPI_ITEM_IMAGE	Yes	Yes	Yes	Yes
V_MERCHAPI_ITEM_IMAGE_JSON	Yes	No	No	No
V_MERCHAPI_ITEM_IMAGE	Yes	No	No	No

REST Endpoint for Omnichannel/Item Initial Price Details

Endpoint

MerchIntegrations/services/foundation/omnichannel/item/initialprice

Functional Area

Foundation

Business Overview

This service is used by Omni Channel applications to get initial price details from Pricing.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/omnichannel/item/initialprice?since={since}&before={before}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
nodelevel	No	String	Node Level. Valid Value are STORE or WAREHOUSE.
nodeid	No	BigDecimal	Node ID. Valid Values are Valid stores present in the STORE table or a Valid Warehouse from the WH table. If a nodelevel or nodeid is provided, the other parameter should also be provided.
offsetkey	No	String	Offset Key. Valid Value are Combination of valid Item and a valid Location separated by comma. For example: item number, location number.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT, DELETE, and NO_CHANGE.
loctype	String	This field specifies type of location in the location field. Valid values are S-Store, W-Warehouse.
location	Number	This field contains numeric identifier of the location in which the item is to be found. This field may contain a store, warehouse.
item	String	This field specifies a unique alphanumeric value that identifies the item.
pricetype	String	This field specifies Price Type. Valid Values are Initial.
price	Number	This field specifies the initial unit retail price in the standard unit of measure for the item/location combination. This field is stored in the local currency.
effective	String	This field specifies the Date on which the unit retail price became or will become active.
source	String	This field specifies the source of the initial unit retail price of each item.
eventid	String	This field specifies the ID of the event.
resetind	String	This field specifies the reset indicator.
clearanceind	String	This field Indicates whether the item is on clearance at the store.

Elements in JSON Output

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

Example JSON input:

" {
  "items": [
    {
      "action": "INSERT",
      "loctype": "S",
      "location": 121,
      "item": "100000104",
      "pricetype": "INITIAL",
      "price": 12.1,
      "effective": null,
      "source": "direct",
      "eventid": null,
      "resetind": null,
      "clearanceind": 0
    }
  ],
  "hasMore": true,
  "limit": 1,
  "count": 1,
  "links": [
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/initialprice?before=2021-05-11T17%3A23%3A22.208547%2B00%3A00&nodelevel=COMPANY&limit=1&nodeid=9118&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "self"
    },
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/initialprice?before=2021-05-11T17%3A23%3A22.208547%2B00%3A00&nodelevel=COMPANY&limit=1&nodeid=9118&offsetkey=S%2C121%2C100000104&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "next"
    }
  ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ICL_RMS_ITEM_LOC	Yes	Yes	Yes	Yes
ITEM_MASTER	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
MERCHAPI_ITEM_LOC	Yes	Yes	Yes	Yes
V_MERCHAPI_ITEM_LOC_JSON	Yes	No	No	No
V_MERCHAPI_INITIAL_ITEM_PRICE	Yes	No	No	No

REST Endpoint for Omnichannel/Item Location Details

Endpoint

MerchIntegrations/services/foundation/omnichannel/item/itemlocation

Functional Area

Foundation

Business Overview

This ReST service will be used by Omni Channel Applications to retrieve Item Location Details. In a VAT environment, this service will also include the VAT details for the item/location. This service supports integration for specific location number or can be used to integrate all item/location combinations.

Service Type

GET

ReST URL

/MerchIntegrations/services/foundation/omnichannel/item/itemlocation?since={since}&before={before}&nodelevel={nodelevel}&nodeid={nodeid}&offsetkey={offsetkey}&limit={limit}

Input Parameter

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
nodelevel	No	String	Node Level. Valid Value are STORE or WAREHOUSE.
nodeid	No	BigDecimal	Node ID. Valid Values are Valid stores present in the STORE table or a Valid Warehouse from the WH table.
offsetkey	No	String	Offset Key. Contains Combination of valid Item and a valid Location separated by comma. For example: item number, location number.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT, DELETE, and NO_CHANGE.
loctype	String	This field specifies type of location in the location field. Valid values are S-Store and W-Warehouse.
location	Number	This field contains a numeric identifier of the location in which the item is to be found. This field may contain a store, warehouse.
item	String	This field specifies a unique alphanumeric value that identifies the item
sellingunitretail	Number	This field specifies the unit retail price in the selling unit of measure for the item/location combination. This field is stored in the local currency.
sellinguom	String	This field specifies the selling unit of measure for an items single-unit retail.
taxableind	String	This field Indicates whether the item is taxable at the store.
localitemdesc	String	This field specifies the selling local description of the item. This field defaults to the item’s description but will be over-ridable. This value will be downloaded to the POS
status	String	This field specifies the Current status of item at the store.
qtykeyoptions	String	This field specifies whether the quantity key on a POS should be used for this item at the location. Valid values are in the code_type RPO. Current values include R - required, P - Prohibited, and O - Optional. Additional values can be added to the code type as needed. This value will be downloaded to the POS as needed.
manualpriceentry	String	This field specifies the price can/should be entered manually on a POS for this item at the location.
foodstampind	String	This field specifies whether the item is approved for food stamps at the location. This value will be downloaded to the POS.
fixedtarevalue	String	This field holds the value associated with the packaging in items sold by weight at the location. Fixed tare is the tare of the packaging used to (that is, if the tare item is bulk candy, this is weight of the bag and twist tie). The only processing Merchandising does involving the fixed tare value is downloading it to the POS. Fixed tare is not subtracted from items sold by weight when sales are uploaded to Merchandising, and so on. This kind of processing is the responsibility of the client and should occur before sales are sent to any Oracle Retail application.
fixedtareuom	String	This field Holds the unit of measure value associated with the tare value. The only processing Merchandising does involving the fixed tare value and UOM is downloading it to the POS. Fixed tare is not subtracted from items sold by weight when sales are uploaded to Merchandising, and so on. This kind of processing is the responsibility of the client and should occur before sales are sent to any Oracle Retail application.
stopsaleind	String	This field specifies whether sale of the item should be stopped immediately at the location (for example, in case of recall). This value will be downloaded to the POS.
returnableind	String	This field will contain a value of Yes when the item can be returned to the location.
backorderind	String	This field will contain a value of Yes when the item can be back-ordered to the location.
merchandiseind	String	This field indicates whether the item is a merchandise item.
clearanceind	String	This field Indicates whether the item is on clearance at the store.
crosssell	String	This field Indicates whether a substitute item exists for the main item.
attacheditem	String	This field Indicates whether Cross/Up Sell items are attached to the main item.
vatcodes	String	This field contains VAT Code information for the item in a JSON array. This does not follow standard JSON structure due to backward compatibility and the quotes character is escaped by a backslash.
localshortdescription	String	Contains the local short description of the item. This field will default to the items short description but will be over-ridable. This value will be downloaded to the POS.
sourcemethod	String	This value will be used to specify how the ad-hoc PO/TSF creation process should source the item/location request. If the value is Warehouse, the process will attempt to fill the request by creating a transfer from the warehouse mentioned in the source_wh field. If this warehouse doesn't have enough inventory to fill the request, a purchase order will be created for the item/location's primary supplier. For warehouses, it is used by Oracle Retail Allocation to determine the valid sources and destinations for warehouse to warehouse allocations.
sourcewarehouse	Number	This value will be used by the ad-hoc PO/Transfer creation process to determine which warehouse to fill the stores request from. It will also be used by the Allocation process to support warehouse to warehouse allocations. A value will be required in this field if the sourcing method is Warehouse.

vatcodes JSON Output

Name	Data Type	Description
code	String	This field contains VAT code that is used to uniquely identify a VAT rate.
date	Date	This filed contains the date on which the VAT rate become active. Format: YYYY-MM-DD

Elements in JSON Output

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

Example JSON input:

" {
    "items": [
        {
            "action": "INSERT",
            "loctype": "S",
            "location": 1111,
            "item": "100750001",
            "sellingunitretail": "132.13",
            "sellinguom": "EA",
            "taxableind": "Y",
            "localitemdesc": "100750001",
            "status": "A",
            "qtykeyoptions": null,
            "manualpriceentry": null,
            "foodstampind": null,
            "fixedtarevalue": null,
            "fixedtareuom": null,
            "stopsaleind": null,
            "returnableind": null,
            "backorderind": null,
            "merchandiseind": "Y",
            "clearanceind": "N",
            "crosssell": "N",
            "attacheditem": "N",
            "vatcodes": "[{\"code\":\"S\",\"date\":\"2020-07-25\"}]", 
            "localshortdescription": "New Component Item",
            "sourcemethod": "W",
            "sourcewarehouse": 10001
        }
    ],
    "hasMore": true,
    "limit": 1,
    "count": 1,
    "links": [
        {
            "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/itemlocation?before=2021-05-03T15%3A50%3A19.189562000%2B00%3A00&nodelevel=COMPANY&limit=2&nodeid=1&offsetkey=S%2C1111%2C100550000%26since%3D1970-01-01T00%3A00%3A00.001Z&since=1970-01-01T00%3A00%3A00.001000000%2B00%3A00",
            "rel": "self"
        },
        {
            "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/itemlocation?before=2021-05-03T15%3A50%3A19.189562000%2B00%3A00&nodelevel=COMPANY&limit=2&nodeid=1&offsetkey=S%2C1151%2C100000067%26since%3D1970-01-01T00%3A00%3A00.001Z&since=1970-01-01T00%3A00%3A00.001000000%2B00%3A00",
            "rel": "next"
        }
    ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ICL_RMS_ITEM_LOC	Yes	Yes	Yes	Yes
ITEM_MASTER	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
MERCHAPI_ITEM_LOC	Yes	Yes	Yes	Yes
V_MERCHAPI_ITEM_LOC_JSON	Yes	No	No	No
V_MERCHAPI_ITEM_LOC	Yes	No	No	No

REST Endpoint for Omnichannel/VAT

Endpoint

MerchIntegrations/services/foundation/omnichannel/vat

Functional Area

Foundation

Business Overview

This service is used by Omni Channel applications to get VAT and its details from Merchandising.

Service Type

GET

ReST URL

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

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value are Combination of valid VAT Region, valid VAT Code and a valid Active Date separated by comma. For example: vatregion, vatcode, activedate
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
action	String	Action for Item details. Valid Values are INSERT, UPDATE, UPSERT and DELETE.
vatregion	BigDecimal	This column contains the unique identifying number for the VAT region in the system.
vatregionname	String	This column contains the name associated with the VAT region.
vatcode	String	This column field contains the alphanumeric identification for the VAT code. Valid values include: S - Standard, C - Composite, Z - Zero, E - Exempt. Other values may also be entered. These are the default VAT Rates that are set up upon installation of Merchandising.
vatcodedesc	String	This column contains a description identifying the VAT code.
activedate	String	This column contains the date on which the VAT rate becomes active.
vatrate	BigDecimal	This column contains the VAT rate associated with a given VAT code.
enddate	String	This column contains the date on which the VAT rate becomes inactive.

Elements in JSON Output

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

Example JSON input:

" {
  "items": [
    {
      "action": "INSERT",
      "vatregion": 1000,
      "vatregionname": "Vat Region 1000",
      "vatcode": "E",
      "vatcodedesc": "Exempt",
      "activedate": "2019-02-10T00:00:00",
      "vatrate": null,
      "enddate": "2019-02-18T00:00:00"
    }
  ],
  "hasMore": true,
  "limit": 1,
  "count": 1,
  "links": [
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/vat?before=2021-05-06T19%3A34%3A38.158110%2B08%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "self"
    },
    {
      "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/vat?before=2021-05-06T19%3A34%3A38.158110%2B08%3A00&limit=1&offsetkey=1000%2CE%2C2019-02-10T00%3A00%3A00&since=1970-01-01T00%3A00%3A00.001Z",
      "rel": "next"
  }"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
VAT_CODES	Yes	No	No	No
VAT_CODE_RATES	Yes	No	No	No
VAT_ITEM	Yes	No	No	No
MERCHAPI_VAT	Yes	Yes	Yes	Yes
V_MERCHAPI_VAT_JSON	Yes	No	No	No
V_MERCHAPI_VAT	Yes	No	No	No

Merchandising ReSTful Web Services

Merchandising Common Services

This section describes the GA account validation service.

Functional Area

Foundation

Business Overview

The primary role of this service is to provide access to cross-functional Merchandising data.

Vdate

Business Overview

Retrieve Merchandising Vdate.

Service Type

Get

ReST URL

/Common/vDate

Input Parameters

NA

Output

Vdate in Long and Date Format

Parameter Name	Data Type
Vdate	Long
Vdate	Date

JSON Structure:

"{
   "vdateDisplay": "01-Jul-2019",
   "vdate": 1561939200000,
   "links": [],
   "hyperMediaContent": {
      "linkRDO": []
   }
}"

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
PERIOD	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Procurement Unit Options

Business Overview

Retrieve Merchandising's Procurement Unit Options.

Service Type

Get

ReST URL

/Common/POSysOps

Input Parameters

NA

Output

ProcurementUnitOptionsRDO

Parameter Name	Data Type
backpostRcaRuaInd	String
calcNegativeIncome	String
copyPoCurrRate	String
costLevel	String
creditMemoLevel	String
dealAgePriority	String
dealLeadDays	BigDecimal
dealTypePriority	String
deptLevelOrders	String
ediCostOverrideInd	String
expiryDelayPreIssue	BigDecimal
genConsignmentInvcFreq	String
genConInvcItmSupLocInd	String
latestShipDays	BigDecimal
ordApprCloseDelay	BigDecimal
ordApprAmtCode	String
ordAutoClosePartRcvdInd	String
ordPartRcvdCloseDelay	BigDecimal
orderBeforeDays	BigDecimal
orderExchInd	String
otbSystemInd	String
rcvCostAdjType	String
reclassApprOrderInd	String
redistFactor	BigDecimal
softContractInd	String
wacRecalcAdjInd	String

JSON Structure

"{
    ""links"": [],
    ""backpostRcaRuaInd"": ""N"",
    ""billToLoc"": ""1000"",
    ""calcNegativeIncome"": ""N"",
    ""copyPoCurrRate"": null,
    ""costLevel"": ""DNN"",
    ""creditMemoLevel"": ""D"",
    ""dealAgePriority"": ""O"",
    ""dealLeadDays"": 1,
    ""dealTypePriority"": ""P"",
    ""deptLevelOrders"": ""N"",
    ""ediCostOverrideInd"": ""Y"",
    ""expiryDelayPreIssue"": 30,
    ""genConsignmentInvcFreq"": ""M"",
    ""genConInvcItmSupLocInd"": ""I"",
    ""latestShipDays"": 30,
    ""ordApprCloseDelay"": 1,
    ""ordApprAmtCode"": ""C"",
    ""ordAutoClosePartRcvdInd"": ""N"",
    ""ordPartRcvdCloseDelay"": 1,
    ""orderBeforeDays"": 5,
    ""orderExchInd"": ""N"",
    ""otbSystemInd"": ""N"",
    ""rcvCostAdjType"": ""F"",
    ""reclassApprOrderInd"": ""Y"",
    ""redistFactor"": 2,
    ""softContractInd"": ""Y"",
    ""wacRecalcAdjInd"": ""N"",
    ""hyperMediaContent"": {
        ""linkRDO"": []
    }
}"

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
PROCUREMENT_UNIT_OPTIONS	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Functional Config Options

Business Overview

Retrieve Merchandising's Functional Config Options.

Service Type

Get

ReST URL

/Common/FuncSysOps

Input Parameters

NA

Output

FunctionalConfigRDO

Parameter Name	Data Type
importInd	String
orgUnitInd	String
supplierSitesInd	String
contractInd	String
elcInd	String

JSON Structure:

"{
    ""links"": [],
    ""importInd"": ""Y"",
    ""orgUnitInd"": ""Y"",
    ""supplierSitesInd"": ""Y"",
    ""contractInd"": ""Y"",
    ""elcInd"": ""Y"",
    ""hyperMediaContent"": {
        ""linkRDO"": []
    }

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
FUNCTIONAL_CONFIG_OPTIONS	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Inventory Movement Unit Options

Business Overview

Retrieve Merchandising's Inventory Movement Unit Options.

Service Type

Get

ReST URL

/Common/InvMovSysOps

Input Parameters

NA

Output

InvMoveUnitOptRDO

Parameter Name	Data Type
allocMethod	String
applyProfPresStock	String
autoRcvStore	String
closeOpenShipDays	BigDecimal
costMoney	BigDecimal
costOutStorage	BigDecimal
costOutStorageMeas	String
costOutStorageUom	String
costWhStorage	BigDecimal
costWhStorageMeas	String
costWhStorageUom	String
defaultAllocChrgInd	String
defaultOrderType	String
defaultSizeProfile	String
deptLevelTransfers	String
distributionRule	String
duplicateReceivingInd	String
increaseTsfQtyInd	String
intercompanyTransferBasis	String
invHistLevel	String
locActivityInd	String
locDlvryInd	String
lookAheadDays	BigDecimal
maxWeeksSupply	BigDecimal
ordWorksheetCleanUpDelay	BigDecimal
racRtvTsfInd	BigDecimal
rejectStoreOrdInd	String
replOrderDays	String
rtvNadLeadTime	BigDecimal
rtvUnitCostInd	BigDecimal
shipRcvStore	String
shipRcvWh	String
storageType	String
storePackCompRcvInd	String
wfDefaultWh	String
targetRoi	BigDecimal
tsfAutoCloseStore	BigDecimal
tsfAutoCloseWh	String
tsfCloseOverdue	String
simForceCloseInd	String
tsfForceCloseInd	String
tsfOverReceiptInd	String
tsfMdStoreToStoreSndRcv	String
tsfMdStoreToWhSndRcv	String
tsfMdWhToStoreSndRcv	String
tsfMdWhToWhSndRcv	String
tsfPriceExceedWacInd	String
ssAutoCloseDays	String
wsAutoCloseDays	BigDecimal
swAutoCloseDays	BigDecimal
wwAutoCloseDays	BigDecimal
wfOrderLeadDays	BigDecimal
whCrossLinkInd	BigDecimal
wrongStReceiptInd	String

JSON Structure:

"{
    ""links"": [],
    ""allocMethod"": ""P"",
    ""applyProfPresStock"": ""N"",
    ""autoRcvStore"": ""Y"",
    ""closeOpenShipDays"": 3,
    ""costMoney"": 7.5,
    ""costOutStorage"": 1.5,
    ""costOutStorageMeas"": ""P"",
    ""costOutStorageUom"": null,
    ""costWhStorage"": 1.5,
    ""costWhStorageMeas"": ""P"",
    ""costWhStorageUom"": null,
    ""defaultAllocChrgInd"": ""Y"",
    ""defaultOrderType"": ""WAVE"",
    ""defaultSizeProfile"": ""N"",
    ""deptLevelTransfers"": ""Y"",
    ""distributionRule"": ""PRORAT"",
    ""duplicateReceivingInd"": ""N"",
    ""increaseTsfQtyInd"": ""N"",
    ""intercompanyTransferBasis"": ""T"",
    ""invHistLevel"": ""A"",
    ""locActivityInd"": ""Y"",
    ""locDlvryInd"": ""Y"",
    ""lookAheadDays"": 7,
    ""maxScalingIterations"": null,
    ""maxWeeksSupply"": 5,
    ""ordWorksheetCleanUpDelay"": 1,
    ""racRtvTsfInd"": ""A"",
    ""rejectStoreOrdInd"": ""N"",
    ""replOrderDays"": 3,
    ""rtvNadLeadTime"": 1,
    ""rtvUnitCostInd"": ""A"",
    ""shipRcvStore"": ""Y"",
    ""shipRcvWh"": ""Y"",
    ""storageType"": ""W"",
    ""storePackCompRcvInd"": ""Y"",
    ""wfDefaultWh"": 1212,
    ""targetRoi"": 7,
    ""tsfAutoCloseStore"": ""Y"",
    ""tsfAutoCloseWh"": ""Y"",
    ""tsfCloseOverdue"": ""Y"",
    ""simForceCloseInd"": ""NL"",
    ""tsfForceCloseInd"": ""SL"",
    ""tsfOverReceiptInd"": ""NL"",
    ""tsfMdStoreToStoreSndRcv"": ""S"",
    ""tsfMdStoreToWhSndRcv"": ""S"",
    ""tsfMdWhToStoreSndRcv"": ""S"",
    ""tsfMdWhToWhSndRcv"": ""S"",
    ""tsfPriceExceedWacInd"": ""Y"",
    ""ssAutoCloseDays"": 1,
    ""wsAutoCloseDays"": 1,
    ""swAutoCloseDays"": 1,
    ""wwAutoCloseDays"": 1,
    ""wfOrderLeadDays"": null,
    ""whCrossLinkInd"": ""Y"",
    ""wrongStReceiptInd"": ""Y"",
    ""hyperMediaContent"": {
        ""linkRDO"": []
    }
}"

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
INV_MOVE_UNIT_OPTIONS	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Currencies

Business Overview

Retrieve Merchandising's Currencies table records.

Service Type

Get

ReST URL

/Common/Currencies

Input Parameters

NA

Output

MblCurrenciesRDO

Parameter Name	Data Type
currencyCode	String
currencyDescription	String
currencyCostFormat	String
currencyRetailFormat	String
currencyCostDecimal	BigDecimal
currencyRetailDecimal	BigDecimal

JSON Structure:

"[
    {
        ""links"": [],
        ""currencyCode"": ""AED"",
        ""currencyDescription"": ""U.A.E. Dirham"",
        ""currencyCostFormat"": ""FM9G999G999G999G990D9099PR"",
        ""currencyRetailFormat"": ""FM9G999G999G999G990D90PR"",
        ""currencyCostDecimal"": 4,
        ""currencyRetailDecimal"": 2,
        ""hyperMediaContent"": {
            ""linkRDO"": []
        }
    },
    {
        ""links"": [],
        ""currencyCode"": ""ALL"",
        ""currencyDescription"": ""UNKNOWN"",
        ""currencyCostFormat"": ""FMD0"",
        ""currencyRetailFormat"": ""FMD90"",
        ""currencyCostDecimal"": 2,
        ""currencyRetailDecimal"": 2,
        ""hyperMediaContent"": {
            ""linkRDO"": []
        }
    },
........"

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
CURRENCIES	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Department Search

Business Overview

This service retrieves departments with ID or name matching search string.

Service Type

Get

ReST URL

/Common/departmentSearch?searchString={searchString}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description	Valid values
searchString	Yes	search string for department Id or Name
PageSize	No	Maximum number of records to retrieve per page
PageNumber	No	Result page to retrieve

Output

MerchHierDeptRDO

Parameter Name	Data Type
department	BigDecimal
departmentName	String

PagedResultsRDO

Parameter Name	Data Type
totalRecordCount	BigDecimal
Next Page URL	String
Previous Page URL	String

JSON Structure:

"{
  “type": “paginationRDO",
  “totalRecordCount": 3512,
  “hyperMediaContent": {},
  “links" : [],
  “results": [{
     “departmentId": 3252,
     “departmentDescription": “some description"
  }]
}"

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_DEPS	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Department Load

Business Overview

This service retrieves departments' name of input IDs.

Service Type

Get

ReST URL

/Common/departmentLoad?departments={departments}

Input Parameters

Parameter Name	Required	Description	Valid values
departments	Yes	Comma separated values for Departments	NA

Output

MerchHierDeptRDO

Parameter Name	Data Type
department	BigDecimal
departmentName	String

JSON Structure:

"{
  "departmentId": 3252,
  "departmentDescription": "some description"
}"

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
V_DEPS	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Allocation Detail Service

This section describes the Allocation Detail service.

Business Overview

Allocation Detail service allows user to retrieve Allocation information for a selected allocation number.

Service Type

Get

ReST URL

Alloc/allocDetail?allocNumber={allocationNumber}

Input Parameters

Parameter Name	Required	Description
allocNumber	Yes	Allocation Number

Output

RestAllocRecRDO

Parameter Name	Data Type
alloc_no	BigDecimal
order_no	BigDecimal
wh	BigDecimal
item	String
status	String
alloc_desc	String
po_type	String
alloc_method	String
release_date	Date
order_type	String
doc	String
doc_type	String
origin_ind	String
close_date	Date
alloc_detail	List<RestAllocDetailRecRDO>

RestAllocDetailRecRDO

Parameter Name	Data Type
to_loc	BigDecimal
to_loc_type	String
qty_transferred	BigDecimal
qty_allocated	BigDecimal
qty_prescaled	BigDecimal
qty_distro	BigDecimal
qty_selected	BigDecimal
qty_cancelled	BigDecimal
qty_received	BigDecimal
qty_reconciled	BigDecimal
po_rcvd_qty	BigDecimal
non_scale_ind	String
in_store_date	Date
wf_order_no	BigDecimal
rush_flag	String

JSON Structure:
 [
    {
        "docType": null,
        "allocDetail": [
            {
                "qtyTransferred": null,
                "rushFlag": null,
                "wfOrderNo": null,
                "inStoreDate": null,
                "qtyAllocated": null,
                "nonScaleInd": null,
                "toLoc": null,
                "qtyPrescaled": null,
                "toLocType": null,
                "qtyDistro": null,
                "qtySelected": null,
                "qtyReceived": null,
                "qtyCancelled": null,
                "qtyReconciled": null,
                "poRcvdQty": null,
                "links": [],
                "hyperMediaContent": {
                    "linkRDO": []
                }
            }
        ],
        "doc": null,
        "originInd": null,
        "allocNo": null,
        "wh": null,
        "allocMethod": null,
        "allocDesc": null,
        "poType": null,
        "item": null,
        "status": null,
        "orderNo": null,
        "orderType": null,
        "releaseDate": null,
        "closeDate": null,
        "links": [],
        "hyperMediaContent": {
            "linkRDO": []
        }
    }
]

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALLOC_HEADER	Yes	No	No	No
ALLOC_DETAIL	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Get Next Allocation Number Service

Business Overview

This service retrieves the next allocation number from Merchandising.

Service Type

GET

ReST URL

/Alloc/allocNo

Input Payload Details

No input

Output

Parameter Name	Data Type
allocNo	Long

JSON Structure:

{
  "allocNo": 1009403
}

Table Impact

N/A

Allocation Publish Services

Endpoint

MerchIntegrations/services/inventory/allocation
MerchIntegrations/services/inventory/allocation/{allocNo}

Functional Area

Inventory – Allocations

Business Overview

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

Service Type

GET

ReST URL

/MerchIntegrations/services/inventory/allocation? since={since}&before={before}&offsetkey={offsetkey}&limit={limit}

Input Parameters

Parameter Name	Required	Data Type	Description
since	No	String	Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
before	No	String	Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm
offsetkey	No	String	Offset Key. Valid Value is warehouse id and ware house type.
limit	No	BigDecimal	Pagination limit. Default Value is 1000.

Output

Name	Data Type	Description
action	String	Action for Allocation details. Valid Values are INSERT, UPDATE and DELETE.
allocNo	Number	This field specifies the number that uniquely identifies the allocation within the system.
docType	String	This field specifies type that is source for allocation.
physicalWarehouse	Number	This field specifies number that is used to identify physical warehouse for virtual warehouse.
warehouse	Number	This field specifies number which uniquely identifies the warehouse.
item	String	This field specifies unique alphanumeric value that identifies the item.
pickNotBeforeDate	String	This field specifies first date on which the allocation should be released from the warehouse for delivery to the store locations.
pickNotAfterDate	String	This field specifies last date on which the allocation should be released from the warehouse for delivery to the store locations.
orderType	String	This field specifies identifies the type of the order. Allocations created against Purchase Orders will be marked as PREDIST order types. Allocations created against Warehouse stock will be populated with the DEFAULT_ORDER_TYPE from the SYSTEM_OPTIONS table which can be AUTOMATIC, MANUAL or WAVE.
orderNo	Number	This field specifies order number to which the allocation applies.
orderDocType	String	This field specifies order type and defaulted to ‘P’.
priority	Number	This field specifies the priority of an allocation. This field is defaulted to 1.
ticketTypeId	String	This field uniquely identifies the ticket type which is associated with the item.
contextType	String	This field specifies functional area code to which the transfer relates to, for example, Promotions. Valid values are: PROM - Promotion.
contextValue	String	This field specifies value relating to the context type, for example, Promotion Number.
allocStatus	String	This field specifies status of the allocation.
createDateTime	String	This column holds the record creation date.
updateDateTime	String	This column holds the date when the record was last updated.
details		This list holds detail records for the allocation.
cacheTimestamp	String	This field specifies date and time when allocation record was last maintained.

Table 5-2 details

Name	Data Type	Description
physicaltoLocation	Number	This field specifies physical warehouse of virtual warehouse, provide to location is a warehouse.
toLocation	Number	This field specfies location to which the allocation is being sent.
locationType	String	This field specfies type of location in the location field. Valid values are Store and Warehouse.
storeType	String	This field specfies if the store is company or franchise store and not populated in case of warehouse.
stockholdingInd	String	This field specfies indicates whether the store can hold stock. In a non-multichannel environment, field is defaulted to Y.Not populated in case of warehouse.
quantityAllocated	Number	This column contains the total number of items allocated.
price	Number	This field specifies unit retail price in the selling unit retail.
sellingUom	String	This field specifies selling unit of measure for an item.
priority	Number	This field specifies the priority of an allocation details. This field is defaulted to 1.
storeOrderMultiple	String	This field contains the multiple in which the item needs to be shipped from a warehouse to the location.
inStoreDate	String	This field contains the date to be included in the publication to communication for warehouse.
rushFlag	String	This field contains rush flag indicator to be included in the publication to communication for warehouse.
createDateTime	String	This field holds the record creation date.
updateDateTime	String	This field holds the date when the record was last updated.
detailsTicket		This List holds attributes for details of allocation details ticket record.

Table 5-3 detailsTicket

Name	Data Type	Description
componentItem	String	This field specifies Alphanumeric value that identifies the component item within the pack.
componentPrice	Number	This field specifies unit retail price in the selling unit retail of the component item within the pack.
componentSellingUom	String	This field specifies selling unit of measure for an component item within the pack.

Table 5-4 Elements in JSON Output

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

Example JSON input:

" {
  "items": [
    {
      "action": "INSERT",
      "allocNo": 5002,
      "docType": "A",
      "physicalWarehouse": 440,
      "warehouse": 441,
      "item": "100500002",
      "pickNotBeforeDate": "2022-02-16",
      "pickNotAfterDate": "2022-03-18",
      "orderType": "AUTOMATIC",
      "orderNo": null,
      "orderDocType": "P",
      "priority": 1,
      "ticketTypeId": null,
      "contextType": null,
      "contextValue": null,
      "allocStatus": "A",
      "createDateTime": "2022-02-16T19:06:31.000Z",
      "updateDateTime": "2022-02-16T19:06:31.000Z",
      "details": [
        {
          "physicaltoLocation": 8811,
          "toLocation": 8811,
          "locationType": "S",
          "storeType": "C",
          "stockholdingInd": "Y",
          "quantityAllocated": 1,
          "price": 12.22,
          "sellingUom": "EA",
          "priority": 1,
          "storeOrderMultiple": "E",
          "inStoreDate": "2022-02-17",
          "rushFlag": null,
          "createDateTime": "2022-02-16T19:06:31.000Z",
          "updateDateTime": "2022-02-16T19:06:31.000Z",
          "detailsTicket": null
        }
      ],
      "cacheTimestamp": "2022-04-06T11:36:30.809Z"
    },
    {
      "action": "INSERT",
      "allocNo": 5003,
      "docType": "A",
      "physicalWarehouse": 440,
      "warehouse": 441,
      "item": "100500002",
      "pickNotBeforeDate": "2022-02-16",
      "pickNotAfterDate": "2022-03-18",
      "orderType": "AUTOMATIC",
      "orderNo": null,
      "orderDocType": "P",
      "priority": 1,
      "ticketTypeId": null,
      "contextType": null,
      "contextValue": null,
      "allocStatus": "A",
      "createDateTime": "2022-02-16T19:27:43.000Z",
      "updateDateTime": "2022-02-16T19:27:43.000Z",
      "details": [
        {
          "physicaltoLocation": 1515,
          "toLocation": 1515,
          "locationType": "S",
          "storeType": "C",
          "stockholdingInd": "Y",
          "quantityAllocated": 1,
          "price": 12.22,
          "sellingUom": "EA",
          "priority": 1,
          "storeOrderMultiple": "E",
          "inStoreDate": "2022-02-17",
          "rushFlag": null,
          "createDateTime": "2022-02-16T19:27:43.000Z",
          "updateDateTime": "2022-02-16T19:27:43.000Z",
          "detailsTicket": null
        }
      ],
      "cacheTimestamp": "2022-04-06T11:36:31.628Z"
    }
  ],
  "hasMore": true,
  "limit": 2,
  "count": 2,
  "links": [
    {
      "href": "https://rex.retail.us-phoenix-1.ocs.oc-test.com/rgbu-rex-rgbu-stg83-mfcs/MerchIntegrations/services/inventory/allocation?limit=2&since=1970-01-01T00:00:00.001Z&before=2022-04-08T12:19:48.608912+00:00",
      "rel": "self"
    },
    {
      "href": "https://rex.retail.us-phoenix-1.ocs.oc-test.com/rgbu-rex-rgbu-stg83-mfcs/MerchIntegrations/services/inventory/allocation?offsetkey=5003&limit=2&since=1970-01-01T00:00:00.001Z&before=2022-04-08T12:19:48.608912+00:00",
      "rel": "next"
    }
  ]
}"

Table Impact

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

TABLE	SELECT	INSERT	UPDATE	DELETE
MERCHAPI_CONFIG	Yes	No	No	No
MERCHAPI_CONSUMER_CONFIG	Yes	No	No	No
MERCHAPI_ASYNC_REQUEST	Yes	No	No	No
MERCH_BATCH_PARAM	Yes	No	No	No
ICL_RMS_ALLOC	Yes	No	Yes	Yes
MERCHAPI_EXT_ALLOC	Yes	Yes	Yes	No
V_MERCHAPI_EXT_ALLOC_JSON	Yes	No	No	No
SYSTEM_OPTIONS	Yes	No	No	No

Background Process Configuration

This section describes the Background Process Configuration.

Business Overview

This service is used to update the configuration for each background jobs in Merchandising.

Service Type

Post

ReST URL

processes/update/process_config/execution

Input Parameters

Parameter Name	Required	Description
JobName	Yes	Job Name
numThreads	No	Maximum number of threads the job will execute
numDataToProcess	No	Number of records a jobs will process each run.
commitMaxCtr	No	Max number of records processed before a commit is issued.
archiveInd	No	This field will be used to determine if associated tables for this job needs to be archived to history or not.

Output

NA

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
B8D_PROCESS_CONFIG	No	No	Yes	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Book Transfer ReSTful Web Service

This section describes the Book Transfer ReSTful Web Service

Functional Area

Transfer and Customer Order

Business Overview

This web service will be built to virtually move inventory from one location to the other for the purposes of attributing the sale to a location different from the location that is fulfilling the order physically. For example, if the order is being fulfilled via shipment from a physical store, some retailers will want to actually have the sale processed against the e-commerce store. This service also accept a customer order number and fulfillment order number to be associated with the transfer when it is created as a cross reference.

Service Type

Post

ReST URL

/Transfer/customerOrderBookTransfer

Input Parameters

The Book Transfer web service has the following parameters:

Parameter Name	Required	Data Type	Description
FromLocation	Yes	BigDecimal	Transfer source location
ToLocation	Yes	BigDecimal	Transfer destination
CustomerOrderNumber	No	String	Customer order identification
FulfillOrderNumber	No	String	Fulfillment order identification
UpdateCustomerReservedQty	No	String	Indicates if any of the customer reserved quantity should be update either the source or destination location or both. Valid values: B update both the source and destination location S update only the source location R update only the destination location N or NULL no update
ItemsDetail	Yes		Collection of itemsDetail RDO
ApprovalDate	No	Date	Approval date of the transfer (Format: ‘DD-MON-YYYY’)

ItemDetail RDO

The Book Transfer web service has the following parameters:

Parameter Name	Required	Data Type	Description
Item	Yes	String	Item identification
Quantity	Yes	BigDecimal	Item quantity to be transferred

Example JSON Input

[
     {
     "toLocation":null,
     "fromLocation":null,
     "customerOrderNumber":null,
     "fulfillOrderNumber":null,
     "updateCustomerReservedQty":null,
     "itemsDetail":[
         {
             "item":null,
             "quantity":null
         },
         {
             "item":null,
             "quantity":null
         },
         {
             "item":null,
             "quantity":null
         }
         ],
     "approvalDate":null
     },
     {
     "fromLocation":null,
     "toLocation":null,
     "customerOrderNumber":null,
     "fulfillOrderNumber":null,
     "updateCustomerReservedQty":null,
     "itemsDetail":[
         {
             "item":null,
             "quantity":null
         }
         ],
     "approvalDate":null
     }
 ]

Output

RestCobtsfStatuRDO

Parameter Name	Data Type
successCobtsfCount	Big Decimal
successCobtsfTbl	List< successCobtsfRDO>
failCobtsfCount	BigDecimal
failCobtsfTable	List<failCobtsfRDO>

SuccessCobtsfRDO

Parameter Name	Data Type
FromLocation	Big Decimal
ToLocation	Big Decimal
TransferNumber	BigDecimal

FailCobtsfRDO

Parameter Name	Data Type
FromLocation	Big Decimal
ToLocation	Big Decimal
errorMessage	BigDecimal

JSON Structure

{
    "successCobtsfCount": 2,
    "successCobtsfTable": [
        {
            "fromLocation ": 123,
            "toLocation ": 987,
            "transferNumber ": 123456789
            "links": [],
            "hyperMediaContent": {
                "linkRDO": []
            }
        },
        {
            "fromLocation ": 456,
            "toLocation ": 654,
            "transferNumber ": 987654321
            "links": [],
            "hyperMediaContent": {
                "linkRDO": []
            }
        }
],
    "failCobtsfCount": 1,
    "failCobtsfTable": [
        {
            "orderNumber": 123,
            "errorMessage": "Invalid Item.",
            "links": [],
            "hyperMediaContent": {
                "linkRDO": []
            }
        }
    ],
    "links": [],
    "hyperMediaContent": {
        "linkRDO": []
    }
}

Table Impact

The following tables are affected:

TABLE	SELECT	INSERT	UPDATE	DELETE
CURRENCIES	Yes	No	No	No
DEPS	Yes	No	No	No
ITEM_LOC	Yes	Yes	No	No
ITEM_LOC_SOH	Yes	Yes	Yes	No
ITEM_MASTER	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
MONTH_DATA	Yes	No	No	No
MV_CURRENCY_CONVERSION_RATES	Yes	No	No	No
ORDCUST	Yes	Yes	No	No
STORE	Yes	No	No	No
TRAN_DATA	No	Yes	No	No
TSFDETAIL	No	Yes	No	No
TSFHEAD	No	No	No	No
UOM_CLASS	Yes	No	No	No
V_PACKSKU_QTY	Yes	No	No	No
WEEK_DATA	Yes	No	No	No
WH	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Cancel Fulfillment Order

Functional Area

Customer Orders

Business Overview

This service can be used to cancel an existing Customer Order or Transfer within Merchandising based on cancellation requests from an external Order Management System.

Service Type

PUT

ReST URL

MerchIntegrations/services/customerOrders/fulfillmentOrder/cancel

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

Table 5-5 Cancel - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	It's a referenced element. For detailed description, please refer referenced element doc.

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

Element Name	Required	Data Type	Description
customerOrderNo	Yes	String (48)	Holds the master customer order number from OMS.
fulfillOrderNo	Yes	String (48)	Unique number from OMS related to the fulfillment details. One or more fulfillment orders could relate back to a single customer order in OMS.
sourceLocationType	No	String (2)	This would be either 'SU' for supplier, 'ST' for store, or 'WH' for warehouse. This would only be populated for vendor, warehouse or multi-site fulfillment orders.
sourceLocation	No	Number (10)	Indicates the supplier, store or warehouse number associated with sourcing the customer order. Only populated for vendor, warehouse or multi-site fulfillment orders.
fulfillLocationType	No	String (1)	This would be either 'S' (for physical store) or 'V' (for virtual store).
fulfillLocation	Yes	Number (10)	Indicates the store or warehouse number associated with fulfilling the customer order. For this release, this should always be populated with a virtual or physical store number.
details	Yes	Collection of Object	Indicates the customer order fulfillment cancellation detail.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	Indicates the item ordered by the customer.
referenceItem	No	String (25)	Indicates the reference item ordered by the customer. Used only if a specific UPC is ordered. This is supported for vendor drop-ships orders only as we don't support transfer requests for a specific reference item.
cancelQuantityInSuom	Yes	Number (12,4)	Indicates the quantity that should be cancelled from the order in item's standard unit of measure.
standardUom	No	String (4)	Indicates item's standard unit of measure.
transactionUom	No	String (4)	Indicates the original transaction unit of measure the order is placed in.
itemLineNo	No	Number (10)	Indicates the detail item line number on the order.

Sample Input Message

{
  "items": [
    {
      "customerOrderNo": "123124",
      "fulfillOrderNo": "123124",
      "sourceLocationType": "SU",
      "sourceLocation": 2400,
      "fulfillLocationType": "S",
      "fulfillLocation": 1521,
      "details": [
        {
          "item": "100100068",
          "referenceItem": "String",
          "cancelQuantityInSuom": 3,
          "standardUom": "EA",
          "transactionUom": "EA",
          "itemLineNo": 1
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Close Allocations

Functional Area

Inventory - Transfers and Allocations

Business Overview

This service can be used to close allocations within Merchandising from an external system. After successfully validating the information in the message, the header level record is updated to the Closed (C) status.

Service Type

PUT

ReST URL

MerchIntegrations/services/inventory/allocations/close

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

Table 5-8 Close - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	References a collection of allocations.

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

Element Name	Required	Data Type	Description
allocationNo	Yes	Number (10)	Contains the unique identifier of the allocation. This should fall within the range of Merchandising IDs already designated for allocations.

Sample Input Message

{
  "items": [
    {
      "allocationNo": 102881222
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Code Detail Service

Business Overview

Code Detail service allows user to retrieve code details for a selected code and code type.

Service Type

GET

ReST URL

CodeDetail/codeDetails?code={ }&codeType={ }

Input Parameters

Parameter Name	Required	Description	Valid values
Code	Yes	Code	NA
Code Type	Yes	Code Type	NA

Output

RestCodeDetailRecRDO

Parameter Name	Data Type
codeDesc	String
requiredInd	String
codeSeq	BigDecimal
codeType	String
codeTypeDesc	String
code	String

JSON Structure

    {
        "codeDesc": null,
        "requiredInd": null,
        "codeSeq": null,
        "codeType": null,
        "codeTypeDesc": null,
        "code": null,
        "links": [],
        "hyperMediaContent": {
            "linkRDO": []
        }
    }

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
CODE_HEAD	Yes	No	No	No
CODE_DETAIL	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Create Allocation Details

Functional Area

Inventory - Transfers and Allocations

Business Overview

This service can be used to create detail level records for one or more allocations within Merchandising from an external application. This would add new destination locations to the items that are already present in existing allocations.

Service Type

POST

ReST URL

MerchIntegrations/services/inventory/allocation/details/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	References a collection of allocations.

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

Element Name	Required	Data Type	Description
allocationNo	Yes	Number (10)	Contains the unique identifier of the allocation. This should fall within the range of Merchandising IDs already designated for allocations.
allocationDescription	Yes	String (300)	Contains the user defined description of the allocation.
orderNo	No	Number (12)	Contains the purchase order with which the allocation is associated. Only used if the source for the allocation is a purchase order.
item	Yes	String (25)	Contains the transaction level item that is being allocated.
fromLocation	Yes	Number (10)	Contains the location that is the source of the allocation. This must be a valid stockholding virtual warehouse.
documentNo	No	String (30)	Contains identification number for a transfer, another allocation, bill of landing number (BOL), or advanced shipping notice (ASN) number for a purchase order. This field is populated according to documentation type and indicates where the inventory for the allocation should be sourced. This should be null if the source for the allocation is warehouse inventory or a purchase order.
documentType	No	String (5)	Contains the type of allocation product source. Valid values are ASN, Transfer (TSF), Bill of Lading (BOL), or Allocation (ALLOC). When this is passed in as null, the source is assumed to be a PO or warehouse inventory if not PO number provided.
details	No	Collection of Object	References a collection of allocation details.

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

Element Name	Required	Data Type	Description
toLocation	Yes	Number (10)	Contains the destination location of the allocation. This must be an active stockholding store or virtual warehouse.
toLocationType	Yes	String (1)	Contains the type of the destination location. Valid values are S (store) and W (warehouse).
quantityAllocated	Yes	Number (12,4)	Contains the allocated quantity of the item for the destination location. When the allocation is being created this value must be a positive integer. If this value is being modified, it will contain the quantity adjusted (positive or negative), rather than an override value.
inStoreDate	No	date	Contains the date the item is to be in store. This date will be included in the Merchandising publication for communication to the warehouse.

Sample Input Message

{
  "items": [
    {
      "allocationNo": 102881222,
      "allocationDescription": "Allocation to 1311.",
      "orderNo": 585036,
      "item": "2147483647",
      "fromLocation": 10001,
      "documentNo": null,
      "documentType": null,
      "details": [
        {
          "toLocation": 6000,
          "toLocationType": "S",
          "quantityAllocated": 3,
          "inStoreDate": "2001-12-31"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Create Allocations

Functional Area

Inventory - Transfers and Allocations

Business Overview

This service can be used to create allocations within Merchandising from an external system. Allocations created or updated using this API include those that are based on warehouse inventory, as well as those using inventory from another transaction such as a purchase order, another allocation, a transfer, or a shipment (Vendor ASN or BOL). When allocating using something other than warehouse inventory, the ID of the transaction must also be included as part of the message.

Allocations can involve both stockholding and non-stockholding locations. This includes the ability to process allocations to both stockholding and non-stockholding company and franchise stores, as well as any stockholding warehouse locations, except internal finishers. If an allocation for a franchise store is received, Merchandising will also create a corresponding franchise order. This API supports multiple types of destination locations (warehouses as well as stores) as part of the detail section within the same message.

The Oracle Retail Allocation Cloud Service does not use this API to interface allocations to Merchandising.

Service Type

POST

ReST URL

MerchIntegrations/services/inventory/allocations/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	References a collection of allocations.

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

Element Name	Required	Data Type	Description
allocationNo	Yes	Number (10)	Contains the unique identifier of the allocation. This should fall within the range of Merchandising IDs already designated for allocations.
allocationDescription	Yes	String (300)	Contains the user defined description of the allocation.
orderNo	No	Number (12)	Contains the purchase order with which the allocation is associated. Only used if the source for the allocation is a purchase order.
item	Yes	String (25)	Contains the transaction level item that is being allocated.
fromLocation	Yes	Number (10)	Contains the location that is the source of the allocation. This must be a valid stockholding virtual warehouse.
releaseDate	No	date	Contains the earliest date on which the warehouse should ship the allocation.
originInd	No	String (6)	Indicates the source application that sends the allocation. Valid values are 'AIP' and 'EG'. It will be defaulted to 'EG' in Merchandising if not defined.
documentNo	No	String (30)	Contains identification number for a transfer, another allocation, bill of landing number (BOL), or advanced shipping notice (ASN) number for a purchase order. This field is populated according to documentation type and indicates where the inventory for the allocation should be sourced. This should be null if the source for the allocation is warehouse inventory or a purchase order.
documentType	No	String (5)	Contains the type of allocation product source. Valid values are ASN, Transfer (TSF), Bill of Lading (BOL), or Allocation (ALLOC). When this is passed in as null, the source is assumed to be a PO or warehouse inventory if not PO number provided.
contextType	No	String (6)	Contains the functional area code to which the allocation relates to. Valid codes are defined in the CNTX code type. Examples are Promotion, Repairing.
contextValue	No	String (25)	Contains the value relating to the context type. Example: Promotion Number.
details	No	Collection of Object	References a collection of allocation details

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

Element Name	Required	Data Type	Description
toLocation	Yes	Number (10)	Contains the destination location of the allocation. This must be an active stockholding store or virtual warehouse.
toLocationType	Yes	String (1)	Contains the type of the destination location. Valid values are S (store) and W (warehouse).
quantityAllocated	Yes	Number (12,4)	Contains the allocated quantity of the item for the destination location. When the allocation is being created this value must be a positive integer. If this value is being modified, it will contain the quantity adjusted (positive or negative), rather than an override value.
inStoreDate	No	date	Contains the date the item is to be in store. This date will be included in the Merchandising publication for communication to the warehouse.

Sample Input Message

{
  "items": [
    {
      "allocationNo": 102881222,
      "allocationDescription": "Allocation to 1311.",
      "orderNo": 585036,
      "item": "2147483647",
      "fromLocation": 10001,
      "releaseDate": "2001-12-31",
      "originInd": "EG",
      "documentNo": null,
      "documentType": null,
      "contextType": "PROM",
      "contextValue": "79890",
      "details": [
        {
          "toLocation": 6000,
          "toLocationType": "S",
          "quantityAllocated": 3,
          "inStoreDate": "2001-12-31"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Create Appointment

Functional Area

Inventory - Appointments

Business Overview

This service can be used to create a new appointment in Merchandising. An appointment is sent to Merchandising when merchandise is about to arrive at a location. After performing the business level validations, appointments will be created through this message in the Scheduled status.

Service Type

POST

ReST URL

MerchIntegrations/services/inventory/appointments/create

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
location	Yes	Number (10)	This field contains the location where the merchandise has been sent.
appointmentNo	Yes	Number (9)	This field contains the unique number generated by warehouse while creating an appointment.
action	Yes	String (2)	The status of the Appointment. Valid values include: SC - Scheduled, MS - Modified Scheduled, AR - Arrived, AC - Closed.
details	No	Collection of Object	References a collection of appointment details.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	This field contains the items shipped to the location.
unitQuantity	Yes	Number (12,4)	This field contains the quantity of the item slated to be sent to the location.
documentNo	Yes	Number (12)	This field contains the purchase order, transfer or allocation corresponding to the shipped merchandise.
documentType	Yes	String (1)	This field indicates the type of document corresponding to the shipped merchandise. Possible choices are Purchase Order (P), Transfer (T), or Allocation (A).
asnNo	No	String (30)	This field contains the advance shipping notice number associated with the appointment. It is populated only when the appointment is based on an ASN.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "location": 2,
      "appointmentNo": 200911,
      "action": "SC",
      "details": [
        {
          "item": "101200001",
          "unitQuantity": 3,
          "documentNo": 100000135000,
          "documentType": "T",
          "asnNo": null
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Class

Functional Area

Merchandise Hierarchy

Business Overview

The merchandise hierarchy allows the retailer to create the relationships that are necessary to support the product management structure of a company. This hierarchy reflects a classification of merchandise into multi-level descriptive categorizations to facilitate the planning, tracking, reporting, and management of merchandise within the company. This service may be used to create the class element of the merchandise hierarchy based on an external system if Merchandising is not the system of record for merchandise hierarchy information.

The merchandise hierarchy must be created from the highest-level down. This means a department is associated with a group; a class is associated with a department; and a subclass is associated with department/class combination because classes are not unique across departments.

When a new class is created, this service will first validate that all the required fields are present in the request payload. Business level validation on the input information will be performed, which checks whether the class already exists. If the class does not exist, the class is created. Active custom flex attributes that are associated with a class can also be created through this service.

Service Type

POST

ReST URL

MerchIntegrations/services/merchandiseHierarchy/class/create

Input Payload Details

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

Element Name	Required	Data Type	Description
class	Yes	Number (4)	The unique number of the class. This field cannot be modified.
className	Yes	String (120)	The name of the class.
dept	Yes	Number (4)	The number of the department which contains the class. This value must be predefined on the DEPS table. This value cannot be modified.
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes.

Table 5-20 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.

Sample Input Message

{
  "class": 1,
  "className": "className",
  "dept": 3041,
  "customFlexAttribute": [
    {
      "name": "REVIEW_DATE",
      "value": null,
      "valueDate": "2001-12-31"
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Cost Change Effective Immediately

Functional Area

Cost - Cost Changes

Business Overview

This service allows external systems to update unit costs within Merchandising. All cost changes that are sent through this service are executed immediately. This service creates both the cost change events with an effective date of the current date, as well as updates unit costs for item/locations that already exist in Merchandising. It does not create or delete item/location relationships in Merchandising. Cost changes can be performed at the item level, or at the following levels of the organization hierarchy - chain, area, region, district or store. Unit costs are updated for all stores within the location group. Warehouses are only impacted by cost changes applied at the warehouse level, since they are not part of the organization hierarchy.

The service takes in a collection of cost changes and will return success and failure through the service response object. This service validates that all the required fields are provided and also checks the supplier's currency and the item status. In case differentiator IDs are passed in the message, it verifies that they are valid for the provided item. The service also retrieves the following:

• Transaction level items, if the passed in item is an item parent.

• All locations based on the passed in hierarchy type and value, if provided.

• All item/location combinations where the passed in supplier/country is the primary supplier/country at an item location.

• All orderable buyer packs that the passed-in item or its children, if above transaction level.

• All item/locations on approved (and worksheet) order, if the recalculate order indicator is set to Yes.

This service performs the following actions:

• Creates a cost change event in the ‘Executed’ status, with the current date set as the effective date.

• Updates the unit cost in Merchandising for all item/supplier/country and item/supplier/country/locations based on the information provided.

• Creates price history records for all item/locations that get updated as part of the cost change.

• If the recalculate order indicator is set to Yes, it updates all relevant order/item/locations unit cost in Merchandising.

It is important to note that cost changes sent through this service do not include estimated landed costs. The cost updated here is the default purchase cost, before any deals, that will be used for purchase orders created in Merchandising, similar to cost changes initiated in Merchandising.

Service Type

POST

ReST URL

MerchIntegrations/services/cost/costChange/immediate/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	It's a referenced element. For detailed description, please refer referenced element doc.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	The item to which the cost change applies. It can be a parent item, but its item level cannot be greater than its transaction level. This cannot be a buyer pack.
supplier	Yes	Number (10)	The ID of the supplier that sources the items the cost change affects. This value must be predefined on the SUPS table. This can be a primary or non-primary supplier.
originCountry	Yes	String (3)	The identifier of the origin country of the item supplier to which the cost change will apply. This value must be predefined on the COUNTRIES table. This can be the primary or a non-primary country.
diffId	No	String (10)	The identifier for a differentiator. This can be used with a parent or grandparent item. The cost change will explode to all the parent's transaction level items with the differentiator. This value must be predefined on the DIFF_IDS table.
unitCost	Yes	Number (20,4)	The new unit cost of the item in the currency specified on the message. Tables item_supp_country_loc, item_loc_soh, and ordloc will also be updated with this value, depending on the values in tags hier_level and hier_value.
recalculateOrderInd	Yes	String (1)	This field will indicate if orders in approved status for items on the cost change will be recalculated with the new cost. Valid values will be Y (yes) and N (no).
currencyCode	Yes	String (3)	The currency code of the unit cost. This value must be predefined on the currencies table and must be the currency of the supplier.
hierarchyLevel	No	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), S (store), W (warehouse).
details	No	Collection of Object	References a collection of hierarchy details
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes.
purchaseRate	No	Number (12,4)	This column contains the percentage of the retail price which will determine the cost paid to the supplier for a consignment or concession item.

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

Element Name	Required	Data Type	Description
hierarchyValue	Yes	Number (10)	The ID of the specified hierarchy level which encompasses the locations affected by the cost change.

Table 5-24 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.

Sample Input Message

{
  "items": [
    {
      "item": "100900006",
      "supplier": 2400,
      "originCountry": "US",
      "diffId": "String",
      "unitCost": 9.65,
      "recalculateOrderInd": "N",
      "currencyCode": "USD",
      "hierarchyLevel": "S",
      "details": [
        {
          "hierarchyValue": 1521
        }
      ],
      "customFlexAttribute": [
        {
          "name": "REVIEW_DATE",
          "value": null,
          "valueDate": "2001-12-31"
        }
      ],
      "purchaseRate": 18.00
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Create Customer Order Item Substitution

Functional Area

Customer Orders

Business Overview

When a store is picking inventory in order to fulfill a customer order, if the inventory of the item ordered does not meet the required quality standards or is unavailable and the order indicates that substitutions are allowed for that item, the store may choose to fulfill the order with a substitute item. If that occurs, the Store Inventory Operations Cloud Services (SIOCS) has the ability to substitute items on the customer order with another predefined substitute item. In such cases, it will notify the Order Management System (OMS) via the Stock Order Status message that an alternative item has been pushed into the order.

Based on this notification, OMS updates the customer order and notifies Merchandising with the same details received from SIOCS using this service. Merchandising will then update the inventory and customer order details by removing the reservation for the original item and adding a reservation for the new item. It will also update the cancelled quantity for the original item on the order and add the details for the substituted item, with a cross reference to the original item.

Service Type

POST

ReST URL

MerchIntegrations/services/customerOrders/itemSubstitution/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	No	Collection of Object	A collection of CustOrdSubDesc objects.

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

Element Name	Required	Data Type	Description
customerOrderNo	Yes	String (48)	Holds the master customer order number from OMS.
fulfillOrderNo	Yes	String (48)	Unique number from OMS related to the fulfillment details.
location	Yes	Number (10)	Indicates the store number associated with the customer order. Should be a valid store location number as item substitution is only supported for Store location.
item	Yes	String (25)	Contains the item number for which substitute item is used.
quantity	Yes	Number (12,4)	Contains the revised order quantity of the original item.
uom	Yes	String (4)	Contains the unit of measure for original item order quantity. This will be the standard uom of the item.
details	Yes	Collection of Object	Contains the substitute item details.
itemLineNo	No	Number (10)	Indicates the detail item line number on the order being substituted for.

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

Element Name	Required	Data Type	Description
substituteItem	Yes	String (25)	Contains the substitute item number. Catchweight, Transformable, Consignment, Concession and Deposit container items are not supported for customer order item substitution.
substituteItemQuantity	Yes	Number (12,4)	Contains the order quantity for the substitute item.
substituteItemQuantityUom	Yes	String (4)	Contains the unit of measure for the substitute item order quantity. This will be the standard uom for the substitute item.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "customerOrderNo": "180008",
      "fulfillOrderNo": "180008",
      "location": 1311,
      "item": "101550001",
      "quantity": 3,
      "uom": "EA",
      "details": [
        {
          "substituteItem": "100000198",
          "substituteItemQuantity": 3,
          "substituteItemQuantityUom": "EA"
        }
      ],
      "itemLineNo": 1
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Create Department

Functional Area

Merchandise Hierarchy

Business Overview

The merchandise hierarchy allows the retailer to create the relationships that are necessary to support the product management structure of a company. This hierarchy reflects a classification of merchandise into multi-level descriptive categorizations to facilitate the planning, tracking, reporting, and management of merchandise within the company. This service may be used to create the department element of the merchandise hierarchy based on an external system if Merchandising is not the system of record for merchandise hierarchy information,

When a new department is created, this service will first validate that all required fields are present in the request payload. Business level validation on the input information will be performed to:

• Verify if the department is not already present.

• Verify if total market amount is received. If received then it should be at least 1000.

• Verify the child details, if included, have their required fields present. The child detail contains the VAT and up charge details for a department.

If all the validations are completed successfully, then the department data is created. Active custom flex attributes that are associated with a department can also be created through this service.

Service Type

POST

ReST URL

MerchIntegrations/services/merchandiseHierarchy/department/create

Input Payload Details

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

Element Name	Required	Data Type	Description
dept	Yes	Number (4)	The number which uniquely identifies the department. This value cannot be modified.
deptName	Yes	String (120)	The name of the department.
buyer	No	Number (4)	The number of the buyer associated to the department. This value must be predefined on the BUYER table.
purchaseType	Yes	Number (1)	The code which indicates whether items in this department are normal merchandise (0) or consignment stock (1).
totalMarketAmount	No	Number (24,4)	The total market amount that is expected for the department. This value cannot be less than 1000.
merchandiser	No	Number (4)	The number of the merchandiser that is associated to the department. This value must be predefined on the MERCHANT table.
groupNo	Yes	Number (4)	The number of the group to which the department belongs. This value must be predefined on the GROUPS table.
budgetedMarkup	No	Number (12,4)	The budgeted markup percentage. The markup percent of cost. If this value is not populated on the message it will be calculated to be the inverse of the budgeted intake percentage. This column will hold 70% as 70, not. 70.
profitCalcType	Yes	Number (1)	The number which indicates whether profit will be calculated by direct cost (1) or retail inventory (2).
markupCalcType	Yes	String (2)	The code letter that indicates how markup is calculated in this department. Valid values are cost (C) and retail (R).
otbCalcType	No	String (1)	The code letter which indicates how OTB is calculated for this department. Valid values are cost (C) and retail (R).
maximumAverageCounter	No	Number (5)	The maximum count of days with acceptable data to include in an average for items within the department. This value is required if RPM is installed.
averageTolerancePercent	No	Number (12,4)	The tolerance percentage value used in averaging for items within this value. This column will hold 70% as 70, not. 70. This value is required if pricing is installed.
budgetedIntakePercent	No	Number (12,4)	The budgeted intake percentage. The percent of the total take that is income. If this field is not populated on the message it will be calculated as the inverse of the budgeted markup percentage. This column will hold 70% as 70, not. 70.
vat	No	Collection of Object	References a collection of department VAT information.
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes.
upcharge	No	Collection of Object	References a collection of department upcharges.

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

Element Name	Required	Data Type	Description
vatRegion	Yes	Number (4)	The number of the VAT region to which this department is associated. This value must be predefined on the VAT_REGION table.
vatCode	Yes	String (6)	The alphanumeric identifier of the VAT code. This value must be predefined on the VAT_CODES table.
vatType	Yes	String (1)	Indicates if the VAT rate is used for purchasing (C), selling (R), or both (B).
reverseVatInd	No	String (1)	Indicates if items in the department are subject to reverse charge VAT at the vat region. Valid values are Y and N.

Table 5-30 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-31 Upcharge - Object. See list of elements for detail

Element Name	Required	Data Type	Description
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 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 destination location to which goods will be transferred. Valid values 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 department upcharge detail information.

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

Element Name	Required	Data Type	Description
component	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.

Sample Input Message

{
  "dept": 3041,
  "deptName": "deptName",
  "buyer": 610,
  "purchaseType": 1,
  "totalMarketAmount": 1010,
  "merchandiser": 810,
  "groupNo": 300,
  "budgetedMarkup": 3,
  "profitCalcType": 1,
  "markupCalcType": "C",
  "otbCalcType": "C",
  "maximumAverageCounter": 42,
  "averageTolerancePercent": 3,
  "budgetedIntakePercent": 3,
  "vat": [
    {
      "vatRegion": 1000,
      "vatCode": "S",
      "vatType": "B",
      "reverseVatInd": "Y"
    }
  ],
  "customFlexAttribute": [
    {
      "name": "REVIEW_DATE",
      "value": null,
      "valueDate": "2001-12-31"
    }
  ],
  "upcharge": [
    {
      "fromLocation": "1231",
      "toLocation": "3111",
      "fromLocationType": "S",
      "toLocationType": "S",
      "details": [
        {
          "component": "UC1",
          "componentRate": 3.55,
          "perCount": 3,
          "perCountUom": "EA",
          "upChargeGroup": "A",
          "componentCurrency": "USD",
          "effectiveDate": "2001-12-31",
          "itemDefaultInd": "Y",
          "transferAllocationDefaultInd": "Y",
          "computationValueBase": "C1",
          "costBasis": "S",
          "includeInTotalUpChargeInd": "N"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Department Taxes

Functional Area

Merchandise Hierarchy

Business Overview

If you are configured to run Merchandising using the Simple VAT (SVAT) setup for your default tax type, then you can set the VAT rates by region for the department using this service. VAT details can be passed in the Department create service payload, or they can be passed in specifically using this service. VAT region and VAT codes records must exist prior to creating department VAT records. Also, when passing in a new VAT region to an existing department with attached items, the VAT information will default to all items.

Service Type

POST

ReST URL

MerchIntegrations/services/merchandiseHierarchy/department/tax/create

Input Payload Details

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

Element Name	Required	Data Type	Description
dept	Yes	Number (4)	The number which uniquely identifies the department. This value cannot be modified.
vat	No	Collection of Object	References a collection of department VAT information.

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

Element Name	Required	Data Type	Description
vatRegion	Yes	Number (4)	The number of the VAT region to which this department is associated. This value must be predefined on the VAT_REGION table.
vatCode	Yes	String (6)	The alphanumeric identifier of the VAT code. This value must be predefined on the VAT_CODES table.
vatType	Yes	String (1)	Indicates if the VAT rate is used for purchasing (C), selling (R), or both (B).
reverseVatInd	No	String (1)	Indicates if items in the department are subject to reverse charge VAT at the vat region. Valid values are Y and N.

Sample Input Message

{
  "dept": 3041,
  "vat": [
    {
      "vatRegion": 1000,
      "vatCode": "S",
      "vatType": "C",
      "reverseVatInd": "Y"
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Department Up Charge

Functional Area

Merchandise Hierarchy

Business Overview

This service is used to create up charges for a department. 

This service first validates the set of required fields, including the from-locations and to-locations in the request payload. If no up-charge record is found, this message creates the up-charge for the department and from/to location combination. As part of the addition, you can indicate in the payload if you want to have the up-charges added to existing items or only added for new items. Similarly, there is a flag in the message to indicate whether the new up charges need to be cascaded to transfers and allocations which are unshipped and not in closed or deleted status. The department up charges will be created as soon as the request payload is consumed, but the new up charges will be cascaded to items, transfers, and allocations via batches which runs at the end of every business day.

Service Type

POST

ReST URL

MerchIntegrations/services/merchandiseHierarchy/department/upCharge/create

Input Payload Details

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

Element Name	Required	Data Type	Description
dept	Yes	Number (4)	The number which uniquely identifies the department. This value cannot be modified.
upcharge	No	Collection of Object	References a collection of department upcharges.

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

Element Name	Required	Data Type	Description
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 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 destination location to which goods will be transferred. Valid values 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 department upcharge detail information.

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

Element Name	Required	Data Type	Description
component	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.

Sample Input Message

{
  "dept": 3041,
  "upcharge": [
    {
      "fromLocation": "1231",
      "toLocation": "6000",
      "fromLocationType": "S",
      "toLocationType": "S",
      "details": [
        {
          "component": "UC1",
          "componentRate": 6.2,
          "perCount": 3,
          "perCountUom": "EA",
          "upChargeGroup": "A",
          "componentCurrency": "USD",
          "effectiveDate": "2001-12-31",
          "itemDefaultInd": "Y",
          "transferAllocationDefaultInd": "Y",
          "computationValueBase": "C1",
          "costBasis": "S",
          "includeInTotalUpChargeInd": "N"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Differentiators

Functional Area

Items - Differentiators

Business Overview

This service is used to create Differentiators in Merchandising from an external system. For successful creation of a new differentiator, this service will first validate that all required fields are present in the payload. After that, the following business level validation on the input information are performed before creating the differentiator.. 

• Verifies if the diff id does not contain white space or underscores

• Verifies if diff id is not already present as a diff id or diff group id

• Verifies if the diff type is a valid value in the DIFF_TYPE table

Service Type

POST

ReST URL

MerchIntegrations/services/item/differentiators/create

Input Payload Details

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

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	References a collection of differentiators.

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

Element Name	Required	Data Type	Description
diffId	Yes	String (10)	The unique identifier of the differentiator.
diffType	Yes	String (6)	The identifier of the differentiator type. This value must be predefined on the DIFF_TYPE table.
diffDescription	Yes	String (120)	The description of the differentiator.
industryCode	No	String (10)	The unique reference number which represents all possible combinations of sizes according to the National Retail Federation.
industrySubgroup	No	String (10)	The unique reference number to represent a sub-grouping code used by industry standards to further identify the differentiator. For example, in the US, the National Retail Federation uses a subgroup for colors (e.g., purple is defined as 500; dark purple represents a range from 501 - 509, medium purple represents a range from 510 - 519, bright purple represents a range from 520 - 529, etc.).

Sample Input Message

{
  "items": [
    {
      "diffId": "XYZ02",
      "diffType": "C",
      "diffDescription": "XYZ02 diffDesc",
      "industryCode": null,
      "industrySubgroup": null
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Create Differentiator Group Details

Functional Area

Items - Differentiators

Business Overview

This service is used to create Differentiator Group details for existing Diff Groups in Merchandising. Successful creation of a Differentiator Group detail depends on if all required fields are present in the message and field specific business validations.

Service Type

POST

ReST URL

MerchIntegrations/services/item/differentiator/group/details/create

Input Payload Details

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

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	It's a referenced element. For detailed description, please refer referenced element doc.

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

Element Name	Required	Data Type	Description
diffGroupId	Yes	String (10)	A unique differentiator group identifier.
details	No	Collection of Object	Description is not available.

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

Element Name	Required	Data Type	Description
diffId	Yes	String (10)	The identifier of the differentiator contained within the differentiator group. This id must be unique within the diff group. This must be populated when a diff group is being created since a diff group needs at least one diff id. Value must be predefined in the DIFF_IDS table.
displaySequence	No	Number (4)	The order in which the differentiators within the differentiator group are displayed on-line.

Sample Input Message

{
  "items": [
    {
      "diffGroupId": "Y21 Colors",
      "details": [
        {
          "diffId": "BLACK",
          "displaySequence": 1
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Create Differentiator Groups

Functional Area

Items - Differentiators

Business Overview

This service is used to create Differentiator Groups in Merchandising. Successful creation of a Differentiator Group depends on if all required fields are present in the message and field specific business validations.

Service Type

POST

ReST URL

MerchIntegrations/services/item/differentiator/groups/create

Input Payload Details

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

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	References a collection of differentiator groups.

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

Element Name	Required	Data Type	Description
diffGroupId	Yes	String (10)	A unique differentiator group identifier.
diffType	Yes	String (6)	A differentiator type which is predefined on the DIFF_TYPE table. Each diff group is composed of one diff type.
diffGroupDescription	Yes	String (120)	The description of the differentiator group.
details	No	Collection of Object	References a collection of differentiators within the differentiator group.

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

Element Name	Required	Data Type	Description
diffId	Yes	String (10)	The identifier of the differentiator contained within the differentiator group. This id must be unique within the diff group. This must be populated when a diff group is being created since a diff group needs at least one diff id. Value must be predefined in the DIFF_IDS table.
displaySequence	No	Number (4)	The order in which the differentiators within the differentiator group are displayed on-line.

Sample Input Message

{
  "items": [
    {
      "diffGroupId": "Y21 Colors",
      "diffType": "C",
      "diffGroupDescription": "Year 2021 Colors",
      "details": [
        {
          "diffId": "BLACK",
          "displaySequence": 1
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Create Division

Functional Area

Merchandise Hierarchy

Business Overview

This service may be used to create the division element of the merchandise hierarchy based on an external system if Merchandising is not the system of record for merchandise hierarchy information. When a new division is created, this service will first validate that all the required fields are present in the request payload. Business level validation on the input information will be performed to:

• Verify division is not already present

• Verify if the total market amount is received, then it should be at least 1000.

If both the above validations are met, the division in the message data is created.

Service Type

POST

ReST URL

MerchIntegrations/services/merchandiseHierarchy/division/create

Input Payload Details

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

Element Name	Required	Data Type	Description
division	Yes	Number (4)	The unique identifier of the division.
divisionName	Yes	String (120)	The name of the division.
merchandiser	No	Number (4)	The number of the merchant associated with the division. This value must be predefined on the MERCHANT table.
buyer	No	Number (4)	The number of the buyer associated with the division. This value must be predefined on the BUYER table.
totalMarketAmount	No	Number (24,4)	The total market amount that is expected for the division. If this field is not null it must be at least 1000.

Sample Input Message

{
  "division": 200,
  "divisionName": "Division 200",
  "merchandiser": 612,
  "buyer": 307,
  "totalMarketAmount": 1010
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create DSD Receipts

Functional Area

Inventory - Shipments and Receipts

Business Overview

Direct store delivery (DSD) is the delivery of merchandise to and/or the performance of services in a store without the benefit of a pre-approved purchase order. When the delivery or service occurs, the store inventory system (for example, SIOCS) informs Merchandising of the receipt, which also generates the purchase order at the same time. The receipt can include both the merchandise item as well as the non-merchandise information associated with the order. This information works in conjunction with payment details sent through Sales Audit if payment was made a part of the delivery or service at the store.

Service Type

POST

ReST URL

MerchIntegrations/services/inventory/shipmentsAndReceipts/dsd/create

Availability During Nightly Batch Cycle

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

Input Payload Details

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

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	References a collection of DSD Receipts.

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

Element Name	Required	Data Type	Description
supplier	Yes	Number (10)	This field contains the unique identifying number for a supplier for the receipt.
originCountry	Yes	String (3)	This field contains the identifier of the country from which the item is being sourced.
store	Yes	Number (10)	This field contains the location where the items were delivered.
dept	No	Number (4)	The department in which all the items on the order belong.
currencyCode	Yes	String (3)	This field contains a code identifying the currency the supplier uses for business transactions.
paidInd	Yes	String (1)	This field indicates if the invoice has already been paid. Valid values are Y (invoice has already been paid) or N (invoice should be paid in accounts payable system).
externalReferenceNo	No	String (30)	If the invoice indicator is Y (invoice has been created), the external reference number, proof of delivery number, or payment reference number must be provided.
proofOfDeliveryNo	No	String (30)	This field contains the proof of delivery or service number given at the time of receipt at the store. This field will also be included when the invoice is interfaced through Sales Audit.
paymentReferenceNo	No	String (16)	This field contains the reference number attached to the invoice payment, used when the invoice is paid from the POS system and interfaced through Sales Audit.
paymentDate	No	date	This field contains the date when the invoice was paid from the POS system. This field will be populated when the invoice is interfaced through Sales Audit.
invoiceInd	Yes	String (1)	This field indicates whether an invoice was created for this receipt by the supplier. Valid values are Yes (Y) and No (N).
dealsInd	Yes	String (1)	This field indicates whether deals need to be applied to the DSD Purchase Order or not. Valid values are Yes (Y) and No (N).
externalReceiptNo	No	String (17)	This field holds the external transaction sequence number for the receipt.
receiptDate	No	date	This field contains the date of the receipt.
details	No	Collection of Object	References a collection of DSD Receipt detail records.
nonMerchDetails	No	Collection of Object	References a collection of DSD Non Merchandise detail records.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	This field contains the item in the receipt. The item must be an approved item that is at transaction level or above.
quantityReceived	Yes	Number (12,4)	This field contains the number of items received for the item/shipment combination. The value must be greater than 0.
unitCost	No	Number (20,4)	This field contains the cost of the item from the supplier/origin country in the supplier's currency.
weight	No	Number (12,4)	This field contains the weight of the item in the receipt, if it is a catch weight item.
weightUom	No	String (4)	This field contains the unit of measure of the received weight.

Table 5-50 NonMerchDetails - Object. See list of elements for detail

Element Name	Required	Data Type	Description
nonMerchCode	Yes	String (6)	This field contains the non-merchandising code that will be added to an invoice for services or other non-merchandise costs associated with the order.
nonMerchAmount	Yes	Number (20)	This field contains the amount of the non-merchandise cost that was invoiced. This field will be held in the invoice currency.
vatCode	No	String (6)	This field contains the code identifying the VAT rate that should be applied to the non-merchandise amount entered.
servicePerformedInd	Yes	String (1)	Indicates if a service non-merchandise cost has actually been performed. Valid values are 'Y' (service has been performed) or 'N' (service has not been performed or non-merchandise cost is not a service cost).

Sample Input Message

{
  "items": [
    {
      "supplier": 2400,
      "originCountry": "US",
      "store": 1531,
      "dept": 1117,
      "currencyCode": "USD",
      "paidInd": "Y",
      "externalReferenceNo": "REF1531",
      "proofOfDeliveryNo": null,
      "paymentReferenceNo": null,
      "paymentDate": "2001-12-31",
      "invoiceInd": "Y",
      "dealsInd": "Y",
      "externalReceiptNo": "RECREF1531",
      "receiptDate": "2001-12-31",
      "details": [
        {
          "item": "100750001",
          "quantityReceived": 3,
          "unitCost": 9.65,
          "weight": 79.00,
          "weightUom": null
        }
      ],
      "nonMerchDetails": [
        {
          "nonMerchCode": "B720",
          "nonMerchAmount": 123456,
          "vatCode": "S",
          "servicePerformedInd": "N"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Franchise Orders

Functional Area

Franchise Management

Business Overview

This service is used from an external source, usually an order management system, to create franchise orders in Merchandising. This service accepts a collection of franchise order and will return success or failure through the service response object. The franchise order uploaded through this service will be created with an order type of 'EDI'. A linked transfer, PO or store order will be created for the approved franchise orders.

Franchise orders created via this service will be systematically approved if the customer is setup for auto approval, provided the customer has valid credit. If the order does not meet the criteria for auto-approval, Merchandising will create the franchise order in Input or Require Credit Approval and will provide the reason of approval failure in the response object. Franchise orders from customers that are not identified for 'Auto Approval' are uploaded into Merchandising in Input status. Such orders will need to be manually approved in Merchandising to be considered active.

The service allows upload of one or more franchise orders in a single service call. Each request is treated as a single unit of work and if there are no validation errors or business validation errors, all the franchise orders in the message will be created and the service will return success through the service response object. In case of one or more validation errors, the service call will be rejected, and the error response will contain the details of the validation errors.

Item Validation

• Packs are allowed for warehouse sourced or supplier sourced franchise orders only. If the pack added is a buyer pacwith an 'order as' type of eaches, then the pack is exploded to its components.

• Deposit container items cannot be added to franchise orders. When the deposit content item is added to an order, the associated container item gets added as well. Deposit item content and container items must have the same costing location.

• Transformable orderable items can be added to an order, however, transformable sellable items are not allowed, as these are not inventoried.

• There cannot be multiple detail record for the same source location/item/customer location combination within a franchise order.

• Multiple order detail lines with the same source location, item and customer location combination in the franchise order is not allowed.

Source Validations

• For supplier sourced orders, the supplier must be an active supplier and allows direct store deliveries.

• For supplier sourced franchise order, items must be 'Active' at the franchise store in order to be included on the order.

• The supplier must belong to the same org unit as the costing location.

• For warehouse or company store sourced order, the items must not be in 'Delete' status at the source location and must be in either 'Active' or 'Discontinued' status at the franchise store.

• If the source for franchise order is not specified, then the costing location for the item and franchise store will be used as the source location.

• If the source location is a physical warehouse, then the service will use distribution rules to determine from which virtual warehouse the inventory will be pulled, similar to distribution rules used for non-franchise transfers.

Customer Location Validation

• If item/franchise store relationship does not exist, the franchise store would be auto ranged as part of franchise order creation.

• For source location as a store, the customer store cannot be non-stockholding.

• When a franchise order is uploaded through this service, having a future cost record for the item/franchise store combination is not necessary. Whether or not the cost template relationship is defined for the item/franchise store, the order can still be approved based on the provided fixed cost. However, if the fixed cost is also not provided, then the order creation would fail.

Inventory Validations

The inventory validation for Franchise orders sourced from company locations is subject to the setting of the 'Validate Availability for External Franchise Orders' system option. If set to No, Franchise Order creation would be carried out without checking for inventory availability. If set to Yes, then the requested quantity is validated against the available inventory at location for the warehouse or store sourced franchise orders. For the warehouse sourced orders, if the requested quantity exceeds the available stock at the warehouse, then Merchandising checks whether the item is on the Store Order replenishment at the same sourcing warehouse for the franchise store. If so, then an order is placed for the sourcing warehouse from the supplier for the unavailable quantity and the sourcing for the franchise location is handled via transfers created through Merchandising replenishment process. When the source location is a store, requested inventory must be available at the location.

Order Date Validations

• Multiple franchise orders with the same source location, item, customer location and need date combination are not allowed in Merchandising.

• For the supplier sourced franchise orders, the not after date must be greater than supplier lead time.

• For the warehouse sourced franchise orders, if the franchise order has a need date that is less than the order lead days in the future, the franchise order is fulfilled with the available warehouse inventory. Any remaining is fulfilled via Store Order replenishment if the item is on Store Order replenishment at the same sourcing warehouse for the franchise store.

• For store sourced franchise orders, the need date must be within order lead days.

Service Type

POST

ReST URL

MerchIntegrations/services/franchiseManagement/franchiseOrder/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	References a collection of franchise order creation details.

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

Element Name	Required	Data Type	Description
customerId	Yes	Number (10)	This value should be a valid customer id.
orderReferenceNo	Yes	String (20)	This is an external reference number that would be provided by the franchisee for their tracking purposes.
currencyCode	Yes	String (3)	This field represents the currency of the order, which may or may not be different from the primary currency in the system. Valid values for this field are based on the currency codes held in the CURRENCIES table.
exchangeRate	No	Number (20,10)	This field represents the exchange rate between the primary currency and the franchise order currency. If this is not provided, it is defaulted based on the conversion type set at system level.
freight	No	Number (20,4)	This field represents any freight charges associated to the franchise order.
otherCharges	No	Number (20,4)	This field represents other miscellaneous charges associated to the franchise order.
defaultBillingLocation	No	Number (10)	A customer's location where the billing for the entire order is sent. If blank, each location is billed.
billToAddressType	No	String (2)	This field represents the address type for the default billing location. This field is defaulted to Invoice address.
comments	No	String (2000)	Free form comments associated with the franchise order.
details	Yes	Collection of Object	Details of the orders. At least one detail item is mandatory.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	This is the item which is on the Franchise Order. This should be an approved, inventory, orderable and transaction level item. The item should be ranged to both customer location and source location and must not be a consignment/concession item.
customerLocation	Yes	Number (10)	This field holds a valid franchise location number.
sourceLocationType	No	String (2)	Contains the source entity type from where the items will originate. Valid values are ST - Store, WH - Warehouse, SU - Supplier. If this field is populated, the source location should also be populated.
sourceLocation	No	Number (10)	Contains the location id from where this item will be sourced from. The id will correspond to a company store, warehouse or supplier depending on the source type value.
requestedQuantity	Yes	Number (12,4)	This field represents the quantity of the item on this record being ordered. This value is always written in the standard UOM for the item.
unitOfPurchase	No	String (3)	This field contains the unit of purchase information. Must be the standard unit of measure or a valid pallet name/case name/inner name for the item/supplier.
needDate	Yes	date	This date represents the initial date by which the franchisee wants the item on this order. The date format should be YYYY-MM-DD. The need date can be business date (VDATE) or a date in future.
notAfterDate	Yes	date	This date represents the last date by which the franchisee will accept the item on this order. The date format should be YYYY-MM-DD. This date should be after need date.
fixedCost	No	Number (20,4)	This is a user defined cost which will override the customer cost for the item on this order if populated. This should be a positive numeric value. This must be provided if there are no cost templates associated with the item.

Table 5-54 CreateError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
customerId	Yes	Number (10)	Input Customer Id
orderReferenceNo	Yes	String (20)	Input order reference number
item	No	String (25)	Input item
customerLocation	No	Number (10)	Input franchise location number
sourceLocationType	No	String (2)	Input source location type
sourceLocation	Yes	Number (10)	Input source location id
errors	Yes	Array of String	List of errors identified during business data processing of the request

Sample Input Message

{
  "items": [
    {
      "customerId": 1001,
      "orderReferenceNo": "1001-A",
      "currencyCode": "USD",
      "exchangeRate": 52.5,
      "freight": 23.5,
      "otherCharges": 2.58,
      "defaultBillingLocation": 100123,
      "billToAddressType": "01",
      "comments": "Franchise order 1001-A",
      "details": [
        {
          "item": "104300083",
          "customerLocation": 100123,
          "sourceLocationType": "ST",
          "sourceLocation": 909090,
          "requestedQuantity": 9000,
          "unitOfPurchase": "EA",
          "needDate": "2001-12-31",
          "notAfterDate": "2001-12-31",
          "fixedCost": 95
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Table 5-55 CreateResponse - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	References a collection of franchise orders created.

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

Element Name	Required	Data Type	Description
franchiseOrder	Yes	Number (10)	This is the unique identifier of the franchise order that is generated by Merchandising.
customerId	Yes	Number (10)	Input Customer Id
orderReferenceNo	Yes	String (20)	Input order reference number
status	Yes	String (1)	This contains the status in which the Franchise order was created. This can be I - Input or A - Approved.
autoApproveErrors	No	Array of String	This will be populated with the reason (like customer fails credit check) why the order could not be approved and ended up getting created in Input status. Using the UI, the franchise order should be approved after fixing the issue.
transactions	No	Collection of Object	References a collection of transfers or purchase orders created.

Table 5-57 Transactions - Object. See list of elements for detail

Element Name	Required	Data Type	Description
customerLocation	Yes	Number (10)	This field holds a valid franchise location number.
sourceLocation	Yes	Number (10)	Contains the location id from where this item will be sourced from. The id will correspond to a company store, warehouse or supplier depending on the source type value.
sourceLocationType	Yes	String (2)	Contains the source entity type from where the items will originate. Valid values are ST - Store, WH - Warehouse, SU - Supplier. If this field is populated, the source location should also be populated.
needDate	Yes	date	This date represents the initial date by which the franchisee wants the item on this order. The date format should be YYYY-MM-DD. The need date can be business date (VDATE) or a date in future.
documentNo	Yes	Number (12)	This contains the purchase order or transfer number created.
documentType	Yes	String (1)	This contains the document type generated. This can be P - Purchase Order or T - Transfer.

Sample Response Message

{
  "items": [
    {
      "franchiseOrder": 30001,
      "customerId": 1001,
      "orderReferenceNo": "1001-A",
      "status": "A",
      "autoApproveErrors": [
        "null"
      ],
      "transactions": [
        {
          "customerLocation": 100123,
          "sourceLocation": 909090,
          "sourceLocationType": "ST",
          "needDate": "2001-12-31",
          "documentNo": 22145453,
          "documentType": "T"
        }
      ]
    }
  ]
}

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

Element Name	Required	Data Type	Description
customerId	Yes	Number (10)	Input Customer Id
orderReferenceNo	Yes	String (20)	Input order reference number
item	No	String (25)	Input item
customerLocation	No	Number (10)	Input franchise location number
sourceLocationType	No	String (2)	Input source location type
sourceLocation	Yes	Number (10)	Input source location id
errors	Yes	Array of String	List of errors identified during business data processing of the request

Sample Error Message

{
  "status": "ERROR",
  "message": "Error found in validation of input payload",
  "validationErrors": [
    {
      "error": "must be one of Y, N",
      "field": "createRecord.arg0.approveInd",
      "inputValue": "X"
    }
  ],
  "businessError": [
    {
      "customerId": 1001,
      "orderReferenceNo": "1001-A",
      "item": "104300083",
      "customerLocation": 100123,
      "sourceLocationType": "ST",
      "sourceLocation": 909090,
      "errors": [
        "Customer Location passed in franchise order is not a valid franchise store."
      ]
    }
  ]
}

Create Fulfillment Order

Functional Area

Customer Orders

Business Overview

This service is used to process Customer Order Fulfillment requests from an external order management system (OMS). If the system option OMS_IND = ‘Y’, then Merchandising expects to receive customer orders through this API. If the system option PERSIST_CUSTOMER_DATA_IND = ‘N’, personal information will not be stored in the customer order table in Merchandising.

The confirmation messages will be sent in a collection as part of the response object.

• Accepts a collection of fulfillment orders as input. If one order fails, the entire service call fails, and no orders will be created.

• Returns Failure status as part of the response object in the web service call if customer orders are not created due to validation errors.

• Returns Success status and a confirmation message as part of the response object of type:

  • X if customer orders are not created due to lack of inventory

  • P if customer orders are partially created due to insufficient inventory

  • C if customer orders are completely created, when sufficient inventory is available

  • R if inventory reservations are created.

• A confirmation type of C and P will be accompanied by a confirmation number, which is the transfer or purchase order number created.

The Customer Order Fulfillment message staged will go through a process of validation. Records that pass validation will create new customer order records. If any validation error occurs, transaction will be rolled back, and no customer orders will be created.

There are two scenarios where a customer order fulfillment request cannot be created in Merchandising:

1. Due to data validation errors (e.g., invalid item).

2. Due to 'No Inventory' - There is not enough inventory available at the source location or item is not ranged or inactive at the source location, or item is not supplied by the supplier (in a PO scenario).

Note:

1. Non-stockholding franchise stores cannot part of a fulfillment order, either as a sourcing location or as a fulfillment location.

2. Catch weight and transformable sellable items are not supported in this integration. To sell items that can vary by weight, like bananas through online channels, setup should be done as a regular (non-catch weight) item with a unit cost and standard UOM defined in items of eaches.

3. It is assumed that customer orders will be captured in the selling UOM in OMS, but that all transactions will be communicated to Merchandising in standard UOM.

4. If the same customer order fulfillment request is sent for a different item or for an existing item but with a different item line number, the existing PO or transfer will be updated.

The Customer Order Fulfillment messages contain information such as delivery type, source type and destination type. Based on these, the system will proceed to create a Purchase Order, Transfer or Inventory Reservation.

Service Type

POST

ReST URL

MerchIntegrations/services/customerOrders/fulfillmentOrder/create

Availability During Nightly Batch Cycle

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

Input Payload Details

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

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	It's a referenced element. For detailed description, please refer referenced element doc.

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

Element Name	Required	Data Type	Description
customerOrderNo	Yes	String (48)	Holds the master customer order number from OMS.
fulfillOrderNo	Yes	String (48)	Unique number from OMS related to the fulfillment details. One or more fulfillment orders could relate back to a single customer order in OMS.
sourceLocationType	No	String (2)	This would be either 'SU' for supplier, 'ST' for store, or 'WH' for warehouse. This would only be populated for vendor, warehouse or multi-site fulfillment orders.
sourceLocation	No	Number (10)	Indicates the supplier, store or warehouse number associated with sourcing the customer order. Only populated for vendor, warehouse or multi-site fulfillment orders.
fulfillLocationType	No	String (1)	This would be either 'S' (for physical store) or 'V' (for virtual store).
fulfillLocation	Yes	Number (10)	Indicates the store or warehouse number associated with fulfilling the customer order. For this release, this should always be populated with a virtual or physical store number.
partialDeliveryInd	Yes	String (1)	Indicates if the order can be picked and shipped partially ('N') or if it should be shipped only when complete ('Y').
deliveryType	No	String (1)	Indicates the fulfillment method - ship to customer or store pickup. Expected values are 'S' (ship direct) and 'C' (customer pickup).
carrierCode	No	String (4)	Indicates the carrier the order is to be shipped with, if specified on the order.
carrierServiceCode	No	String (6)	Indicates the method that was selected for shipping by the customer placing the order (e. g. Standard Shipping, Overnight, etc. ).
consumerDeliveryDate	Yes	date	Indicates the desired date the delivery is required by the customer. This will be the GMT time.
consumerDeliveryTime	No	date-time	Indicates the desired time the delivery is required by the customer. This will be the GMT time.
deliveryCharges	No	Number (20,4)	Contains the delivery charges on drop ship. Mostly relevant for Brazil.
deliveryChargesCurrency	No	String (3)	Contains the currency of the delivery charges.
comments	No	String (2000)	Any comments sent by OMS about the order.
customerDetails	No	Record	Referenced object for customer information related to the order.
details	Yes	Collection of Object	References a collection of customer order fulfillment details.
orderPlacedStore	No	Number (10)	Indicates the store number associated with the location that the customer order was placed. For on-line orders this will contain the virtual store number associated with the on-line store. For orders captured in a physical store this will contain the store number for the physical store.

Table 5-61 CustomerDetails - Object. See list of elements for detail

Element Name	Required	Data Type	Description
customerNo	No	String (14)	Indicates the number that uniquely identifies the customer in OMS.
deliverFirstName	No	String (120)	Contains the first name for the delivery address on the order.
deliverPhoneticFirst	No	String (120)	Contains the phonetic first name for the delivery address on the order.
deliverLastName	No	String (120)	Contains the last name for the delivery address on the order.
deliverPhoneticLast	No	String (120)	Contains the phonetic last name for the delivery address on the order.
deliverPreferredName	No	String (120)	Contains the preferred name for the delivery address on the order.
deliverCompanyName	No	String (120)	Contains the company name for the delivery address on the order.
deliverAdd1	No	String (240)	First line of the delivery address for the customer.
deliverAdd2	No	String (240)	Second line of the delivery address for the customer.
deliverAdd3	No	String (240)	Third line of the delivery address for the customer.
deliverCounty	No	String (250)	County portion of the delivery address.
deliverCity	No	String (120)	City portion of the delivery address.
deliverState	No	String (3)	State portion of the delivery address.
deliverCountryId	No	String (3)	Country portion of the delivery address.
deliverPost	No	String (30)	Postal code portion of the delivery address.
deliverJurisdiction	No	String (10)	Identifies the jurisdiction code for the delivery country-state relationship.
deliverPhone	No	String (20)	Contains the delivery phone number.
deliverEmail	No	String (120)	Contains the delivery email.
billFirstName	No	String (120)	Contains the first name for the billing address on the order.
billPhoneticFirst	No	String (120)	Contains the phonetic first name for the billing address on the order.
billLastName	No	String (120)	Contains the last name for the billing address on the order.
billPhoneticLast	No	String (120)	Contains the phonetic last name for the billing address on the order.
billPreferredName	No	String (120)	Contains the preferred name for the billing address on the order.
billCompanyName	No	String (120)	Contains the company name for the billing address on the order.
billAdd1	No	String (240)	First line of the billing address for the customer.
billAdd2	No	String (240)	Second line of the billing address for the customer.
billAdd3	No	String (240)	Third line of the billing address for the customer.
billCounty	No	String (250)	County portion of the billing address.
billCity	No	String (120)	City portion of the billing address.
billState	No	String (3)	State portion of the billing address.
billCountryId	No	String (3)	Country portion of the billing address.
billPost	No	String (30)	Postal code portion of the billing address.
billJurisdiction	No	String (10)	Identifies the jurisdiction code for the billing country-state relationship.
billPhone	No	String (20)	Contains the billing phone number.
billEmail	No	String (120)	Contains the billing email.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	Indicates the item ordered by the customer.
referenceItem	No	String (25)	Indicates the reference item ordered by the customer. Used only if a specific UPC is ordered. This is supported for vendor drop-ships orders only as we don't support transfer requests for a specific reference item.
orderQuantitySuom	Yes	Number (12,4)	Indicates the quantity of the item ordered by the customer in item's standard unit of measure.
standardUom	No	String (4)	Indicates item's standard unit of measure.
transactionUom	No	String (4)	Indicates the original transaction unit of measure the order is placed in.
substituteInd	Yes	String (1)	Indicates if substitutes are allowed on a customer order. This will only be used by orders passed to SIM.
unitRetail	No	Number (20,4)	Indicates the unit sales retail of item on the customer order. This will only be used by Brazil orders in case of Warehouse Fulfillment or vendor sourced POs shipped directly to the customer. It is needed for Sales NF generation.
retailCurrency	No	String (3)	Indicates currency of unit retail and total retail. This will only be used by Brazil orders in case of Warehouse Fulfillment or vendor sourced POs shipped directly to the customer. It is needed for Sales NF generation.
comments	No	String (2000)	Used to indicate any special instructions for the item, such as services (monograms, engrave, etc).
itemLineNo	No	Number (10)	Indicates the detail item line number on the order.

Sample Input Message

{
  "items": [
    {
      "customerOrderNo": "123124",
      "fulfillOrderNo": "123124",
      "sourceLocationType": "SU",
      "sourceLocation": 2400,
      "fulfillLocationType": "S",
      "fulfillLocation": 1521,
      "partialDeliveryInd": "N",
      "deliveryType": "S",
      "carrierCode": "30",
      "carrierServiceCode": "D",
      "consumerDeliveryDate": "2001-12-31",
      "consumerDeliveryTime": "2001-12-31T23:59:59.123Z",
      "deliveryCharges": 3.55,
      "deliveryChargesCurrency": "USD",
      "comments": "CO for John Scott",
      "customerDetails": {
        "customerNo": "123456",
        "deliverFirstName": "John",
        "deliverPhoneticFirst": "Mr",
        "deliverLastName": "Scott",
        "deliverPhoneticLast": null,
        "deliverPreferredName": null,
        "deliverCompanyName": null,
        "deliverAdd1": "7th Street",
        "deliverAdd2": "2504 Centergate Dr Apt 103",
        "deliverAdd3": null,
        "deliverCounty": "Miramar County",
        "deliverCity": "Minneapolis",
        "deliverState": "MN",
        "deliverCountryId": "US",
        "deliverPost": "55555-1234",
        "deliverJurisdiction": null,
        "deliverPhone": "1800800800",
        "deliverEmail": "[e-mail]",
        "billFirstName": "John",
        "billPhoneticFirst": "Mr",
        "billLastName": "Scott",
        "billPhoneticLast": null,
        "billPreferredName": null,
        "billCompanyName": null,
        "billAdd1": "7th Street",
        "billAdd2": "2504 Centergate Dr Apt 103",
        "billAdd3": null,
        "billCounty": "Miramar County",
        "billCity": "Minneapolis",
        "billState": "MN",
        "billCountryId": "US",
        "billPost": "55555-1234",
        "billJurisdiction": null,
        "billPhone": "1800800800",
        "billEmail": "[e-mail]"
      },
      "details": [
        {
          "item": "100100068",
          "referenceItem": null,
          "orderQuantitySuom": 3,
          "standardUom": "EA",
          "transactionUom": "EA",
          "substituteInd": "N",
          "unitRetail": 12.99,
          "retailCurrency": "USD",
          "comments": "Customer Order Item Details",
          "itemLineNo": 1
        }
      ],
      "orderPlacedStore": 1311
    }
  ]
}

Response Code: 200 (Success)

Table 5-63 CreateResponse - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	It's a referenced element. For detailed description, please refer referenced element doc.

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

Element Name	Required	Data Type	Description
customerOrderNo	Yes	String (48)	Holds the master customer order number from OMS.
fulfillOrderNo	Yes	String (48)	Unique number from OMS related to the fulfillment details. One or more fulfillment orders could relate back to a single customer order in OMS.
confirmationType	Yes	String (1)	Contains the confirmation type. 'P' - Order Partially Created; 'X' - Order Could not be Created; 'C' - Order Completely Created, 'R' - Inventory Reservation.
confirmationNo	No	Number (12)	Contains the PO or Transfer number in RMS related to the fulfillment order line. Required if fulfillment status is 'P'.
details	No	Collection of Object	References a collection of customer order confirmation item details. This will be null for confirmation type 'R' - inventory reservation.
fulfillLocation	No	Number (10)	Contains the fulfillment location for the order. This will be null for confirmation type 'R' - inventory reservation.
systemCode	No	String (10)	The code identifying the system associated with the location. This will be null for confirmation type 'R' - inventory reservation.

Table 5-65 CreateResponse.Items.Details - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	Indicates the item ordered by the customer. This will be null for confirmation type 'R' - inventory reservation.
referenceItem	No	String (25)	Indicates the reference item ordered by the customer. Used only if a specific UPC is ordered. This is supported for vendor drop-ships orders only as we don't support transfer requests for a specific reference item. This will be null for confirmation type 'R' - inventory reservation.
confirmedQuantity	Yes	Number (12,4)	Indicates the quantity of the item that can be sourced or fulfilled on the order. This will be null for confirmation type 'R' - inventory reservation.
confirmedQuantityUom	Yes	String (4)	Indicates the unit of measure of the confirmation quantity. This will be null for confirmation type 'R' - inventory reservation.
itemLineNo	No	Number (10)	Indicates the detail item line number on the order. This will be null for confirmation type 'R' - inventory reservation.

Sample Response Message

{
  "items": [
    {
      "customerOrderNo": "123123",
      "fulfillOrderNo": "123124",
      "confirmationType": "P",
      "confirmationNo": 9999999,
      "details": [
        {
          "item": "100100076",
          "referenceItem": null,
          "confirmedQuantity": 3,
          "confirmedQuantityUom": "EA",
          "itemLineNo": 1
        }
      ],
      "fulfillLocation": 6000,
      "systemCode": "INV"
    }
  ]
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Group

Functional Area

Merchandise Hierarchy

Business Overview

This service may be used to create the group element of the merchandise hierarchy based on an external system if Merchandising is not the system of record for merchandise hierarchy information.

When a new group is created, this service will first validate that all the required fields are present in the request payload. Business level validation on the input information will be performed, which checks whether the group already exists. If it does not exist, the group is created.

Service Type

POST

ReST URL

MerchIntegrations/services/merchandiseHierarchy/group/create

Input Payload Details

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

Element Name	Required	Data Type	Description
groupNo	Yes	Number (4)	The number which uniquely identifies the group. This field cannot be modified.
groupName	Yes	String (120)	Description is not available.
division	Yes	Number (4)	The identifier of the division of which the group is a member. This value must be predefined on the DIVISION table.
merchandiser	No	Number (4)	The number of the merchandiser associated to the group. This value must be predefined on the MERCHANT table.
buyer	No	Number (4)	The number of the buyer associated to the group. This value must be predefined on the BUYER table.

Sample Input Message

{
  "groupNo": 1000,
  "groupName": "groupName",
  "division": 1000,
  "merchandiser": 1000,
  "buyer": 1000
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Inventory Adjustments

Functional Area

Inventory - Inventory Adjustments

Business Overview

Merchandising receives requests for inventory adjustments from an integration subsystem through this service. The request contains information about the item and location whose inventory is being adjusted, the quantity to adjust, a ‘from’ and a ‘to’ disposition code, and the reason for the adjustment. Merchandising uses the information in these requests to perform the following actions :

• Adjust overall quantities of stock on hand for the item and location combination

• Adjust the availability of item-location quantities based on status.

After initial processing and validation, Merchandising performs the following tasks:

• The item/location is ranged if it does not already exist.

• For total stock on hand adjustments:

  • Stock on hand is updated for the item at the location, for total stock on hand adjustments.

  • Stock adjustment is recorded to the Merchandising transaction level stock ledger.

• For status-based adjustments:

  • Quantities by inventory status are adjusted for the item/location combination.

  • Non-sellable quantity is updated for the item/location.

• For both types, an audit trail is created for the inventory adjustment by item, location, inventory status and reason.

Note:

An adjustment can impact both total stock on hand and inventory status at the same time.

Inventory Adjustment Transaction Codes

Whenever the status or quantity of inventory changes, Merchandising writes transaction codes to adjust inventory values in the stock ledger. The types of inventory adjustment transaction codes are:

• Tran code 22 - adjustments where positive and negative adjustments are made to total stock on hand using a reason code with the COGS indicator = N. In this case, a transaction is inserted to the transaction level stock ledger for both the retail and cost value of the adjustment.

• Tran code 23 - adjustments where positive and negative adjustments are made to total stock on hand using a reason code with the COGS indicator = Y. In this case, a transaction is inserted to the transaction level stock ledger for both the retail and cost value of the adjustment.

• Tran code 25 - adjustments to inventory status, where inventory is moved to or from an unavailable or non-sellable status.

Other Notes

• One or both of the ‘from’ disposition and ‘to’ disposition fields must have values. Both cannot be empty.

• The item must be inventoried and approved.

• If the item is a simple pack catch weight item, then both the weight and weight UOM need to be defined or NULL. The weight UOM must be of the type ‘Mass’.

• The item should be a transaction-level or a reference item. When a reference item is passed in, its parent item (the transaction level item) has its inventory adjusted.

• If adjusting a pack at a warehouse, the pack item must have its inventory tracked at the pack level (receive as type = Pack for the item/warehouse).

• If the location is a warehouse, then either a virtual or physical warehouse can be supported. If it is a virtual warehouse, it must be a stockholding warehouse. If it is a physical warehouse, then the adjusted quantity is distributed among the virtual locations of the physical location.

Service Type

POST

ReST URL

MerchIntegrations/services/inventory/inventoryAdjustments/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
location	Yes	Number (10)	This field contains the location where the inventory adjustment is being made.
details	Yes	Collection of Object	References a collection of items for which stock is being adjusted.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	This contains the item for which stock is being adjusted. The item should be an approved inventory item.
adjustmentReasonCode	No	Number (4)	Contains the reason for inventory adjustment. This field will only have a value for saleable inventory types.
unitQuantity	Yes	Number (12,4)	This field contains the number of units to be added or reduced. The value should not be 0 and should be a whole number if the standard UOM of the item is EA.
fromDisposition	No	String (4)	Used to fetch the inv_status. Also used to determine if the adjustment quantity is negative or positive.
toDisposition	No	String (4)	Used to fetch the inv_status. Also used to determine if the adjustment quantity is negative or positive.
userId	Yes	String (30)	This field contains the name of the user who created the inventory adjustment.
createDate	Yes	date	This field contains the date and time the inventory adjustment was made.
poNo	No	String (12)	This field contains either a PO, Allocation, BOL or Transfer number associated to the inventory adjustment based on the doc_type. The value should exist in Merchandising.
documentType	No	String (1)	This field indicates the type of document where the inventory adjustment originated from. Valid values are: P - Purchase Order, T - Transfer and A - Allocation.
weight	No	Number (12,4)	This contains the weight of the item. Weight and Weight UOM should both have values or both should be NULL.
weightUom	No	String (4)	This is the unit of measurement for weight. Weight and Weight UOM should both have values, or both should be NULL. This value should belong to the uom_class, MASS.
unitCost	No	Number (20,4)	Contains the current unit cost of the item

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "location": 6000,
      "details": [
        {
          "item": "100100076",
          "adjustmentReasonCode": 99,
          "unitQuantity": 3,
          "fromDisposition": null,
          "toDisposition": "ATS",
          "userId": "BOYLE",
          "createDate": "2001-12-31",
          "poNo": null,
          "documentType": null,
          "weight": 2.5,
          "weightUom": "KG",
          "unitCost": 9.65
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Inventory Backorder

Functional Area

Customer Orders

Business Overview

Retailers selling through e-commerce channels often take customer orders even if inventory is not available immediately, with the expectation of future inventory being available to fill the order. If an order is captured against future inventory by the Order Management System (OMS), then a backorder message is sent to Merchandising through this service. The location which will be back ordered is decided by OMS.

This web service updates the backorder quantity in Merchandising - increasing when the backorder is taken and decreasing when the backorder is released for fulfillment or cancellation. Backorders can be taken against both stores and warehouses.

Service Type

POST

ReST URL

MerchIntegrations/services/customerOrders/inventoryBackorder/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	No	Collection of Object	A collection of items for which backorder quantity has to be updated.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	The item identifier. An item does not need to have an open purchase order in order to increase backorder quantity. Catchweight, Transformable, Consignment, Concession and Deposit container items are not supported for backorder requests. The item should not be in discontinued status at the specified location.
locationType	Yes	String (1)	Type of location. Valid values are 'S' (store) and 'W' (warehouse).
location	Yes	Number (10)	Location where the item back order inventory has to be updated. This field may contain a store or a physical warehouse.
channelId	No	Number (4)	Channel id for the Physical Warehouse.
backorderQuantity	Yes	Number (12,4)	Contains the Back Order quantity to be adjusted for the item/location.
uom	No	String (4)	Contains the unit of measure for Back Order quantity. If not defined, back orderable quantity is assumed to be in standard unit of measure.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100050005",
      "locationType": "S",
      "location": 1521,
      "channelId": 1,
      "backorderQuantity": 3,
      "uom": "EA"
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Create Inventory Requests

Functional Area

Inventory

Business Overview

Merchandising receives requests for inventory using this service, which allows for items to be ordered by the store and fulfilled through Merchandising. Unlike store order replenishment, Merchandising fulfills inventory requests from the store regardless of replenishment review cycles, delivery dates, and any other factors that may restrict a request from being fulfilled.

For item/store combinations that are on the Store Order type of replenishment in Merchandising, orders will be placed using this service and then the replenishment process builds the recommended order quantity (ROQ) based on the store's requests. Requests that will not be reviewed prior to the date requested by the store are fulfilled through a one-off process (through this service) that creates warehouse transfers and/or purchase orders to fulfill the requested quantities.

For item/location combinations that are currently using other methods of replenishment in Merchandising, the store requested quantities will be added on top of the calculated recommended order quantities to increase the overall replenishment. It can also be used for item/store combinations not on replenishment in Merchandising. In these cases, the one-off process described above will be used to create purchase orders or transfers, utilizing attributes defined for the item/location.

Other validation notes:

• Order quantities will be rounded using the store order multiple when an order is created for a warehouse or rounded to the case size if ordering from the supplier.

• Up charges will always be applied to a transfer, if they are defined for the items with locations matching the transfer.

• Merchandising will validate that all items belong to the same department when department level ordering (supplier) or department level transfers (warehouse) are being used.

• The store must be open for ordering.

Service Type

POST

ReST URL

MerchIntegrations/services/inventory/requests/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
requestId	Yes	Number (10)	Used to build an error record when necessary.
store	Yes	Number (10)	The store ID which is requesting the item. The store must exist as a valid stockholding store in Merchandising.
requestType	Yes	String (2)	Defines the request type. Valid values are: Store order (SO) or Inventory Request (IR). If the request type is SO or blank, then replenishment method should be store order. If the request type is IR, delivery slot should be provided.
details	Yes	Collection of Object	References a collection of items on the inventory request.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	Unique alphanumeric value that identifies the item to be requested. The item must be approved, orderable, and inventoried item; it must also be ranged to the location in the inventory request and must be active at that location.
quantity	Yes	Number (12,4)	This is the quantity being requested in standard UOM.
unitOfPurchase	Yes	String (6)	Unit of purchase must either be eaches (EA), case (CA), or pallet (PA).
needDate	Yes	date	This is the date that the store needs the item by.
deliverySlotId	No	String (15)	Specifies when the store requested quantity is needed at the store. Valid delivery slots are in the DELIVERY_SLOT table.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "requestId": 693933,
      "store": 6000,
      "requestType": "SO",
      "details": [
        {
          "item": "100100076",
          "quantity": 3,
          "unitOfPurchase": "EA",
          "needDate": "2001-12-31",
          "deliverySlotId": null
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Inventory Transfer Services

This section describes the inventory transfer services.

Functional Area

Inventory Movement

Business Overview

The primary role of these services is to create transfers and send them to Merchandising.

Transfer Number

Business Overview

Retrieves the next transfer number from Merchandising.

Service Type

Get

ReST URL

/Transfer/transferId

Input Parameters

No input

Output

…RDO

Parameter Name	Data Type
transfer_no	Long

JSON Structure:
"{
    ""links"": [],
    ""transfer_no"": 100000029403,
    ""hyperMediaContent"": {
        ""linkRDO"": []
    }
}"

Table Impact

NA

Search Items

Business Overview

This service retrieves items applicable for inventory transfer. Item can be searched either by Item or VPN. To search the item, enter an item number, a partial item description, or a VPN in the search string.

• When search type is ITEM, the search string can be an item number, a partial item number, an item description, or partial item description. In this case, the query returns all items which match the item description or partial description, or which match the item number entered.

• When search type is VPN, the search string can be a VPN or partial VPN, the API should return all items with that VPN.

  The items returned are constrained by the following criteria:

  • Approved status.

  • Transaction-level items.

  • Inventory items.

• When From Location is sent as an input, then only the following items are returned:

  • With available inventory at the From Location.

  • Packs with Receive as Type as Each are filtered out when, from location is a virtual warehouse.

• If the System Option for DEPT_LEVEL_TRANSFERS is set as"Y" and a Department ID is sent as input, then only the input department items are returned.

Service Type

Get

ReST URL

/Transfer/item?itemSearchType={itemSearchType}&searchString={searchString}&dept={dept}&fromLocation={fromLocation}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description	Valid values
itemSearchType	Yes	Search type item or VPN.	ITEM, VPN
searchString	Yes	Search string for items ID or Name.	NA
dept	No	Selected items' department ID.	NA
fromLocation	No	Selected from location ID.	NA
PageSize	No	Maximum number of items to retrieve per page.	NA
PageNumber	No	Result page to retrieve.	NA

Output

TsfItemSearchRDO

Parameter Name	Data Type
item	String
itemDesc	String
dept	BigDecimal
availQty	BigDecimal
averageCost	BigDecimal
unitRetail	BigDecimal
currencyCode	String
standardlUnitOfMeasure	String
suppPackSize	BigDecimal
innerPackSize	BigDecimal
itemImageUrl	String

PagedResultsRDO

Parameter Name	Data Type
totalRecordCount	BigDecimal
Next Page URL	String
Previous Page URL	String

JSON Structure:
"{
    ""links"": [
        {
            ""href"": ""/Transfer/item?itemSearchType=ITEM&searchString=Black&fromLocation=363640301&pageSize=1&pageNumber=3"",
            ""rel"": ""next"",
            ""type"": ""GET"",
            ""methodType"": null
        },
        {
            ""href"": ""/Transfer/item?itemSearchType=ITEM&searchString=Black&fromLocation=363640301&pageSize=1&pageNumber=1"",
            ""rel"": ""prev"",
            ""type"": ""GET"",
            ""methodType"": null
        }
    ],
    ""totalRecordCount"": 51,
    ""results"": [
        {
            ""links"": [],
            ""item"": ""100001406"",
            ""itemDesc"": ""DIT Test 11:Black:Extra Small"",
            ""dept"": 1102,
            ""availQty"": 100,
            ""averageCost"": 5,
            ""unitRetail"": 7.26,
            ""currencyCode"": ""USD"",
            ""standardlUnitOfMeasure"": ""CKG"",
            ""suppPackSize"": 1,
            ""innerPackSize"": 1,
            ""itemImageUrl"": null,
            ""hyperMediaContent"": {
                ""linkRDO"": []
            }
        }
    ],
    ""hyperMediaContent"": {
        ""linkRDO"": [
            {
                ""href"": ""/Transfer/item?itemSearchType=ITEM&searchString=Black&fromLocation=363640301&pageSize=1&pageNumber=3"",
                ""rel"": ""next"",
                ""type"": ""GET"",
                ""methodType"": null
            },
            {
                ""href"": ""/Transfer/item?itemSearchType=ITEM&searchString=Black&fromLocation=363640301&pageSize=1&pageNumber=1"",
                ""rel"": ""prev"",
                ""type"": ""GET"",
                ""methodType"": null
            }
        ]
    }
}"

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALLOC_HEADER	Yes	No	No	No
ALLOC_DETAIL	Yes	No	No	No
DAILY_PURGE	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
ITEM_LOC_SOH	Yes	No	No	No
ITEM_IMAGE	Yes	No	No	No
ITEM_SUPPLIER	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
ORDHEAD	Yes	No	No	No
STORE	Yes	No	No	No
V_ITEM_MASTER	Yes	No	No	No
WH	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Load Items

This section describes the load items.

Business Overview

Load items service allows the user to refresh item records information for already selected items.

Service Type

Get

ReST URL

/Transfer/item/load?items={items}&fromLocation={fromLocation}

Input Paramters

Parameter Name	Required	Description
items	Yes	Comma Separated values for selected items' ID.
fromLocation	No	Selected from location ID.

Output

TsfItemSearchRDO

Parameter Name	Data Type
item	String
itemDesc	String
dept	BigDecimal
availQty	BigDecimal
averageCost	BigDecimal
unitRetail	BigDecimal
currencyCode	String
standardlUnitOfMeasure	String
suppPackSize	BigDecimal
innerPackSize	BigDecimal
itemImageUrl	String

JSON Structure:
"[
    {
        ""links"": [],
        ""item"": ""100001887"",
        ""itemDesc"": ""DIT Test 12:Black:Medium"",
        ""dept"": 1102,
        ""availQty"": 100,
        ""averageCost"": 5,
        ""unitRetail"": 7.26,
        ""currencyCode"": ""USD"",
        ""standardlUnitOfMeasure"": ""CKG"",
        ""suppPackSize"": 1,
        ""innerPackSize"": 1,
        ""itemImageUrl"": null,
        ""hyperMediaContent"": {
            ""linkRDO"": []
        }
    }
]"

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALLOC_HEADER	Yes	No	No	No
ALLOC_DETAIL	Yes	No	No	No
DAILY_PURGE	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
ITEM_LOC_SOH	Yes	No	No	No
ITEM_IMAGE	Yes	No	No	No
ITEM_SUPPLIER	Yes	No	No	No
ITEM_SUPP_COUNTRY	Yes	No	No	No
ORDHEAD	Yes	No	No	No
STORE	Yes	No	No	No
V_ITEM_MASTER	Yes	No	No	No
WH	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Search From Location

This section describes the Search From Location service.

Business Overview

This service retrieves locations applicable for inventory transfer. Location can be searched by either 'S'tore or 'W'arehouse. Then enter a location number, a partial location number, a location description, or a partial location description in the search string.

The locations returned are constrained by the following criteria:

• When search type is warehouse only virtual warehouses are returned.

• Only stockholding location.

• When search type is store then only open stores are returned.

• When items are sent as input then only locations with available inventory are returned.

• When To Location is sent as input then:

  • It cannot be the same as the To Location.

  • When transfer type is Manual Requisition, then only locations with the same Transfer Entity/Set of Books as the To Location are returned in the search results.

  • When the transfer type is Intercompany, then only locations with a different Transfer Entity/Set of Books to the To Location are returned in the search results.

  • Only locations in the same transfer zone are returned in the search results.

Service Type

Get

ReST URL

/Transfer/fromLocation?locationType={locationType}&searchString={searchString}&tsfType={tsfType}&toLocation={toLocation}&items={items}&pageSize={pageSize}&pageNumber={pageNumber}

Input Parameters

Parameter Name	Required	Description	Valid values
LocationType	Yes	Location type Store or warehouse	S, W
SearchString	Yes	search string for locations Id or Name	NA
tsfType	Yes	Transfer type	IC, MR
toLocation	No	Selected to location ID	NA
items	No	Comma Separated values for selected items	NA
PageSize	No	Maximum number of locations to retrieve per page	NA
PageNumber	No	Result page to retrieve	NA

Output

TsfLocSearchResultRDO

Parameter Name	Data Type
location	BigDecimal
locType	String
locName	String
locCurrencyCode	String
entity	BigDecimal
entityDesc	String
tsfLocitemSearchRes	List<TsfLocitemSearchResRDO>

TsfLocitemSearchResRDO

Parameter Name	Data Type
item	String
availQty	BigDecimal
averageCost	BigDecimal
unitRetail	BigDecimal
currencyCode	String

PagedResultsRDO

Parameter Name	Data Type
totalRecordCount	BigDecimal
Next Page URL	String
Previous Page URL	String

JSON Structure:
"{
    ""links"": [],
    ""totalRecordCount"": 1,
    ""results"": [
        {
            ""links"": [],
            ""location"": 5991,
            ""locType"": ""S"",
            ""locName"": ""DIT Company Stockholding Store"",
            ""locCurrencyCode"": ""USD"",
            ""entity"": 1000,
            ""entityDesc"": ""Regular Stores"",
            ""tsfLocitemSearchRes"": [
                {
                    ""links"": [],
                    ""item"": ""100054006"",
                    ""availQty"": 100,
                    ""averageCost"": 0,
                    ""unitRetail"": 181.82,
                    ""currencyCode"": ""USD"",
                    ""hyperMediaContent"": {
                        ""linkRDO"": []
                    }
                },
                {
                    ""links"": [],
                    ""item"": ""100040051"",
                    ""availQty"": 998,
                    ""averageCost"": 1,
                    ""unitRetail"": 1.54,
                    ""currencyCode"": ""USD"",
                    ""hyperMediaContent"": {
                        ""linkRDO"": []
                    }
                }
            ],
            ""hyperMediaContent"": {
                ""linkRDO"": []
            }
        }
    ],
    ""hyperMediaContent"": {
        ""linkRDO"": []
    }
}"

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALLOC_HEADER	Yes	No	No	No
ALLOC_DETAIL	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
ITEM_LOC_SOH	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
MV_LOC_SOB	Yes	No	No	No
ORDHEAD	Yes	No	No	No
ORG_UNIT	Yes	No	No	No
STORE	Yes	No	No	No
TRANSFER_LOC	Yes	No	No	No
TSF_ENTITY	Yes	No	No	No
V_STORE	Yes	No	No	No
V_TRANSFER_FROM_LOC	Yes	No	No	No
V_TRANSFER_TO_LOC	Yes	No	No	No
V_WH	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Search To Location

This section describes the Search To Location service.

Business Overview

This service retrieves locations applicable for inventory transfer. Location can be searched by either 'S'tore or 'W'arehouse. Then enter a location number, a partial location number, a location description, or a partial location description in the search string.

The locations returned are constrained by the following criteria:

• When search type is warehouse only virtual warehouses are returned.

• Internal finishers are filtered out.

• Only stockholding location.

• When search type is Store then only open stores are returned.

• When items are sent as input then only locations with available inventory are returned.

• When From Location is sent as input then:

  • To Location cannot be the same as the From Location.

  • When Transfer Type is set as a manual request, then only locations with the same Transfer Entity/Set of Books as the From Location are returned in the search results.

  • When the Transfer Type is Intercompany, then only locations with a different Transfer Entity/Set of Books to the From Location are returned in the search results.

  • Only locations in the same transfer zone are returned in the search results.

Service Type

Get

ReST URL

/Transfer/toLocation?locationType={locationType}&searchString={searchString}&tsfType={tsfType}&fromLocation={fromLocation}&pageSize={pageSize}&pageNumber={pageNumber}")

Input Parameters

Parameter Name	Required	Description	Valid values
LocationType	Yes	Location type Store or warehouse	S, W
SearchString	Yes	search string for locations Id or Name	NA
tsfType	Yes	Transfer type	IC, MR
fromLocation	No	Selected from location ID	NA
PageSize	No	Maximum number of locations to retrieve per page	NA
PageNumber	No	Result page to retrieve	NA

Output

TsfLocSearchResultRDO

Parameter Name	Data Type
location	BigDecimal
locType	String
locName	String
locCurrencyCode	String
entity	BigDecimal
entityDesc	String
tsfLocitemSearchRes	List<TsfLocitemSearchResRDO>

TsfLocitemSearchResRDO

Parameter Name	Data Type
item	String
availQty	BigDecimal
averageCost	BigDecimal
unitRetail	BigDecimal
currencyCode	String

PagedResultsRDO

Parameter Name	Data Type
totalRecordCount	BigDecimal
Next Page URL	String
Previous Page URL	String

JSON Structure:
"{
    ""links"": [],
    ""totalRecordCount"": 1,
    ""results"": [
        {
            ""links"": [],
            ""location"": 5991,
            ""locType"": ""S"",
            ""locName"": ""DIT Company Stockholding Store"",
            ""locCurrencyCode"": ""USD"",
            ""entity"": 1000,
            ""entityDesc"": ""Regular Stores"",
            ""tsfLocitemSearchRes"": [],
            ""hyperMediaContent"": {
                ""linkRDO"": []
            }
        }
    ],
    ""hyperMediaContent"": {
        ""linkRDO"": []
    }
}"

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALLOC_HEADER	Yes	No	No	No
ALLOC_DETAIL	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
ITEM_LOC_SOH	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
MV_LOC_SOB	Yes	No	No	No
ORDHEAD	Yes	No	No	No
ORG_UNIT	Yes	No	No	No
STORE	Yes	No	No	No
TRANSFER_LOC	Yes	No	No	No
TSF_ENTITY	Yes	No	No	No
V_STORE	Yes	No	No	No
V_TRANSFER_FROM_LOC	Yes	No	No	No
V_TRANSFER_TO_LOC	Yes	No	No	No
V_WH	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Load Locations

This section describes the Load Locations service.

Business Overview

Load locations Web service allows user to refresh selected locations records.

Service Type

Get

ReST URL

/Transfer/loadLocations?fromLocation={fromLocation}&toLocation={toLocation}

Input Parameters

Parameter Name	Required	Description
FromLocation	No	Selected from location ID.
ToLocation	No	Selected to location ID.

Output

TsfLocSearchResultRDO

Parameter Name	Data Type
location	BigDecimal
locType	String
locName	String
locCurrencyCode	String
entity	BigDecimal
entityDesc	String
tsfLocitemSearchRes	List<TsfLocitemSearchResRDO>

TsfLocitemSearchResRDO

Parameter Name	Data Type
item	String
availQty	BigDecimal
averageCost	BigDecimal
unitRetail	BigDecimal
currencyCode	String

JSON Structure:
"[
    {
        ""links"": [],
        ""location"": 5991,
        ""locType"": ""S"",
        ""locName"": ""DIT Company Stockholding Store"",
        ""locCurrencyCode"": ""USD"",
        ""entity"": 1000,
        ""entityDesc"": ""Regular Stores"",
        ""tsfLocitemSearchRes"": [],
        ""hyperMediaContent"": {
            ""linkRDO"": []
        }
    },
    {
        ""links"": [],
        ""location"": 12310101,
        ""locType"": ""W"",
        ""locName"": ""test"",
        ""locCurrencyCode"": ""USD"",
        ""entity"": 1000,
        ""entityDesc"": ""Regular Stores"",
        ""tsfLocitemSearchRes"": [],
        ""hyperMediaContent"": {
            ""linkRDO"": []
        }
    }
]"

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
ALLOC_HEADER	Yes	No	No	No
ALLOC_DETAIL	Yes	No	No	No
ITEM_LOC	Yes	No	No	No
ITEM_LOC_SOH	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
MV_LOC_SOB	Yes	No	No	No
ORDHEAD	Yes	No	No	No
ORG_UNIT	Yes	No	No	No
STORE	Yes	No	No	No
TRANSFER_LOC	Yes	No	No	No
TSF_ENTITY	Yes	No	No	No
V_STORE	Yes	No	No	No
V_TRANSFER_FROM_LOC	Yes	No	No	No
V_TRANSFER_TO_LOC	Yes	No	No	No
V_WH	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Create Transfer

This section describes the Create Transfer service.

Business Overview

The Web service calls the existing Merchandising XTSF API directly with input parameters. For more information on Merchandising XTSF API, see Store Order Subscription API and Transfer Subscription API sections.

Service Type

Post

ReST URL

/Transfer

Input Parameters

Example JSON RDO input:

{
    "links" : [ ],
     "tsfdtlRDOs" : [ {
       "links" : [ ],
       "item" : null,
       "tsfQty" : null,
       "suppPackSize" : null,
       "invStatus" : null, 
       "unitCost" : null,
       "hyperMediaContent" : {
         "linkRDO" : [ ]
       }
     } ],
     "tsfNo" : null,
     "fromLocType" : null,
     "fromLoc" : null,
     "toLocType" : null,
     "toLoc" : null,
     "deliveryDate" : null,
     "dept" : null,
     "routingCode" : null,
     "freightCode" : null,
     "tsfType" : null,
     "status" : null,
     "userId" : null,
     "commentDesc" : null,
     "contextType" : null,
     "contextValue" : null,
     "hyperMediaContent" : {
       "linkRDO" : [ ]
     }
   }

Output

NA

Table Impact

For more information on the Merchandising XTSF API, see the Store Order Subscription API and Transfer Subscription API sections.

Create Items

Functional Area

Items

Business Overview

This service is used by an external system to create items in Merchandising.

Item request payload include the detail nodes for the supplier and supplier/country. If the item is not a non-sellable pack, the item/zone/price node is also required. Optional nodes can be included in the message for supplier/country, supplier/country/location, pack components, item/vat, dimension, UDA, season, image, translations, HTS, assessments, expenses, and upcharges.

This service supports the insertion of data into the Item Induction staging tables without requiring that the data sent to be functionally complete. If a complete set of item data is sent by the external system through this service, then it is possible to automatically trigger the upload of the data directly into Merchandising by setting a flag in the input payload, such that item information is uploaded without further user interaction.

Items must be created and maintained following a logical hierarchy as outlined by the referential integrity of the item database tables: Item parents before child items; item components before items that are packs; items before item-suppliers; item/suppliers before item/supplier/countries; items before item/locations (a separate service), and so on. Failing to do so results in message failure.

The auto-creation of item children using differentiator records attached to an item parent, as currently occurs using RMS online processes, is not supported in this service.

When a new item is created, this service will first validate that all required fields are present in the message. After that, business level validation on the input information will be performed. If all the validations are met, then the item is created with the status defined in the message. If the status in the message is approved, then the item is also subjected to a series of approval checks. For an item to be successfully approved, mandatory information, such as supplier, supplier country, component item information (if item is a pack), is required to be passed as part of the item message. If the item cannot be approved, it is not created. The following information can be included for the item: Expenses, HTS and Assessments, Tickets, UDA, VAT (for SVAT tax type), Upcharges, Images, Seasons, Item Supplier Country Locations, Item Supplier Manufacturing Country and Item Supplier Country Dimension. If included, these are created simultaneously with the creation of the item. 

If item VAT is not populated, item VAT defaults to the corresponding department's VAT information.

Service Type

POST

ReST URL

MerchIntegrations/services/items/create

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the main item on the message.
itemParent	No	String (25)	The item at the level above this item. This value must be predefined as an item on the ITEM_MASTER table.
itemGrandparent	No	String (25)	The item two levels above this item. This value must be predefined as an item on the ITEM_MASTER table.
itemNumberType	No	String (6)	Contains the code specifying what type the item is. Valid codes are defined in the UPCT code type. Examples are: MANL - Manual, ITEM - Oracle Retail Item Number.
itemLevel	No	Number (1)	The level of the item. Valid values are 1 (single level or pack item), 2 (child item), and 3 (grandchild item).
tranLevel	No	Number (1)	The transaction level of the item. Valid values are 1, 2, and 3. If this is a transaction item this will equal the item level. If the item is a pack this will equal 1. This value cannot be modified.
status	No	String (1)	Status of the item.
inventoryInd	No	String (1)	This indicates if an item holds inventory or not for item transformation. Valid values are Y (yes) and N (no).
dept	No	Number (4)	The number of the department to which this item belongs. This value must be predefined on the DEPS table. It cannot be modified.
class	No	Number (4)	The number of the class to which the item belongs. This value must be predefined on the CLASS table. It cannot be modified.
subclass	No	Number (4)	The number of the subclass to which the item belongs. This value must be predefined on the SUBCLASS table. It cannot be modified.
itemDescription	No	String (250)	The long description of the item.
shortDescription	No	String (120)	The short description of the item. If this field is not populated it will default from the long description.
itemDescriptionSecondary	No	String (250)	Secondary descriptions of the item.
standardUom	No	String (4)	The unit of measure at which the item is tracked at the corporate level. This will be defaulted to EA (eaches) if not populated on the message. It cannot be modified.
sellableInd	No	String (1)	If the item is a pack, this value indicates if the pack can be sold as a unique unit. Valid values are Y (yes) and N (no). This value cannot be modified. It should be Y for a non-pack item.
orderableInd	No	String (1)	If the item is a pack, this field indicates if it can be placed on orders. Valid values are Y (yes) and N (no). This field cannot be modified. It should be Y for a non-pack item.
simplePackInd	No	String (1)	Indicates if the item is a simple pack. This field is required if the item is a pack. Valid values are Y (yes) and N (no). This value cannot be modified.
packInd	No	String (1)	Indicates if the item is a pack item. Valid values are Y (yes) and N (no). This value cannot be modified.
containsInnerInd	No	String (1)	This should be Y (yes) if the item is a pack and at least one component item is a pack; otherwise it should be N (no).
packType	No	String (1)	If the item is a pack, this field will indicate what type of pack it is. Valid values are B (buyer) and V (vendor). This field cannot be modified. If the item is not a pack this value should be null.
orderAsType	No	String (1)	If the item is an orderable buyer pack, this indicates how it will be ordered. Valid values are E (eaches) and P (pack). This field cannot be modified. If the item is not a pack, this should be null.
diff1	No	String (10)	Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz).
diff2	No	String (10)	Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz).
diff3	No	String (10)	Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz).
diff4	No	String (10)	Diff_group or diff_id that differentiates the current item from its item_parent. For an item that is a parent, this field may be either a group (i.e. Mens pant sizes) or a value (6 oz).
storeOrderMultiple	No	String (1)	The unit type of merchandise shipped from the warehouse to the store for this item. Valid values are C (cases), I (inners), and E (eaches).
forecastInd	No	String (1)	Indicates whether the item is forecastable. Valid value are Y (yes) and N (no). This value should be N if the item is a pack.
uomConversionFactor	No	Number (20,10)	Conversion factor between an Each and the standard_uom when the standard_uom is not in the quantity class (e. g. if standard_uom = lb and 1 lb = 10 eaches, this factor will be 10). This factor will be used to convert sales and stock data when an item is retailed in eaches but does not have eaches as its standard unit of measure.
packageSize	No	Number (12,4)	Holds the size of the product printed on any packaging (i. e. 24 ounces). This field is used for reporting purposes, as well as by Oracle Retail Price Mangement to determine same sized and different sized items.
handlingTemperature	No	String (6)	Holds the temperature information associated with the item. Valid codes are defined in the HTMP code type. Examples are: FRIDGE - Keep Refrigerated, FROZEN - Keep Frozen.
handlingSensitivity	No	String (6)	Holds the sensitivity information associated with the item. Valid codes are defined in the HSEN code type. Examples are: EXPLOD - Explosive, FRAG - Fragile.
manufacturerRecommendedRetail	No	Number (20,4)	Manufacturers recommended retail price for the item in primary currency. Used for informational purposes only.
wasteType	No	String (6)	Identifies the wastage type as either sales or spoilage wastage. Valid values are: SP - Spoilage, SL - Sales Wastage is not applicable to pack items.
averageWastePercentage	No	Number (12,4)	Average percent of wastage for the item over its shelf life. Used in inflating the retail price for wastage items.
catchWeightInd	No	String (1)	Indiactes whether the item should be weighed when it arives at a location. Valid values for this field are Y and N.
orderType	No	String (6)	This determines how catch weight items are ordered. Valid codes are defined in the ORDT code type. Examples are: F - fixed weight, V - Variable weight.
saleType	No	String (6)	This indicates the method of how catch weight items are sold in store locations. Valid values are: V - variable weight each, L - Loose weight.
catchWeightUom	No	String (4)	Unit of measure of a catch weight item.
depositItemType	No	String (6)	This is the deposit item component type. Valid values are: E - Contents, A - Container, Z - Crate, T - Returned Item (Empty bottle), P - Complex pack (with deposit items).
containerItem	No	String (25)	This holds the container item number for a content item.
packageUom	No	String (4)	Holds the unit of measure associated with the package size. This field is used for reporting purposes and by Retek Price Management to determine same sized and different sized items.
formatId	No	String (1)	This field will hold the format ID that corresponds to the items variable UPC. This value is only used for items with variable UPCs.
prefix	No	Number (2)	This column holds the prefix for variable weight UPCs.
itemTransformationInd	No	String (1)	This indicates if an item is associated with an item transformation process. If yes, the item will be either the sellable item or the orderable item in the transformation process.
brandName	No	String (120)	This is added to capture the brand information of an item.
productClassification	No	String (6)	This defines which items can be combined (packed or boxed) together. Valid codes are defined in the PCLA code type. Examples are: APP - Apparel, GRC - Grocery.
merchandiseInd	No	String (1)	Indicates if the item is a merchandise item. Valid values are Y (yes) and N (no).
originalRetail	No	Number (20,4)	The original retail price of the item per unit. This field is stored in the primary currency.
retailLabelType	No	String (6)	This field indicates any special label type assoctiated with an item. Valid codes are defined in the RTLT code type. Examples are: COFF - Cents Off, EXTRA - Extra Product, PREP - Pre-Priced.
retailLabelValue	No	Number (20,4)	This field represents the value associated with the retail label type.
defaultWastePercentage	No	Number (12,4)	Default daily wastage percent for spoilage type wastage items.
itemServiceLevel	No	String (6)	Holds a value that restricts the type of shipment methods that RCOM can select for an item.
depositInPricePerUom	No	String (6)	This field indicates if the deposit amount is included in the price per UOM calculation for a contents item ticket. Valid codes are defined in the DITM code type. Examples are: E - Exclusive of Deposit Amount, I - Inclusive of Deposit Amount.
constantDimensionInd	No	String (1)	Indicates that the dimensions of the product are always the same, regardless of the supplier. If this field is Y, the dimensions for all suppliers will be defaulted to the primary supplier/primary country dimensions. Editing of dimensions for the item will only be allowed for the primary supplier/primary country.
giftWrapInd	No	String (1)	This field will contain a value of 'Y' if the item is eligible to be gift wrapped.
shipAloneInd	No	String (1)	This field will contain a value of Y if the item should be shipped to the customer is a seperate package versus being grouped together in a box.
itemAggregateInd	No	String (1)	This field holds an indicator of whether the retailer wants to aggregate inventory and sales for the item with the inventory and sales of other child items. For staple items, this indicator is always set to N. For fashion items, this indicator may be Y. If this indicator is Y, the retailer may also define which diff positions should be aggregated into item/diff combinations. Aggregated sales and inventory planning data can be used for inventory decision making and other reporting.
diff1AggregateInd	No	String (1)	This field holds an indicator (Y/N) of whether the retailer wants to aggregate inventory and sales for the item by the first Diff defined for the item (e.g Style/Color).
diff2AggregateInd	No	String (1)	This field holds an indicator (Y/N) of whether the retailer wants to aggregate inventory and sales for the item by the second Diff defined for the item (e.g Style/Waist Size).
diff3AggregateInd	No	String (1)	This field holds an indicator (Y/N) of whether the retailer wants to aggregate inventory and sales for the item by the third Diff defined for the item (e.g Style/Inseam).
diff4AggregateInd	No	String (1)	This field holds an indicator (Y/N) of whether the retailer wants to aggregate inventory and sales for the item by the fourth Diff defined for the item (e.g Style/Pattern).
perishableInd	No	String (1)	Indicates if an item is perishable.
storePackInventoryInd	No	String (1)	Indicates if inventory for a sellable simple pack should be tracked at a pack level in Store Inventory Operations. Valid values are Y (yes) for tracking at a pack level and N (no) for tracking at a component level.
sohInquiryAtPackInd	No	String (1)	Indicates in Store Inventory Operations if a notional simple pack item's inventory should be displayed in packs. Valid values are Y (yes) and N (no).
aipCaseType	No	String (6)	Only used if AIP is integrated. Determines which case sizes to extract against an item in the AIP interface. Applicable only to non-pack orderable items.
costZoneGroupId	No	Number (4)	The cost zone from the cost_zone_group table to which the item belongs. This should be null if landed cost is not being used in the system or the item is an orderable buyer pack.
itemSuppCountryLocHierarchyLevel	No	String (2)	The level of the organizational hierarchy used to create item supplier country location relationships. Valid values are CH (chain), AR (area), RE (region), DI (district), S (store), W (warehouse).
itemZonePriceHierarchyLevel	No	String (2)	The level of the organizational hierarchy used to create item zone price relationships. Valid values are CH (chain), AR (area), RE (region), DI (district), S (store), and W (warehouse). This value should be null if the item is a non sellable pack.
comments	No	String (2000)	Comments associated with the item.
dataLoadingDestination	No	String (6)	This field indicates if the item will be created in Merchandising or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes.
translation	No	Collection of Object	References a collection of translations of the item description field.
supplier	No	Collection of Object	References a collection of suppliers associated to the item.
retailByZone	No	Collection of Object	References a collection of item zone price information.
packDetail	No	Collection of Object	References a collection of component items if the item is a pack item.
vat	No	Collection of Object	References a collection of vat information.
uda	No	Collection of Object	References a collection of item UDAs.
season	No	Collection of Object	References a collection of item seasons.
image	No	Collection of Object	References a collection of item images.
hts	No	Collection of Object	References a collection of item HTS.
expense	No	Collection of Object	References a collection of item expenses.
ticket	No	Collection of Object	References a collection of item ticket.
upcharge	No	Collection of Object	References a collection of item upcharges.

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

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

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

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

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

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

Table 5-80 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-81 Dimension - Object. See list of elements for detail

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

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

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

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

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

Table 5-84 PackDetail - Object. See list of elements for detail

Element Name	Required	Data Type	Description
componentItem	Yes	String (25)	The component item within the pack. This value must be predefined on ITEM_MASTER. It will only be populated if the item on the message is a pack item. This value cannot be modified. Only transaction level items can be pack components.
quantity	Yes	Number (12,4)	The quantity of the component item. This value cannot be modified.

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

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

Table 5-86 RetailByZone - Object. See list of elements for detail

Element Name	Required	Data Type	Description
hierarchyId	Yes	Number (10)	The specific hierarchy id for this Item Zone Price message. Corresponds with value used in izp_hier_level field.
sellingUnitRetail	No	Number (20,4)	The selling unit retail value in the currency and the selling UOM on the message. This field cannot be modified.
sellingUom	No	String (4)	The selling unit of measure for the item's single unit retail. This field cannot be modified.
multiUnitSellingUom	No	String (4)	The selling unit of measure for the item's multi unit retail. This field cannot be modified.
country	No	String (3)	Not used.
currencyCode	No	String (3)	The code of the currency the retail value and zones are in. Item zone price records will only be created for stores with the same currency as the retail value on the message.
multiUnits	No	Number (12,4)	The multi units for the item zone. This field cannot be modified.
multiUnitRetail	No	Number (20,4)	The multi unit retail in the currency and the multi unit UOM specified on the message. This field cannot be modified.

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

Element Name	Required	Data Type	Description
udaId	Yes	Number (5)	This field contains a number identifying the User-Defined Attribute.
displayType	Yes	String (2)	This field contains the display type (how the UDA values will be displayed to the user) for the given UDA. The valid values are DT -Date, FF - Free From, LV - List of values.
udaDate	No	date	This field contains the text value of the Used Defined attribute for the item.
udaValue	No	String (30)	This field contains value of the Used Defined attribute for the item.
udaText	No	String (250)	This field contains the text value of the Used Defined attribute for the item.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Element Name	Required	Data Type	Description
fromLocationType	Yes	String (6)	Location type of the from_loc. This can be S - Store,W - Warehouse,A - Area,R - Region,C - Country,AS - All Stores,AW - All Warehouses
fromLocation	No	String (10)	Depending on the from_loc_type, this contains the organization hierarchy value of store, warehouse, area, region, or country from which transferring goods will incur upcharges. It will not contain a value when from_loc_type is AS (all stores) or AW (all warehouses).
toLocationType	Yes	String (6)	Location_type of the to_loc. This can be S - Store,W - Warehouse,A - Area,R - Region,C - Country,AS - All Stores,AW - All Warehouses
toLocation	No	String (10)	Depending on the to_loc_type, this contains the organization hierarchy value of store, warehouse, area, region, or country to which transferring goods will incur upcharges. It will not contain a value when to_loc_type is AS (all stores) or AW (all warehouses).
details	Yes	Collection of Object	References a collection of item upcharge detail records.

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

Element Name	Required	Data Type	Description
componentId	Yes	String (10)	Up Charge component.
componentRate	Yes	Number (20,4)	The rate to be charged against the cost of the Item/To Location combinations within the department. The value in this field will be a percentage if the calculation basis is V (Value), and a monetary amount if the calculation basis is S.
perCount	No	Number (12,4)	count indicating the amount of the Per Count Unit of Measure to which the rate applies. This will only contain a value if the calculation basis is S (Specific).
perCountUom	No	String (4)	contains the unit of measure in which the Per Count is specified. This column will only contain a value if the calculation basis is S (Specific).
upChargeGroup	Yes	String (6)	group to which the component ID belongs. This can be A-Admin. Fee,F-Freight,K-Special K Fees,M-Miscellaneous,T-Taxes,W-Franchise.
componentCurrency	Yes	String (3)	Currency of the Up Charge component.
transferAllocationDefaultInd	No	String (1)	Indicates whether all existing transfers and allocations belonging to the hierarchy should be updated or not.
computationValueBase	No	String (10)	Contains the Computation Value Basis for the Up Charge component.
costBasis	No	String (6)	Contains the basis the Up Charge will be calculated against. Valid values are defined in code type UCCB (Up Charge Cost Basis) with values: Weighted Average Cost (W) and Supplier Cost (S) and Off-Invoice Net Cost (N).
includeInTotalUpchargeInd	No	String (1)	Used to determine if the value of the individual up charge component is used to calculate the total up charge (Y) or if it is only used as the basis of calculating another up charge (N).

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "itemParent": null,
      "itemGrandparent": null,
      "itemNumberType": "MANL",
      "itemLevel": 1,
      "tranLevel": 1,
      "status": "W",
      "inventoryInd": "Y",
      "dept": 3041,
      "class": 1,
      "subclass": 1,
      "itemDescription": "Regular Item 100100076",
      "shortDescription": "100100076 Item",
      "itemDescriptionSecondary": "100100076 Item Regular",
      "standardUom": "EA",
      "sellableInd": "Y",
      "orderableInd": "Y",
      "simplePackInd": "N",
      "packInd": "N",
      "containsInnerInd": "N",
      "packType": null,
      "orderAsType": null,
      "diff1": null,
      "diff2": null,
      "diff3": null,
      "diff4": null,
      "storeOrderMultiple": "E",
      "forecastInd": null,
      "uomConversionFactor": 3,
      "packageSize": 90.00,
      "handlingTemperature": null,
      "handlingSensitivity": null,
      "manufacturerRecommendedRetail": 12.99,
      "wasteType": null,
      "averageWastePercentage": 18.00,
      "catchWeightInd": "N",
      "orderType": null,
      "saleType": null,
      "catchWeightUom": null,
      "depositItemType": null,
      "containerItem": null,
      "packageUom": null,
      "formatId": null,
      "prefix": null,
      "itemTransformationInd": "N",
      "brandName": null,
      "productClassification": null,
      "merchandiseInd": "Y",
      "originalRetail": 12.99,
      "retailLabelType": null,
      "retailLabelValue": null,
      "defaultWastePercentage": null,
      "itemServiceLevel": null,
      "depositInPricePerUom": "I",
      "constantDimensionInd": "Y",
      "giftWrapInd": "Y",
      "shipAloneInd": "Y",
      "itemAggregateInd": "N",
      "diff1AggregateInd": "N",
      "diff2AggregateInd": "N",
      "diff3AggregateInd": "N",
      "diff4AggregateInd": "N",
      "perishableInd": "Y",
      "storePackInventoryInd": "N",
      "sohInquiryAtPackInd": "N",
      "aipCaseType": null,
      "costZoneGroupId": 1000,
      "itemSuppCountryLocHierarchyLevel": "S",
      "itemZonePriceHierarchyLevel": "S",
      "comments": null,
      "dataLoadingDestination": "RMS",
      "customFlexAttribute": [
        {
          "name": "REVIEW_DATE",
          "value": null,
          "valueDate": "2001-12-31"
        }
      ],
      "translation": [
        {
          "language": 2,
          "shortDescription": "shortDesc",
          "itemDescription": "itemDesc",
          "itemDescriptionSecondary": "itemDescSecondary"
        }
      ],
      "supplier": [
        {
          "supplier": "2400",
          "primarySupplierInd": "Y",
          "vpn": null,
          "supplierLabel": null,
          "consignmentRate": 3,
          "supplierDiscontinueDate": "2001-12-31",
          "directShipInd": "Y",
          "palletName": "PAL",
          "caseName": "CS",
          "innerName": "INR",
          "primaryCaseSize": null,
          "supplierDiff1": null,
          "supplierDiff2": null,
          "supplierDiff3": null,
          "supplierDiff4": null,
          "concessionRate": 1,
          "defaultExpenseProfilesInd": "Y",
          "customFlexAttribute": [
            {
              "name": "REVIEW_DATE",
              "value": null,
              "valueDate": "2001-12-31"
            }
          ],
          "translation": [
            {
              "language": 2,
              "supplierDiff1": null,
              "supplierDiff2": null,
              "supplierDiff3": null,
              "supplierDiff4": null,
              "supplierLabel": null
            }
          ],
          "countryOfSourcing": [
            {
              "originCountry": "US",
              "primaryCountryInd": "Y",
              "unitCost": 9.65,
              "leadTime": 1,
              "pickupLeadTime": 1,
              "mininumOrderQuantity": 1,
              "maximumOrderQuantity": 1,
              "supplierHierarchyLevel1": null,
              "supplierHierarchyLevel2": null,
              "supplierHierarchyLevel3": null,
              "defaultUop": "EA",
              "supplierPackSize": 1,
              "innerPackSize": 1,
              "ti": 1,
              "hi": 1,
              "costUom": "EA",
              "toleranceType": null,
              "minimumTolerance": 76.00,
              "maximumTolerance": 69.00,
              "supplierHierarchyType1": null,
              "supplierHierarchyType2": null,
              "supplierHierarchyType3": null,
              "roundLevel": "C",
              "roundToInnerPercentage": 50,
              "roundToCasePercentage": 50,
              "roundToLayerPercentage": 50,
              "roundToPalletPercentage": 50,
              "packingMethod": "HANG",
              "defaultExpenseProfilesInd": "Y",
              "purchaseType": "0",
              "calculationBasis": null,
              "purchaseRate": 18.00,
              "customFlexAttribute": [
                {
                  "name": "REVIEW_DATE",
                  "value": null,
                  "valueDate": "2001-12-31"
                }
              ],
              "dimension": [
                {
                  "dimensionObject": "PA",
                  "tareWeight": 12,
                  "tareType": "D",
                  "lwhUom": "IN",
                  "length": 3,
                  "width": 3,
                  "height": 3,
                  "liquidVolume": 3,
                  "liquidVolumeUom": null,
                  "statisticalCase": null,
                  "weightUom": "LBS",
                  "weight": 3,
                  "netWeight": 11.00,
                  "presentationMethod": null
                }
              ],
              "location": [
                {
                  "hierarchyId": 113605,
                  "unitCost": 9.65,
                  "negotiatedItemCost": 9.65,
                  "pickupLeadTime": 1000,
                  "roundLevel": "C",
                  "roundToCasePercentage": 3,
                  "roundToLayerPercentage": 3,
                  "roundToPalletPercentage": 3,
                  "roundToInnerPercentage": 3,
                  "supplierHierarchyLevel1": null,
                  "supplierHierarchyLevel2": null,
                  "supplierHierarchyLevel3": null,
                  "costUom": "EA",
                  "purchaseType": "0",
                  "calculationBasis": null,
                  "purchaseRate": 3,
                  "customFlexAttribute": [
                    {
                      "name": "REVIEW_DATE",
                      "value": null,
                      "valueDate": "2001-12-31"
                    }
                  ]
                }
              ]
            }
          ],
          "countryOfManufacture": [
            {
              "manufacturerCountry": "BR",
              "primaryManufacturerCountryInd": "N"
            }
          ]
        }
      ],
      "retailByZone": [
        {
          "hierarchyId": 113605,
          "sellingUnitRetail": 12.99,
          "sellingUom": "EA",
          "multiUnitSellingUom": "EA",
          "country": "US",
          "currencyCode": "USD",
          "multiUnits": 3,
          "multiUnitRetail": 12.99
        }
      ],
      "packDetail": [
        {
          "componentItem": null,
          "quantity": 3
        }
      ],
      "vat": [
        {
          "vatType": "B",
          "vatRegion": 1000,
          "vatCode": "S",
          "activeDate": null,
          "reverseVatInd": "N"
        }
      ],
      "uda": [
        {
          "udaId": 201,
          "displayType": "FF",
          "udaDate": null,
          "udaValue": null,
          "udaText": null
        }
      ],
      "season": [
        {
          "seasonId": 100,
          "phaseId": 100,
          "sequenceNo": 1000,
          "diffId": null
        }
      ],
      "image": [
        {
          "imageName": "imageName1",
          "imageAddress": "http://www.oracle.com/",
          "imageDescription": "imageDesc1",
          "imageType": "T",
          "primaryImageInd": "Y",
          "displayPriority": 1,
          "translation": [
            {
              "language": 2,
              "imageDescription": "Item Image"
            }
          ]
        }
      ],
      "hts": [
        {
          "hts": null,
          "importCountry": "US",
          "originCountry": "US",
          "effectFrom": "2001-12-31",
          "effectTo": "2001-12-31",
          "clearingZoneId": null,
          "status": "W",
          "assessments": [
            {
              "componentId": "AGCOMM",
              "computationValueBase": "TDTYUS",
              "componentRate": 3.55,
              "perCount": null,
              "perCountUom": null,
              "estimatedAssessmentValue": null,
              "nominationFlag1": "N",
              "inDuty": "+",
              "nominationFlag3": "N",
              "inExpense": "N",
              "inAlc": "N"
            }
          ]
        }
      ],
      "expense": [
        {
          "supplier": 2400,
          "componentId": "AGCOMM",
          "dischargePort": "480",
          "originCountry": "US",
          "ladingPort": "7",
          "costZoneId": 696323,
          "costZoneGroupId": 1000,
          "baseExpenseInd": "N",
          "computationValueBase": null,
          "componentRate": 3.55,
          "perCount": 1,
          "perCountUom": "EA",
          "componentCurrency": "USD",
          "updateOrdersInd": "Y",
          "nominationFlag1": "N",
          "inDuty": "N",
          "nominationFlag3": "N",
          "inExpense": "+",
          "inAlc": "N"
        }
      ],
      "ticket": [
        {
          "ticketTypeId": null,
          "poPrintType": null,
          "printOnPriceChangeInd": "Y",
          "ticketOverPrintPercentage": 3
        }
      ],
      "upcharge": [
        {
          "fromLocationType": "S",
          "fromLocation": "6000",
          "toLocationType": "S",
          "toLocation": "6001",
          "details": [
            {
              "componentId": null,
              "componentRate": 3.55,
              "perCount": 3,
              "perCountUom": "EA",
              "upChargeGroup": null,
              "componentCurrency": "USD",
              "transferAllocationDefaultInd": "Y",
              "computationValueBase": null,
              "costBasis": null,
              "includeInTotalUpchargeInd": null
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Description Translations

Functional Area

Items

Business Overview

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/description/translations/create

Input Payload Details

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

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

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

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

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

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

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "106150023",
      "dataLoadingDestination": "RMS",
      "translation": [
        {
          "language": 5,
          "shortDescription": "登録項目",
          "itemDescription": "レギュラーアイテム 106150023",
          "itemDescriptionSecondary": "レギュラーアイテム二次 106150023"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Expenses

Functional Area

Items

Business Overview

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/expenses/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

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

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

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

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "expense": [
        {
          "supplier": 2400,
          "componentId": "AGCOMM",
          "dischargePort": "480",
          "originCountry": "US",
          "ladingPort": "7",
          "costZoneId": 696323,
          "costZoneGroupId": 1000,
          "baseExpenseInd": "N",
          "computationValueBase": null,
          "componentRate": 3.55,
          "perCount": 1,
          "perCountUom": "EA",
          "componentCurrency": "USD",
          "updateOrdersInd": "Y",
          "nominationFlag1": "N",
          "inDuty": "N",
          "nominationFlag3": "N",
          "inExpense": "+",
          "inAlc": "N"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item HTS

Functional Area

Items

Business Overview

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/hts/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

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

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

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

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

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

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item HTS Assessments

Functional Area

Items

Business Overview

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/hts/assessments/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

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

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

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

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

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

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Image Translations

Functional Area

Items

Business Overview

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/image/translations/create

Input Payload Details

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

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

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

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

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

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

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

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

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100083",
      "dataLoadingDestination": "RMS",
      "image": [
        {
          "imageName": "imageName1",
          "translation": [
            {
              "language": 8,
              "imageDescription": "供应商形象优先"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Images

Functional Area

Items

Business Overview

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/images/create

Input Payload Details

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

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

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

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

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

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

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

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

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "image": [
        {
          "imageName": "imageName1",
          "imageAddress": "http://www.oracle.com/",
          "imageDescription": "imageDesc1",
          "imageType": "T",
          "primaryImageInd": "Y",
          "displayPriority": 1,
          "translation": [
            {
              "language": 2,
              "imageDescription": "Item Image"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Locations

Functional Area

Items

Business Overview

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

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/locations/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

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

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

Element Name	Required	Data Type	Description
hierarchyValue	Yes	Number (10)	Valid ID for a chain, area, region, district, store or warehouse given based on the hierarchy Level.
primarySupplier	No	Number (10)	The primary supplier for the item at the location. If not populated, this will default from the primary supplier on the ITEM_SUPPLIER table.
primaryCountry	No	String (3)	The primary country for the item at the location. If not populated on a create message this will default from the primary country on the ITEM_SUPP_COUNTRY table.
localItemDescription	No	String (250)	Local description for the item at the location. If not populated on the message this will default from the ITEM_MASTER table.
status	Yes	String (1)	The status of the item at the location.
storeOrderMultiple	Yes	String (1)	The unit type of the item shipped from the warehouse to the location. Valid values are C (cases), I (inners), and E (eaches). Eaches will default if left null on a create message.
receiveAsType	No	String (1)	The unit in which the warehouse will receive goods. Valid values are E (eaches) and P (pack). This field only applies to buyer packs. If the item is not a buyer pack this field should be null.
taxableInd	Yes	String (1)	Indicates if the item is taxable at the location. Valid values are 'Y' and 'N'. If not populated on the message it will default to 'Y'.
ti	No	Number (12)	Number of shipping units (cases) that make up one tier of a pallet. Multiply TI x HI to get total number of cases for a pallet.
hi	No	Number (12)	Number of tiers that make up a complete pallet (height). Multiply TI x HI to get total number of cases for a pallet.
dailyWastePercent	No	Number (12,4)	Average percentage lost from inventory on a daily basis due to natural wastage.
localShortDescription	No	String (120)	The local short description of the item. Will default to the item's short description. Will be downloaded to the POS.
uinType	No	String (6)	This attribute will contain the type of the unique identification number (UIN) used to identify instances of the item at the location. Valid values for this attribute should be user-definable on the Merchandising code tables. This attribute should be nullable.
uinLabel	No	String (6)	This attribute will contain the label for the UIN when displayed in Store Inventory Operations. Valid values should be user-definable on the Merchandising code tables. This attribute should be nullable but a value is required when a UIN Type is specified.
captureTime	No	String (6)	This attribute will indicate when the UIN should be captured for an item during transaction processing. There are 2 valid values for this field which should be stored on the Merchandising code tables: Sale and Store Receiving. This attribute should be nullable.
externalUinInd	No	String (1)	This Yes/No indicator indicates if UIN is being generated in the external system (e. g. SIM). This value will always be N (no) when the Capture Time attribute is set to Sale.
sourceMethod	No	String (1)	Determines the source method for a requested item at a store. Valid values: 'W'(warehouse) and 'S'(supplier), default value is 'S'.
sourceWarehouse	No	Number (10)	If the source_method is 'W', this field contains the source warehouse for fulfilling item requests at a store.
unitCost	No	Number (20,4)	The current corporate unit cost for the item in the location's currency. This field will only be used to establish the item supplier country loc unit cost; it cannot be modified.
purchaseType	No	String (1)	This contains a code to indicate whether the item is normal merchandise (i. e. owned by the retailer), consignment stock or a concession item. Valid values are 0 - Owned, 1 - Consignment, 2 - Concession.
calculationBasis	No	String (1)	This indicates if the cost for the consignment/concession item will be managed either based on cost per unit or as a percentage of retail. Valid values are C - Cost per Unit, P - Purchase Rate.
purchaseRate	No	Number (12,4)	This column contains the percentage of the retail price which will determnie the cost paid to the supplier for a consignment or concession item.
promotableInd	No	String (1)	This field will indicates,if the item can be included on promotions or not.
rfidInd	No	String (1)	This indicates if the item is RFID tagged or not. Valid values are Yes (Y) and No (N).
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes.
trait	No	Record	References a location trait record.

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

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

Table 5-124 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.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100000024",
      "hierarchyLevel": "S",
      "locations": [
        {
          "hierarchyValue": 6000,
          "primarySupplier": 6100,
          "primaryCountry": "US",
          "localItemDescription": "100000024 at 6000",
          "status": "A",
          "storeOrderMultiple": "E",
          "receiveAsType": null,
          "taxableInd": "N",
          "ti": 1,
          "hi": 1,
          "dailyWastePercent": 1,
          "localShortDescription": "100000024 at 6000",
          "uinType": null,
          "uinLabel": null,
          "captureTime": null,
          "externalUinInd": "N",
          "sourceMethod": "S",
          "sourceWarehouse": null,
          "unitCost": 9.65,
          "purchaseType": null,
          "calculationBasis": null,
          "purchaseRate": 1,
          "promotableInd": "N",
          "rfidInd": "N",
          "customFlexAttribute": [
            {
              "name": "REVIEW_DATE",
              "value": null,
              "valueDate": null
            }
          ],
          "trait": {
            "launchDate": "2001-12-31",
            "quantityKeyOptions": null,
            "manualPriceEntry": null,
            "depositCode": null,
            "foodStampInd": "N",
            "wicInd": "N",
            "proportionalTarePercent": 3,
            "fixedTareValue": 3,
            "fixedTareUom": "EA",
            "rewardEligibleInd": "N",
            "nationalBrandCompetitorItem": null,
            "returnPolicy": null,
            "stopSaleInd": "N",
            "electronicMarketClubs": null,
            "reportCode": null,
            "requiredShelfLifeOnSelection": 1000,
            "requiredShelfLifeOnReceipt": 1000,
            "investmentBuyShelfLife": 1000,
            "storeReorderableInd": "Y",
            "rackSize": null,
            "fullPalletItem": null,
            "inStoreMarketBasket": null,
            "storageLocation": null,
            "alternateStorageLocation": null,
            "returnableInd": "N",
            "refundableInd": "N",
            "backOrderInd": "N"
          }
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Reclassification

Functional Area

Merchandise Hierarchy - Reclassification

Business Overview

This service allows external systems to create item reclassification events within Merchandising which are necessary in order to keep it in sync with the external system. Merchandising subscribes to item reclassification messages, which updates the department, class, and/or subclass for an item, based on the data that is published by the external system. Only the following item types can be interfaced using this API:

• Transaction level items without a parent

• Parent items, whose child items are the transaction level, such as with a fashion style (parent) and its SKUs (children)

• Complex pack items - but the reclassification cannot include the component items in the pack

The following item types cannot be reclassified:

• Child items with a parent - these are reclassified when the parent is updated

• Reference items - these below transaction level items are automatically reclassified with the transaction level item or its parent, whichever applies.

• Simple Packs - these are reclassified when the component item is reclassified

This service also allows a reclassification event to be created for a department/class/subclass combination that does not exist yet. This is valid as long as the merchandise hierarchy is scheduled to be created on or prior to the reclassification taking effect. In order to create a reclassification, both header and detail level records are required.

Service Type

POST

ReST URL

MerchIntegrations/services/merchandiseHierarchy/itemReclassification/create

Availability During Nightly Batch Cycle

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

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
reclassNo	Yes	Number (4)	The unique number which identifies the reclass event.
description	Yes	String (120)	The description of the reclass event.
reclassDate	Yes	date	The date on which the reclass event is scheduled to take place.
toDept	Yes	Number (4)	The department to which the item will belong after the reclass event.
toClass	Yes	Number (4)	The class to which the item will belong after the reclass event.
toSubclass	Yes	Number (4)	The subclass to which the item will belong after the reclass event.
items	No	Collection of Object	References a collection of items in the reclassification event.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	The item in the reclass event.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "reclassNo": 1,
      "description": "reclassDesc",
      "reclassDate": "2001-12-31",
      "toDept": 3041,
      "toClass": 1,
      "toSubclass": 1,
      "items": [
        {
          "item": "100100076"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Reclassification Detail

Functional Area

Merchandise Hierarchy - Reclassification

Business Overview

This service allows external systems to add items to an existing item reclassification event in Merchandising in order to keep it in sync with the external system. Merchandising subscribes to item reclassification requests, which update the department, class, and/or subclass for the item, based on the data that is published by the external system. 

Before an item is added to the reclassification event, the following things would be validated:

• Must be a level 1 item

• If the item is a pack, it should not be a simple pack

• Must not be on any approved order

• Must not be an orderable buyer pack that can be received as component items

• Must not be on an existing reclassification

Service Type

POST

ReST URL

MerchIntegrations/services/merchandiseHierarchy/itemReclassification/detail/create

Availability During Nightly Batch Cycle

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

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
reclassNo	Yes	Number (4)	The unique number which identifies the reclass event.
description	Yes	String (120)	The description of the reclass event.
reclassDate	Yes	date	The date on which the reclass event is scheduled to take place.
toDept	Yes	Number (4)	The department to which the item will belong after the reclass event.
toClass	Yes	Number (4)	The class to which the item will belong after the reclass event.
toSubclass	Yes	Number (4)	The subclass to which the item will belong after the reclass event.
items	No	Collection of Object	References a collection of items in the reclassification event.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	The item to be added to the reclassification event.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "reclassNo": 1,
      "description": "reclassDesc",
      "reclassDate": "2001-12-31",
      "toDept": 3041,
      "toClass": 1,
      "toSubclass": 1,
      "items": [
        {
          "item": "100100076"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Seasons

Functional Area

Items

Business Overview

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/seasons/create

Input Payload Details

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

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

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

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

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

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

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "season": [
        {
          "seasonId": 1,
          "phaseId": 1,
          "sequenceNo": 1,
          "diffId": null
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Suppliers

Functional Area

Items

Business Overview

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/suppliers/create

Input Payload Details

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

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

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

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

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

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

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

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

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

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

Table 5-139 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-140 CountryOfManufacture - Object. See list of elements for detail

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

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

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

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Supplier Countries

Functional Area

Items

Business Overview

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/supplier/countries/create

Input Payload Details

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

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

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

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

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

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

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

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

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

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

Table 5-147 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.

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Supplier Countries of Manufacture

Functional Area

Items

Business Overview

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/supplier/countriesOfManufacture/create

Input Payload Details

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

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

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

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

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

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

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

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

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100300001",
      "dataLoadingDestination": "RMS",
      "supplier": [
        {
          "supplier": "2400",
          "countryOfManufacture": [
            {
              "manufacturerCountry": "BR",
              "primaryManufacturerCountryInd": "N"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Supplier Country Dimensions

Functional Area

Items

Business Overview

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

Service Type

POST

ReST URL

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

Input Payload Details

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

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

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

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

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

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

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

Element Name	Required	Data Type	Description
originCountry	Yes	String (3)	The identifier for the country where the item is sourced. This value must be predefined on the COUNTRY table.
dimension	No	Collection of Object	References a collection of item supplier country dimensions.

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

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

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "102250001",
      "dataLoadingDestination": "RMS",
      "supplier": [
        {
          "supplier": "2400",
          "countryOfSourcing": [
            {
              "originCountry": "US",
              "dimension": [
                {
                  "dimensionObject": "CA",
                  "tareWeight": 3,
                  "tareType": "D",
                  "lwhUom": "IN",
                  "length": 3,
                  "width": 3,
                  "height": 3,
                  "liquidVolume": 3,
                  "liquidVolumeUom": "EA",
                  "statisticalCase": null,
                  "weightUom": "EA",
                  "weight": 3,
                  "netWeight": 11.00,
                  "presentationMethod": null
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Supplier Country Locations

Functional Area

Items

Business Overview

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

Service Type

POST

ReST URL

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

Input Payload Details

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

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

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

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

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

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

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

Element Name	Required	Data Type	Description
originCountry	Yes	String (3)	The identifier for the country where the item is sourced. This value must be predefined on the COUNTRY table.
location	No	Collection of Object	References a collection of item supplier country locations.

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

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

Table 5-162 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.

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Supplier Translations

Functional Area

Items

Business Overview

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/supplier/translations/create

Input Payload Details

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

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

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

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

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

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

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

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

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "dataLoadingDestination": "RMS",
      "supplier": [
        {
          "supplier": "2400",
          "translation": [
            {
              "language": 13,
              "supplierDiff1": "فرق المورد 1",
              "supplierDiff2": "فرق المورد 2",
              "supplierDiff3": "فرق المورد 3",
              "supplierDiff4": "فرق المورد 4",
              "supplierLabel": "عنصر تسمية المورد"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Taxes

Functional Area

Items

Business Overview

This service is used to add VAT (value added tax) information to an existing item in Merchandising when default tax type for the system is SVAT (Simple VAT).  The item must already exist in Merchandising, else an error will be returned. Item VAT can also be created together with the creation of a new item. For more details on item creation, see the Create Items service description.

Service Type

POST

ReST URL

MerchIntegrations/services/item/taxes/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

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

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

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

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "itemLevel": 1,
      "tranLevel": 1,
      "dataLoadingDestination": "RMS",
      "vat": [
        {
          "vatType": "B",
          "vatRegion": 1000,
          "vatCode": "S",
          "activeDate": null,
          "reverseVatInd": "N"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Tickets

Functional Area

Items

Business Overview

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/tickets/create

Input Payload Details

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

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

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

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

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

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

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "102350095",
      "dataLoadingDestination": "RMS",
      "ticket": [
        {
          "ticketTypeId": "TKT2",
          "poPrintType": "R",
          "printOnPriceChangeInd": "Y",
          "ticketOverPrintPercentage": 99
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Transformations

Functional Area

Items

Business Overview

The service provides the ability to process inventory adjustments and WAC recalculation in Merchandising for item transformations from an external system such as the Fresh Product Management System. The service accepts the list of input & output items involved in the transformation and carry out inventory adjustments to account for inventory conversions in the transformation. Based on the product transformations details, the inventory of the input item(s) will be decremented, and the inventory of the output item(s) will be incremented.  

An item transformation may also include the costs involved in labor and packaging. In order to communicate the conversion cost to Merchandising as this will have impact on Stock Ledger postings and WAC calculation, the transformation request can also carry activity codes for each transformation activity involved in producing the output items. The cost associated with each of these activities can be predefined in Merchandising or can be interfaced in the transformation message with the activity code.

The service supports a collection of item transformation request and will return success or failure through the service response object. If there are upload validation errors, the record will be rejected, and a failure status will be returned as part of the response object in the web service call.

Service Type

POST

ReST URL

MerchIntegrations/services/item/transformations/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
transformationId	Yes	String (15)	The external reference id corresponding to a transformation. This should be unique at LOCATION and TRANSFORMATION DATE level.
location	Yes	Number (10)	The stockholding company store or the stockholding virtual warehouse at which the transformation was performed.
locationType	Yes	String (1)	The type of the location. Valid values are S - Store and W - Warehouse.
transformationDate	No	date	The date of transformation. This can be a past or present date in reference to the Vdate. Valid format is 'yyyy-mm-dd'.
workOrderActivity	No	Collection of Object	Collection of all the work order activities involved in the transformation.
transformationInput	Yes	Collection of Object	Collection of the input item details involved in the transformation.
transformationOutput	Yes	Collection of Object	Collection of the output item details involved in the transformation.

Table 5-175 WorkOrderActivity - Object. See list of elements for detail

Element Name	Required	Data Type	Description
activityCode	Yes	String (10)	The activity code corresponding to the work order activity involved in transformation such as labor and packaging cost.
activityCost	No	Number (20,4)	The cost involved in the work order activity.
currencyCode	No	String (3)	The currency in which the activity cost is provided. If the value is null and an activity cost is provided, then it is assumed that the given activity cost is in the location's currency.

Table 5-176 TransformationInput - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	The transaction level or below transaction level item which was used as an input item or as an output item in the transformation activity.
disposition	No	String (10)	This value is used to determine if the quantity of the input/output item consumed/generated in the transformation is from available or unavailable inventory buckets based on the dispositions INV_STATUS value in the INV_STATUS_CODES table.
quantity	Yes	Number (12,4)	The quantity consumed for the input item or the quantity generated for the output item.
quantityUom	No	String (4)	The UOM corresponding to the quantity value. It should be a UOM from the same uom class as that of the uom class of the Standard UOM of the item.

Table 5-177 CreateError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
itemTransformationError	Yes	Collection of Object	Collection of Item transformation error records.

Table 5-178 ItemTransformationError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
transformationId	Yes	String (15)	The external reference id corresponding to a transformation. This should be unique at LOCATION and TRANSFORMATION DATE level.
location	Yes	Number (10)	The stockholding company store or the stockholding virtual warehouse at which the transformation was performed.
locationType	Yes	String (1)	The type of the location. Valid values are S - Store and W - Warehouse.
transformationDate	Yes	date	The date of transformation. This can be a past or present date in reference to the Vdate. Valid format is 'yyyy-mm-dd'.
errors	Yes	Array of String	Collection of error messages.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "transformationId": "10001",
      "location": 1531,
      "locationType": "S",
      "transformationDate": "2001-12-31",
      "workOrderActivity": [
        {
          "activityCode": "12122",
          "activityCost": 10,
          "currencyCode": "USD"
        }
      ],
      "transformationInput": [
        {
          "item": "101050103",
          "disposition": "ATS",
          "quantity": 2,
          "quantityUom": "EA"
        }
      ],
      "transformationOutput": [
        {
          "item": "101050103",
          "disposition": "ATS",
          "quantity": 2,
          "quantityUom": "EA"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Response Code: 400 (Error)

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

Table 5-179 CreateError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
itemTransformationError	Yes	Collection of Object	Collection of Item transformation error records.

Table 5-180 ItemTransformationError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
transformationId	Yes	String (15)	The external reference id corresponding to a transformation. This should be unique at LOCATION and TRANSFORMATION DATE level.
location	Yes	Number (10)	The stockholding company store or the stockholding virtual warehouse at which the transformation was performed.
locationType	Yes	String (1)	The type of the location. Valid values are S - Store and W - Warehouse.
transformationDate	Yes	date	The date of transformation. This can be a past or present date in reference to the Vdate. Valid format is 'yyyy-mm-dd'.
errors	Yes	Array of String	Collection of error messages.

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": [
    {
      "itemTransformationError": [
        {
          "transformationId": "String",
          "location": 190104,
          "locationType": "?",
          "transformationDate": "2001-12-31",
          "errors": [
            "String"
          ]
        }
      ]
    }
  ]
}

Create Item UDAs

Functional Area

Items

Business Overview

This service is used to create item UDA (user defined attributes) of type data/freeform text/list of values for an existing item in Merchandising.  UDAs can also be created together with the creation of a new item.  For more details on item creation, see the Create Items service description.

Service Type

POST

ReST URL

MerchIntegrations/services/item/uda/create

Input Payload Details

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

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

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

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

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

Element Name	Required	Data Type	Description
udaId	Yes	Number (5)	This field contains a number identifying the User-Defined Attribute.
displayType	Yes	String (2)	This field contains the display type (how the UDA values will be displayed to the user) for the given UDA. The valid values are DT -Date, FF - Free From, LV - List of values.
udaDate	No	date	This field contains the text value of the Used Defined attribute for the item.
udaValue	No	String (30)	This field contains value of the Used Defined attribute for the item.
udaText	No	String (250)	This field contains the text value of the Used Defined attribute for the item.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100087",
      "dataLoadingDestination": "RMS",
      "uda": [
        {
          "udaId": 201,
          "displayType": "FF",
          "udaDate": "2001-12-31",
          "udaValue": null,
          "udaText": "UDA FF Text 100100087"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Item Up Charges

Functional Area

Items

Business Overview

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/upCharges/create

Availability During Nightly Batch Cycle

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

Input Payload Details

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

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

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

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

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

Element Name	Required	Data Type	Description
fromLocationType	Yes	String (6)	Location type of the from_loc. This can be S - Store,W - Warehouse,A - Area,R - Region,C - Country,AS - All Stores,AW - All Warehouses
fromLocation	No	String (10)	Depending on the from_loc_type, this contains the organization hierarchy value of store, warehouse, area, region, or country from which transferring goods will incur upcharges. It will not contain a value when from_loc_type is AS (all stores) or AW (all warehouses).
toLocationType	Yes	String (6)	Location_type of the to_loc. This can be S - Store,W - Warehouse,A - Area,R - Region,C - Country,AS - All Stores,AW - All Warehouses
toLocation	No	String (10)	Depending on the to_loc_type, this contains the organization hierarchy value of store, warehouse, area, region, or country to which transferring goods will incur upcharges. It will not contain a value when to_loc_type is AS (all stores) or AW (all warehouses).
details	Yes	Collection of Object	References a collection of item upcharge detail records.

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

Element Name	Required	Data Type	Description
componentId	Yes	String (10)	Up Charge component.
componentRate	Yes	Number (20,4)	The rate to be charged against the cost of the Item/To Location combinations within the department. The value in this field will be a percentage if the calculation basis is V (Value), and a monetary amount if the calculation basis is S.
perCount	No	Number (12,4)	count indicating the amount of the Per Count Unit of Measure to which the rate applies. This will only contain a value if the calculation basis is S (Specific).
perCountUom	No	String (4)	contains the unit of measure in which the Per Count is specified. This column will only contain a value if the calculation basis is S (Specific).
upChargeGroup	Yes	String (6)	group to which the component ID belongs. This can be A-Admin. Fee,F-Freight,K-Special K Fees,M-Miscellaneous,T-Taxes,W-Franchise.
componentCurrency	Yes	String (3)	Currency of the Up Charge component.
transferAllocationDefaultInd	No	String (1)	Indicates whether all existing transfers and allocations belonging to the hierarchy should be updated or not.
computationValueBase	No	String (10)	Contains the Computation Value Basis for the Up Charge component.
costBasis	No	String (6)	Contains the basis the Up Charge will be calculated against. Valid values are defined in code type UCCB (Up Charge Cost Basis) with values: Weighted Average Cost (W) and Supplier Cost (S) and Off-Invoice Net Cost (N).
includeInTotalUpchargeInd	No	String (1)	Used to determine if the value of the individual up charge component is used to calculate the total up charge (Y) or if it is only used as the basis of calculating another up charge (N).

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100550000",
      "dataLoadingDestination": "RMS",
      "upcharge": [
        {
          "fromLocationType": "S",
          "fromLocation": "1411",
          "toLocationType": "W",
          "toLocation": "50002",
          "details": [
            {
              "componentId": "WHFEE",
              "componentRate": 6.66,
              "perCount": 1,
              "perCountUom": "EA",
              "upChargeGroup": "A",
              "componentCurrency": "USD",
              "transferAllocationDefaultInd": "Y",
              "computationValueBase": null,
              "costBasis": null,
              "includeInTotalUpchargeInd": "Y"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Location Trait

Functional Area

Foundation

Business Overview

The service is used to create location traits within Merchandising in order to keep it in sync with an external system that is used to maintain location traits. While a location trait is being created, this service will first validate that all required fields are present in the payload. Next, business level validations will be performed on the input information. Once all the validations are met, the location trait gets created in Merchandising.

Service Type

POST

ReST URL

MerchIntegrations/services/foundation/locationTrait/create

Input Payload Details

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

Element Name	Required	Data Type	Description
traitId	Yes	Number (4)	The unique id number of the location trait.
description	Yes	String (120)	The description of the location trait.

Sample Input Message

{
  "traitId": 1000,
  "description": "traitDesc"
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Merchandise Hierarchy Reclassification

Functional Area

Merchandise Hierarchy - Reclassification

Business Overview

This service allows Merchandising to subscribe to merchandise hierarchy reclassification requests from an external system and is intended to be used by retailers who manage their hierarchies in an external system which is outside Merchandising. This service creates pending merchandise hierarchy reclassification events within Merchandising based on the data sent by the external system.

When a new merchandise hierarchy reclassification is created, the service will first validate that all the required fields are present in the payload. There are certain fields that are required irrespective of the hierarchy level, while there are a few which depend on other hierarchy configurations. After this is completed, business level validation will be carried out on the input information. 

There is a separate batch process to read the information that is present in the pending merchandise hierarchy table and create the merchandise hierarchy information in Merchandising on the effective date.

Service Type

POST

ReST URL

MerchIntegrations/services/merchandiseHierarchy/reclassification/create

Availability During Nightly Batch Cycle

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

Input Payload Details

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

Element Name	Required	Data Type	Description
hierarchyLevel	Yes	String (1)	Indicates the level of the merchandise hierarchy. Valid values are V (division), G (group), D (department), C (class), and S (subclass).
hierarchyId	Yes	Number (4)	Contains the merchandise hierarchy ID.
parentHierarchyId	No	Number (4)	The parent of the hierarchy identified in the hierarchyId field. This field is optional when hierarchyLevel is V (Division). For a Division, if parent is provided, it must be Company.
grandparentHierarchyId	No	Number (4)	The grandparent of the hierarchy identified in the hierarchyId field. This field will only be used when the hierarchyLevel indicates subclass. It will contain the number of the department the subclass belongs to.
hierarchyName	Yes	String (120)	The name of the hierarchy value.
effectiveDate	Yes	date	The date the hierarchy change will become effective.
actionType	No	String (1)	Indicates if this field is an addition or modification. Valid values are A and M. It is required on a create message and should not be populated on a modify message.
buyer	No	Number (4)	The number of the buyer associated with the entity. This value must be predefined on the BUYER table. This field should only hold a value if the hierarchy level indicates division, group, or department.
purchaseType	No	Number (1)	The code which indicates whether items in the department are normal merchandise (0) or consignment stock (1). This field will only be used if the hierarchy level indicates department.
totalMarketAmount	No	Number (24,4)	The total market amount that is expected for the entity. This field will only be used if the hierarchy value indicates division or department.
merchandiser	No	Number (4)	The number of the merchandiser associated with the entity. This value must be predefined on the MERCHANT table. This field should hold a value only if the hierarchy level indicates division, group, or department.
budgetedMarkupPercent	No	Number (12,4)	The budgeted markup percentage. The markup percent of cost. This field will only be used if the hierarchy level indicates department.
profitCalcType	No	Number (1)	The number which indicates whether profit will be calculated by direct cost (1) or retail inventory (2). This field will only be used if the hierarchy level indicates department.
markupCalcType	No	String (2)	The code letter which indicates how markup is calculated in the department. This field will only be used if the hierarchy level indicates department. Valid values are C (cost) and R (retail).
otbCalcType	No	String (1)	The code letter which indicates how OTB is calculated in the department. Valid values are cost (C) and retail (R). This field will only be used if the hierarchy value indicates department.
maximumAverageCounter	No	Number (5)	The maximum count of days with acceptable data to include in an average for items with the department. This field will only be used if the hierarchy level indicates department. It is required if RPM is installed.
averageTolerancePercent	No	Number (12,4)	The tolerance percentage value used in averaging for items within this value. This column will hold 70% as 70, not. 70. This field will only be used if the hierarchy value indicates department. It is required if RPM is installed.
budgetedIntakePercent	No	Number (12,4)	The budgeted intake percentage. The percent of the total take that is income. This field will only be used if the hierarchy value indicates department.
deptVatIncludeInd	No	String (1)	Indicates the default value for the class VAT indicator. When classes are initially set up they will inherit this value. This field will only be populated when the hierarchy level indicates department.
classVatInd	No	String (1)	Indicates if retail is displayed and held with or without VAT for items within a class. Valid values are Y (yes) and N (no). This field will only be used if the hierarchy level indicates class.

Sample Input Message

{
  "hierarchyLevel": "D",
  "hierarchyId": 100,
  "parentHierarchyId": 108,
  "grandparentHierarchyId": 1000,
  "hierarchyName": "Dept 100 MrchRcls Action New",
  "effectiveDate": null,
  "actionType": "A",
  "buyer": 305,
  "purchaseType": 0,
  "totalMarketAmount": 3,
  "merchandiser": 601,
  "budgetedMarkupPercent": 3,
  "profitCalcType": 1,
  "markupCalcType": "C",
  "otbCalcType": "C",
  "maximumAverageCounter": 10000,
  "averageTolerancePercent": 3,
  "budgetedIntakePercent": 15.00,
  "deptVatIncludeInd": "Y",
  "classVatInd": null
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

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

Create Outbound ASNs

Functional Area

Inventory - Shipments and Receipts

Business Overview

Merchandising receives advanced shipping notifications (ASNs), also known as a bill of lading (BOL) messages, from a warehouse management system, like Oracle Warehouse Management Cloud, or a store inventory system like Oracle Retail Store Inventory and Operations Cloud Service (SIOCS).

These ASNs are notifications to Merchandising that inventory is moving from one location to another and they contain data that is used by Merchandising to create or modify a shipment record. ASNs are received for:

• Pre-existing allocations

• Pre-existing transfers

• Externally generated transfers created in the store or warehouse (created as transfer type of EG within Merchandising).

An ASN message may contain details related to multiple transfers or allocations, and would enable the shipment record in Merchandising to reflect these multiple movements of the merchandise. The BOL number present on the shipment record is a way to track one or more transfers and allocations through their respective stock order records. Shipments for customer orders, franchise orders, and franchise returns are also managed through this service. If the receiving location is a non-stockholding location, like in the case of a warehouse shipment to a non-stockholding franchise store, or a warehouse shipment direct to a customer (that is processed through a non-stockholding store), then the shipment will be automatically received when processed by Merchandising.

Note:

ASNs related to a purchase order from a supplier are classified as an Inbound ASNs. Details for those types of expected shipments are found in the ASN In Subscription service documentation.

Other Notes

• For customer order fulfillment, SIOCS will send an ASN Out message that does not include a ship-to location. Such messages are ignored by Merchandising.

• Store to customer fulfillment requests will not have associated transfers in Merchandising. When Oracle Retail Store Inventory and Operations Cloud Service (SIOCS) ships the customer order,  then SIOCS will generate an Outbound ASN message with an empty ‘To Location’ or with the Location Type set as Customer (C). Since there are no associated transfers within Merchandising, it will not process these Outbound ASN messages. The reserved inventory will be backed out when Merchandising processes the related SALES transaction.

• Messages received through this service can create new shipments or update existing shipments. A new shipment record will be created in Merchandising in the ‘Input’ status if the BOL number is not yet associated to any shipment record. If the BOL number is already associated to a shipment record, the shipment record will be updated accordingly.

Service Type

POST

ReST URL

MerchIntegrations/services/inventory/shipmentsAndReceipts/outboundAsn/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
toLocation	No	Number (10)	Contains the location that the shipment will be delivered to.
fromLocation	Yes	Number (10)	For transfer and allocation shipments, this field will hold the location from which the shipment was sourced.
cartonQuantity	No	Number (6)	Contains the number of boxes associated with the shipment.
asnNo	No	String (30)	Holds the bill of lading number associated with a shipment. This field will be persisted in the bol_no column of the Shipment table in Merchandising.
bolNo	Yes	String (17)	Holds the transaction sequence number on the message from the transfer shipment confirmation process. This field will be persisted in the ext_ref_no_out column of the Shipment table in Merchandising.
shipDate	No	date	This field contains the date the transfer or PO was shipped.
estimatedArrivalDate	No	date	This field contains the estimated arrival date of a vendor PO shipment. It is updated by EDIUP856. It is used for vendor/lead time analysis.
comments	No	String (2000)	Contains any miscellaneous comments about the shipment.
carrierCode	No	String (4)	Contains the courier that will deliver the shipment.
shipmentDetails	No	Collection of Object	Description is not available.

Table 5-193 ShipmentDetails - Object. See list of elements for detail

Element Name	Required	Data Type	Description
distroNo	Yes	String (12)	Specifies the transfer or allocation number associated with the shipment/item/carton.
distroDocumentType	Yes	String (1)	Specifies what the distro_nbr field corresponds to in RMS: V, D, and T specify transfer, A specifies Allocation.
customerOrderNo	No	String (48)	This is the customer order number that was generated by OMS and contains multiple fulfillment numbers.
fulfillOrderNo	No	String (48)	Based on a customer order - OMS will generate fulfillments to specific locations based on availability. RMS will generate Transfers based on the fulfillment request.
comments	No	String (2000)	Not used by RMS.
cartons	Yes	Collection of Object	Description is not available.

Table 5-194 Cartons - Object. See list of elements for detail

Element Name	Required	Data Type	Description
carton	Yes	String (30)	Identifies the UCC-128 carton number for shipments originating from the Advance Shipment Notification process as carton shipments. This field will be zero for all shipments that are not at a carton level.
weight	No	Number (12,4)	Actual weight shipped for the container.
weightUom	No	String (4)	Unit of measurement for weight (e. g. pounds, kilograms) that was shipped.
items	Yes	Collection of Object	Description is not available.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	Unique identifier for the item.
unitQuantity	Yes	Number (12,4)	Contains the number of items expected to be received based on the supplier's advance shipment notification for this item/shipment combination.
fromDisposition	No	String (4)	This value is used to determine if the inventory is available or unavailable, based on the code's INV_STATUS value on the INV_STATUS_CODES table.
unitCost	No	Number (20,4)	Contains the unit cost of the item in the shipment.
baseCost	No	Number (20,4)	This value will be used to get the base cost (BC) from RFM for a transfer, which will flow into RMS.
weight	No	Number (12,4)	Actual weight shipped.
weightUom	No	String (4)	Unit of measurement for weight (e. g. pounds, kilograms) shipped.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "toLocation": 1221,
      "fromLocation": 1151,
      "cartonQuantity": 5,
      "asnNo": "ASN-100100990",
      "bolNo": "BOL-100100990",
      "shipDate": "2001-12-31",
      "estimatedArrivalDate": "2001-12-31",
      "comments": "Shipment for transfer 100100990",
      "carrierCode": "FDX",
      "shipmentDetails": [
        {
          "distroNo": "100100990",
          "distroDocumentType": "T",
          "customerOrderNo": null,
          "fulfillOrderNo": null,
          "comments": "Shipment for transfer 100100990",
          "cartons": [
            {
              "carton": "CRTN10001",
              "weight": 3,
              "weightUom": "KG",
              "items": [
                {
                  "item": "100100991",
                  "unitQuantity": 10,
                  "fromDisposition": "ATS",
                  "unitCost": 9.65,
                  "baseCost": 10.65,
                  "weight": 3,
                  "weightUom": "KG"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Payment Term

Functional Area

Financials - Terms

Business Overview

This service is used by Oracle Retail Financial Integration (RFI) for integration of payment terms with PeopleSoft Financials, and can also be used by an external financial system to send new payment terms information to Merchandising.

Service Type

POST

ReST URL

MerchIntegrations/services/financials/terms/paymentTerm/create

Input Payload Details

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

Element Name	Required	Data Type	Description
terms	No	String (15)	Unique id for this payment term.
termsCode	Yes	String (50)	The alpha value which acts as the Term code in Oracle Financials.
description	Yes	String (240)	Description of the payment terms.
rank	No	Number (10)	Unique rank to rate invoice payment terms against PO terms
details	No	Collection of Object	Child node.

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

Element Name	Required	Data Type	Description
termsSequence	Yes	Number (10)	Sequence for the discount percent and part of unique identifier for the detail line.
dueDays	Yes	Number (3)	The number of days until payment is due.
dueMaximumAmount	Yes	Number (12,4)	Maximum payment amount due by a certain date.
dueDayOfMonth	Yes	Number (2)	Day of month used to calculate due date.
discountDays	Yes	Number (3)	Number of days in which payment must be made to get the discount.
percent	Yes	Number (12,4)	Percentage used to calculate discount available.
discountDayOfMonth	Yes	Number (2)	Day of month used to calculate discount date.
discountMonthForward	Yes	Number (3)	Number of months ahead to calculate discount date.
fixedDate	No	date	Fixed due date.
enabledFlag	Yes	String (1)	Indicates whether the Payment terms are valid or invalid within the respective application. The values would be either (Y)es or (N)o.
startActiveDate	No	date	Start date terms are in effect.
endActiveDate	No	date	End date terms are in effect.
dueMonthForward	Yes	Number (3)	Number of months ahead to calculate due date.
cutoffDay	Yes	Number (2)	Day of month after which the following month will be used for calculations.

Sample Input Message

{
  "terms": "55",
  "termsCode": "55",
  "description": "55 termsDesc",
  "rank": 12,
  "details": [
    {
      "termsSequence": 1,
      "dueDays": 100,
      "dueMaximumAmount": 12.95,
      "dueDayOfMonth": 10,
      "discountDays": 100,
      "percent": 3,
      "discountDayOfMonth": 10,
      "discountMonthForward": 100,
      "fixedDate": "2001-12-31",
      "enabledFlag": "N",
      "startActiveDate": "2001-12-31",
      "endActiveDate": "2001-12-31",
      "dueMonthForward": 100,
      "cutoffDay": 10
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Payment Term Detail

Functional Area

Financials - Terms

Business Overview

This service can be used by an external financial system to send additional details for existing payment terms to Merchandising.

Service Type

POST

ReST URL

MerchIntegrations/services/financials/terms/paymentTerm/detail/create

Input Payload Details

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

Element Name	Required	Data Type	Description
terms	No	String (15)	Unique id for this payment term.
termsCode	Yes	String (50)	The alpha value which acts as the Term code in Oracle Financials.
description	Yes	String (240)	Description of the payment terms.
rank	No	Number (10)	Unique rank to rate invoice payment terms against PO terms
details	No	Collection of Object	Child node.

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

Element Name	Required	Data Type	Description
termsSequence	Yes	Number (10)	Sequence for the discount percent and part of unique identifier for the detail line.
dueDays	Yes	Number (3)	The number of days until payment is due.
dueMaximumAmount	Yes	Number (12,4)	Maximum payment amount due by a certain date.
dueDayOfMonth	Yes	Number (2)	Day of month used to calculate due date.
discountDays	Yes	Number (3)	Number of days in which payment must be made to get the discount.
percent	Yes	Number (12,4)	Percentage used to calculate discount available.
discountDayOfMonth	Yes	Number (2)	Day of month used to calculate discount date.
discountMonthForward	Yes	Number (3)	Number of months ahead to calculate discount date.
fixedDate	No	date	Fixed due date.
enabledFlag	Yes	String (1)	Indicates whether the Payment terms are valid or invalid within the respective application. The values would be either (Y)es or (N)o.
startActiveDate	No	date	Start date terms are in effect.
endActiveDate	No	date	End date terms are in effect.
dueMonthForward	Yes	Number (3)	Number of months ahead to calculate due date.
cutoffDay	Yes	Number (2)	Day of month after which the following month will be used for calculations.

Sample Input Message

{
  "terms": "55",
  "termsCode": "55DTLADD",
  "description": "55DESCDTLADD",
  "rank": 14,
  "details": [
    {
      "termsSequence": 2,
      "dueDays": 100,
      "dueMaximumAmount": 12.95,
      "dueDayOfMonth": 10,
      "discountDays": 100,
      "percent": 4,
      "discountDayOfMonth": 10,
      "discountMonthForward": 100,
      "fixedDate": "2001-12-31",
      "enabledFlag": "N",
      "startActiveDate": "2001-12-31",
      "endActiveDate": "2001-12-31",
      "dueMonthForward": 100,
      "cutoffDay": 12
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Placeholder Items

Functional Area

Items

Business Overview

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

The following item attributes are defaulted in this service -

• The transaction level of the item will be 2.

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

• The item will be created in the Worksheet status

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

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

• The item number type will be Manual.

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

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

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

Service Type

POST

ReST URL

MerchIntegrations/services/item/placeholderItems/create

Input Payload Details

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

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

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

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

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

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

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

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

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Create Pre-issued Order Numbers

Functional Area

Purchase Orders

Business Overview

This webservice generates pre-issued order numbers for the calling application with a set expiry date to be used in orders that will later be created and integrated to Merchandising.

Service Type

POST

ReST URL

MerchIntegrations/services/purchaseOrder/preIssuedOrderNumber/create

Input Payload Details

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

Element Name	Required	Data Type	Description
supplier	No	Number (10)	Contains the supplier to which the order number is assigned.
quantity	Yes	Number (4)	Contains the number of order numbers to be generated.
expiryDays	Yes	Number (4)	Contains the number of days before the pre-issued order numbers expire.

Sample Input Message

{
  "supplier": 2400,
  "quantity": 5,
  "expiryDays": 14
}

Response Code: 200 (Success)

Table 5-205 CreateResponse - Object. See list of elements for detail

Element Name	Required	Data Type	Description
orderNumbers	No	Collection of Object	References a collection of order numbers generated.

Table 5-206 OrderNumbers - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplier	No	Number (10)	Contains the supplier to which the order number is assigned.
orderNo	Yes	Number (12)	Contains the order number generated in Merchandising.
expiryDate	Yes	date	The date when the pre-issued order number will expire.

Sample Response Message

{
  "orderNumbers": [
    {
      "supplier": 2400,
      "orderNo": 90989990,
      "expiryDate": "2001-12-31"
    }
  ]
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Purchase Order Details

Functional Area

Purchase Orders

Business Overview

This webservice is used to create new detail level attributes of the purchase order such as the addition of items and locations in order to keep Merchandising in sync with an external system that is responsible for maintaining purchase orders. Order details can be created for orders in Approved, Worksheet, Submitted or Closed status. The only information needed at the header level is the order number, which if not provided, will cause the message to be rejected.

For more details on Purchase Orders, see the Create Purchase Order service description.

Service Type

POST

ReST URL

MerchIntegrations/services/purchaseOrder/details/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

Element Name	Required	Data Type	Description
items	Yes	Collection of Object

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

Element Name	Required	Data Type	Description
orderNo	Yes	Number (12)	The unique identifier for the order.
approvedBy	No	String (30)	Indicates where the order was approved. It will be the user ID of the person approving the order.
dataLoadingDestination	No	String (6)	This field indicates if the order will be created in RMS or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
details	No	Collection of Object	This references the order detail node.
itemDetails	No	Collection of Object	This references the collection of items in the order.

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

Element Name	Required	Data Type	Description
item	No	String (25)	An approved, transaction level item. If a pack, it must be an orderable pack (with an order_as_type of 'P'). This is required if the ref_item field is not populated. An item/location may be added to the order in worksheet or approved status.
location	Yes	Number (10)	An active store or warehouse. If multichannel is on, and a warehouse is being order to, a virtual warehouse is expected. An item/location may be added to the order in worksheet or approved status.
locationType	No	String (1)	The location type of the location. Valid values are 'S' store and 'W' warehouse. This field cannot be modified.
unitCost	No	Number (20,4)	The cost of the item from the supplier in the order's currency. This can be modified if the status is worksheet or approved, but not if any portion of the item's order quantity is in transit or has been received. If it is not specified on the message, it will default from the item supplier cost for this location.
referenceItem	No	String (25)	The id of a reference item which can be used instead of using the item field. If the item field is not populated this field is required. A ref item/location may be added to the order in worksheet or approved status.
originCountry	No	String (3)	The identifier of the country from which the item is being sourced. This field cannot be modified.
supplierPackSize	No	Number (12,4)	The supplier pack size for the item on the order. This may be updated in worksheet or approved status.
quantityOrdered	No	Number (12,4)	The quantity ordered of item. This can be updated in worksheet or approved status to adjust the quantity of an item/location or cancel an item/location from the order.
cancelInd	No	String (1)	Indicates if the detail record's quantity should be cancelled. Valid values are 'Y'es and 'N'o.
reinstateInd	No	String (1)	Indicates if a detail record which was previously cancelled should be reinstated. This will reinstate in the order quantity the amount in the cancelled bucket. Valid values are 'Y'es and 'N'o.
deliveryDate	No	date	The date by which goods are to be delivered. There can be multiple item-locations on the order with different delivery dates.
quantityCancelled	No	Number (12,4)	This field contains the quantity that was left to be ordered when the line item was cancelled.
cancelCode	No	String (1)	This field contains the reason that the line item was cancelled. This field is required if a line item is cancelled.
estimatedInstockDate	No	date	Date that the item on the PO is expected to be available to ship from the PO location to another location. It is calculated as the Order Creation or Approval Date + Supplier Lead Time + Transit Days between the Supplier and the PO/location + Item/Warehouse Inbound Handling Days (if PO location is a warehouse).
earliestShipDate	No	date	The date before which the item can not be shipped by the supplier.
latestShipDate	No	date	The date after which the item can not be shipped by the supplier.
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes for the order/location.

Table 5-210 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-211 ItemDetails - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	No	String (25)	An approved, transaction level item. If a pack, it must be an orderable pack (with an order_as_type of 'P'). This is required if the ref_item field is not populated. An item/location may be added to the order in worksheet or approved status.
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes for ordsku.

Sample Input Message

{
  "items": [
    {
      "orderNo": 464690012,
      "approvedBy": null,
      "dataLoadingDestination": "RMS",
      "details": [
        {
          "item": "103900095",
          "location": 6000,
          "locationType": "W",
          "unitCost": 45.2,
          "referenceItem": null,
          "originCountry": "IN",
          "supplierPackSize": 1,
          "quantityOrdered": 25,
          "cancelInd": null,
          "reinstateInd": null,
          "deliveryDate": "2001-12-31",
          "quantityCancelled": null,
          "cancelCode": null,
          "estimatedInstockDate": "2001-12-31",
          "earliestShipDate": "2001-12-31",
          "latestShipDate": "2001-12-31",
          "customFlexAttribute": [
            {
              "name": "REVIEW_DATE",
              "value": null,
              "valueDate": "2001-12-31"
            }
          ]
        }
      ],
      "itemDetails": [
        {
          "item": "103900095",
          "customFlexAttribute": [
            {
              "name": "REVIEW_DATE",
              "value": null,
              "valueDate": "2001-12-31"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Create Purchase Order Expenses

Functional Area

Purchase Orders

Business Overview

This webservice is used to create expense information on the purchase order within Merchandising in order to keep it in sync with an external system that is responsible for maintaining purchase orders. It also updates order header information with the values provided in the request if the order is not yet submitted or approved. Expenses may be created alongside the creation of a new order or added to an existing order that has location records defined. Internally, the service sets the status of the order to Worksheet in order to accommodate the modification of expense information for purchase orders in the system that have been submitted or approved. Validation of the new expense information is performed before automatic order re-approval is attempted.

For more details on Purchase Orders, see the Create Purchase Order service description.

Service Type

POST

ReST URL

MerchIntegrations/services/purchaseOrder/expenses/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
orderNo	Yes	Number (12)	The unique identifier for the order.
supplier	No	Number (10)	The identifier of the supplier from which the order will be sourced. This cannot be modified if details exist for the PO.
currencyCode	No	String (3)	The code of the order's currency. If not populated, the supplier's currency will be used. This field can be modified if the order status is worksheet or approved and the order has not been shipped.
terms	No	String (15)	The sales terms of the order. If not populated on the create message, will default to the supplier's terms. This can be modified in worksheet or approved status.
notBeforeDate	No	date	The first date that delivery will be accepted. This can be modified in worksheet or approved status.
notAfterDate	No	date	The last date that delivery will be accepted. This can be modified in worksheet or approved status.
otbEowDate	No	date	The end of week date of the OTB bucket used. This can be modified in worksheet or approved status.
dept	No	Number (4)	The department in which are all the items on the order. This field is required if the system enforces single department ordering. This cannot be modified if details exist for the PO.
status	No	String (1)	The code for the status of the order. Valid values are 'W' worksheet and 'A' approved for PO creation. It is also possible to modify the status to 'C' closed.
includeOnOrderInd	No	String (1)	Indicates if the order should be included in on-order calculations. This can be modified in worksheet or approved status. Valid values are Y and N.
writtenDate	No	date	The date the order was created. If this field is not populated on the message it will default to the time of creation in RMS. It cannot be modified.
origin	No	String (1)	Indicates where the order originated. Valid values include: 2 - Manual, 6 - Inventory Planning generated order, 7 , 8.
ediPoInd	No	String (1)	Indicates whether or not the order will be transmitted to the supplier via an Electronic Data Exchange transaction. Valid values are: Y = Submit via EDI, N = Do not use EDI.
preMarkInd	No	String (1)	This field indicated whether or not a supplier has agreed to break an order into separate boxes so that the boxes can be sent directly to stores. Valid values are Y and N.
approvedBy	No	String (30)	Indicates where the order was approved. It will be the user ID of the person approving the order.
commentDesc	No	String (2000)	Any comments pertaining to the order.
dataLoadingDestination	No	String (6)	This field indicates if the order will be created in RMS or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
masterOrderNo	No	Number (10)	This field indicates the master order number from which child records were created.
ladingPort	No	String (5)	This field indicates the port from which the items on the purchase order are shipped.
dischargePort	No	String (5)	This field indicates the port at which the items on the purchase order will enter the country of import.
factory	No	String (10)	This field indicates the factory at which the items on the purchase order are made.
agent	No	String (10)	This field indicates the agent that is used in the purchase of the items on the purchase order.
shipMethod	No	String (6)	This field indicates the method used to ship the items on the purchase order from the country of origin to the country of import.
partnerType1	No	String (6)	This field indicates Partner 1 Type.
partner1	No	String (10)	This field indicates the Additional Partner 1.
partnerType2	No	String (6)	This field indicates Partner 2 Type.
partner2	No	String (10)	This field indicates the Additional Partner 2.
partnerType3	No	String (6)	This field indicates Partner 3 Type.
partner3	No	String (10)	This field indicates the Additional Partner 3.
importCountry	No	String (3)	The identifier of the country into which the items on the order are being imported.
purchaseType	No	String (6)	This field indicates whats included in the suppliers cost of the item. Valid values include C (Cost), CI (Cost and Insurance), CIF (Cost, Insurance and Freight) and FOB (Free on Board).
paymentMethod	No	String (6)	This field indicates how the purchase order will be paid. Valid options are LC (Letter of Credit), WT (Wire Transfer) and OA (Open Account).
titlePassLocationType	No	String (2)	Contains the code indicating the type of location or point where ownership of merchandise changes hands from seller/supplier to buyer/retailer. Valid values are found under the FOBT code type. Examples are City and State (AC), Country Of Sourcing (CA) and City (CI).
titlePassLocation	No	String (250)	Contains the description of the location or point where ownership of merchandise changes hands from seller/supplier to buyer/retailer.
purchaseOrderType	No	String (4)	This field contains the value associated with the PO_TYPE for the order.
orderType	No	String (3)	Indicates the type of order and which Open To Buy bucket will be updated. Valid values include: N/B - Non Basic, ARB - Automatic Reorder of Basic, BRB - Buyer Reorder of Basic.
buyer	No	Number (4)	Contains the number associated with the buyer for the order.
location	No	Number (10)	This field contains the location all items on the order will be delivered to if populated. i. e. It will mean a single location order.
locationType	No	String (1)	This field contains the type of location in the location field. Valid values are: Valid values are S (Store) or W (Warehouse).
promotion	No	Number (10)	Contains the RPCS offer ID associated with the order to provide a link between the order dialog and the promotions dialog.
qualityControlInd	No	String (1)	Determines whether or not quality control will be required when items for this order are received. Valid values are Y and N.
freightTerms	No	String (30)	Indicator that references what freight terms are related to the order.
backhaulType	No	String (6)	This field contains the type of backhaul allowance that will be applied to the order. Some examples are Calculated or Flat rate.
backhaulAllowance	No	Number (20,4)	This field will contain the backhaul allowance value.
shipPayMethod	No	String (2)	Code indicating the payment terms for freight charges associated with the order. Valid values include: CC - Collect, CF - Collect Freight Credited Back to Customer, DF - Defined by Buyer and Seller, MX - Mixed, PC - Prepaid but Charged to Customer, PO - Prepaid Only, PP - Prepaid by Seller.
transportationResponsibilityType	No	String (2)	Contains the code indicating the type of location or point at which the responsibility for transportation transfers from the seller/supplier to the buyer/retailer. Valid values are found under the FOBT code type. Examples are City and State (AC), Country Of Sourcing (CA) and Country (CC).
transportationResponsibility	No	String (250)	Contains the description of the location or point at which the responsibility for transportation transfers from the seller/supplier to the buyer/retailer.
vendorOrderNo	No	String (15)	Contains the vendors unique identifying number for an order. These orders may have originated by the vendor through the EDI process or this number can be associated to a Oracle Retail order when the order is created on-line.
freightContractNo	No	String (10)	The number of the contract with a shipper that will give specific freight rates. This field is only available when the system is running Import functionality.
pickupLocation	No	String (250)	Contains the location at which the order will be picked up, if the order is a Pickup order.
pickupNo	No	String (25)	Contains the reference number of the Pickup order.
pickupDate	No	date	Contains the date when the order can be picked up from the Supplier. This field is only required if the Purchase Type of the order is Pickup.
appointmentDatetime	No	date-time	This column will hold the date and time of the receiving appointment at the warehouse.
importType	No	String (1)	Valid values are IMporter and EXporter. This is the default importer/exporter assigned to the supplier of the Puchase order.
importId	No	Number (10)	This identifies the importer/exporter assigned to the supplier. This should reference the WH. WH folumn with foreign key created.
clearingZoneId	No	String (5)	This column will hold the clearing zone id.
routingLocation	No	String (5)	This is the default routing location for the import order. FK on OUTLOC. OUTLOC_ID.
reApproveInd	No	String (1)	This field indicates that the update to the corresponding purchase order needs to be performed, and then it should be approved again. Valid values are Y and N.
earliestShipDate	No	date	The date before which the item can not be shipped by the supplier.
latestShipDate	No	date	The date after which the item can not be shipped by the supplier.
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes at the order header level.
expenses	No	Collection of Object	References the expense associated with a particular item/location of the purchase order.

Table 5-214 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-215 Expenses - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	This field contains alphanumeric value that uniquely identifies the item.
packItem	No	String (25)	This field contains alphanumeric value that uniquely identifies the pack.
location	Yes	Number (10)	This field contains the location that item will be ordered to. This field may contain a store or a warehouse.
locationType	Yes	String (1)	This field contains the type of location in the location field. Valid values are: S - Store W - Warehouse.
component	Yes	String (10)	This field contains a user specified code representing a specific expense found on the ELC_COMP table.
computationValueBase	No	String (10)	This field contains a code representing the base value for calculating the expense.
calculationBasis	No	String (1)	This field contains the basis the expense will be calculated against if there is no CVB code attached to the expense. Valid values are S (Supplier) or O (Order). If the Cost Basis is S then when calculating the expense, the items supplier cost will be used. If the Cost Basis is O then the order unit cost of the item on the order will be used to calculate the expense. The code type for this field is EXCB.
componentRate	Yes	Number (20,4)	This field contains the rate to be charged against the calculation base of the component (either value or specific).
componentCurrency	Yes	String (3)	This field contains the currency the expense or assessment is to be entered in. If the Calculation Basis is V (Value), then comp_currency will be NULL.
exchangeRate	Yes	Number (20,10)	This field contains the exchange rate of the individual expense.
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. When creating an expense that is defined as $. 20 for every 10 kilograms of an item ordered, the Per Count would be 10.
perCountUom	No	String (4)	This field contains the unit of measure in which the Per Count is specified. When creating an expense that is defined as $. 20 for every 10 kilograms of an item ordered, the Per Count UOM would be the Unit of Measure code for Kilograms.
nominationFlag1	Yes	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 1), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 1), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 1). For example, if cost component ABC has a + in Nomination Flag 1, then all CVBs that include Nomination Flag 1 will include this cost component value in their calculation basis.
inDuty	Yes	String (1)	If Import Management is enabled in Merchandising (i. e. system_options. import_ind = Y), the inDuty flag is used to indicate if the value of the cost component should be included in total duty.
nominationFlag3	Yes	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 3), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 3), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 3). For example, if cost component ABC has a + in Nomination Flag 3, then all CVBs that include Nomination Flag 3 will include this cost component value in their calculation basis.
inExpense	Yes	String (1)	See description for nom_flag_1. If ALC is turned on (i. e. system_options. import_ind = Y), nom_flag_2 is used to indicate the status of a component in duty calculation nom_flag_4 is used to indicate the status of a component in ELC calculation nom_flag_5 is used to indicate the status of a component in ALC calculation i. e. these 3 flags can not be used for any other purposes if ALC is turned on.
inAlc	Yes	String (1)	See description for nom_flag_1. If ALC is turned on (i. e. system_options. import_ind = Y), nom_flag_2 is used to indicate the status of a component in duty calculation nom_flag_4 is used to indicate the status of a component in ELC calculation nom_flag_5 is used to indicate the status of a component in ALC calculation i. e. these 3 flags can not be used for any other purposes if ALC is turned on.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "orderNo": 464690012,
      "supplier": 2400,
      "currencyCode": "USD",
      "terms": "02",
      "notBeforeDate": "2001-12-31",
      "notAfterDate": "2001-12-31",
      "otbEowDate": "2001-12-31",
      "dept": null,
      "status": "A",
      "includeOnOrderInd": "Y",
      "writtenDate": "2001-12-31",
      "origin": "2",
      "ediPoInd": "Y",
      "preMarkInd": "Y",
      "approvedBy": null,
      "commentDesc": "Create Order",
      "dataLoadingDestination": "RMS",
      "masterOrderNo": null,
      "ladingPort": "7",
      "dischargePort": "480",
      "factory": "100",
      "agent": "007",
      "shipMethod": "32",
      "partnerType1": "AG",
      "partner1": "007",
      "partnerType2": "E",
      "partner2": "4678",
      "partnerType3": null,
      "partner3": null,
      "importCountry": "US",
      "purchaseType": "FOB",
      "paymentMethod": "LC",
      "titlePassLocationType": "FF",
      "titlePassLocation": "US",
      "purchaseOrderType": "4000",
      "orderType": "N/B",
      "buyer": 1000,
      "location": null,
      "locationType": null,
      "promotion": 41,
      "qualityControlInd": "Y",
      "freightTerms": "03",
      "backhaulType": null,
      "backhaulAllowance": null,
      "shipPayMethod": "PO",
      "transportationResponsibilityType": "FF",
      "transportationResponsibility": "US",
      "vendorOrderNo": "9987001",
      "freightContractNo": "111",
      "pickupLocation": null,
      "pickupNo": null,
      "pickupDate": null,
      "appointmentDatetime": "2001-12-31T23:59:59.123Z",
      "importType": "W",
      "importId": 10001,
      "clearingZoneId": null,
      "routingLocation": null,
      "reApproveInd": null,
      "earliestShipDate": "2001-12-31",
      "latestShipDate": "2001-12-31",
      "customFlexAttribute": [
        {
          "name": "REVIEW_DATE",
          "value": null,
          "valueDate": "2001-12-31"
        }
      ],
      "expenses": [
        {
          "item": "103900095",
          "packItem": null,
          "location": 10001,
          "locationType": "W",
          "component": "OCFRT",
          "computationValueBase": null,
          "calculationBasis": null,
          "componentRate": 17,
          "componentCurrency": "INR",
          "exchangeRate": 29,
          "perCount": 1,
          "perCountUom": "M3",
          "nominationFlag1": "N",
          "inDuty": "N",
          "nominationFlag3": "N",
          "inExpense": "+",
          "inAlc": "N"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Purchase Order HTS

Functional Area

Purchase Orders

Business Overview

This webservice is used to create Harmonized Tariff Schedules and related assessments within Merchandising in order to keep it in sync with an external system that is responsible for maintaining purchase orders. It also updates order header information with the values provided in the request if the order has not yet been submitted or approved. HTS and Assessments may be created together with the creation of a new import order or added to an existing order. Internally, the service sets the status of the order to Worksheet in order to accommodate the addition of HTS information for purchase orders in the system that have been submitted or approved. Validation of the new HTS information is performed before automatic order re-approval is attempted.

For more details on Purchase Orders, see the Create Purchase Order service description.

Service Type

POST

ReST URL

MerchIntegrations/services/purchaseOrder/hts/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
orderNo	Yes	Number (12)	The unique identifier for the order.
supplier	No	Number (10)	The identifier of the supplier from which the order will be sourced. This cannot be modified if details exist for the PO.
currencyCode	No	String (3)	The code of the order's currency. If not populated, the supplier's currency will be used. This field can be modified if the order status is worksheet or approved and the order has not been shipped.
terms	No	String (15)	The sales terms of the order. If not populated on the create message, will default to the supplier's terms. This can be modified in worksheet or approved status.
notBeforeDate	No	date	The first date that delivery will be accepted. This can be modified in worksheet or approved status.
notAfterDate	No	date	The last date that delivery will be accepted. This can be modified in worksheet or approved status.
otbEowDate	No	date	The end of week date of the OTB bucket used. This can be modified in worksheet or approved status.
dept	No	Number (4)	The department in which are all the items on the order. This field is required if the system enforces single department ordering. This cannot be modified if details exist for the PO.
status	No	String (1)	The code for the status of the order. Valid values are 'W' worksheet and 'A' approved for PO creation. It is also possible to modify the status to 'C' closed.
includeOnOrderInd	No	String (1)	Indicates if the order should be included in on-order calculations. This can be modified in worksheet or approved status. Valid values are Y and N.
writtenDate	No	date	The date the order was created. If this field is not populated on the message it will default to the time of creation in RMS. It cannot be modified.
origin	No	String (1)	Indicates where the order originated. Valid values include: 2 - Manual, 6 - Inventory Planning generated order, 7 , 8.
ediPoInd	No	String (1)	Indicates whether or not the order will be transmitted to the supplier via an Electronic Data Exchange transaction. Valid values are: Y = Submit via EDI, N = Do not use EDI.
preMarkInd	No	String (1)	This field indicated whether or not a supplier has agreed to break an order into separate boxes so that the boxes can be sent directly to stores. Valid values are Y and N.
approvedBy	No	String (30)	Indicates where the order was approved. It will be the user ID of the person approving the order.
commentDesc	No	String (2000)	Any comments pertaining to the order.
dataLoadingDestination	No	String (6)	This field indicates if the order will be created in RMS or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
masterOrderNo	No	Number (10)	This field indicates the master order number from which child records were created.
ladingPort	No	String (5)	This field indicates the port from which the items on the purchase order are shipped.
dischargePort	No	String (5)	This field indicates the port at which the items on the purchase order will enter the country of import.
factory	No	String (10)	This field indicates the factory at which the items on the purchase order are made.
agent	No	String (10)	This field indicates the agent that is used in the purchase of the items on the purchase order.
shipMethod	No	String (6)	This field indicates the method used to ship the items on the purchase order from the country of origin to the country of import.
partnerType1	No	String (6)	This field indicates Partner 1 Type.
partner1	No	String (10)	This field indicates the Additional Partner 1.
partnerType2	No	String (6)	This field indicates Partner 2 Type.
partner2	No	String (10)	This field indicates the Additional Partner 2.
partnerType3	No	String (6)	This field indicates Partner 3 Type.
partner3	No	String (10)	This field indicates the Additional Partner 3.
importCountry	No	String (3)	The identifier of the country into which the items on the order are being imported.
purchaseType	No	String (6)	This field indicates whats included in the suppliers cost of the item. Valid values include C (Cost), CI (Cost and Insurance), CIF (Cost, Insurance and Freight) and FOB (Free on Board).
paymentMethod	No	String (6)	This field indicates how the purchase order will be paid. Valid options are LC (Letter of Credit), WT (Wire Transfer) and OA (Open Account).
titlePassLocationType	No	String (2)	Contains the code indicating the type of location or point where ownership of merchandise changes hands from seller/supplier to buyer/retailer. Valid values are found under the FOBT code type. Examples are City and State (AC), Country Of Sourcing (CA) and City (CI).
titlePassLocation	No	String (250)	Contains the description of the location or point where ownership of merchandise changes hands from seller/supplier to buyer/retailer.
purchaseOrderType	No	String (4)	This field contains the value associated with the PO_TYPE for the order.
orderType	No	String (3)	Indicates the type of order and which Open To Buy bucket will be updated. Valid values include: N/B - Non Basic, ARB - Automatic Reorder of Basic, BRB - Buyer Reorder of Basic.
buyer	No	Number (4)	Contains the number associated with the buyer for the order.
location	No	Number (10)	This field contains the location all items on the order will be delivered to if populated. i. e. It will mean a single location order.
locationType	No	String (1)	This field contains the type of location in the location field. Valid values are: Valid values are S (Store) or W (Warehouse).
promotion	No	Number (10)	Contains the RPCS offer ID associated with the order to provide a link between the order dialog and the promotions dialog.
qualityControlInd	No	String (1)	Determines whether or not quality control will be required when items for this order are received. Valid values are Y and N.
freightTerms	No	String (30)	Indicator that references what freight terms are related to the order.
backhaulType	No	String (6)	This field contains the type of backhaul allowance that will be applied to the order. Some examples are Calculated or Flat rate.
backhaulAllowance	No	Number (20,4)	This field will contain the backhaul allowance value.
shipPayMethod	No	String (2)	Code indicating the payment terms for freight charges associated with the order. Valid values include: CC - Collect, CF - Collect Freight Credited Back to Customer, DF - Defined by Buyer and Seller, MX - Mixed, PC - Prepaid but Charged to Customer, PO - Prepaid Only, PP - Prepaid by Seller.
transportationResponsibilityType	No	String (2)	Contains the code indicating the type of location or point at which the responsibility for transportation transfers from the seller/supplier to the buyer/retailer. Valid values are found under the FOBT code type. Examples are City and State (AC), Country Of Sourcing (CA) and Country (CC).
transportationResponsibility	No	String (250)	Contains the description of the location or point at which the responsibility for transportation transfers from the seller/supplier to the buyer/retailer.
vendorOrderNo	No	String (15)	Contains the vendors unique identifying number for an order. These orders may have originated by the vendor through the EDI process or this number can be associated to a Oracle Retail order when the order is created on-line.
freightContractNo	No	String (10)	The number of the contract with a shipper that will give specific freight rates. This field is only available when the system is running Import functionality.
pickupLocation	No	String (250)	Contains the location at which the order will be picked up, if the order is a Pickup order.
pickupNo	No	String (25)	Contains the reference number of the Pickup order.
pickupDate	No	date	Contains the date when the order can be picked up from the Supplier. This field is only required if the Purchase Type of the order is Pickup.
appointmentDatetime	No	date-time	This column will hold the date and time of the receiving appointment at the warehouse.
importType	No	String (1)	Valid values are IMporter and EXporter. This is the default importer/exporter assigned to the supplier of the Puchase order.
importId	No	Number (10)	This identifies the importer/exporter assigned to the supplier. This should reference the WH. WH folumn with foreign key created.
clearingZoneId	No	String (5)	This column will hold the clearing zone id.
routingLocation	No	String (5)	This is the default routing location for the import order. FK on OUTLOC. OUTLOC_ID.
reApproveInd	No	String (1)	This field indicates that the update to the corresponding purchase order needs to be performed, and then it should be approved again. Valid values are Y and N.
earliestShipDate	No	date	The date before which the item can not be shipped by the supplier.
latestShipDate	No	date	The date after which the item can not be shipped by the supplier.
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes at the order header level.
hts	No	Collection of Object	References the HTS code associated with a particular item of the purchase order.

Table 5-218 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-219 Hts - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	This field contains an unique alphanumeric value that identifies the item.
packItem	No	String (25)	This field contains alphanumeric value that uniquely identifies the pack.
hts	Yes	String (25)	This field contains an identifier for the Harmonized Tariff Schedule code.
status	Yes	String (1)	This field contains a flag to indicate the status of the Purchase Order/Item/HTS relationship. Valid values are (W)orksheet and (A)pproved.
originCountry	Yes	String (3)	This field contains the country of manufacture when the HTS tracking level is M. When the HTS tracking level is S, this stores the country of sourcing.
importCountry	No	String (3)	This field contains the country that the item will be imported in to.
assessments	No	Collection of Object	References the HTS code assessments associated with a particular item of the purchase order.

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

Element Name	Required	Data Type	Description
component	Yes	String (10)	This field contains a user specified code representing the specific assessment component found on the ELC_COMP table.
computationValueBase	No	String (10)	This field contains a code representing the base value for calculating the assessment.
componentRate	Yes	Number (20,4)	This field contains the rate to be charged against the calculation base. This field will hold a percentage value if the Calculation Basis of the Component is Value or a monetary amount in the currency defined for the assessment (usually the import country’s currency) if the Calculation Basis is Specific.
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. When creating an expense that is defined as $. 20 for every 10 kilograms of an item ordered, the Per Count would be 10.
perCountUom	No	String (4)	This field contains the unit of measure in which the Per Count is specified. When creating an expense that is defined as $. 20 for every 10 kilograms of an item ordered, the Per Count UOM would be the Unit of Measure code for Kilograms.
nominationFlag1	Yes	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 1), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 1), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 1). For example, if cost component ABC has a + in Nomination Flag 1, then all CVBs that include Nomination Flag 1 will include this cost component value in their calculation basis.
inDuty	Yes	String (1)	If Import Management is enabled in Merchandising (i. e. system_options. import_ind = Y), the inDuty flag is used to indicate if the value of the cost component should be included in total duty.
nominationFlag3	Yes	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 3), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 3), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 3). For example, if cost component ABC has a + in Nomination Flag 3, then all CVBs that include Nomination Flag 3 will include this cost component value in their calculation basis.
inExpense	Yes	String (1)	The inExpense flag is used to indicate if the value of the cost component should be included in total expenses.
inAlc	Yes	String (1)	The inALC flag is used for cost components where the retailer does not expect to receive an actual value for the charge via an obligation or customs entry. The inALC flag allows the value of the cost component to be included in ALC via direct nomination and indicates to the system that the estimated value on the order should be used as the actual value as well because no other actual will be provided.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "orderNo": 464690012,
      "supplier": 2400,
      "currencyCode": "USD",
      "terms": "02",
      "notBeforeDate": "2001-12-31",
      "notAfterDate": "2001-12-31",
      "otbEowDate": "2001-12-31",
      "dept": null,
      "status": "A",
      "includeOnOrderInd": "Y",
      "writtenDate": "2001-12-31",
      "origin": "2",
      "ediPoInd": "Y",
      "preMarkInd": "Y",
      "approvedBy": null,
      "commentDesc": "Create Order",
      "dataLoadingDestination": "RMS",
      "masterOrderNo": null,
      "ladingPort": "7",
      "dischargePort": "480",
      "factory": "100",
      "agent": "007",
      "shipMethod": "32",
      "partnerType1": "AG",
      "partner1": "007",
      "partnerType2": "E",
      "partner2": "4678",
      "partnerType3": null,
      "partner3": null,
      "importCountry": "US",
      "purchaseType": "FOB",
      "paymentMethod": "LC",
      "titlePassLocationType": "FF",
      "titlePassLocation": "US",
      "purchaseOrderType": "4000",
      "orderType": "N/B",
      "buyer": 1000,
      "location": null,
      "locationType": null,
      "promotion": 41,
      "qualityControlInd": "Y",
      "freightTerms": "03",
      "backhaulType": null,
      "backhaulAllowance": null,
      "shipPayMethod": "PO",
      "transportationResponsibilityType": "FF",
      "transportationResponsibility": "US",
      "vendorOrderNo": "9987001",
      "freightContractNo": "111",
      "pickupLocation": null,
      "pickupNo": null,
      "pickupDate": null,
      "appointmentDatetime": "2001-12-31T23:59:59.123Z",
      "importType": "W",
      "importId": 10001,
      "clearingZoneId": null,
      "routingLocation": null,
      "reApproveInd": null,
      "earliestShipDate": "2001-12-31",
      "latestShipDate": "2001-12-31",
      "customFlexAttribute": [
        {
          "name": "REVIEW_DATE",
          "value": null,
          "valueDate": "2001-12-31"
        }
      ],
      "hts": [
        {
          "item": "103900095",
          "packItem": null,
          "hts": "9014111112",
          "status": "W",
          "originCountry": "IN",
          "importCountry": "US",
          "assessments": [
            {
              "component": "DTYCAUS",
              "computationValueBase": null,
              "componentRate": 12,
              "perCount": 1,
              "perCountUom": "EA",
              "nominationFlag1": "N",
              "inDuty": "+",
              "nominationFlag3": "-",
              "inExpense": "N",
              "inAlc": "N"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Purchase Order HTS Assessments

Functional Area

Purchase Orders

Business Overview

This webservice is used to create Harmonized Tariff Schedules assessments within Merchandising in order to keep it in sync with an external system that is responsible for maintaining purchase orders. It also updates order header information with the values provided in the request if the order is not yet submitted or approved. Assessments may be created together with the creation of a new import order or added to an existing order. Internally, the service sets the status of the order to Worksheet in order to accommodate the addition of HTS information for purchase orders in the system that have been submitted or approved. Validation of the new and updated information is performed before automatic order re-approval is attempted.

For more details on Purchase Orders, see the Create Purchase Order service description.

Service Type

POST

ReST URL

MerchIntegrations/services/purchaseOrder/hts/assessments/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
orderNo	Yes	Number (12)	The unique identifier for the order.
supplier	No	Number (10)	The identifier of the supplier from which the order will be sourced. This cannot be modified if details exist for the PO.
currencyCode	No	String (3)	The code of the order's currency. If not populated, the supplier's currency will be used. This field can be modified if the order status is worksheet or approved and the order has not been shipped.
terms	No	String (15)	The sales terms of the order. If not populated on the create message, will default to the supplier's terms. This can be modified in worksheet or approved status.
notBeforeDate	No	date	The first date that delivery will be accepted. This can be modified in worksheet or approved status.
notAfterDate	No	date	The last date that delivery will be accepted. This can be modified in worksheet or approved status.
otbEowDate	No	date	The end of week date of the OTB bucket used. This can be modified in worksheet or approved status.
dept	No	Number (4)	The department in which are all the items on the order. This field is required if the system enforces single department ordering. This cannot be modified if details exist for the PO.
status	No	String (1)	The code for the status of the order. Valid values are 'W' worksheet and 'A' approved for PO creation. It is also possible to modify the status to 'C' closed.
includeOnOrderInd	No	String (1)	Indicates if the order should be included in on-order calculations. This can be modified in worksheet or approved status. Valid values are Y and N.
writtenDate	No	date	The date the order was created. If this field is not populated on the message it will default to the time of creation in RMS. It cannot be modified.
origin	No	String (1)	Indicates where the order originated. Valid values include: 2 - Manual, 6 - Inventory Planning generated order, 7 , 8.
ediPoInd	No	String (1)	Indicates whether or not the order will be transmitted to the supplier via an Electronic Data Exchange transaction. Valid values are: Y = Submit via EDI, N = Do not use EDI.
preMarkInd	No	String (1)	This field indicated whether or not a supplier has agreed to break an order into separate boxes so that the boxes can be sent directly to stores. Valid values are Y and N.
approvedBy	No	String (30)	Indicates where the order was approved. It will be the user ID of the person approving the order.
commentDesc	No	String (2000)	Any comments pertaining to the order.
dataLoadingDestination	No	String (6)	This field indicates if the order will be created in RMS or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
masterOrderNo	No	Number (10)	This field indicates the master order number from which child records were created.
ladingPort	No	String (5)	This field indicates the port from which the items on the purchase order are shipped.
dischargePort	No	String (5)	This field indicates the port at which the items on the purchase order will enter the country of import.
factory	No	String (10)	This field indicates the factory at which the items on the purchase order are made.
agent	No	String (10)	This field indicates the agent that is used in the purchase of the items on the purchase order.
shipMethod	No	String (6)	This field indicates the method used to ship the items on the purchase order from the country of origin to the country of import.
partnerType1	No	String (6)	This field indicates Partner 1 Type.
partner1	No	String (10)	This field indicates the Additional Partner 1.
partnerType2	No	String (6)	This field indicates Partner 2 Type.
partner2	No	String (10)	This field indicates the Additional Partner 2.
partnerType3	No	String (6)	This field indicates Partner 3 Type.
partner3	No	String (10)	This field indicates the Additional Partner 3.
importCountry	No	String (3)	The identifier of the country into which the items on the order are being imported.
purchaseType	No	String (6)	This field indicates whats included in the suppliers cost of the item. Valid values include C (Cost), CI (Cost and Insurance), CIF (Cost, Insurance and Freight) and FOB (Free on Board).
paymentMethod	No	String (6)	This field indicates how the purchase order will be paid. Valid options are LC (Letter of Credit), WT (Wire Transfer) and OA (Open Account).
titlePassLocationType	No	String (2)	Contains the code indicating the type of location or point where ownership of merchandise changes hands from seller/supplier to buyer/retailer. Valid values are found under the FOBT code type. Examples are City and State (AC), Country Of Sourcing (CA) and City (CI).
titlePassLocation	No	String (250)	Contains the description of the location or point where ownership of merchandise changes hands from seller/supplier to buyer/retailer.
purchaseOrderType	No	String (4)	This field contains the value associated with the PO_TYPE for the order.
orderType	No	String (3)	Indicates the type of order and which Open To Buy bucket will be updated. Valid values include: N/B - Non Basic, ARB - Automatic Reorder of Basic, BRB - Buyer Reorder of Basic.
buyer	No	Number (4)	Contains the number associated with the buyer for the order.
location	No	Number (10)	This field contains the location all items on the order will be delivered to if populated. i. e. It will mean a single location order.
locationType	No	String (1)	This field contains the type of location in the location field. Valid values are: Valid values are S (Store) or W (Warehouse).
promotion	No	Number (10)	Contains the RPCS offer ID associated with the order to provide a link between the order dialog and the promotions dialog.
qualityControlInd	No	String (1)	Determines whether or not quality control will be required when items for this order are received. Valid values are Y and N.
freightTerms	No	String (30)	Indicator that references what freight terms are related to the order.
backhaulType	No	String (6)	This field contains the type of backhaul allowance that will be applied to the order. Some examples are Calculated or Flat rate.
backhaulAllowance	No	Number (20,4)	This field will contain the backhaul allowance value.
shipPayMethod	No	String (2)	Code indicating the payment terms for freight charges associated with the order. Valid values include: CC - Collect, CF - Collect Freight Credited Back to Customer, DF - Defined by Buyer and Seller, MX - Mixed, PC - Prepaid but Charged to Customer, PO - Prepaid Only, PP - Prepaid by Seller.
transportationResponsibilityType	No	String (2)	Contains the code indicating the type of location or point at which the responsibility for transportation transfers from the seller/supplier to the buyer/retailer. Valid values are found under the FOBT code type. Examples are City and State (AC), Country Of Sourcing (CA) and Country (CC).
transportationResponsibility	No	String (250)	Contains the description of the location or point at which the responsibility for transportation transfers from the seller/supplier to the buyer/retailer.
vendorOrderNo	No	String (15)	Contains the vendors unique identifying number for an order. These orders may have originated by the vendor through the EDI process or this number can be associated to a Oracle Retail order when the order is created on-line.
freightContractNo	No	String (10)	The number of the contract with a shipper that will give specific freight rates. This field is only available when the system is running Import functionality.
pickupLocation	No	String (250)	Contains the location at which the order will be picked up, if the order is a Pickup order.
pickupNo	No	String (25)	Contains the reference number of the Pickup order.
pickupDate	No	date	Contains the date when the order can be picked up from the Supplier. This field is only required if the Purchase Type of the order is Pickup.
appointmentDatetime	No	date-time	This column will hold the date and time of the receiving appointment at the warehouse.
importType	No	String (1)	Valid values are IMporter and EXporter. This is the default importer/exporter assigned to the supplier of the Puchase order.
importId	No	Number (10)	This identifies the importer/exporter assigned to the supplier. This should reference the WH. WH folumn with foreign key created.
clearingZoneId	No	String (5)	This column will hold the clearing zone id.
routingLocation	No	String (5)	This is the default routing location for the import order. FK on OUTLOC. OUTLOC_ID.
reApproveInd	No	String (1)	This field indicates that the update to the corresponding purchase order needs to be performed, and then it should be approved again. Valid values are Y and N.
earliestShipDate	No	date	The date before which the item can not be shipped by the supplier.
latestShipDate	No	date	The date after which the item can not be shipped by the supplier.
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes at the order header level.
hts	No	Collection of Object	References the HTS code associated with a particular item of the purchase order.

Table 5-223 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-224 Hts - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	This field contains an unique alphanumeric value that identifies the item.
packItem	No	String (25)	This field contains alphanumeric value that uniquely identifies the pack.
hts	Yes	String (25)	This field contains an identifier for the Harmonized Tariff Schedule code.
status	Yes	String (1)	This field contains a flag to indicate the status of the Purchase Order/Item/HTS relationship. Valid values are (W)orksheet and (A)pproved.
originCountry	Yes	String (3)	This field contains the country of manufacture when the HTS tracking level is M. When the HTS tracking level is S, this stores the country of sourcing.
importCountry	No	String (3)	This field contains the country that the item will be imported in to.
assessments	No	Collection of Object	References the HTS code assessments associated with a particular item of the purchase order.

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

Element Name	Required	Data Type	Description
component	Yes	String (10)	This field contains a user specified code representing the specific assessment component found on the ELC_COMP table.
computationValueBase	No	String (10)	This field contains a code representing the base value for calculating the assessment.
componentRate	Yes	Number (20,4)	This field contains the rate to be charged against the calculation base. This field will hold a percentage value if the Calculation Basis of the Component is Value or a monetary amount in the currency defined for the assessment (usually the import country’s currency) if the Calculation Basis is Specific.
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. When creating an expense that is defined as $. 20 for every 10 kilograms of an item ordered, the Per Count would be 10.
perCountUom	No	String (4)	This field contains the unit of measure in which the Per Count is specified. When creating an expense that is defined as $. 20 for every 10 kilograms of an item ordered, the Per Count UOM would be the Unit of Measure code for Kilograms.
nominationFlag1	Yes	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 1), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 1), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 1). For example, if cost component ABC has a + in Nomination Flag 1, then all CVBs that include Nomination Flag 1 will include this cost component value in their calculation basis.
inDuty	Yes	String (1)	If Import Management is enabled in Merchandising (i. e. system_options. import_ind = Y), the inDuty flag is used to indicate if the value of the cost component should be included in total duty.
nominationFlag3	Yes	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 3), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 3), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 3). For example, if cost component ABC has a + in Nomination Flag 3, then all CVBs that include Nomination Flag 3 will include this cost component value in their calculation basis.
inExpense	Yes	String (1)	The inExpense flag is used to indicate if the value of the cost component should be included in total expenses.
inAlc	Yes	String (1)	The inALC flag is used for cost components where the retailer does not expect to receive an actual value for the charge via an obligation or customs entry. The inALC flag allows the value of the cost component to be included in ALC via direct nomination and indicates to the system that the estimated value on the order should be used as the actual value as well because no other actual will be provided.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "orderNo": 464690012,
      "supplier": 2400,
      "currencyCode": "USD",
      "terms": "02",
      "notBeforeDate": "2001-12-31",
      "notAfterDate": "2001-12-31",
      "otbEowDate": "2001-12-31",
      "dept": null,
      "status": "A",
      "includeOnOrderInd": "Y",
      "writtenDate": "2001-12-31",
      "origin": "2",
      "ediPoInd": "Y",
      "preMarkInd": "Y",
      "approvedBy": null,
      "commentDesc": "Create Order",
      "dataLoadingDestination": "RMS",
      "masterOrderNo": null,
      "ladingPort": "7",
      "dischargePort": "480",
      "factory": "100",
      "agent": "007",
      "shipMethod": "32",
      "partnerType1": "AG",
      "partner1": "007",
      "partnerType2": "E",
      "partner2": "4678",
      "partnerType3": null,
      "partner3": null,
      "importCountry": "US",
      "purchaseType": "FOB",
      "paymentMethod": "LC",
      "titlePassLocationType": "FF",
      "titlePassLocation": "US",
      "purchaseOrderType": "4000",
      "orderType": "N/B",
      "buyer": 1000,
      "location": null,
      "locationType": null,
      "promotion": 41,
      "qualityControlInd": "Y",
      "freightTerms": "03",
      "backhaulType": null,
      "backhaulAllowance": null,
      "shipPayMethod": "PO",
      "transportationResponsibilityType": "FF",
      "transportationResponsibility": "US",
      "vendorOrderNo": "9987001",
      "freightContractNo": "111",
      "pickupLocation": null,
      "pickupNo": null,
      "pickupDate": null,
      "appointmentDatetime": "2001-12-31T23:59:59.123Z",
      "importType": "W",
      "importId": 10001,
      "clearingZoneId": null,
      "routingLocation": null,
      "reApproveInd": null,
      "earliestShipDate": "2001-12-31",
      "latestShipDate": "2001-12-31",
      "customFlexAttribute": [
        {
          "name": "REVIEW_DATE",
          "value": null,
          "valueDate": "2001-12-31"
        }
      ],
      "hts": [
        {
          "item": "103900095",
          "packItem": null,
          "hts": "9014111112",
          "status": "W",
          "originCountry": "IN",
          "importCountry": "US",
          "assessments": [
            {
              "component": "DTYCAUS",
              "computationValueBase": null,
              "componentRate": 12,
              "perCount": 1,
              "perCountUom": "EA",
              "nominationFlag1": "N",
              "inDuty": "+",
              "nominationFlag3": "-",
              "inExpense": "N",
              "inAlc": "N"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Purchase Order Letters of Credit

Functional Area

Purchase Orders

Business Overview

This webservice is used to create letter of credit information within Merchandising when the order payment type is Letter of Credit in order to keep it in sync with an external system that is responsible for maintaining purchase orders. It also updates order header information with the values provided in the request if the order has not yet been submitted or approved. For an existing order that has a payment type of Letter of Credit, the modification of header level order information is not necessary; however header level fields, particularly the payment type can be updated in case a letter of credit needs to be attached to the worksheet order that has an existing payment type other than Letter of Credit. Internally, the service sets the status of the order to Worksheet in order to accommodate the modification of letter of credit information for purchase orders in the system that have been submitted or approved. Validation of updated information is performed before automatic order re-approval is attempted.

For more details on Purchase Orders, see the Create Purchase Order service description.

Service Type

POST

ReST URL

MerchIntegrations/services/purchaseOrder/lettersOfCredit/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
orderNo	Yes	Number (12)	The unique identifier for the order.
supplier	No	Number (10)	The identifier of the supplier from which the order will be sourced. This cannot be modified if details exist for the PO.
currencyCode	No	String (3)	The code of the order's currency. If not populated, the supplier's currency will be used. This field can be modified if the order status is worksheet or approved and the order has not been shipped.
terms	No	String (15)	The sales terms of the order. If not populated on the create message, will default to the supplier's terms. This can be modified in worksheet or approved status.
notBeforeDate	No	date	The first date that delivery will be accepted. This can be modified in worksheet or approved status.
notAfterDate	No	date	The last date that delivery will be accepted. This can be modified in worksheet or approved status.
otbEowDate	No	date	The end of week date of the OTB bucket used. This can be modified in worksheet or approved status.
dept	No	Number (4)	The department in which are all the items on the order. This field is required if the system enforces single department ordering. This cannot be modified if details exist for the PO.
status	No	String (1)	The code for the status of the order. Valid values are 'W' worksheet and 'A' approved for PO creation. It is also possible to modify the status to 'C' closed.
includeOnOrderInd	No	String (1)	Indicates if the order should be included in on-order calculations. This can be modified in worksheet or approved status. Valid values are Y and N.
writtenDate	No	date	The date the order was created. If this field is not populated on the message it will default to the time of creation in RMS. It cannot be modified.
origin	No	String (1)	Indicates where the order originated. Valid values include: 2 - Manual, 6 - Inventory Planning generated order, 7 , 8.
ediPoInd	No	String (1)	Indicates whether or not the order will be transmitted to the supplier via an Electronic Data Exchange transaction. Valid values are: Y = Submit via EDI, N = Do not use EDI.
preMarkInd	No	String (1)	This field indicated whether or not a supplier has agreed to break an order into separate boxes so that the boxes can be sent directly to stores. Valid values are Y and N.
approvedBy	No	String (30)	Indicates where the order was approved. It will be the user ID of the person approving the order.
commentDesc	No	String (2000)	Any comments pertaining to the order.
dataLoadingDestination	No	String (6)	This field indicates if the order will be created in RMS or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
masterOrderNo	No	Number (10)	This field indicates the master order number from which child records were created.
ladingPort	No	String (5)	This field indicates the port from which the items on the purchase order are shipped.
dischargePort	No	String (5)	This field indicates the port at which the items on the purchase order will enter the country of import.
factory	No	String (10)	This field indicates the factory at which the items on the purchase order are made.
agent	No	String (10)	This field indicates the agent that is used in the purchase of the items on the purchase order.
shipMethod	No	String (6)	This field indicates the method used to ship the items on the purchase order from the country of origin to the country of import.
partnerType1	No	String (6)	This field indicates Partner 1 Type.
partner1	No	String (10)	This field indicates the Additional Partner 1.
partnerType2	No	String (6)	This field indicates Partner 2 Type.
partner2	No	String (10)	This field indicates the Additional Partner 2.
partnerType3	No	String (6)	This field indicates Partner 3 Type.
partner3	No	String (10)	This field indicates the Additional Partner 3.
importCountry	No	String (3)	The identifier of the country into which the items on the order are being imported.
purchaseType	No	String (6)	This field indicates whats included in the suppliers cost of the item. Valid values include C (Cost), CI (Cost and Insurance), CIF (Cost, Insurance and Freight) and FOB (Free on Board).
paymentMethod	No	String (6)	This field indicates how the purchase order will be paid. Valid options are LC (Letter of Credit), WT (Wire Transfer) and OA (Open Account).
titlePassLocationType	No	String (2)	Contains the code indicating the type of location or point where ownership of merchandise changes hands from seller/supplier to buyer/retailer. Valid values are found under the FOBT code type. Examples are City and State (AC), Country Of Sourcing (CA) and City (CI).
titlePassLocation	No	String (250)	Contains the description of the location or point where ownership of merchandise changes hands from seller/supplier to buyer/retailer.
purchaseOrderType	No	String (4)	This field contains the value associated with the PO_TYPE for the order.
orderType	No	String (3)	Indicates the type of order and which Open To Buy bucket will be updated. Valid values include: N/B - Non Basic, ARB - Automatic Reorder of Basic, BRB - Buyer Reorder of Basic.
buyer	No	Number (4)	Contains the number associated with the buyer for the order.
location	No	Number (10)	This field contains the location all items on the order will be delivered to if populated. i. e. It will mean a single location order.
locationType	No	String (1)	This field contains the type of location in the location field. Valid values are: Valid values are S (Store) or W (Warehouse).
promotion	No	Number (10)	Contains the RPCS offer ID associated with the order to provide a link between the order dialog and the promotions dialog.
qualityControlInd	No	String (1)	Determines whether or not quality control will be required when items for this order are received. Valid values are Y and N.
freightTerms	No	String (30)	Indicator that references what freight terms are related to the order.
backhaulType	No	String (6)	This field contains the type of backhaul allowance that will be applied to the order. Some examples are Calculated or Flat rate.
backhaulAllowance	No	Number (20,4)	This field will contain the backhaul allowance value.
shipPayMethod	No	String (2)	Code indicating the payment terms for freight charges associated with the order. Valid values include: CC - Collect, CF - Collect Freight Credited Back to Customer, DF - Defined by Buyer and Seller, MX - Mixed, PC - Prepaid but Charged to Customer, PO - Prepaid Only, PP - Prepaid by Seller.
transportationResponsibilityType	No	String (2)	Contains the code indicating the type of location or point at which the responsibility for transportation transfers from the seller/supplier to the buyer/retailer. Valid values are found under the FOBT code type. Examples are City and State (AC), Country Of Sourcing (CA) and Country (CC).
transportationResponsibility	No	String (250)	Contains the description of the location or point at which the responsibility for transportation transfers from the seller/supplier to the buyer/retailer.
vendorOrderNo	No	String (15)	Contains the vendors unique identifying number for an order. These orders may have originated by the vendor through the EDI process or this number can be associated to a Oracle Retail order when the order is created on-line.
freightContractNo	No	String (10)	The number of the contract with a shipper that will give specific freight rates. This field is only available when the system is running Import functionality.
pickupLocation	No	String (250)	Contains the location at which the order will be picked up, if the order is a Pickup order.
pickupNo	No	String (25)	Contains the reference number of the Pickup order.
pickupDate	No	date	Contains the date when the order can be picked up from the Supplier. This field is only required if the Purchase Type of the order is Pickup.
appointmentDatetime	No	date-time	This column will hold the date and time of the receiving appointment at the warehouse.
importType	No	String (1)	Valid values are IMporter and EXporter. This is the default importer/exporter assigned to the supplier of the Puchase order.
importId	No	Number (10)	This identifies the importer/exporter assigned to the supplier. This should reference the WH. WH folumn with foreign key created.
clearingZoneId	No	String (5)	This column will hold the clearing zone id.
routingLocation	No	String (5)	This is the default routing location for the import order. FK on OUTLOC. OUTLOC_ID.
reApproveInd	No	String (1)	This field indicates that the update to the corresponding purchase order needs to be performed, and then it should be approved again. Valid values are Y and N.
earliestShipDate	No	date	The date before which the item can not be shipped by the supplier.
latestShipDate	No	date	The date after which the item can not be shipped by the supplier.
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes at the order header level.
letterOfCredit	No	Record	References the letter of credit for the purchase order.

Table 5-228 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-229 LetterOfCredit - Object. See list of elements for detail

Element Name	Required	Data Type	Description
lcReferenceId	No	Number (8)	This field contains the ID of the LC to which the order is attached.
lcGroupId	No	String (10)	This field contains an ID that can be used to group Orders together so that they can be attached to a single Letter of Credit.
applicant	Yes	String (10)	This field contains the ID of the applicant being used for the LC process.
beneficiary	Yes	Number (10)	This field contains the ID of the beneficiary being used for the LC process.
merchandiseDescription	Yes	String (2000)	This field holds a description of the merchandise on the order.
transshipmentInd	Yes	String (1)	This field indicates whether or not the LC to which the order is attached will allow the order to be transshipped. Valid values are 'Y'es and 'N'o.
partialShipmentInd	Yes	String (1)	This field indicates whether or not the LC to which the order is attached will allow the order to be partially shipped. Valid values are 'Y'es and 'N'o.
lcAttachedInd	Yes	String (1)	This field indicates whether or not the order has been attached to a Letter of Credit. Valid values are Y and N.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "orderNo": 464690012,
      "supplier": 2400,
      "currencyCode": "USD",
      "terms": "02",
      "notBeforeDate": "2001-12-31",
      "notAfterDate": "2001-12-31",
      "otbEowDate": "2001-12-31",
      "dept": null,
      "status": "A",
      "includeOnOrderInd": "Y",
      "writtenDate": "2001-12-31",
      "origin": "2",
      "ediPoInd": "Y",
      "preMarkInd": "Y",
      "approvedBy": "RMS_ADMIN",
      "commentDesc": "Create Order",
      "dataLoadingDestination": "RMS",
      "masterOrderNo": null,
      "ladingPort": "7",
      "dischargePort": "480",
      "factory": "100",
      "agent": "007",
      "shipMethod": "32",
      "partnerType1": "AG",
      "partner1": "007",
      "partnerType2": "E",
      "partner2": "4678",
      "partnerType3": null,
      "partner3": null,
      "importCountry": "US",
      "purchaseType": "FOB",
      "paymentMethod": "LC",
      "titlePassLocationType": "FF",
      "titlePassLocation": "US",
      "purchaseOrderType": "4000",
      "orderType": "N/B",
      "buyer": 1000,
      "location": null,
      "locationType": null,
      "promotion": 41,
      "qualityControlInd": "Y",
      "freightTerms": "03",
      "backhaulType": null,
      "backhaulAllowance": null,
      "shipPayMethod": "PO",
      "transportationResponsibilityType": "FF",
      "transportationResponsibility": "US",
      "vendorOrderNo": "9987001",
      "freightContractNo": "111",
      "pickupLocation": null,
      "pickupNo": null,
      "pickupDate": null,
      "appointmentDatetime": "2001-12-31T23:59:59.123Z",
      "importType": "W",
      "importId": 10001,
      "clearingZoneId": null,
      "routingLocation": null,
      "reApproveInd": null,
      "earliestShipDate": "2001-12-31",
      "latestShipDate": "2001-12-31",
      "customFlexAttribute": [
        {
          "name": "REVIEW_DATE",
          "value": null,
          "valueDate": "2001-12-31"
        }
      ],
      "letterOfCredit": {
        "lcReferenceId": 10015000,
        "lcGroupId": null,
        "applicant": "500",
        "beneficiary": 2400,
        "merchandiseDescription": "Bath Essentials",
        "transshipmentInd": "Y",
        "partialShipmentInd": "Y",
        "lcAttachedInd": "Y"
      }
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Purchase Orders

Functional Area

Purchase Orders

Business Overview

This webservice is used to create purchase orders in order to keep Merchandising in sync with an external system that is responsible for maintaining purchase orders. It creates orders in Worksheet, Approved or Closed status. It also creates other data associated with a purchase order, including letter of credit, expenses, harmonized tariff schedules (HTS) and assessments, and custom flex attributes (CFAS). It also will apply rounding rules, default inventory management parameters, apply bracket costs, update open to buy buckets, and insert a record into the deals queue for deals to be applied to the order, if applicable. If the location specified on a purchase order is a franchise store, a corresponding franchise order is also created along with the PO.

It is assumed that the source of the orders sent in this service is not the supplier, as vendor managed inventory (VMI) POs can be sent using the Upload Purchase Order and Purchase Order Change Acknowledgements from Suppliers to Merchandising (ediupack) batch upload. It also does not support creating customer order POs or contract POs. Customer order POs are assumed to be sent using the Customer Order Fulfillment Subscription API and contract orders are created using replenishment processes in Merchandising or manually using the UI.

Service Type

POST

ReST URL

MerchIntegrations/services/purchaseOrders/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	Collection of orders.

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

Element Name	Required	Data Type	Description
orderNo	Yes	Number (12)	The unique identifier for the order.
supplier	No	Number (10)	The identifier of the supplier from which the order will be sourced. This cannot be modified if details exist for the PO.
currencyCode	No	String (3)	The code of the order's currency. If this is not populated, the supplier's currency will be used. This field can be modified if the order status is worksheet or approved and the order has not been shipped.
terms	No	String (15)	The sales terms of the order. If this is not populated on the create message, will default to the supplier's terms. This can be modified in worksheet or approved status.
notBeforeDate	No	date	The first date that delivery will be accepted. This can be modified in worksheet or approved status.
notAfterDate	No	date	The last date that delivery will be accepted. This can be modified in worksheet or approved status.
otbEowDate	No	date	The end of week date of the OTB bucket used. This can be modified in worksheet or approved status.
dept	No	Number (4)	The department in which are all the items on the order. This field is required if the system enforces single department ordering. This cannot be modified if details exist for the PO.
status	No	String (1)	The code for the status of the order. Valid values are 'W' worksheet and 'A' approved for PO creation. It is also possible to modify the status to 'C' closed.
exchangeRate	No	Number (20,10)	The rate of exchange for the PO used between the order and primary currencies. This field can be modified if the order status is worksheet or approved and the order has not been shipped.
includeOnOrderInd	No	String (1)	Indicates if the order should be included in on-order calculations. This can be modified in worksheet or approved status. Valid values are Y and N.
writtenDate	No	date	The date the order was created. If this field is not populated on the message it will default to the time of creation in RMS. It cannot be modified.
origin	No	String (1)	Indicates where the order originated. Valid values include: 2 - Manual, 6 - Inventory Planning generated order, 7 , 8.
ediPoInd	No	String (1)	Indicates whether or not the order will be transmitted to the supplier via an Electronic Data Exchange transaction. Valid values are: Y = Submit via EDI, N = Do not use EDI.
preMarkInd	No	String (1)	This field indicated whether or not a supplier has agreed to break an order into separate boxes so that the boxes can be sent directly to stores. Valid values are Y and N.
approvedBy	No	String (30)	Indicates where the order was approved. It will be the user ID of the person approving the order.
commentDesc	No	String (2000)	Any comments pertaining to the order.
dataLoadingDestination	No	String (6)	This field indicates if the order will be created in RMS or the staging tables. Valid values are RMS or STG. If this is not defined, the default is STG.
masterOrderNo	No	Number (10)	This field indicates the master order number from which child records were created.
ladingPort	No	String (5)	This field indicates the port from which the items on the purchase order are shipped.
dischargePort	No	String (5)	This field indicates the port at which the items on the purchase order will enter the country of import.
factory	No	String (10)	This field indicates the factory at which the items on the purchase order are made.
agent	No	String (10)	This field indicates the agent that is used in the purchase of the items on the purchase order.
shipMethod	No	String (6)	This field indicates the method used to ship the items on the purchase order from the country of origin to the country of import.
partnerType1	No	String (6)	This field indicates Partner 1 Type.
partner1	No	String (10)	This field indicates the Additional Partner 1.
partnerType2	No	String (6)	This field indicates Partner 2 Type.
partner2	No	String (10)	This field indicates the Additional Partner 2.
partnerType3	No	String (6)	This field indicates Partner 3 Type.
partner3	No	String (10)	This field indicates the Additional Partner 3.
importCountry	No	String (3)	The identifier of the country into which the items on the order are being imported.
purchaseType	No	String (6)	This field indicates what is included in the suppliers cost of the item. Valid values include C (Cost), CI (Cost and Insurance), CIF (Cost, Insurance and Freight) and FOB (Free on Board).
paymentMethod	No	String (6)	This field indicates how the purchase order will be paid. Valid options are LC (Letter of Credit), WT (Wire Transfer) and OA (Open Account).
titlePassLocationType	No	String (2)	Contains the code indicating the type of location or point where ownership of merchandise changes hands from seller/supplier to buyer/retailer. Valid values are found under the FOBT code type. Examples are City and State (AC), Country Of Sourcing (CA) and City (CI).
titlePassLocation	No	String (250)	Contains the description of the location or point where ownership of merchandise changes hands from seller/supplier to buyer/retailer.
purchaseOrderType	No	String (4)	This field contains the value associated with the PO_TYPE for the order.
orderType	No	String (3)	Indicates the type of order and which Open To Buy bucket will be updated. Valid values include: N/B - Non Basic, ARB - Automatic Reorder of Basic, BRB - Buyer Reorder of Basic.
buyer	No	Number (4)	Contains the number associated with the buyer for the order.
location	No	Number (10)	This field contains the location all items on the order will be delivered to if populated. i. e. It will mean a single location order.
locationType	No	String (1)	This field contains the type of location in the location field. Valid values are: Valid values are S (Store) or W (Warehouse).
promotion	No	Number (10)	Contains the RPCS offer ID associated with the order to provide a link between the order dialog and the promotions dialog.
qualityControlInd	No	String (1)	Determines whether or not quality control will be required when items for this order are received. Valid values are Y and N.
freightTerms	No	String (30)	Indicator that references what freight terms are related to the order.
backhaulType	No	String (6)	This field contains the type of backhaul allowance that will be applied to the order. Some examples are Calculated or Flat rate.
backhaulAllowance	No	Number (20,4)	This field will contain the backhaul allowance value.
shipPayMethod	No	String (2)	Code indicating the payment terms for freight charges associated with the order. Valid values include: CC - Collect, CF - Collect Freight Credited Back to Customer, DF - Defined by Buyer and Seller, MX - Mixed, PC - Prepaid but Charged to Customer, PO - Prepaid Only, PP - Prepaid by Seller.
transportationResponsibilityType	No	String (2)	Contains the code indicating the type of location or point at which the responsibility for transportation transfers from the seller/supplier to the buyer/retailer. Valid values are found under the FOBT code type. Examples are City and State (AC), Country Of Sourcing (CA) and Country (CC).
transportationResponsibility	No	String (250)	Contains the description of the location or point at which the responsibility for transportation transfers from the seller/supplier to the buyer/retailer.
vendorOrderNo	No	String (15)	Contains the vendors unique identifying number for an order. These orders may have originated by the vendor through the EDI process or this number can be associated to an Oracle Retail order when the order is created on-line.
freightContractNo	No	String (10)	The number of the contract with a shipper that will give specific freight rates. This field is only available when the system is running Import functionality.
pickupLocation	No	String (250)	Contains the location at which the order will be picked up, if the order is a Pickup order.
pickupNo	No	String (25)	Contains the reference number of the Pickup order.
pickupDate	No	date	Contains the date when the order can be picked up from the Supplier. This field is only required if the Purchase Type of the order is Pickup.
appointmentDatetime	No	date-time	This column will hold the date and time of the receiving appointment at the warehouse.
importType	No	String (1)	Valid values are IMporter and EXporter. This is the default importer/exporter assigned to the supplier of the Purchase order.
importId	No	Number (10)	This identifies the importer/exporter assigned to the supplier. This should reference the WH. WH column with foreign key created.
clearingZoneId	No	String (5)	This column will hold the clearing zone id.
routingLocation	No	String (5)	This is the default routing location for the import order. FK on OUTLOC. OUTLOC_ID.
reApproveInd	No	String (1)	This field indicates that the update to the corresponding purchase order needs to be performed, and then it should be approved again. Valid values are Y and N.
earliestShipDate	No	date	The date before which the item can not be shipped by the supplier.
latestShipDate	No	date	The date after which the item can not be shipped by the supplier.
fileId	No	String (20)	In order to support supplier pooling via the buyer worksheet, the recommended order quantities for the individual suppliers are linked together for logistical purposes while generating orders from the worksheet based on this identifier.
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes at the order header level.
details	No	Collection of Object	This references the order detail node.
itemDetails	No	Collection of Object	This references the collection of items in the order.
letterOfCredit	No	Record	References the letter of credit for the purchase order.
expenses	No	Collection of Object	References the expense associated with a particular item/location of the purchase order.
hts	No	Collection of Object	References the HTS code associated with a particular item of the purchase order.

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

Element Name	Required	Data Type	Description
item	No	String (25)	An approved, transaction level item. If a pack, it must be an orderable pack (with an order_as_type of 'P'). This is required if the ref_item field is not populated. An item/location may be added to the order in worksheet or approved status.
location	Yes	Number (10)	An active store or warehouse. If multichannel is on, and a warehouse is being order to, a virtual warehouse is expected. An item/location may be added to the order in worksheet or approved status.
locationType	No	String (1)	The location type of the location. Valid values are 'S' store and 'W' warehouse. This field cannot be modified.
unitCost	No	Number (20,4)	The cost of the item from the supplier in the order's currency. This can be modified if the status is worksheet or approved, but not if any portion of the item's order quantity is in transit or has been received. If it is not specified on the message, it will default from the item supplier cost for this location.
referenceItem	No	String (25)	The id of a reference item which can be used instead of using the item field. If the item field is not populated this field is required. A ref item/location may be added to the order in worksheet or approved status.
originCountry	No	String (3)	The identifier of the country from which the item is being sourced. This field cannot be modified.
supplierPackSize	No	Number (12,4)	The supplier pack size for the item on the order. This may be updated in worksheet or approved status.
quantityOrdered	No	Number (12,4)	The quantity ordered of item. This can be updated in worksheet or approved status to adjust the quantity of an item/location or cancel an item/location from the order.
cancelInd	No	String (1)	Indicates if the detail record's quantity should be cancelled. Valid values are 'Y'es and 'N'o.
reinstateInd	No	String (1)	Indicates if a detail record which was previously cancelled should be reinstated. This will reinstate in the order quantity the amount in the cancelled bucket. Valid values are 'Y'es and 'N'o.
deliveryDate	No	date	The date by which goods are to be delivered. There can be multiple item-locations on the order with different delivery dates.
quantityCancelled	No	Number (12,4)	This field contains the quantity that was left to be ordered when the line item was cancelled.
cancelCode	No	String (1)	This field contains the reason that the line item was cancelled. This field is required if a line item is cancelled.
estimatedInstockDate	No	date	Date that the item on the PO is expected to be available to ship from the PO location to another location. It is calculated as the Order Creation or Approval Date + Supplier Lead Time + Transit Days between the Supplier and the PO/location + Item/Warehouse Inbound Handling Days (if PO location is a warehouse).
earliestShipDate	No	date	The date before which the item can not be shipped by the supplier.
latestShipDate	No	date	The date after which the item can not be shipped by the supplier.
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes for the order/location.

Table 5-233 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-234 ItemDetails - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	No	String (25)	An approved, transaction level item. If a pack, it must be an orderable pack (with an order_as_type of 'P'). This is required if the ref_item field is not populated. An item/location may be added to the order in worksheet or approved status.
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes for ordsku.

Table 5-235 LetterOfCredit - Object. See list of elements for detail

Element Name	Required	Data Type	Description
lcReferenceId	No	Number (8)	This field contains the ID of the LC to which the order is attached.
lcGroupId	No	String (10)	This field contains an ID that can be used to group Orders together so that they can be attached to a single Letter of Credit.
applicant	Yes	String (10)	This field contains the ID of the applicant being used for the LC process.
beneficiary	Yes	Number (10)	This field contains the ID of the beneficiary being used for the LC process.
merchandiseDescription	Yes	String (2000)	This field holds a description of the merchandise on the order.
transshipmentInd	Yes	String (1)	This field indicates whether or not the LC to which the order is attached will allow the order to be transshipped. Valid values are 'Y'es and 'N'o.
partialShipmentInd	Yes	String (1)	This field indicates whether or not the LC to which the order is attached will allow the order to be partially shipped. Valid values are 'Y'es and 'N'o.
lcAttachedInd	Yes	String (1)	This field indicates whether or not the order has been attached to a Letter of Credit. Valid values are Y and N.

Table 5-236 Expenses - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	This field contains alphanumeric value that uniquely identifies the item.
packItem	No	String (25)	This field contains alphanumeric value that uniquely identifies the pack.
location	Yes	Number (10)	This field contains the location that item will be ordered to. This field may contain a store or a warehouse.
locationType	Yes	String (1)	This field contains the type of location in the location field. Valid values are: S - Store W - Warehouse.
component	Yes	String (10)	This field contains a user specified code representing a specific expense found on the ELC_COMP table.
computationValueBase	No	String (10)	This field contains a code representing the base value for calculating the expense.
calculationBasis	No	String (1)	This field contains the basis the expense will be calculated against if there is no CVB code attached to the expense. Valid values are S (Supplier) or O (Order). If the Cost Basis is S then when calculating the expense, the items supplier cost will be used. If the Cost Basis is O then the order unit cost of the item on the order will be used to calculate the expense. The code type for this field is EXCB.
componentRate	Yes	Number (20,4)	This field contains the rate to be charged against the calculation base of the component (either value or specific).
componentCurrency	Yes	String (3)	This field contains the currency the expense or assessment is to be entered in. If the Calculation Basis is V (Value), then comp_currency will be NULL.
exchangeRate	Yes	Number (20,10)	This field contains the exchange rate of the individual expense.
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. When creating an expense that is defined as $. 20 for every 10 kilograms of an item ordered, the Per Count would be 10.
perCountUom	No	String (4)	This field contains the unit of measure in which the Per Count is specified. When creating an expense that is defined as $. 20 for every 10 kilograms of an item ordered, the Per Count UOM would be the Unit of Measure code for Kilograms.
nominationFlag1	Yes	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 1), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 1), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 1). For example, if cost component ABC has a + in Nomination Flag 1, then all CVBs that include Nomination Flag 1 will include this cost component value in their calculation basis.
inDuty	Yes	String (1)	See description for nom_flag_1. If ALC is turned on (i. e. system_options. import_ind = Y), nom_flag_2 is used to indicate the status of a component in duty calculation nom_flag_4 is used to indicate the status of a component in ELC calculation nom_flag_5 is used to indicate the status of a component in ALC calculation i. e. these 3 flags can not be used for any other purposes if ALC is turned on.
nominationFlag3	Yes	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 3), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 3), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 3). For example, if cost component ABC has a + in Nomination Flag 3, then all CVBs that include Nomination Flag 3 will include this cost component value in their calculation basis.
inExpense	Yes	String (1)	See description for nom_flag_1. If ALC is turned on (i. e. system_options. import_ind = Y), nom_flag_2 is used to indicate the status of a component in duty calculation nom_flag_4 is used to indicate the status of a component in ELC calculation nom_flag_5 is used to indicate the status of a component in ALC calculation i. e. these 3 flags can not be used for any other purposes if ALC is turned on.
inAlc	Yes	String (1)	See description for nom_flag_1. If ALC is turned on (i. e. system_options. import_ind = Y), nom_flag_2 is used to indicate the status of a component in duty calculation nom_flag_4 is used to indicate the status of a component in ELC calculation nom_flag_5 is used to indicate the status of a component in ALC calculation i. e. these 3 flags can not be used for any other purposes if ALC is turned on.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	This field contains an unique alphanumeric value that identifies the item.
packItem	No	String (25)	This field contains alphanumeric value that uniquely identifies the pack.
hts	Yes	String (25)	This field contains an identifier for the Harmonized Tariff Schedule code.
status	Yes	String (1)	This field contains a flag to indicate the status of the Purchase Order/Item/HTS relationship. Valid values are (W)orksheet and (A)pproved.
originCountry	Yes	String (3)	This field contains the country of manufacture when the HTS tracking level is M. When the HTS tracking level is S, this stores the country of sourcing.
importCountry	No	String (3)	This field contains the country that the item will be imported in to.
assessments	No	Collection of Object	References the HTS code assessments associated with a particular item of the purchase order.

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

Element Name	Required	Data Type	Description
component	Yes	String (10)	This field contains a user specified code representing the specific assessment component found on the ELC_COMP table.
computationValueBase	No	String (10)	This field contains a code representing the base value for calculating the assessment.
componentRate	Yes	Number (20,4)	This field contains the rate to be charged against the calculation base. This field will hold a percentage value if the Calculation Basis of the Component is Value or a monetary amount in the currency defined for the assessment (usually the import country’s currency) if the Calculation Basis is Specific.
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. When creating an expense that is defined as $. 20 for every 10 kilograms of an item ordered, the Per Count would be 10.
perCountUom	No	String (4)	This field contains the unit of measure in which the Per Count is specified. When creating an expense that is defined as $. 20 for every 10 kilograms of an item ordered, the Per Count UOM would be the Unit of Measure code for Kilograms.
nominationFlag1	Yes	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 1), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 1), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 1). For example, if cost component ABC has a + in Nomination Flag 1, then all CVBs that include Nomination Flag 1 will include this cost component value in their calculation basis.
inDuty	Yes	String (1)	See description for nom_flag_1. If ALC is turned on (i. e. system_options. import_ind = Y), nom_flag_2 is used to indicate the status of a component in duty calculation nom_flag_4 is used to indicate the status of a component in ELC calculation nom_flag_5 is used to indicate the status of a component in ALC calculation i. e. these 3 flags can not be used for any other purposes if ALC is turned on.
nominationFlag3	Yes	String (1)	This field contains a flag that is used to indicate if the value of the cost component should be included in the calculation of another. Nomination flags are used to calculate the value of a Computation Value Base (CVB) which has the corresponding nomination flag set to Yes (Y). Valid values are: N/A (N) (the value of this component will not be included in CVBs which look at Nomination Flag 3), Add (+) (the value of this component will be added to CVBs which look at Nomination Flag 3), and Subtract (-) (the value of this component will be deducted from CVBs which look at Nomination Flag 3). For example, if cost component ABC has a + in Nomination Flag 3, then all CVBs that include Nomination Flag 3 will include this cost component value in their calculation basis.
inExpense	Yes	String (1)	See description for nom_flag_1. If ALC is turned on (i. e. system_options. import_ind = Y), nom_flag_2 is used to indicate the status of a component in duty calculation nom_flag_4 is used to indicate the status of a component in ELC calculation nom_flag_5 is used to indicate the status of a component in ALC calculation i. e. these 3 flags can not be used for any other purposes if ALC is turned on.
inAlc	Yes	String (1)	See description for nom_flag_1. If ALC is turned on (i. e. system_options. import_ind = Y), nom_flag_2 is used to indicate the status of a component in duty calculation nom_flag_4 is used to indicate the status of a component in ELC calculation nom_flag_5 is used to indicate the status of a component in ALC calculation i. e. these 3 flags can not be used for any other purposes if ALC is turned on.

Sample Input Message

{
  "items": [
    {
      "orderNo": 464690012,
      "supplier": 2400,
      "currencyCode": "USD",
      "terms": "02",
      "notBeforeDate": "2001-12-31",
      "notAfterDate": "2001-12-31",
      "otbEowDate": "2001-12-31",
      "dept": null,
      "status": "A",
      "exchangeRate": 2,
      "includeOnOrderInd": "Y",
      "writtenDate": "2001-12-31",
      "origin": "2",
      "ediPoInd": "Y",
      "preMarkInd": "Y",
      "approvedBy": null,
      "commentDesc": "Create Order",
      "dataLoadingDestination": "RMS",
      "masterOrderNo": null,
      "ladingPort": "7",
      "dischargePort": "480",
      "factory": "100",
      "agent": "007",
      "shipMethod": "32",
      "partnerType1": "AG",
      "partner1": "007",
      "partnerType2": "E",
      "partner2": "4678",
      "partnerType3": null,
      "partner3": null,
      "importCountry": "US",
      "purchaseType": "FOB",
      "paymentMethod": "LC",
      "titlePassLocationType": "FF",
      "titlePassLocation": "US",
      "purchaseOrderType": "4000",
      "orderType": "N/B",
      "buyer": 1000,
      "location": null,
      "locationType": null,
      "promotion": 41,
      "qualityControlInd": "Y",
      "freightTerms": "03",
      "backhaulType": null,
      "backhaulAllowance": null,
      "shipPayMethod": "PO",
      "transportationResponsibilityType": "FF",
      "transportationResponsibility": "US",
      "vendorOrderNo": "9987001",
      "freightContractNo": "111",
      "pickupLocation": null,
      "pickupNo": null,
      "pickupDate": null,
      "appointmentDatetime": "2001-12-31T23:59:59.123Z",
      "importType": "W",
      "importId": 10001,
      "clearingZoneId": null,
      "routingLocation": null,
      "reApproveInd": null,
      "earliestShipDate": "2001-12-31",
      "latestShipDate": "2001-12-31",
      "fileId": "String",
      "customFlexAttribute": [
        {
          "name": "REVIEW_DATE",
          "value": null,
          "valueDate": "2001-12-31"
        }
      ],
      "details": [
        {
          "item": "103900095",
          "location": 10001,
          "locationType": "W",
          "unitCost": 45.2,
          "referenceItem": null,
          "originCountry": "IN",
          "supplierPackSize": 1,
          "quantityOrdered": 25,
          "cancelInd": null,
          "reinstateInd": null,
          "deliveryDate": "2001-12-31",
          "quantityCancelled": null,
          "cancelCode": null,
          "estimatedInstockDate": "2001-12-31",
          "earliestShipDate": "2001-12-31",
          "latestShipDate": "2001-12-31",
          "customFlexAttribute": [
            {
              "name": "REVIEW_DATE",
              "value": null,
              "valueDate": "2001-12-31"
            }
          ]
        }
      ],
      "itemDetails": [
        {
          "item": "103900095",
          "customFlexAttribute": [
            {
              "name": "REVIEW_DATE",
              "value": null,
              "valueDate": "2001-12-31"
            }
          ]
        }
      ],
      "letterOfCredit": {
        "lcReferenceId": 10015000,
        "lcGroupId": null,
        "applicant": "500",
        "beneficiary": 2400,
        "merchandiseDescription": "Bath Essentials",
        "transshipmentInd": "Y",
        "partialShipmentInd": "Y",
        "lcAttachedInd": "Y"
      },
      "expenses": [
        {
          "item": "103900095",
          "packItem": null,
          "location": 10001,
          "locationType": "W",
          "component": "OCFRT",
          "computationValueBase": null,
          "calculationBasis": null,
          "componentRate": 17,
          "componentCurrency": "INR",
          "exchangeRate": 29,
          "perCount": 1,
          "perCountUom": "M3",
          "nominationFlag1": "N",
          "inDuty": "N",
          "nominationFlag3": "N",
          "inExpense": "+",
          "inAlc": "N"
        }
      ],
      "hts": [
        {
          "item": "103900095",
          "packItem": null,
          "hts": "9014111112",
          "status": "W",
          "originCountry": "IN",
          "importCountry": "US",
          "assessments": [
            {
              "component": "DTYCAUS",
              "computationValueBase": null,
              "componentRate": 12,
              "perCount": 1,
              "perCountUom": "EA",
              "nominationFlag1": "N",
              "inDuty": "+",
              "nominationFlag3": "-",
              "inExpense": "N",
              "inAlc": "N"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Create Stock Count Schedules

Functional Area

Inventory - Stock Counts

Business Overview

Stock count schedules are published by an inventory sub-system, such as Oracle Retail Store Inventory and Operations Cloud Service (SIOCS), to communicate unit and value stock count schedules to Merchandising. This stock count schedule data helps in synchronizing the inventory values of the integrated system and Merchandising. This integrated system then performs a physical inventory count and uploads the results, and Merchandising compares the discrepancies.

This webservice allows the external systems to create Unit and Value stock count requests within Merchandising. The count is assumed to be for the full location, unless any department, class or subclass details are included.

When a new stock count request is created, this webservice will validate all the required fields that are present in the message which includes a description, date, location type and location details. The stock take type will always be B (both unit and dollar). Optionally, the merchandise hierarchy information can also be included, but, if not included, it will be assumed the entire location will be counted. After the required field and business validations are successfully completed, the stock counts will be created in Merchandising.

Service Type

POST

ReST URL

MerchIntegrations/services/inventory/stockCount/schedules/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
cycleCount	Yes	Number (8)	Contains the number which uniquely identifies the stock or cycle count.
description	Yes	String (250)	This field contains a description of the cycle or stock count which, along with the cycle count number, identifies the cycle or stock count.
locationType	Yes	String (1)	This field contains an indicator which identifies whether the cycle count will be for Stores or Warehouses. Valid values are Store (S) and Warehouse (W).
stocktakeDate	Yes	date	Contains the date on which the stock or cycle count even will take place.
merchandiseHierarchy	No	Collection of Object	References a collection of merchandies hierarchies to be included in the stock count. If not present, all departments will be included in the count.
locations	No	Collection of Object	References a collection of locations to be included in the stock count.

Table 5-241 MerchandiseHierarchy - Object. See list of elements for detail

Element Name	Required	Data Type	Description
dept	Yes	Number (4)	This field contains the department number where the cycle count will occur. If the value = -1, the stock count will apply to all departments. The dept/class/subclass hierarchy must be a valid hierarchy in Merchandising.
class	No	Number (4)	This field contains the class number where the cycle count will occur. The dept/class/subclass hierarchy must be a valid hierarchy in Merchandising.
subclass	No	Number (4)	This field contains the subclass number where the cycle count will occur. The dept/class/subclass hierarchy must be a valid hierarchy in Merchandising.

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

Element Name	Required	Data Type	Description
location	Yes	Number (10)	This field contains the store or warehouse number on the cycle count. This must be a valid store or a stockholding warehouse in Merchandising.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "cycleCount": 1001,
      "description": "Cycle count 1001",
      "locationType": "S",
      "stocktakeDate": "2001-12-31",
      "merchandiseHierarchy": [
        {
          "dept": 3041,
          "class": 1,
          "subclass": 1
        }
      ],
      "locations": [
        {
          "location": 6000
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

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

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

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

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

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	Unique ID of the store. This store must be same as the store Id at the header level.
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.

Sample Input Message

{
  "store": 6001,
  "storeName": "6001 Retail",
  "storeType": "C",
  "storeNameSecondary": "storeNameSecondary",
  "channelId": 1,
  "district": 121,
  "transferZone": 1000,
  "defaultWarehouse": 10001,
  "currencyCode": "USD",
  "orgUnitId": 1111111111,
  "stockholdingInd": "Y",
  "customerOrderLocationInd": "Y",
  "customerOrderShippingInd": "Y",
  "giftWrappingInd": "Y",
  "onlineStoreInd": "Y",
  "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": "[e-mail]",
  "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": 174686,
  "copyReplenishmentInd": "Y",
  "transferEntity": 1000,
  "sisterStore": 174114,
  "transactionNoGenerated": "S",
  "timezoneName": "America/New_York",
  "customerId": 121902,
  "taxId": null,
  "copyClearanceInd": "Y",
  "customFlexAttribute": [
    {
      "name": "REVIEW_DATE",
      "value": null,
      "valueDate": null
    }
  ],
  "address": [
    {
      "addressType": "1",
      "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": "[e-mail]",
      "oracleVendorSiteId": 625128,
      "customFlexAttribute": [
        {
          "name": "REVIEW_DATE",
          "value": null,
          "valueDate": null
        }
      ]
    }
  ],
  "hours": [
    {
      "store": 6001,
      "dayNo": 1,
      "storeOpenTime": null,
      "storeCloseTime": null
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

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-247 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.

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

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

Table 5-249 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.

Sample Input Message

{
  "store": 6000,
  "storeType": "C",
  "address": [
    {
      "addressType": "2",
      "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": "[e-mail]",
      "oracleVendorSiteId": 625128,
      "customFlexAttribute": [
        {
          "name": "REVIEW_DATE",
          "value": null,
          "valueDate": "2001-12-31"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create 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-250 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.

Table 5-251 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-252 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.

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create 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-253 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.

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

Element Name	Required	Data Type	Description
store	Yes	Number (10)	Unique ID of the store. This store must be same as the store Id at the header level.
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.

Sample Input Message

{
  "store": 6000,
  "storeType": "C",
  "hours": [
    {
      "store": 6000,
      "dayNo": 1,
      "storeOpenTime": null,
      "storeCloseTime": null
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

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-255 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.

Table 5-256 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,
  "storeType": "C",
  "traits": [
    {
      "traitId": 1000
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create 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-257 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-258 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)

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

Sample Error Message

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

Create Subclass

Functional Area

Merchandise Hierarchy

Business Overview

This service is can be used to create subclasses for an existing department-class in Merchandising. When a new subclass is created, this service will first validate that all required fields are present in the request payload. Business level validation on the input information will be performed, which checks whether the subclass already exists. If the subclass does not exist, then it is created.  Active custom flex attributes that are associated with a subclass can also be created through this service.

Service Type

POST

ReST URL

MerchIntegrations/services/merchandiseHierarchy/subclass/create

Input Payload Details

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

Element Name	Required	Data Type	Description
subclass	Yes	Number (4)	The unique number which identifies the subclass. This value cannot be modified.
subclassName	Yes	String (120)	The name of the subclass.
class	Yes	Number (4)	The number of the class which contains the subclass. This value must be predefined on the CLASS table. This value cannot be modified.
dept	Yes	Number (4)	The number of the department which contains the subclass. This value must be predefined on the DEPS table. This value cannot be modified.
intercompanyTransferPriceBasis	No	String (6)	This specifies the Default Intercompany Transfer Price that will be used during recording of transaction data postings on intercompany transfers and allocations. Valid values are 'W'(Weighted Average Cost) and 'S'(Supplier Cost). If not defined, the value will default to 'W' for subclasses under departments with cost-based profit calculation type or to 'R' (Retail Based) for subclasses under departments with retail-based profit calculation type.
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes.

Table 5-260 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.

Sample Input Message

{
  "subclass": 1,
  "subclassName": "subclassName",
  "class": 1,
  "dept": 3041,
  "intercompanyTransferPriceBasis": null,
  "customFlexAttribute": [
    {
      "name": "REVIEW_DATE",
      "value": null,
      "valueDate": "2001-12-31"
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Suppliers

Functional Area

Foundation - Suppliers

Business Overview

This service is used for creation of suppliers, supplier sites, org unit association, addresses and flex attributes from an external application.

When new suppliers or supplier sites are sent from an external system, they must contain the required header details, as well as address and org unit information. One or more org units can be associated with a supplier site using this service, if applicable. When creating a supplier parent, providing the supplier site information is optional. The following defaults are performed by the service:

• Yes/No indicators are defaulted to No if not provided

• Settlement code - defaulted to N if not provided

• EDI sales report frequency - defaulted to NULL if the provided value is not D or W

• Supplier Quantity Level - defaulted to EA if not provided

When creating supplier sites, you must provide both supplier parent and supplier site information. 

Mandatory addresses as defined in the system are defaulted when creating address records even if the request does not contain the mandatory address types.

Service Type

POST

ReST URL

MerchIntegrations/services/foundation/suppliers/create

Input Payload Details

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

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	References a collection of suppliers.

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

Element Name	Required	Data Type	Description
supplierReferenceNo	Yes	String (32)	This holds the ID for the supplier used in the external financial system. It is populated by the integration that brings suppliers from external financial systems into Merchandising. This ID and the supplier site ID can be used to join to information about the supplier in the external system.
supplier	No	Number (10)	Unique identifying number for a supplier parent within the system. When a new supplier is added to the system, this value can either be provided by the user or it can be system generated. Leave this field as null for a system generated supplier ID.
attributes	Yes	Record	This contains supplier parent information.
supplierSites	No	Collection of Object	References a collection of supplier sites.
procurementSiteInd	No	String (1)	Indicates if the supplier site is a procurement site used for purchasing.
paymentSiteInd	No	String (1)	Indicates if the supplier site is a payment site used for invoice payment.

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

Element Name	Required	Data Type	Description
supplierName	Yes	String (240)	This field contains the supplier name.
supplierNameSecondary	No	String (240)	This type can hold secondary name for the supplier with a max length of 240 characters.
contactName	No	String (120)	This field contains the name of the supplier representative contact for this site.
contactPhone	No	String (20)	This field contains a telephone number for the supplier's representative contact.
contactFax	No	String (20)	This field contains a fax number for the supplier's representative contact.
contactPager	No	String (20)	This field contains a pager number for the supplier's representative contact.
supplierStatus	Yes	String (1)	This field contains the status of the supplier. Valid values include: 'A' for an active supplier or 'I' for an inactive supplier. The status of a supplier will be checked when an order is being created to make certain the supplier is active.
qualityControlInd	No	String (1)	This field determines whether orders from this supplier will require quality control. Valid values are Yes (Y) and No (N).
qualityControlPercentage	No	Number (12,4)	This field contains the percentage of items per receipt that will be marked for quality checking.
qualityControlFrequency	No	String (2)	This field contains the frequency for which items per receipt will be marked for quality checking.
vendorCheckingInd	No	String (1)	This field determines whether orders from this supplier will require vendor control. Valid values are Yes (Y) and No (N).
vendorCheckingPercentage	No	Number (12,4)	This field contains percentage of items per receipt that will be marked for vendor checking.
vendorCheckingFrequency	No	Number (2)	This field contains the frequency for which items per receipt that will be marked for vendor checking.
currencyCode	Yes	String (3)	This field contains code identifying the currency the supplier site uses for business transactions.
language	Yes	Number (6)	This field contains the supplierss preferred language. This field is provided for custom purchase orders in a specified language.
terms	Yes	String (15)	This field contains an indicator identifying the purchase terms that will default when an order is created for the supplier site. These terms specify when payment is due and if any discounts exist for early payment.
freightTerms	Yes	String (30)	This field contains code indicating what freight terms will default when an order is created for the supplier site.
returnAllowedInd	No	String (1)	This field indicates whether the supplier site will accept returns. Valid values are Yes (Y) or No (N).
returnAuthReqInd	No	String (1)	This field indicates if returns must be accompanied by an authorization number when sent back to the vendor. Valid values are Yes (Y) and No (N).
minReturnValue	No	Number (20,4)	This field contains a value if the supplier site requires a minimum merchandise value to be returned to accept the return. Returns of less than this amount will not be processed by the system. This field is stored in the supplier's currency.
returnCourier	No	String (250)	This field contains the name of the courier that should be used for returns to the supplier site.
handlingPercentage	No	Number (12,4)	This field contains the default percent to be multiplied by the return's total cost to determine the handling cost for the return.
ediOrderInd	No	String (1)	This field indicates whether purchase orders will be sent to the supplier via Electronic Data Interchange (EDI). Valid values are Yes (Y) and No (N).
ediOrderChangeInd	No	String (1)	This field indicates whether purchase order changes will be sent to the supplier via EDI. Valid values are Yes (Y) and No (N).
ediOrderConfirmInd	No	String (1)	This field indicates whether acknowledgements of purchase orders will be sent from the supplier via EDI. Valid values are Yes (Y) and No (N).
ediAsnInd	No	String (1)	This field indicates whether the supplier will send Advance Shipment Notifications electronically. Valid values are Yes (Y) and No (N).
ediSalesReportFreq	No	String (1)	This field contains the EDI sales report frequency for the supplier. Valid values are weekly (W) or daily (D).
ediSupplierAvailabilityInd	No	String (1)	This field indicates whether the supplier will send availability via EDI. Valid values are Yes (Y) and No (N).
ediContractInd	No	String (1)	Indicates whether contracts will be sent to the supplier via EDI. Valid values are Yes (Y) and No (N).
ediInvcInd	No	String (1)	This field indicates whether invoices, debit memos, and credit note requests will be sent to/from the supplier via EDI. Valid values are Yes (Y) and No (N).
ediChannel	No	Number (4)	If the supplier is an EDI supplier and supports vendor initiated ordering, this field will contain the channel ID for the channel to which all inventory for these types of orders will flow. This field is used when a vendor initiated order is created for a physical warehouse to determine the virtual warehouse within the physical warehouse to which the inventory will flow. The virtual warehouse belonging to the indicated channel will be used. This will only be used in a multichannel environment. Valid values are Yes (Y) and No (N).
costChangeVariancePercentage	No	Number (12,4)	This field contains a percent that determines whether a cost change can be auto approve via induction. If the cost change falls within these boundaries, it will be approved when uploaded.
costChangeVarianceAmt	No	Number (20,4)	This field contains an amount (in supplier currency) that determines whether a cost change can be auto approve via induction. If the cost change falls within these boundaries, it will be approved when uploaded.
replenApprovalInd	No	String (1)	This field indicates whether contract orders created via replenishment should be created in Approved status. Valid values are Yes (Y) and No (N).
shipMethod	No	String (6)	This field contains the default method used to ship the items on the purchase order from the supplier site. Valid values are held in the Shipment Type code type, SHPM. Examples of shipment types are Vessel, Non-Container (10 ), Vessel, Container (11), Rail, Non-container (20) and Rail, Container (21).
paymentMethod	No	String (6)	This field indicates the default method for how purchase orders for this site will be paid. Valid options are 'LC' - Letter of Credit, 'WT' - Wire Transfer and 'OA' - Open Account
contactTelex	No	String (20)	This field contains the telex number of the partner or suppliers representative contact.
contactEmail	No	String (100)	This field contains the email address of the partner or suppliers representative contact.
settlementCode	No	String (1)	This field indicates which payment process method is used for this supplier.
preMarkInd	No	String (1)	This field indicates whether or not the supplier has agreed to break an order into separate boxes (and mark them) that can be shipped directly to the stores. Valid values are Yes (Y) and No (N).
autoApproveInvoiceInd	No	String (1)	Indicates whether or not the suppliers invoice matches can be automatically approved for payment. This field will only be populated if invoice matching is installed. Valid values are Yes (Y) and No (N).
debitMemoCode	No	String (1)	This field indicates when a debit memo will be sent to the supplier site to resolve a discrepancy. Valid values are 'Y' - if debit memos are always to be sent, 'L '- if debit memos are used only if a credit note is not sent by the invoice due date and 'N' - if debit memos are never sent.
freightChargeInd	No	String (1)	This field indicates whether a supplier site can charge freight costs. Valid values are Yes (Y) and No (N).
autoApproveDebitMemoInd	No	String (1)	This field indicates whether debit memos sent to the supplier site can be automatically approved on creation. Valid values are Yes (Y) and No (N).
prepayInvoiceInd	No	String (1)	This field indicates whether all invoices for the supplier can be pre-paid. Valid values are Yes (Y) and No (N).
backorderInd	No	String (1)	This field indicates if backorders or partial shipments will be accepted. Valid values are Yes (Y) and No (N).
vatRegion	No	Number (4)	This field contains the unique identifying number for the VAT region applicable for this site.
invManagementLevel	No	String (6)	This field indicates the level for managing supplier inventory information. Valid values are supplier (S), supplier/location (L), supplier/department (D), or supplier/department/location (A). If no value is provided, then if the department level orders system option is set to Yes, then this is defaulted to supplier/department, otherwise it is defaulted to supplier.
servicePerfReqInd	No	String (1)	This field indicates if the supplier's services must be confirmed as performed before paying an invoice from that supplier site. Valid values are Yes (Y) and No (N).
invoicePayLocation	No	String (6)	This field indicates where invoices from this supplier site are paid - at the store (S) or centrally through corporate accounting (C).
invoiceReceiveLocation	No	String (6)	This field indicates where invoices from this supplier site are received - at the store (S) or centrally through corporate accounting (C).
invoiceGrossNet	No	String (6)	This field indicates if the supplier site invoice lists items at gross cost (G) or net cost (N).
deliveryPolicy	No	String (6)	This field contains the default delivery policy of the supplier site. Valid values come from the DLVY (Delivery Policy) code type. Examples of delivery policies are Next Valid Delivery Day (NDD), Next Day (NEXT) and Bank Instructions (BI).
comments	No	String (2000)	This field contains any miscellaneous comments associated with the supplier.
defaultItemLeadTime	No	Number (4)	This field holds the default lead time for the supplier site. The lead time is the time the supplier needs between receiving an order and having the order ready to ship. This value will be defaulted to item/supplier relationships.
dunsNumber	No	String (9)	The Dun and Bradstreet number of the supplier.
dunsLocation	No	String (4)	The Dun and Bradstreet number of the location of the supplier.
bracketCostingInd	No	String (1)	This field will determine if the supplier site supports bracket costing pricing structures. Valid values are Yes (Y) and No (N).
vmiOrderStatus	No	String (6)	This field determines the status in which any inbound POs from this supplier will be created. A NULL value indicates that the supplier is not a VMI supplier.
dsdSupplierInd	No	String (1)	This field specifies whether the vendor supports DSD ordering, where the supplier replenishes the store directly, creating the PO and receipt at the same time. Valid values are Y and N. Valid values are Yes (Y) and No (N).
scaleAipOrders	No	String (1)	Depending upon the value in this column, scaling is done for Inventory Planning orders. Default value is N. Valid values are Yes (Y) and No (N).
supplierQuantityLevel	No	String (6)	This field indicates the supplier site order quantity level. Valid values are cases (CA) or eaches (EA).
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes.
dealUploadStatus	No	String (6)	Indicates the status in which the deal needs to be uploaded into the system by upload batch process. The valid values are 'W'orksheet, 'S'ubmitted, 'A'pproved.
taxId	No	String (20)	This field contains the unique tax identification number of the supplier site.

Table 5-264 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-265 SupplierSites - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplierSiteReferenceNo	Yes	String (32)	This holds the ID for the supplier used in the external financial system. It is populated by the integration that brings suppliers from external financial systems into Merchandising. This ID and the supplier site ID can be used to join to information about the supplier in the external system.
supplierSite	No	Number (10)	Unique identifying number for a supplier site within the system. When a new supplier site is added to the system, this can either be provided by the user or it can be system generated. Leave this field as null for a system generated supplier site ID.
attributes	Yes	Record	This contains supplier site attributes.
orgUnit	Yes	Collection of Object	References a collection of supplier org units.
address	Yes	Collection of Object	References a collection of supplier addresses.

Table 5-266 OrgUnit - Object. See list of elements for detail

Element Name	Required	Data Type	Description
orgUnitId	Yes	Number (15)	This field contains org_unit_id.
primaryPaySite	No	String (1)	This field contains the primary pay site indicator.

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

Element Name	Required	Data Type	Description
addressReferenceKey	No	String (32)	This column contains the external reference ID used to distinguish between different addresses.
addressKey	No	Number (11)	This column contains a unique number used to distinguish between different addresses.
address	Yes	Record	This contains the supplier's address information.

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

Element Name	Required	Data Type	Description
addressType	Yes	String (2)	This contains the address type. Valid values (e. g. 01 - Business, 02 - Postal, etc. ) are on the add_type table. If any address types have been flagged as mandatory and are not included when the supplier is being created, then if an ordering address has been included, the missing mandatory addresses will be defaulted to that address. If not, then the remittance address will be used. If neither an order nor remittance address is included, then the first address sent is used.
primaryAddressInd	No	String (1)	This column indicates whether the address is the primary address for the address type.
add1	Yes	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	Yes	String (120)	This column contains the name of the city that is associated with the address.
state	No	String (3)	This column contains the state abbreviation for the address.
country	Yes	String (3)	This column contains the country where the address exists.
post	No	String (30)	This column contains the zip code for the address.
contactName	No	String (120)	This column contains the name of the contact for the supplier at this address.
contactPhone	No	String (20)	This column contains the phone number of the contact person at this address.
contactFax	No	String (20)	This column contains the fax number of the contact person at this address.
contactEmail	No	String (100)	This column contains the email address of the partner or suppliers representative contact.
jurisdictionCode	No	String (10)	ID associated to the tax jurisdiction of the country-state relationship.
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes.

Sample Input Message

{
  "items": [
    {
      "supplierReferenceNo": "1",
      "supplier": 3026,
      "attributes": {
        "supplierName": "Prime Hardware",
        "supplierNameSecondary": "Prime Hardware 2",
        "contactName": "Alexandre Roma",
        "contactPhone": "234-112-7654",
        "contactFax": "234-112-7654",
        "contactPager": null,
        "supplierStatus": "A",
        "qualityControlInd": "Y",
        "qualityControlPercentage": 3,
        "qualityControlFrequency": "5",
        "vendorCheckingInd": "Y",
        "vendorCheckingPercentage": 3,
        "vendorCheckingFrequency": 2,
        "currencyCode": "USD",
        "language": 1,
        "terms": "108",
        "freightTerms": "03",
        "returnAllowedInd": "Y",
        "returnAuthReqInd": "N",
        "minReturnValue": 3.55,
        "returnCourier": "125",
        "handlingPercentage": 3,
        "ediOrderInd": "Y",
        "ediOrderChangeInd": "Y",
        "ediOrderConfirmInd": "Y",
        "ediAsnInd": "Y",
        "ediSalesReportFreq": "W",
        "ediSupplierAvailabilityInd": "Y",
        "ediContractInd": "Y",
        "ediInvcInd": "Y",
        "ediChannel": 2,
        "costChangeVariancePercentage": 9.65,
        "costChangeVarianceAmt": 9.65,
        "replenApprovalInd": "Y",
        "shipMethod": "30",
        "paymentMethod": "OA",
        "contactTelex": "234-112-7654",
        "contactEmail": "[e-mail]",
        "settlementCode": "N",
        "preMarkInd": "Y",
        "autoApproveInvoiceInd": "Y",
        "debitMemoCode": "N",
        "freightChargeInd": "Y",
        "autoApproveDebitMemoInd": "Y",
        "prepayInvoiceInd": "Y",
        "backorderInd": "Y",
        "vatRegion": 1000,
        "invManagementLevel": "S",
        "servicePerfReqInd": "Y",
        "invoicePayLocation": "S",
        "invoiceReceiveLocation": "C",
        "invoiceGrossNet": "G",
        "deliveryPolicy": "NEXT",
        "comments": null,
        "defaultItemLeadTime": 7,
        "dunsNumber": "108890",
        "dunsLocation": "1055",
        "bracketCostingInd": "Y",
        "vmiOrderStatus": null,
        "dsdSupplierInd": "Y",
        "scaleAipOrders": "N",
        "supplierQuantityLevel": "EA",
        "customFlexAttribute": [
          {
            "name": "REVIEW_DATE",
            "value": null,
            "valueDate": "2001-12-31"
          }
        ],
        "dealUploadStatus": "W",
        "taxId": null,
        "procurementSiteInd": "Y",
        "paymentSiteInd": "Y"
      },
      "supplierSites": [
        {
          "supplierSiteReferenceNo": "2",
          "supplierSite": 3026001,
          "attributes": {
            "supplierName": "Prime Hardware",
            "supplierNameSecondary": "Prime Hardware 2",
            "contactName": "Alexandre Roma",
            "contactPhone": "234-112-7654",
            "contactFax": "234-112-7654",
            "contactPager": null,
            "supplierStatus": "A",
            "qualityControlInd": "Y",
            "qualityControlPercentage": 3,
            "qualityControlFrequency": "5",
            "vendorCheckingInd": "Y",
            "vendorCheckingPercentage": 3,
            "vendorCheckingFrequency": 2,
            "currencyCode": "USD",
            "language": 1,
            "terms": "108",
            "freightTerms": "03",
            "returnAllowedInd": "Y",
            "returnAuthReqInd": "N",
            "minReturnValue": 3.55,
            "returnCourier": "125",
            "handlingPercentage": 3,
            "ediOrderInd": "Y",
            "ediOrderChangeInd": "Y",
            "ediOrderConfirmInd": "Y",
            "ediAsnInd": "Y",
            "ediSalesReportFreq": "W",
            "ediSupplierAvailabilityInd": "Y",
            "ediContractInd": "Y",
            "ediInvcInd": "Y",
            "ediChannel": 2,
            "costChangeVariancePercentage": 9.65,
            "costChangeVarianceAmt": 9.65,
            "replenApprovalInd": "Y",
            "shipMethod": "30",
            "paymentMethod": "OA",
            "contactTelex": "234-112-7654",
            "contactEmail": "[e-mail]",
            "settlementCode": "N",
            "preMarkInd": "Y",
            "autoApproveInvoiceInd": "Y",
            "debitMemoCode": "N",
            "freightChargeInd": "Y",
            "autoApproveDebitMemoInd": "Y",
            "prepayInvoiceInd": "Y",
            "backorderInd": "Y",
            "vatRegion": 1000,
            "invManagementLevel": "S",
            "servicePerfReqInd": "Y",
            "invoicePayLocation": "S",
            "invoiceReceiveLocation": "C",
            "invoiceGrossNet": "G",
            "deliveryPolicy": "NEXT",
            "comments": null,
            "defaultItemLeadTime": 7,
            "dunsNumber": "108890",
            "dunsLocation": "1055",
            "bracketCostingInd": "Y",
            "vmiOrderStatus": null,
            "dsdSupplierInd": "Y",
            "scaleAipOrders": "N",
            "supplierQuantityLevel": "EA",
            "customFlexAttribute": [
              {
                "name": "REVIEW_DATE",
                "value": null,
                "valueDate": "2001-12-31"
              }
            ],
            "dealUploadStatus": "W",
            "taxId": null,
            "procurementSiteInd": "Y",
            "paymentSiteInd": "Y"
          },
          "orgUnit": [
            {
              "orgUnitId": 1111111111,
              "primaryPaySite": "Y"
            }
          ],
          "address": [
            {
              "addressReferenceKey": "2",
              "addressKey": 114772,
              "address": {
                "addressType": "01",
                "primaryAddressInd": "Y",
                "add1": "200 Ryan Way",
                "add2": "Suite 100",
                "add3": null,
                "city": "Somerville",
                "state": "MA",
                "country": "US",
                "post": "55555-1234",
                "contactName": "Laura Johnson",
                "contactPhone": "617-897-0900",
                "contactFax": "617-897-0902",
                "contactEmail": "[e-mail]",
                "jurisdictionCode": null,
                "customFlexAttribute": [
                  {
                    "name": "REVIEW_DATE",
                    "value": null,
                    "valueDate": "2001-12-31"
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Table 5-269 CreateResponse - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	References a collection of suppliers created.

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

Element Name	Required	Data Type	Description
supplierReferenceNo	Yes	String (32)	This field holds the ID for the supplier used in the external financial system. It is populated by the integration that brings suppliers from external financial systems into RMS. This ID and the supplier site ID can be used to join to information about the supplier in the external system.
supplier	Yes	Number (10)	This contains the supplier ID created in the system.
supplierSites	No	Collection of Object	References a collection of supplier sites created.

Table 5-271 CreateResponse.Items.SupplierSites - Object. See list of elements for detail

Element Name	Required	Data Type	Description
supplierSiteReferenceNo	Yes	String (32)	This field holds the ID for the supplier site used in the external financial system. It is populated by the integration that brings suppliers from external financial systems into RMS. This ID and the supplier site ID can be used to join to information about the supplier in the external system.
supplierSite	Yes	Number (10)	Unique identifying number for a supplier within the system.
address	Yes	Collection of Object	References a collection of supplier addresses created.

Table 5-272 CreateResponse.Items.SupplierSites.Address - Object. See list of elements for detail

Element Name	Required	Data Type	Description
addressReferenceKey	Yes	String (32)	This column contains the external reference ID used to distinguish between different addresses.
addressKey	Yes	Number (11)	This column contains a unique number used to distinguish between different addresses.

Sample Response Message

{
  "items": [
    {
      "supplierReferenceNo": "1",
      "supplier": 2400,
      "supplierSites": [
        {
          "supplierSiteReferenceNo": "2",
          "supplierSite": 3026001,
          "address": [
            {
              "addressReferenceKey": null,
              "addressKey": 33445
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 400 (Error)

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

Sample Error Message

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

Create Transfers

Functional Area

Inventory - Transfers and Allocations

Business Overview

This service is used to by external systems to create one or more transfers at a time in Merchandising. Within Oracle Retail solutions, this is also leveraged by Advanced Inventory Planning (AIP) to create standalone transfers generated out of its replenishment processing.

When a new transfer is created, this service will first validate that all required fields are present in the message. Certain fields are required regardless of transfer type and system configuration, while others are dependent on other Merchandising configurations. Additionally, when creating a new transfer at least one detail line must also be included in the message. After that, business level validation on the input information will be performed.

Location Validation

The from and to locations passed into the message must be valid stores or warehouses in Merchandising; but they cannot be the same. If both locations are stores, then they must both exist in the same transfer zone. Additionally, if the to location is a store, then it must be open. This is determined based on whether there is a close date defined for the store and the stop order days.

If either location is a warehouse, then it can be either a physical warehouse or a virtual warehouse, depending on transfer type. A physical warehouse is only allowed as the from location type for an EG type of transfer. Additionally, only Book type transfers are allowed between two warehouses in the same physical warehouse.

If either the from or to location is a franchise store, then the other location cannot be a finisher. If the franchise store is a non-stockholding location, then the other location on the transfer must be a warehouse.

Validation is also done at the item level based on the locations on the transfer. Each item on the transfer must be in active, inactive, or discontinued status at the from location. It also must have been ranged to the from location in Merchandising, when that location is a warehouse. However, if the from location is a store, there is an exception where the transfer can still be created even though it is not yet ranged, which also bypasses inventory validation. This is to support a specific function in Oracle Retail Store Inventory Management (SIM). If the item is not already ranged to the to location, then ranging will occur when the transfer is created, regardless of status. The ranging that occurs will flag the item/location as unintentionally ranged for all transfer types except service. If the to location is an external finisher, see the section below on transfers with finishing.

Inventory Validation

Another part of the validation that is applicable for all transfers created is that inventory is available for transfer if the status passed through the integration is approve (A), with a few exceptions. First, EG type transfers do not have inventory validated as it is assumed that this type of transfer is generated in the store or warehouse and the inventory availability check has been done in that solution as part of the shipping of the inventory. Additionally, if the system option titled Validate External Warehouse Availability is set to No (unchecked), then warehouse inventory will not be validated for any transfers initiated in this service regardless of type. Store inventory availability is never validated by this service because of support for the process where the item does not need to be ranged to the shipping store.

Status Validation

Transfers can be created in a status of Input (I) or Approved (A) using this service. Transfers in input status are not subject to inventory validation, but all other validations are applicable. Book type transfers can only be created in Input status using this service, as there isn't really a concept of an 'approved' book transfer. As soon as it is approved it is executed. Additionally, transfers of type Reallocation (RAC) and Return to Vendor (RV) can also only be created in Input status. Conversely, transfers of type AIP, SIM, and EG must always be created in Approved status. If any validation fails when processing the new transfer that results in it not being able to be approved, the transfer will be created but will remain in input status. The exception to this is for transfers of type AIP, SIM, and EG, as they must always be created in approved status. If they are not able to be approved, the transfer is not created or updated.

Transfer Type Specific Validation

Most of the validation defined above is relevant regardless of transfer type, except where noted. However, there are also some other validations done as part of this service processing that are specific to a type of transfer.

Administrative (AD)

See Manual Requisition (MR)

Service Type

This type of transfer is expected only to be sent from AIP as an output of the replenishment process. As such, Merchandising assumes certain validations have been done by AIP in advance of receiving the transfer and slightly different validation is enforced. The following special validations apply for this transfer type using this service:

• Must be created in Approved status

• Can only be to stockholding locations

• Supports transferring packs from stores

• Allows the department number to be passed even when the system option is N

• Item/location ranging to the to location will result in the Ranged flag being set to Yes as it is assumed this an intentional ranging.

• Can be an intercompany transfer

Book (BT)

Book transfers processed through this service can be created for two virtual warehouses in the same physical warehouse only. This is usually used for inventory rebalancing between virtual locations. The following special validations apply for this transfer type using this service:

• Can only be created in Input status

• Can only be created for virtual warehouses in the same physical warehouse

• Warehouses must be in the same legal entity

Confirmation (CF)

See Manual Requisition (MR)

Externally Generated (EG)

Externally Generated transfers are assumed to be created in the store or warehouse. Further, it is assumed that once they get to Merchandising, the transfer is already in process at that location. As such, there are certain validations that are managed differently for this transfer type in this service:

• Must be created in Approved status

• Supports transferring packs from stores

• Allows the department number to be passed even when the system option is N

• Can be an intercompany transfer

• Uses the physical warehouse number, not a virtual warehouse number, if warehouses are involved

Intercompany (IC)

An intercompany transfer is a type of business to business transaction that sells product from one legal entity and purchases it into another. Legal entities in Merchandising are determined based on the setting of the Intercompany Basis system option, which indicates whether the transfer entity or the set of books of a location should be used. This transfer type is used when either it is explicitly passed into the service or if the transfer type is NULL in the inbound message and the locations are in different legal entities. Other transfer types may also be intercompany, as well, but the below rules apply for those flagged as intercompany type explicitly:

• The legal entity of the from and to locations must be different.

• If an adjustment type or value is passed into the message, that will be used to calculate the 'selling' price between entities. Otherwise, the from location's weighted average cost is used

Manual Requisition (MR)

This is the most basic type of transfer in Merchandising, so it is used as a default transfer type when either it is explicitly passed into the service or if the transfer type is NULL in the inbound message and the locations are in the same legal entity. The behavior for this transfer type is the same as that for AD and CF types of transfers, those could be used as different reasons for a transfer. For this transfer type the following validation rules are enforced:

• Locations must be in the same legal entity

Reallocation (RAC)

A reallocation transfer is assumed to be used to pull back inventory from stores or warehouses to a single warehouse for re-allocation to other stores or other warehouses. This is the type of transfer that is created when a mass-return transfer is created, for example. Because it has unique rules tied to it related to MRTs, some additional validations are followed:

• Can only be created in Input status in this service

• Locations must be in the same legal entity

Return to Vendor (RV)

A return to vendor type of transfer is similar to a reallocation type, in that it is assumed to be pulling inventory back to a warehouse from stores or other warehouses, but in this case, for the purpose of returning the merchandise to the supplier. This is the type of transfer that is created when a mass-return transfer is created, for example. Because it has some unique rules tied to it related to MRTs, some additional validations are followed:

• Can only be created in Input status in this service

• Locations must be in the same legal entity

SIM Generated (SIM)

SIM generated transfers are created only by the store orders process in SIM. This functionality is not available in SIOCS. Because of this, they have special rules applied, including the ability to create the transfer even though no item/store relationship exists for the originating location in Merchandising. The rules that apply for this type of transfer include:

• Must be created in Approved status

• Supports transferring packs from stores

• Allows the department number to be passed even when the Merchandising system option is No

• Can be an intercompany transfer

All Transfer Types

For all of the above transfer types, if all validation described above passes, then the transfer will be created. If the transfer is created in Approved status, then in addition to the transfer itself, other details may also be created based on the items and locations involved.

• Inventory will be updated to reflect the reserved quantity at the from location and expected quantity at the to location.

• Upcharges will be applied, if configured, for transfers that do not include a physical warehouse location. For transfers with a physical warehouse, the records for upcharges are added when the transfer is shipped.

• An associated franchise order or return will be created if the transfer involves a franchise location.

Transfers with Finishing

Transfers with finishing are sometimes referred to as a two-legged transfer, as they generate two transfers in Merchandising. One from the originating store or warehouse to the finisher and one from the finisher back to a store or warehouse. This service supports the creation of a transfer with finishing only through an external finisher, a type of partner, and back to the originating location. Transfers to an internal finisher are not supported via this integration. To do this, when sending the transfer details in the message, you will indicate the external finisher as the to location. Then when the transfer is created, it will automatically generate the second leg.

When creating transfers in this way, it does not generate any work order activities to send to the finisher with the transfer. These will either need to be added manually in the Merchandising screens, or sent separately to the finisher.

Flex Attributes

If you have defined any custom flex attributes (CFAS) for transfers, then they can be integrated as part of this service. The node of the integration that supports this will accept the name of the attribute as it is defined in the group set level view and the value for the attribute. Flex attributes can only be added or updated to a transfer, they cannot be deleted. Additionally, for transfers with finishing, flex attributes can only be added to the first leg of the transfer.

Service Type

POST

ReST URL

MerchIntegrations/services/inventory/transfers/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	References a collection of transfers.

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

Element Name	Required	Data Type	Description
transferNo	Yes	Number (12)	Number that uniquely identifies the transfer.
fromLocationType	Yes	String (1)	The location type of the from location. Valid values are 'S' and 'W'.
fromLocation	Yes	Number (10)	The location number of the from location.
toLocationType	Yes	String (1)	The location type of the to location. Valid values are 'S', 'W' and 'E'
toLocation	Yes	Number (10)	The location number of the to location.
deliveryDate	No	date	The earliest date the transfer can be delivered. When Inventory Planning is part of your implementation, this is required for all transfer types, except RAC, EG, and Store Inventory Operations transfers. If included in the message, this must be today or a future date.
department	No	Number (4)	The department number associated with the transfer. A system option determines whether or not the department is required for transfers. If the system option is set to require a department, then this must be included in the message. If the system option is set to not require the department, then the department must be null in this message unless the transfer type is SIM (Store Inventory Operations), AIP (Inventory Planning), or EG (Externally Generated).
routingCode	No	String (1)	If the freight code is Expedite (E), then this must have a value. Otherwise, it must be null. The descriptions for these three options are held in the Codes table under code TRRC and can be configured as needed for your business. Examples are Federal Express (1), UPS (2) and mail (3).
transferType	No	String (6)	The department number associated with the transfer. A system option determines whether or not the department is required for transfers. If the system option is set to require a department, then this must be included in the message. If the system option is set to not require the department, then the department must be null in this message unless the transfer type is SIM (Store Inventory Operations), AIP (Inventory Planning), or EG (Externally Generated).
details	No	Collection of Object	References a collection of transfer details.
status	No	String (1)	A code indicating the status of the transfer. Valid values are 'I' and 'A'.
createdBy	No	String (30)	The userid of the user who created the transfer.
comments	No	String (2000)	Comments associated with the transfer.
contextType	No	String (6)	This field holds the reason code related to which a transfer is made. Valid values are found in the code type CNTX. Examples are Promotion (PROM), Customer Transfer (WED), Store Requisition (STORE) and Repairing (REPAIR). Two-legged transfer can not be created for context types Promotion, Customer Transfer and Store Requisition. For the context type Repairing only external finisher can be selected. Note: context type Repairing (REPAIR) has specific logic tied to it and must be associated with a return to warehouse or a transfer using an external finisher.
contextValue	No	String (25)	This field holds the value relating to the context type like Promotion number.
customFlexAttribute	No	Collection of Object	References a collection of customer flexible attributes. Child node.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the item being transferred.
transferQuantity	Yes	Number (12,4)	The total quantity of the item reserved for this transfer at the from location.
supplierPackSize	No	Number (12,4)	The supplier pack size for this item/transfer.
invStatus	No	Number (2)	A code indicating the inventory status for this transfer detail. Valid values are found on the inv_status_types table.
adjustmentType	No	String (6)	This field, along with the adjustment value, is used to calculate the transfer price for intercompany transfers. It will be ignored for all other transfers. If the adjustment value is provided, then the type must also be specified. Valid values are: 'IA', 'IP', 'DA', 'DP', 'S'. IA and IP can only be used if you have your system options set to allow the transfer price to exceed weighted average cost.
adjustmentValue	No	Number (20,4)	If the adjustment type is provided, then the value must also be specified. This must always be a positive amount.

Table 5-276 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.

Sample Input Message

{
  "items": [
    {
      "transferNo": 12300056,
      "fromLocationType": "S",
      "fromLocation": 1521,
      "toLocationType": "S",
      "toLocation": 1511,
      "deliveryDate": "2001-12-31",
      "department": null,
      "routingCode": null,
      "transferType": "AD",
      "details": [
        {
          "item": "104100022",
          "transferQuantity": 3,
          "supplierPackSize": 3,
          "invStatus": 1,
          "adjustmentType": "IA",
          "adjustmentValue": 3.6
        }
      ],
      "status": "I",
      "createdBy": "RMS01APP",
      "comments": "transfer to loc 1511",
      "contextType": "PROM",
      "contextValue": "2255",
      "customFlexAttribute": [
        {
          "name": "REVIEW_DATE",
          "value": null,
          "valueDate": "2001-12-31"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Create Transfer Details

Functional Area

Inventory - Transfers and Allocations

Business Overview

This service is used to create additional line items for one or more existing transfers at a time in Merchandising. For more information about transfer, see the Create Transfer service.

Service Type

POST

ReST URL

MerchIntegrations/services/inventory/transfer/details/create

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

Element Name	Required	Data Type	Description
items	Yes	Collection of Object	References a collection of transfers.

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

Element Name	Required	Data Type	Description
transferNo	Yes	Number (12)	Number that uniquely identifies the transfer.
fromLocationType	Yes	String (1)	The location type of the from location. Valid values are 'S' and 'W'.
fromLocation	Yes	String (10)	The location number of the from location.
toLocationType	Yes	String (1)	The location type of the to location. Valid values are 'S', 'W' and 'E'
toLocation	Yes	String (10)	The location number of the to location.
details	No	Collection of Object	References collection of transfer details

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier of the item being transferred.
transferQuantity	Yes	Number (12,4)	The total quantity of the item reserved for this transfer at the from location.
supplierPackSize	No	Number (12,4)	The supplier pack size for this item/transfer.
invStatus	No	Number (2)	A code indicating the inventory status for this transfer detail. Valid values are found on the inv_status_types table.
adjustmentType	No	String (6)	This field, along with the adjustment value, is used to calculate the transfer price for intercompany transfers. It will be ignored for all other transfers. If the adjustment value is provided, then the type must also be specified. Valid values are: 'IA', 'IP', 'DA', 'DP', 'S'. IA and IP can only be used if you have your system options set to allow the transfer price to exceed weighted average cost.
adjustmentValue	No	Number (20,4)	If the adjustment type is provided, then the value must also be specified. This must always be a positive amount.

Sample Input Message

{
  "items": [
    {
      "transferNo": 12300056,
      "fromLocationType": "S",
      "fromLocation": "1521",
      "toLocationType": "S",
      "toLocation": "1511",
      "details": [
        {
          "item": "100100076",
          "transferQuantity": 3,
          "supplierPackSize": 3,
          "invStatus": 1,
          "adjustmentType": "IA",
          "adjustmentValue": 3.55
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Create 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-280 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.

Table 5-281 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,
  "storeType": "C",
  "walkThrough": [
    {
      "walkThroughStore": 187308
    }
  ]
}

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

Currency Rates Service

This section describes the Currency Rate service.

Business Overview

This service is used to retrieve all currencies and currency conversion rates. The conversion rate is the value used to convert to the primary currency.

Service Type

Get

ReST URL

CurrencyRates/currencyRates

Input Parameters

NA

Output

RestCurrencyRatesRecRDO

Parameter Name	Data Type
exchangeRate	BigDecimal
effectiveDate	Timestamp
currencyCode	String
exchangeType	String

JSON Structure:
 
 [
    {
        "exchangeRate": null,
        "effectiveDate": null,
        "currencyCode": null,
        "exchangeType": null,
        "links": [],
        "hyperMediaContent": {
            "linkRDO": []
        }
    }
 ]

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
CURRENCY_RATES	Yes	No	No	No
JOB_AUDIT_LOGS	No	Yes	No	No
JOB_AUDIT_PAYLOAD	No	Yes	No	No

Data Privacy Access Service

This section describes the Data Privacy Access service for Merchandising.

Business Overview

This query service provides access to data stored in Merchandising that contain personally identifiable information.

Service Type

GET

ReSTURL

https://<host:port>/RetailAppsDataPrivServicesRESTApp/rest/privatedata/getPersonalInfo?customer_id={entityName}::{entityType}::{entityId}::{fullName}:: {phone}::{email}

Accept

• application/json

• application/xml

Query Parameters

• customer_id (required): The customer ID string containing the parameters to be used in looking up data. The format of this string is as follows:

  • entity name}::{entity type}::{entity id}::{full name}::{phone}::{email}

Path Parameters

Parameter	Description
Entity Name	The query group type for which data is to be retrieved. The available group types for Merchandising are: BUYER (Buyer) MERCHANT (Merchant) STORE (Store) WAREHOUSE (Warehouse) SUPPLIER (Supplier) PARTNER (Partner) OUTLOC (Outside Location) ORDER CUSTOMER (Merchandising Customer)
Entity Type	Used if the entity name is PARTNER or OUTLOC. The value here should indicate the type of partner or outside location being queried. Valid values for this input can be found on the Codes table for each type: Partner Types = PTNR Outside Location Types = LOCT
Entity ID	The ID of the entity being queried. For example, the supplier ID.
Full Name	The full name to be searched for the selected entity.
Phone	The phone number to be searched for the selected entity.
Email	The email to be searched for the selected entity.

Default Response

The response will return all instances of the data being searched that occur in the requested entity. For example, if the entity requested was BUYER, all instances where the buyer, name, and phone match the data sent will be returned. If any of these parameters are not sent (e.g. buyer), then it will not be used as part of the search. The following data is included in the response:

Parameter	Description
Entity Name	Valid values are: BUYER (Buyer) MERCHANT (Merchant) STORE (Store) WAREHOUSE (Warehouse) SUPPLIER (Supplier) PARTNER (Partner) OUTLOC (Outside Location) ORDER CUSTOMER (Merchandising Customer)
Entity Type	If the entity name is PARTNER or OUTLOC, the value here indicates the type of partner or outside location being queried. Valid values for this input can be found on the Codes table for each type: Partner Types = PTNR Outside Location Types = LOCT For other entity types, this will be null.
Entity ID	The ID of the entity where the data was found.
Full Name	The name associated with the entity.
Phone	The phone number associated with the entity.
Fax	The fax number associated with the entity.
Telex	The telex number associated with the entity.
Pager	The pager number associated with the entity.
Email	The email address associated with the entity.

Sample Response

{
    "Personal Information": {
        "list": [],
            "Get Personal Information": {
                "list": [            
                   [
                        {
                            "ENTITY_NAME": "BUYER",
                            "ENTITY_TYPE": "null",
                            "ENTITY_ID": "1002",
                            "FULL_NAME": "Matt Wilsman",
                            "PHONE": "6125251034",
                            "FAX": "6125259800",
                            "TELEX": "null",
                            "PAGER": "null",
                            "EMAIL": "null"
                        }
                    ]
                ]
            }
        }
    }
}

Response Codes and Error Messages

• 200 - Success

• 400 - Bad Request - for the following situations:

  • Customer ID does not match the required format

  • Invalid input type

  • Missing customer ID

  • Invalid jsonFormat

• 500 - Internal Server Errors - for all other types of errors (for example, configuration errors, SQL errors, and so on)

Success Payloads

• When Accept=application/json, this API will return data in JSON format

• When Accept=application/xml, this API will return data formatted as an HTML page

Data Privacy Forget Service

This section describes the Data Privacy Forget service for Merchandising.

Business Overview

This service supports updating personal information stored in Merchandising. When the service is invoked with mask strings as inputs, it overwrites the fields with mask strings, which effectively removes the personal information from the system.

Service Type

DELETE

ReSTURL

https://<host:port>/RetailAppsDataPrivServicesRESTApp/rest/privatedata/updatePersonalInfo?customer_id={entityName}::{entityType}::{entityId}::{fullName}:: {phone}::{fax}::{telex}::{pager}::{email}::{addr1}::{addr2}::{addr3}::{county}::{city}::{state}::{countryId}::{postalCode}

Accept

• application/json

• application/xml

Query Parameters

• customer_id (required): The customer ID string containing the parameters to be used in updating data. The format of this string is as follows:

  • {entityName}::{entityType}::{entityId}::{fullName}::{phone}::{fax}::{telex}::{pager}::{email}::{addr1}::{addr2}::{addr3}::{county}::{city}::{state}::{countryId}::{postalCode}

Path Parameters

Parameter	Description
Entity Name (required)	The group type for which data is to be updated. The available group types for Merchandising are: BUYER (Buyer) MERCHANT (Merchant) STORE (Store) WAREHOUSE (Warehouse) SUPPLIER (Supplier) PARTNER (Partner) OUTLOC (Outside Location) ORDER CUSTOMER (Merchandising Customer)
Entity Type	Required if the entity name is PARTNER or OUTLOC. The value here should indicate the type of partner or outside location. Valid values for this input can be found on the Codes table for each type: Partner Types = PTNR Outside Location Types = LOCT
Entity ID (required)	The ID of the entity to be updated. For example, the supplier ID.
Full Name	The value to update the full name with. If the value is null and this is a required field in the entity, 'XXXXX' will be used.
Phone	The value to update the phone number with. If the value is null and this is a required field in the entity, 'XXXXX' will be used.
Fax	The value to update the fax number with.
Telex	The value to update the telex number with.
Pager	The value to update the pager number with.
Email	The value to update the email address with.
Addr1	The value to update the address 1 with.
Addr2	The value to update the address 2 with.
Addr3	The value to update the address 3 with.
County	The value to update the county with.
City	The value to update the city with.
State	The value to update the state with.
Country	The value to update the country with.
Postal Code	The value to update the postal code with.

Default Response

This service only returns a response code to signify if the request is successful or not. If no record is updated, the service returns an error.

Response Codes and Error Messages

• 200 - Success

• 400 - Bad Request - for the following situations:

  • Customer ID does not match the required format

  • Invalid input type

  • Missing customer ID

  • Invalid jsonFormat

• 500 - Internal Server Errors - for all other types of errors (e.g. config errors, sql errors, etc).

Success Payloads

N/A

Delete Allocation Details

Functional Area

Inventory - Transfers and Allocations

Business Overview

This service can be used to remove detail level data from one or more allocations within Merchandising from an external system. On successful validation of the information present in the message, the detail level records are deleted from the database.

Service Type

DELETE

ReST URL

MerchIntegrations/services/inventory/allocation/details/delete

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

Element Name	Required	Data Type	Description
items	No	Collection of Object	References a collection of allocations.

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

Element Name	Required	Data Type	Description
allocationNo	Yes	Number (10)	Contains the unique identifier of the allocation. This should fall within the range of Merchandising IDs already designated for allocations.
details	No	Collection of Object	References a collection of allocation details

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

Element Name	Required	Data Type	Description
toLocation	Yes	Number (10)	Contains the destination location of the allocation. This must be an active stockholding store or virtual warehouse.
toLocationType	Yes	String (1)	Contains the type of the destination location. Valid values are S (store) and W (warehouse).

Sample Input Message

{
  "items": [
    {
      "allocationNo": 102881222,
      "details": [
        {
          "toLocation": 1311,
          "toLocationType": "S"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Appointment

Functional Area

Inventory - Appointments

Business Overview

This service can be used to delete existing appointments in Merchandising. In addition, Merchandising attempts to close the document that is related to the appointment, when applicable. For more details on Appointments, see the Create Appointment service description.

Service Type

DELETE

ReST URL

MerchIntegrations/services/inventory/appointments/delete

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
appointmentNo	Yes	Number (9)	This field contains the unique number generated by warehouse while creating an appointment.
location	Yes	Number (10)	This field contains the location where the merchandise has been sent.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "appointmentNo": 200911,
      "location": 2
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Appointment Details

Functional Area

Inventory - Appointments

Business Overview

This service is used to delete appointment details from Merchandising. To know more about appointment details, see the Manage Appointment Details service description.

Service Type

DELETE

ReST URL

MerchIntegrations/services/inventory/appointment/details/delete

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
appointmentNo	Yes	Number (9)	This field contains the unique number generated by warehouse while creating an appointment.
location	Yes	Number (10)	This field contains the location where the merchandise has been sent.
details	No	Collection of Object	References a collection of appointment details.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	This field contains the items shipped to the location.
documentNo	Yes	Number (12)	This field contains the purchase order, transfer or allocation corresponding to the shipped merchandise.
asnNo	No	String (30)	This field contains the advance shipping notice number associated with the appointment. It is populated only when the appointment is based on an ASN.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "appointmentNo": 200911,
      "location": 2,
      "details": [
        {
          "item": "101200001",
          "documentNo": 100000135000,
          "asnNo": null
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Class

Functional Area

Merchandise Hierarchy

Business Overview

This service may be used to delete the class element of the merchandise hierarchy based on an external system if Merchandising is not the system of record for merchandise hierarchy information. When a class is deleted, this service will add the class to a purging staging table for processing in the Daily Purge of Foundation Data process.

Note: Associated custom flex attributes are deleted when the class is deleted.

For more details on Class, see the Create Class service description.

Service Type

DELETE

ReST URL

MerchIntegrations/services/merchandiseHierarchy/class/delete

Input Payload Details

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

Element Name	Required	Data Type	Description
class	Yes	Number (4)	The unique number of the class.
dept	Yes	Number (4)	The ID of the department which which contains the class.

Sample Input Message

{
  "class": 1,
  "dept": 3041
}

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 Department

Functional Area

Merchandise Hierarchy

Business Overview

This service may be used to delete the department element of the merchandise hierarchy based on an external system if Merchandising is not the system of record for merchandise hierarchy information. When a department is deleted, this service will add the department to a purge staging table for processing in the Daily Purge of Foundation Data process. 

Note: Associated custom flex attributes are also deleted when the department is deleted.

For more details on Departments, see the Create Department service description.

Service Type

DELETE

ReST URL

MerchIntegrations/services/merchandiseHierarchy/department/delete

Input Payload Details

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

Element Name	Required	Data Type	Description
dept	Yes	Number (4)	The number which uniquely identifies the department.

Sample Input Message

{
  "dept": 3041
}

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 Department Up Charge

Functional Area

Merchandise Hierarchy

Business Overview

This service is used to delete up charges linked with a department. When a request containing an up charge is received, the set of required fields is validated. If the up charge record exists for the department, then this gets deleted. If no up charge component is provided, the system will delete all the up charge components along with the from location / to location combination. Deleting up charges from a department does not automatically remove them from the items or transfers and allocations for items in the department.

Service Type

DELETE

ReST URL

MerchIntegrations/services/merchandiseHierarchy/department/upCharge/delete

Input Payload Details

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

Element Name	Required	Data Type	Description
dept	Yes	Number (4)	The number which uniquely identifies the department.
upcharge	No	Collection of Object	References a collection of department upcharge information.

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

Element Name	Required	Data Type	Description
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 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 destination location to which goods will be transferred. Valid values 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 department upcharge detail information.

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

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

Sample Input Message

{
  "dept": 3041,
  "upcharge": [
    {
      "fromLocation": "1121",
      "toLocation": "1311",
      "fromLocationType": "S",
      "toLocationType": "S",
      "details": [
        {
          "component": "UC1"
        }
      ]
    }
  ]
}

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 Differentiator Group Details

Functional Area

Items - Differentiators

Business Overview

This service is used to delete existing Differentiator Groups details from Merchandising. For successful deletion, validation is performed to ensure that the Diff ID is associated with the Differentiator Group.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/differentiator/group/details/delete

Input Payload Details

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

Element Name	Required	Data Type	Description
items	No	Collection of Object	It's a referenced element. For detailed description, please refer referenced element doc.

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

Element Name	Required	Data Type	Description
diffGroupId	Yes	String (10)	A unique differentiator group identifier.
details	No	Collection of Object	Description is not available.

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

Element Name	Required	Data Type	Description
diffId	Yes	String (10)	The identifier of the differentiator contained within the differentiator group. This id must be unique within the diff group. Value must be predefined in the DIFF_IDS table.

Sample Input Message

{
  "items": [
    {
      "diffGroupId": "Y21 Colors",
      "details": [
        {
          "diffId": "BLACK"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Differentiator Groups

Functional Area

Items - Differentiators

Business Overview

This service is used to delete existing Differentiator Groups from Merchandising. For successful deletion, this API will validate that the Differentiator Group is valid and that it is not associated with any items or diff ranges.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/differentiator/groups/delete

Input Payload Details

Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	References a collection of differentiator groups.

Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffGroupId	Yes	String (10)	A unique differentiator group identifier.

Sample Input Message

{
  "items": [
    {
      "diffGroupId": "Y21 Colors"
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Differentiators

Functional Area

Items - Differentiators

Business Overview

This service is used to delete existing Differentiator from Merchandising. For a successful deletion, this service first validates that all required fields are present in the message and if Diff id to be deleted exists in Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/differentiators/delete

Input Payload Details

Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
items	No	Collection of Object	References a collection of differentiators.

Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
diffId	Yes	String (10)	The unique identifier for the differentiator.

Sample Input Message

{
  "items": [
    {
      "diffId": "XYZ02"
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Division

Functional Area

Merchandise Hierarchy

Business Overview

This service may be used to delete the division element of the merchandise hierarchy based on an external system if Merchandising is not the system of record for merchandise hierarchy information. When a division is deleted, this service will first validate that all required fields are present in the message. Business level validation on the input information will be performed to:

• Verify the division already exists.

• Verify the division is not associated to a differentiator group.

• Verify the division is not associated to a season ID.

• Verify the division is not associated to a ticket type.

• Verify the division is not associated to a UDA.

If the information passes the above validations, the division will be deleted in Merchandising. Deletion of a division will get processed immediately upon receipt of the request, assuming that there are no dependent levels below it.

Service Type

DELETE

ReST URL

MerchIntegrations/services/merchandiseHierarchy/division/delete

Input Payload Details

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

Element Name	Required	Data Type	Description
division	Yes	Number (4)	The unique identifier of the division.

Sample Input Message

{
  "division": 1000
}

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 Group

Functional Area

Merchandise Hierarchy

Business Overview

This service may be used to delete the group element of the merchandise hierarchy based on an external system if Merchandising is not the system of record for merchandise hierarchy information. When a group is deleted, this service will first validate that all required fields are present in the request payload. Business level validation on the input information will be performed to:

• Verify the group already exists.

• Verify the group is not associated to a differentiator group.

• Verify the group is not associated to a season ID

• Verify the group is not associated to a ticket type.

• Verify the group is not associated to a UDA.

If the information passes the above validations, the group will be deleted from Merchandising. Deletion of a group will get processed immediately upon receipt of the request, assuming that there are no dependent levels below it.

Service Type

DELETE

ReST URL

MerchIntegrations/services/merchandiseHierarchy/group/delete

Input Payload Details

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

Element Name	Required	Data Type	Description
groupNo	Yes	Number (4)	Description is not available.

Sample Input Message

{
  "groupNo": 1000
}

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 Inbound ASNs

Functional Area

Inventory - Shipments and Receipts

Business Overview

This service is used to delete shipments from Merchandising that have not been received. Only ASN shipments (Ship Origin = 0) and ASN UCC-128 shipments (Ship Origin = 6) can be deleted using this service.

Service Type

DELETE

ReST URL

MerchIntegrations/services/inventory/shipmentsAndReceipts/inboundAsn/delete

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
asnNo	Yes	String (30)	Not used in Merchandising.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "asnNo": "ASN-464690028"
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Items

Functional Area

Items

Business Overview

This service is used to delete existing items within Merchandising based on the item number present in the message.

If you are deleting an item, the service will first validate that the item number provided is valid.  If the item does not exist in Merchandising, an error message will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/items/delete

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	The unique identifier for the item.

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Description Translations

Functional Area

Items

Business Overview

This service is used to delete header level translations of an existing item in Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/description/translations/delete

Input Payload Details

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

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

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

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

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

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

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "translation": [
        {
          "language": 5
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Expenses

Functional Area

Items

Business Overview

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

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/expenses/delete

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

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

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

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

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item HTS

Functional Area

Items

Business Overview

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

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/hts/delete

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

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

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

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

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item HTS Assessments

Functional Area

Items

Business Overview

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

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/hts/assessments/delete

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

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

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

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

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

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

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Image Translations

Functional Area

Items

Business Overview

This service is used to delete image level translations from an existing item within Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/image/translations/delete

Input Payload Details

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

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

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

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

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

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

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

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

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100000041",
      "image": [
        {
          "imageName": "Omni_Int_Delta_Change",
          "translation": [
            {
              "language": 38
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Images

Functional Area

Items

Business Overview

This service is used to delete an existing item image information from Merchandising. In order to perform this deletion, the image must exist for the item in Merchandising, else an error will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/images/delete

Input Payload Details

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

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

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

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

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

Element Name	Required	Data Type	Description
imageName	Yes	String (120)	The name of the image.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "image": [
        {
          "imageName": "imageName"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Reclassification

Functional Area

Merchandise Hierarchy - Reclassification

Business Overview

This service allows external systems to delete item reclassification events within Merchandising in order to keep it in sync with the external system. Reclassifications can be deleted using any of the following:

• Deleting a single reclassification event

• Deleting all reclassification events on a particular event date

• Deleting all reclassification events

Service Type

DELETE

ReST URL

MerchIntegrations/services/merchandiseHierarchy/itemReclassification/delete

Availability During Nightly Batch Cycle

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

Input Payload Details

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

Element Name	Required	Data Type	Description
reclassNo	No	Number (4)	If this is provided, then the particular reclass event will be deleted. The purgeAllInd must be N when this is provided.
reclassDate	No	date	If this is provided, then all reclass events with this date will be deleted. The purgeAllInd must be N when this is provided.
purgeAllInd	No	String (1)	If this field is Y, then all item reclass events will be deleted. If this is provided, both reclassNo and reclassDate must not be provided.

Sample Input Message

{
  "reclassNo": 1,
  "reclassDate": "2001-12-31",
  "purgeAllInd": "Y"
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Reclassification Detail

Functional Area

Merchandise Hierarchy - Reclassification

Business Overview

This service allows external systems to remove items from an existing item reclassification event in Merchandising in order to keep it in sync with the external system. The entire reclassification event gets deleted once there are no remaining item lines based on detail level deletion.

Service Type

DELETE

ReST URL

MerchIntegrations/services/merchandiseHierarchy/itemReclassification/detail/delete

Availability During Nightly Batch Cycle

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

Input Payload Details

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

Element Name	Required	Data Type	Description
reclassNo	Yes	Number (4)	The reclass event for which deletion activity is occurring.
items	Yes	Collection of Object	References a collection of items to be deleted from a reclassification event.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	The item in the reclassification event that needs to be deleted.

Sample Input Message

{
  "reclassNo": 1,
  "items": [
    {
      "item": "100100076"
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Seasons

Functional Area

Items

Business Overview

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

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/seasons/delete

Input Payload Details

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

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

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

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

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

Element Name	Required	Data Type	Description
seasonId	Yes	Number (3)	The season identifier.
phaseId	Yes	Number (3)	The phase identifier
diffId	No	String (10)	This field will hold a value for group/differentiator combination records only.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "season": [
        {
          "seasonId": 1,
          "phaseId": 1,
          "diffId": null
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Supplier Countries

Functional Area

Items

Business Overview

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

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/supplier/countries/delete

Input Payload Details

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

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

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

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

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

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

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

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

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Supplier Countries of Manufacture

Functional Area

Items

Business Overview

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

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/supplier/countriesOfManufacture/delete

Input Payload Details

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

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

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

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

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

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

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

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

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Supplier Country Dimensions

Functional Area

Items

Business Overview

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

Service Type

DELETE

ReST URL

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

Input Payload Details

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

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

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

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

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

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

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

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

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

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

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Supplier Country Locations

Functional Area

Items

Business Overview

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

Service Type

DELETE

ReST URL

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

Input Payload Details

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

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

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

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

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

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

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

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

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

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

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Supplier Translations

Functional Area

Items

Business Overview

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

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/supplier/translations/delete

Input Payload Details

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

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

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

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

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

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

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

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

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Suppliers

Functional Area

Items

Business Overview

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

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/suppliers/delete

Input Payload Details

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

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

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

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

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

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

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Taxes

Functional Area

Items

Business Overview

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

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/taxes/delete

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

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

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

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

Sample Input Message

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

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Tickets

Functional Area

Items

Business Overview

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

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/tickets/delete

Input Payload Details

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

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

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

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

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

Element Name	Required	Data Type	Description
ticketTypeId	Yes	String (4)	Id of the ticket type associated with the item.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "ticket": [
        {
          "ticketTypeId": "TKT1"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item UDAs

Functional Area

Items

Business Overview

This service is used to delete item UDAs in Merchandising. In order to delete an item UDA, the UDA must exist for the item in Merchandising, otherwise, an error will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/uda/delete

Input Payload Details

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

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

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

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

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

Element Name	Required	Data Type	Description
udaId	Yes	Number (5)	This field contains a number uniquely identifying the User-Defined Attribute.
displayType	Yes	String (2)	This field contains the display type (how the UDA values will be displayed to the user) for the given UDA. The valid values are DT -Date, FF - Free From, LV - List of values.
udaDateValueText	No	String (30)	This field contains value of the Used Defined attribute for the item

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "100100076",
      "uda": [
        {
          "udaId": 201,
          "displayType": "FF",
          "udaDateValueText": "FF14St"
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Item Up Charges

Functional Area

Items

Business Overview

This service is used to delete existing item upcharges from Merchandising. In order to delete item upcharges, the upcharge or upcharge/component id must exist for the item in Merchandising, otherwise, an error will be returned.

Service Type

DELETE

ReST URL

MerchIntegrations/services/item/upCharges/delete

Availability During Nightly Batch Cycle

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

Input Payload Details

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

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

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

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

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

Element Name	Required	Data Type	Description
fromLocationType	Yes	String (6)	Location type of the from_loc. This can be S - Store,W - Warehouse,A - Area,R - Region,C - Country,AS - All Stores,AW - All Warehouses
fromLocation	No	String (10)	Depending on the from_loc_type, this contains the organization hierarchy value of store, warehouse, area, region, or country from which transferring goods will incur upcharges. It will not contain a value when from_loc_type is AS (all stores) or AW (all warehouses).
toLocationType	Yes	String (6)	Location_type of the to_loc. This can be S - Store,W - Warehouse,A - Area,R - Region,C - Country,AS - All Stores,AW - All Warehouses
toLocation	No	String (10)	Depending on the to_loc_type, this contains the organization hierarchy value of store, warehouse, area, region, or country from which transferring goods will incur upcharges. It will not contain a value when to_loc_type is AS (all stores) or AW (all warehouses).
details	No	Collection of Object	References a collection of item upcharge detail records.

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

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

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "item": "104600060",
      "upcharge": [
        {
          "fromLocationType": "S",
          "fromLocation": "1211",
          "toLocationType": "S",
          "toLocation": "1111",
          "details": [
            {
              "componentId": "WHFEE"
            }
          ]
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

{
  "status": "SUCCESS"
}

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Location Trait

Functional Area

Foundation

Business Overview

The service is used to delete an existing location trait from Merchandising in order to keep it in sync with an external system that is used to maintain location traits. While deleting a location trait, this service will first validate that all required fields are present in the payload. If all the validations are met, the location trait data is deleted from Merchandising.

Service Type

DELETE

ReST URL

MerchIntegrations/services/foundation/locationTrait/delete

Input Payload Details

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

Element Name	Required	Data Type	Description
traitId	Yes	Number (4)	The id number of the location trait being deleted.

Sample Input Message

{
  "traitId": 1000
}

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 Merchandise Hierarchy Reclassification

Functional Area

Merchandise Hierarchy - Reclassification

Business Overview

This service allows for pending merchandise hierarchy reclassification events to be deleted in Merchandising. Prior to deleting a previously created reclassification event, the existence of any related child reclassification records will be checked and the necessary validations will be executed to ensure there are no conflicts.

Service Type

DELETE

ReST URL

MerchIntegrations/services/merchandiseHierarchy/reclassification/delete

Availability During Nightly Batch Cycle

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

Input Payload Details

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

Element Name	Required	Data Type	Description
hierarchyLevel	Yes	String (1)	Indicates the level of the merchandise hierarchy. Valid values are V (division), G (group), D (department), C (class), and S (subclass).
hierarchyId	Yes	Number (4)	Contains the merchandise hierarchy ID.
parentHierarchyId	No	Number (4)	The parent of the hierarchy identified in the hierarchyId field.
grandparentHierarchyId	No	Number (4)	The grandparent of the hierarchy identified in the hierarchyId field. This column will only be populated if the hierarchyLevel = subclass. In this case, the column will contain the dept number.

Sample Input Message

{
  "hierarchyLevel": "D",
  "hierarchyId": 100,
  "parentHierarchyId": 108,
  "grandparentHierarchyId": 1000
}

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

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 Purchase Orders

Functional Area

Purchase Orders

Business Overview

This webservice is used to delete purchase orders from Merchandising in sync with an external system that is responsible for maintaining purchase orders. If you are deleting the entire purchase order, this service will first validate that the order number is valid since an existing order number is the only required field for a header delete message. Deleting an order will in effect set the status of the order at the header level to D. Only worksheet orders can be deleted and deletion will not be allowed if the order is submitted, approved or has been approved, or if allocations exist for the order. Delete messages will still be processed, however it will be treated as an update of cancelled quantity and the quantity ordered will be reduced to the quantity available to be cancelled. If this results in all line items being cancelled or if the delete is made at header level, the status of the order will become Closed.

If an order is still in worksheet status, the entire order will be deleted. If the order involves any franchise stores, then any franchise order or return created with the order will also be cancelled or deleted.

For more details on Purchase Orders, see the Create Purchase Order service description.

Service Type

DELETE

ReST URL

MerchIntegrations/services/purchaseOrders/delete

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
orderNo	Yes	Number (12)	The unique identifier for the order.
dataLoadingDestination	No	String (6)	This field indicates if the order will be created in RMS or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "orderNo": 464690012,
      "dataLoadingDestination": "RMS"
    }
  ]
}

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 Purchase Order Details

Functional Area

Purchase Orders

Business Overview

This webservice is used to delete line items from purchase orders in the worksheet status in order to keep Merchandising in sync with an external system that is responsible for maintaining purchase orders. For orders that are not in worksheet status, when a detail delete is requested, it will update the quantities to cancelled quantities and will be subject for re-approval.

For more details on Purchase Orders, see the Create Purchase Order service description.

Service Type

DELETE

ReST URL

MerchIntegrations/services/purchaseOrder/details/delete

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

Element Name	Required	Data Type	Description
items	No	Collection of Object

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

Element Name	Required	Data Type	Description
orderNo	Yes	Number (12)	The unique identifier for the order.
dataLoadingDestination	No	String (6)	This field indicates if the order will be created in RMS or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
details	No	Collection of Object	This references the order detail node.

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

Element Name	Required	Data Type	Description
item	No	String (25)	An approved, transaction level item. If a pack, it must be an orderable pack (with an order_as_type of 'P').
location	Yes	Number (10)	An active store or warehouse. If multichannel is on, and a warehouse is being order to, a virtual warehouse is expected.
referenceItem	No	String (25)	The id of a reference item which can be used instead of using the item field. If the item field is not populated this field is required.

Sample Input Message

{
  "items": [
    {
      "orderNo": 464690012,
      "dataLoadingDestination": "RMS",
      "details": [
        {
          "item": "100000323",
          "location": 10001,
          "referenceItem": null
        }
      ]
    }
  ]
}

Response Code: 200 (Success)

Sample Response Message

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

Response Code: 400 (Error)

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

Sample Error Message

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

Delete Purchase Order Expenses

Functional Area

Purchase Orders

Business Overview

This webservice is used to delete expense information from the purchase order within Merchandising in order to keep it in sync with an external system that is responsible for maintaining purchase orders. It also updates order header information with the values provided in the request if the order is not yet submitted or approved. Internally, the service sets the status of the order to Worksheet in order to accommodate the modification of expense information for purchase orders in the system that have been submitted or approved. Validation of the updated information is performed before automatic order re-approval is attempted.

For more details on Purchase Orders, see the Create Purchase Order service description.

Service Type

DELETE

ReST URL

MerchIntegrations/services/purchaseOrder/expenses/delete

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
orderNo	Yes	Number (12)	The unique identifier for the order.
dataLoadingDestination	No	String (6)	This field indicates if the order will be created in RMS or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
expenses	No	Collection of Object	References the expense associated with a particular item/location of the purchase order.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	Unique alphanumeric value that identifies the item.
packItem	No	String (25)	Alphanumeric value that uniquely identifies the pack.
location	Yes	Number (10)	This field contains the location that the item was ordered to.
component	Yes	String (10)	This field contains the component id.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "orderNo": 464690012,
      "dataLoadingDestination": "RMS",
      "expenses": [
        {
          "item": "103900095",
          "packItem": null,
          "location": 10001,
          "component": "OCFRT"
        }
      ]
    }
  ]
}

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 Purchase Order HTS

Functional Area

Purchase Orders

Business Overview

This webservice is used to delete Harmonized Tariff Schedules and related assessments within Merchandising in order to keep it in sync with an external system that is responsible for maintaining purchase orders. It also updates order header information with the values provided in the request if the order is not yet submitted or approved. When deleting HTS information from a purchase order that has been submitted or approved, internally, the service sets the status of the order to Worksheet in order to accommodate the change in HTS information. Validation of the new HTS information is performed before automatic order re-approval is attempted.

For more details on Purchase Orders, see the Create Purchase Order service description.

Service Type

DELETE

ReST URL

MerchIntegrations/services/purchaseOrder/hts/delete

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

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

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

Element Name	Required	Data Type	Description
orderNo	Yes	Number (12)	The unique identifier for the order.
dataLoadingDestination	No	String (6)	This field indicates if the order will be created in RMS or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
hts	No	Collection of Object	References the HTS code associated with a particular item of the purchase order.

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

Element Name	Required	Data Type	Description
item	Yes	String (25)	Unique alphanumeric value that identifies the item.
packItem	No	String (25)	Alphanumeric value that uniquely identifies the pack.
hts	Yes	String (25)	The unique identifier for the Harmonized Tariff Schedule code.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "orderNo": 464690012,
      "dataLoadingDestination": "RMS",
      "hts": [
        {
          "item": "103900095",
          "packItem": null,
          "hts": "9014111112"
        }
      ]
    }
  ]
}

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 Purchase Order HTS Assessments

Functional Area

Purchase Orders

Business Overview

This webservice is used to delete Harmonized Tariff Schedule assessments within Merchandising in order to keep it in sync with an external system that is responsible for maintaining purchase orders. It also updates order header information with the values provided in the request if the order is not yet submitted or approved. When deleting assessment information from a purchase order that has been submitted or approved, the service internally sets the status of the order to Worksheet in order to accommodate the change in information. Validation of the new HTS information is performed before automatic order re-approval is attempted.

For more details on Purchase Orders, see the Create Purchase Order service description.

Service Type

DELETE

ReST URL

MerchIntegrations/services/purchaseOrder/hts/assessments/delete

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

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

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of order HTS assessment records.

Table 5-383 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
orderNo	Yes	Number (12)	The unique identifier for the order.
dataLoadingDestination	No	String (6)	This field indicates if the order will be created in RMS or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.
hts	No	Collection of Object	References the HTS code associated with a particular item of the purchase order.

Table 5-384 Hts - Object. See list of elements for detail

Element Name	Required	Data Type	Description
item	Yes	String (25)	Unique alphanumeric value that identifies the item.
packItem	No	String (25)	Alphanumeric value that uniquely identifies the pack.
hts	Yes	String (25)	The unique identifier for the Harmonized Tariff Schedule code.
assessments	No	Collection of Object	References the assessment associated with the HTS of a particular item in the purchase order.

Table 5-385 Assessments - Object. See list of elements for detail

Element Name	Required	Data Type	Description
component	Yes	String (10)	This field contains the component id.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "orderNo": 464690012,
      "dataLoadingDestination": "RMS",
      "hts": [
        {
          "item": "103900095",
          "packItem": null,
          "hts": "9014111112",
          "assessments": [
            {
              "component": "MPFUS"
            }
          ]
        }
      ]
    }
  ]
}

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 Purchase Order Letters of Credit

Functional Area

Purchase Orders

Business Overview

This webservice is used to delete letter of credit information within Merchandising when the order payment type is Letter of Credit in order to keep it in sync with an external system that is responsible for maintaining purchase orders. 

For more details on Purchase Orders, see the Create Purchase Order service description.

Service Type

DELETE

ReST URL

MerchIntegrations/services/purchaseOrder/lettersOfCredit/delete

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

Table 5-386 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
collectionSize	Yes	Number (4)	Number of items in the collection.
items	Yes	Collection of Object	References a collection of letter of credit records.

Table 5-387 Items - Object. See list of elements for detail

Element Name	Required	Data Type	Description
orderNo	Yes	Number (12)	The unique identifier for the order.
dataLoadingDestination	No	String (6)	This field indicates if the order will be created in RMS or the staging tables. Valid values are RMS or STG. If not defined, the default is STG.

Sample Input Message

{
  "collectionSize": 1,
  "items": [
    {
      "orderNo": 464690012,
      "dataLoadingDestination": "RMS"
    }
  ]
}

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 Stock Count Schedules

Functional Area

Inventory - Stock Counts

Business Overview

This webservice allows the external systems to delete stock counts from Merchandising. This webservice will validate if all the required fields are present in the message. After required field and business validation are successfully completed, the stock counts will be marked for deletion in Merchandising. 

A separate webservice Delete Stock Count Schedule Locations supports deleting a location from the count.

For more details on Stock Count Schedules, see the Create Stock Count Schedule service description.

Service Type

DELETE

ReST URL

MerchIntegrations/services/inventory/stockCount/schedules/delete

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

Table 5-388 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
cycleCount	Yes	Number (8)	Contains the number which uniquely identifies the stock or cycle count.

Sample Input Message

{
  "cycleCount": 1001
}

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 Stock Count Schedule Locations

Functional Area

Inventory - Stock Counts

Business Overview

This webservice allows external systems to delete locations from existing stock counts within Merchandising. This validates if all the required fields are present in the message and after the required field and business validations are completed successfully, the stock count locations will be removed. If all locations in the stock count are deleted, the entire stock count will be marked for deletion.

Service Type

DELETE

ReST URL

MerchIntegrations/services/inventory/stockCount/schedule/locations/delete

Availability During Nightly Batch Cycle

This service will not be available when batches that affect inventory are in-progress.

Input Payload Details

Table 5-389 Delete - Object. See list of elements for detail

Element Name	Required	Data Type	Description
cycleCount	Yes	Number (8)	Contains the number which uniquely identifies the stock or cycle count.
locations	No	Collection of Object	References a collection of locations to be deleted from the stock count.

Table 5-390 Locations - Object. See list of elements for detail

Element Name	Required	Data Type	Description
location	Yes	Number (10)	This field contains the store or warehouse number on the cycle count. This must be a valid store or a stockholding warehouse in Merchandising.

Sample Input Message

{
  "cycleCount": 1001,
  "locations": [
    {
      "location": 6000
    }
  ]
}

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 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

Re