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. A few were built specifically to support mobile applications. These may not be useful for general use, however if you wanted to build your own mobile applications leveraging these services, this can be done. The ReSTful Web services Java code cannot be customized. The diagram below shows how the services are intended to interact with a mobile client.
Figure 5-1 Mobile Client and Web Services Integration through Javascript
Note:
The services should not be used during the restricted 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
. User can change it though, in case they need content in a specific language.
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
-
POST/UPDATE : 204
-
DELETE : 204
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 following links provide access to the Merchandising services:
-
The ReSTful Web services WADL file is available at:
https://<hostname>/RmsReSTServices/services/application.wadl
-
The ReSTful Web services are available at:
https://<hostname>/RmsReSTServices/services/private/<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 WADL file is available at:
https://<hostname>/ResaReSTServices/services/application.wadl
-
To access the ReSTful web services:
https://<hostname>/ResaReSTServices/services/private/Resa/<service>
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:
-
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.
-
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.
-
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>
whereSERVICETYPE
is MFCS andENVIRONMENT
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.
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
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 |
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.
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.
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.
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.
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
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"
}
Merchandising Omni Integration
REST Endpoint for Omni Channel/Diff Group
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Diff Group details. This ReST service is pulled from data cache table MERCHAPI_DIFF_GROUP. Data Pre-Processing logic populates this table using MERCHAPI_DIFF_GROUP_SQL.
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. Ex: diffGroupId, diffId |
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. |
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, etc.). |
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 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",
"diffgroupid": "1177",
"diffgroupdesc": "EIT_Diff_Group_1",
"difftypeid": "CF",
"diffid": "4280"
}
],
"hasMore": true,
"limit": 1,
"count": 1,
"links": [
{
"href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/diff/group?before=2021-05-06T16%3A12%3A02.551757%2B08%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z",
"rel": "self"
},
{
"href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/diff/group?before=2021-05-06T16%3A12%3A02.551757%2B08%3A00&limit=1&offsetkey=1177%2C4280&since=1970-01-01T00%3A00%3A00.001Z",
"rel": "next"
}
]
} "
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
ICL_RMS_DIFF_GROUP |
Yes |
Yes |
Yes |
Yes |
MERCHAPI_DIFF_GROUP |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_DIFF_GROUP |
Yes |
No |
No |
No |
V_MERCHAPI_DIFF_GROUP_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_ITEM_JSON |
Yes |
No |
No |
No |
MERCHAPI_ITEM_DIFF_TYPE |
Yes |
Yes |
Yes |
Yes |
REST Endpoint for Omni Channel/Diff IDs
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Diff Ids. This ReST service is pulled from data cache table MERCHAPI_DIFF_IDS. Data Pre-Processing logic populates this table using MERCHAPI_DIFF_IDS_SQL.
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. Ex: diffid. |
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. |
diffid |
String |
Contains the code to uniquely identify a differentiator. |
diffdesc |
String |
Description of the differentiator (for example, Blueberry, Shower Fresh, Red, etc.). |
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 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", "diffid": "1005", "diffdesc": "EIT_Diff_ID : Black", "difftype": "CF", "difftypedesc": "Cereal Flavour" } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/diff?before=2021-05-05T16%3A18%3A57.100893%2B08%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/diff?before=2021-05-05T16%3A18%3A57.100893%2B08%3A00&limit=1&offsetkey=1005&since=1970-01-01T00%3A00%3A00.001Z", "rel": "next" } ] }"
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_ASYNC_REQUEST |
Yes |
No |
No |
No |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
ICL_RMS_DIFF_IDS |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_DIFF_TYPE |
Yes |
Yes |
Yes |
Yes |
DIFF_IDS |
Yes |
No |
No |
No |
MERCHAPI_DIFF_IDS |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_DIFF_IDS_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_DIFF_IDS |
Yes |
No |
No |
No |
V_MERCHAPI_ITEM_JSON |
Yes |
No |
No |
No |
MERCHAPI_ITEM_DIFF_TYPE |
Yes |
Yes |
Yes |
Yes |
MERCHAPI_ITEM_DIFF_VALUE |
Yes |
Yes |
Yes |
Yes |
REST Endpoint for Omni Channel/Inventory/Store Details
Business Overview
This ReST service will be used by Omni Channel Inventory Applications to integrate available inventory for store locations. This service can be called to integrate available inventory for selective store location or fetch available inventory for all the stores. This service is backed by database view V_MERCHAPI_STORE_CO_INV.
ReST URL
/MerchIntegrations/services/inventory/omnichannel/inventory/store?since={since}&before={before}&offsetkey={offsetkey}&limit={limit}
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
since |
No |
String |
Since Date. Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm |
before |
No |
String |
Before Date Format: yyyy-mm-dd"T"hh24:mi:ss.fftzh:tzm |
offsetkey |
No |
String |
Offset Key. Valid Value is combination of store id and item in case of entire stores list being pulled or item in case specific store id is pulled. |
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. |
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 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", "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=1=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=1=1341%2C100000286=1970-01-01T00%3A00%3A00.001Z", "rel": "next" } ] }"
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_LOC_SOH |
Yes |
No |
No |
No |
STORE |
Yes |
No |
No |
No |
MERCHAPI_ITEM_LOC |
Yes |
No |
No |
No |
REST Endpoint for Omni Channel/Inventory/Warehouse Details
Business Overview
This ReST service will be used by Omni Channel Inventory Applications to integrate available inventory for warehouse locations. This service can be called to integrate available inventory for selective warehouse location or fetch available inventory for all the warehouse. This service is backed by database view V_MERCHAPI_STORE_CO_INV.
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 10000. |
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 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", "item": "100000075", "location": "10001", "loctype": "W", "availablequantity": 0, "stockonhand": 0, "standarduom": "EA", "physicalwarehouse": 2 } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/inventory/omnichannel/inventory/warehouse?before=2021-05-13T19%3A14%3A44.470363%2B05%3A30&limit=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/inventory/omnichannel/inventory/warehouse?before=2021-05-13T19%3A14%3A44.470363%2B05%3A30&limit=1&offsetkey=10001%2C100000075&since=1970-01-01T00%3A00%3A00.001Z", "rel": "next" } ] }"
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_LOC_SOH |
Yes |
No |
No |
No |
WH |
Yes |
No |
No |
No |
MERCHAPI_ITEM_LOC |
Yes |
No |
No |
No |
REST Endpoint for Omni Channel/Item Details
Business Overview
This ReST service will be used by Omni Channel Applications to integrate Item details. Attributes for this service are pulled from data cache table MERCHAPI_ITEM_MASTER. Data Pre-Processing logic populates this table using MERCHAPI_ITEM_SQL. This service can be called by enterprise application in which all the items are interfaced, or this service can be called for retrieving ranged items for specific location.
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 ‘S’tore or ‘W’arehouse. |
nodeid |
No |
BigDecimal |
Node Id. Valid Values are Valid stores present in 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 10000. |
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 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 alphanumeric value that uniquely identifies the item/group at the level above the item. |
itemgrandparent |
String |
This field specifies alphanumeric value that uniquely identifies the item/group two levels above the item. |
itemlevel |
Number |
This field specifies number indicating which of the three levels the item resides. The item level determines if the item stands alone or if it is part of a family of related items. |
tranlevel |
Number |
This field specifies 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 if 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 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 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 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 number which uniquely identifies the division of the company. |
groupid |
Number |
This field specifies 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 if 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 which 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 specifies 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 weather 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 is a seperate package versus being grouped together in a box. |
standarduom |
String |
Field specifies 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, etc. |
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 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": [ { "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
Business Overview
This ReST service will be used by Omni Channel Applications to integrate Item UPC Foundation data. This service is backed by the same data cache table MERCHAPI_ITEM_MASTER that is use for Item service. Data Pre-Processing logic populates this table using MERCHAPI_ITEM_SQL. This service can be called by an enterprise application to replicate all the item/upc data or can be called individually by a store system to only replicate the item/upc ranged to that location.
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 ‘S’tore or ‘W’arehouse. |
nodeid |
No |
BigDecimal |
Node Id. Valid Values are Valid stores present in 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 10000. |
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 location id associated with item if 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 alphanumeric value that uniquely identifies the item/group at the level above the item. |
itemgrandparent |
String |
This field specifies alphanumeric value that uniquely identifies the item/group two levels above the item. |
itemlevel |
Number |
This field specifies number indicating which of the three levels the item resides. The item level determines if the item stands alone or if it is part of a family of related items. |
tranlevel |
Number |
This field specifies 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 if 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 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 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 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 number which uniquely identifies the division of the company. |
groupid |
Number |
This field specifies 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 is populated as empty for an UPC Item. |
brandname |
String |
This field specifies the brand associated to an item. |
merchandiseind |
String |
Indicates if 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 which 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 an UPC Item. |
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 weather 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 is a seperate package versus being grouped together in a box. |
standarduom |
String |
Field specifies 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, etc. |
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 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": [ { "item": "101100001", "action": "INSERT", "itemlocation": "ent", "itemparent": "100250007", "itemgrandparent": null, "itemlevel": 2, "tranlevel": 1, "inventoryind": "Y", "diff1level": null, "diff1type": null, "diff1": null, "diff2level": null, "diff2type": null, "diff2": null, "diff3level": null, "diff3type": null, "diff3": null, "DIVISION": 3000, "groupid": 304, "dept": 3041, "class": 1, "uniqueclass": 139, "subclass": 1, "uniquesubclass": 17, "description": "Something - MK", "localdescription": null, "merchandiseind": "Y", "uintype": null, "mfgrecretail": null, "orginalunitretail": null, "catchweightind": "N", "itemservicelevel": null, "giftwrapind": "N", "shipaloneind": "N", "standarduom": "EA", "productclassification": null, "xdiff1desc": null, "xdiff2desc": null, "xdiff3desc": null } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/item/upc?before=2021-05-13T16%3A38%3A07.284763%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&since=1970-01-01T00%3A00%3A00.001Z ", "rel": "self" }, { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/item/upc?before=2021-05-13T16%3A38%3A07.284763%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&offsetkey=101100001&since=1970-01-01T00%3A00%3A00.001Z ", "rel": "next" } ] }"
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_ASYNC_REQUEST |
Yes |
No |
No |
No |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
ITEM_MASTER |
Yes |
No |
No |
No |
ICL_RMS_ITEM_MASTER |
Yes |
No |
Yes |
Yes |
MERCHAPI_ITEM_MASTER |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_ITEM_MASTER |
Yes |
No |
No |
No |
ICL_RMS_ITEM_IMAGE |
No |
Yes |
No |
No |
ICL_RMS_RELATED_ITEM |
No |
Yes |
No |
No |
ICL_RMS_ITEM_LOC |
No |
Yes |
No |
No |
SYSTEM_OPTIONS |
Yes |
No |
No |
No |
REST Endpoint for Omni Channel/Merchandise Hierarchy Details
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Merchandise Hierarchy details. Attributes for this service are pulled from data cache table MERCHAPI_MERCH_HIER. Data Pre-Processing logic populates this table using MERCHAPI_MERCH_HIER_SQL.
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 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": "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=1=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=1=2%2Cvirtual=1970-01-01T00%3A00%3A00.001Z ", "rel": "next" } ] }"
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_ASYNC_REQUEST |
Yes |
No |
No |
No |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
ICL_RMS_DIVISION |
Yes |
No |
Yes |
Yes |
ICL_RMS_GROUPS |
Yes |
No |
Yes |
Yes |
ICL_RMS_DEPS |
Yes |
No |
Yes |
Yes |
ICL_RMS_CLASS |
Yes |
No |
Yes |
Yes |
ICL_RMS_SUBCLASS |
Yes |
No |
Yes |
Yes |
COMPHEAD |
Yes |
No |
No |
No |
CODE_DETAIL |
Yes |
No |
No |
No |
MERCHAPI_MERCH_HIER |
Yes |
Yes |
Yes |
Yes |
V_ MERCHAPI_MERCH_HIER |
Yes |
No |
No |
No |
V_ MERCHAPI_MERCH_HIER _JSON |
Yes |
No |
No |
No |
SYSTEM_OPTIONS |
Yes |
No |
No |
No |
REST Endpoint for Omni Channel/Org Hier Descendant’s Details
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Organization Hierarchy Descendants details. Org hierarchy descendants are used by Oracle Retail Xstore Point of Service to retrieve a complete branch of org hierarchy rooted at a specific node – for example, locations under a region. This ReST service is pulled from data cache table MERCHAPI_ORG_HIER. Data Pre-Processing logic populates this table using MERCHAPI_ORG_HIER_SQL.
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 CHAIN, AREA, REGION, DISTRICT, WAREHOUSE and STORE. |
nodeid |
No |
BigDecimal |
Node Id. Valid Values are Chain, Area, Region, District, Warehouse and Store IDs present in respective tables. |
offsetkey |
No |
String |
Offset Key. Valid Value: levelorder. |
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, NO_CHANGE and DELETE. |
hierarchylevel |
String |
This field specifies Organization Hierarchy Level. |
hierarchynodeid |
Number |
This field specifies Organization Hierarchy ID. |
hierarchynodename |
String |
This field specifies name of the Organization Hierarchy ID |
parentlevel |
String |
This field specifies Parent Organization Hierarchy Level. |
parentid |
Number |
This field specifies 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 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": [ { "hierarchylevel": "COMPANY", "hierarchynodeid": 9118, "hierarchynodename": "Retailers Ltd", "parentlevel": null, "parentid": null, "levelorder": 1 } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/orghier/descendant?nodelevel=COMPANY&limit=1&nodeid=9118", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/orghier/descendant?nodelevel=COMPANY&limit=1&nodeid=9118&offsetkey=1%2C9118", "rel": "next" } ] }"
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_ASYNC_REQUEST |
Yes |
No |
No |
No |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
V_ICL_RMS_ORGHIER |
Yes |
No |
No |
No |
ICL_RMS_CHAIN |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_AREA |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_REGION |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_DISTRICT |
Yes |
Yes |
Yes |
Yes |
ITEM_LOC |
Yes |
No |
No |
No |
MERCHAPI_ORG_HIER |
Yes |
Yes |
Yes |
Yes |
V_ORG_HIER_FULL_VW |
Yes |
No |
No |
No |
V_MERCHAPI_ORG_HIER |
Yes |
No |
No |
No |
REST Endpoint for Omni Channel/Org Hierarchy Details
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Organization Hierarchy details. This ReST service is pulled from data cache table MERCHAPI_ORG_HIER. Data Pre-Processing logic populates this table using MERCHAPI_ORG_HIER_SQL.
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 CHAIN, AREA, REGION, DISTRICT, WAREHOUSE and STORE. |
nodeid |
No |
BigDecimal |
Node Id. Valid Values are Chain, Area, Region, District, Warehouse 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 10000. |
Output
Name | Data Type | Description |
---|---|---|
Action |
String |
Action for Item details. Valid Values are INSERT, UPDATE, UPSERT, NO_CHANGE and DELETE. |
hierarchylevel |
String |
This field specifies Organization Hierarchy Level. |
hierarchynodeid |
Number |
This field specifies Organization Hierarchy ID. |
hierarchynodename |
String |
This field specifies name of the Organization Hierarchy ID |
parentlevel |
String |
This field specifies Parent Organization Hierarchy Level. |
parentid |
Number |
This field specifies Parent Organization Hierarchy ID. |
mgrname |
String |
This field specifies 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 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 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:
" { "action": "UPDATE", "hierarchylevel": "AREA", "hierarchynodeid": 1212, "hierarchynodename": "Area 12121", "parentlevel": "CHAIN", "parentid": 1212, "mgrName": "V", "stockholding": null, "integratedPos": null } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/orghier?before=2021-05-11T15%3A20%3A25.711306%2B00%3A00&nodelevel=COMPANY&limit=1&nodeid=9118&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/orghier?before=2021-05-11T15%3A20%3A25.711306%2B00%3A00&nodelevel=COMPANY&limit=1&nodeid=9118&offsetkey=AREA%2C1212&since=1970-01-01T00%3A00%3A00.001Z", "rel": "next" } ] }"
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_ASYNC_REQUEST |
Yes |
No |
No |
No |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
V_ICL_RMS_ORGHIER |
Yes |
No |
No |
No |
ICL_RMS_CHAIN |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_AREA |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_REGION |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_DISTRICT |
Yes |
Yes |
Yes |
Yes |
ITEM_LOC |
Yes |
No |
No |
No |
MERCHAPI_ORG_HIER |
Yes |
Yes |
Yes |
Yes |
V_ORG_HIER_FULL_VW |
Yes |
No |
No |
No |
V_MERCHAPI_ORG_HIER |
Yes |
No |
No |
No |
REST Endpoint for Omni Channel/Refresh Date
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve metadata related to individual Merch Integrations services. This service returns the timestamp when the data cache table was initially loaded or had a complete data refresh. A change in last refresh date for a service end point is an indication for the consuming system that high volume of data will be interfaced and the consumer can choose to use regular delta integration process or switch to flushing earlier interfaced data and load the data freshly . This ReST service is pulled from data cache table V_CACHE_REFRESH_DATE.
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 Refresh date of Merchandising Integration Rest Service API. |
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": [ { "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=10000=1970-01-01T00%3A00%3A00.001Z", "rel": "self" } ] }"
REST Endpoint for Omni Channel/Warehouse Details
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve warehouse location details. Attribute’s for this service are pulled from data cache table MERCHAPI_WH. Data Pre-Processing logic populates this table using MERCHAPI_WH_SQL.
ReST URL
/MerchIntegrations/services/foundation/omnichannel/location/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 warehouse id and ware house type. |
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. |
warehouseid |
Number |
This field uniquely identifies the warehouse. |
type |
String |
This field determine which warehouses are physical and which are virtual. |
warehousename |
String |
This field specifies name of the warehouse which along with the warehouse number, identifies the warehouse. |
whnamesecondary |
String |
This field specifies Secondary name of the warehouse. |
contactname |
String |
This field specifies the name of the contact at this location. |
phonenumber |
Number |
This field specifies phone number of the contact person at this location. |
faxnumber |
Number |
This field specifies fax number of the contact person at this location. |
|
String |
This field contains the email address for the location. |
currencycode |
String |
This field specifies currency code under which the warehouse operates. |
physicalwh |
String |
This field specifies number of the physical warehouse that is assigned to the virtual warehouse. |
vatregion |
Number |
This field specifies 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 code associated with the specific organizational hierarchy type. |
orgentitytype |
String |
This field specifies if the warehouse is a legal entity (Importer, Exporter) or a regular warehouse. |
channelid |
Number |
This field specifies the channel for which the virtual warehouse will be assigned. |
channelname |
String |
This field specifies name of the channel for which the virtual warehouse will be assigned. |
address1 |
String |
This field specifies first line of the address for this location. |
address2 |
String |
This field specifies second line of the address for this location. |
address3 |
String |
This field specifies third line of the address for this location. |
city |
String |
This field specifies name of the city that is associated with the address for this location. |
State |
String |
This field specifies state abbreviation for the address for this location. |
Country |
String |
This field specifies country where the address exists. |
postalcode |
String |
This field specifies zip code for the address. |
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", "warehouseid": 2, "type": "virtual", "warehousename": "N. America Central", "whnamesecondary": null, "contactname": "Sue Glass", "phonenumber": "3122222473", "faxnumber": null, "email": null, "currencycode": "USD", "physicalwh": 2, "vatregion": 1000, "orghiertype": null, "orghiervalue": null, "orgentitytype": "R", "channelid": null, "channelname": null, "address1": "123 Street", "address2": "Anytown", "address3": null, "city": "Anycity", "state": "MN", "country": "US", "postalcode": "50250" } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/location/warehouse?before=2021-05-12T20%3A15%3A13.253929%2B05%3A30&limit=1&since=1970-01-01T00%3A00%3A00.001Z ", "rel": "self" }, { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/merchhier?before=2021-05-12T21%3A00%3A13.036021%2B05%3A30&limit=1&offsetkey=10%2C1&since=1970-01-01T00%3A00%3A00.001Z ", "rel": "next" } ] }"
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_ASYNC_REQUEST |
Yes |
No |
No |
No |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
ICL_RMS_WH |
Yes |
No |
Yes |
Yes |
ICL_RMS_ADDR |
Yes |
No |
Yes |
Yes |
ADDR |
Yes |
No |
No |
No |
MERCHAPI_WH |
Yes |
Yes |
Yes |
Yes |
MERCHAPI_ORG_HIER |
No |
No |
Yes |
No |
V_MERCHAPI_WH |
Yes |
No |
No |
No |
V_MERCHAPI_WH_JSON |
Yes |
No |
No |
No |
SYSTEM_OPTIONS |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/Related Item
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Related Item details. This ReST service is pulled from data cache table MERCHAPI_RELATED_ITEM. Data Pre-Processing logic populates this table using MERCHAPI_RELATED_ITEM_SQL.
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 are ‘S’tore or ‘W’arehouse. |
nodeid |
No |
BigDecimal |
Node Id. Valid Values are Valid stores present in STORE table or Valid Warehouse from WH table. |
offsetkey |
No |
String |
Offset Key. Valid Value are Combination of valid Relationship Id and a valid Related Item separated by comma. Ex: relid, relitem |
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. |
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 realted item. |
relateditemaction |
String |
Related Action for Item details. Valid Values are INSERT, UPDATE, UPSERT and DELETE. |
startdate |
String |
This column contains start date for a realted item. Represents the date from which related item can be used on transactions. |
enddate |
String |
This column contains end date for a related item. Represents the date till 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 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", "relationshipid": 120001, "item": "111150001", "relationshiptype": "CRSL", "mandatoryind": "N", "relateditem": "111051290", "relateditemaction": "INSERT", "startdate": null, "enddate": null, "priority": null } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/relateditem?before=2021-05-06T18%3A17%3A30.285106%2B08%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://localhost:8080/MerchIntegrations/services/foundation/omnichannel/item/relateditem?before=2021-05-06T18%3A17%3A30.285106%2B08%3A00&limit=1&offsetkey=120001%2C111051290&since=1970-01-01T00%3A00%3A00.001Z", "rel": "next" } ] }"
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_ASYNC_REQUEST |
Yes |
No |
No |
No |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
ICL_RMS_RELATED_ITEM |
Yes |
Yes |
Yes |
Yes |
MERCHAPI_RELATED_ITEM |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_RELATED_ITEM_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_RELATED_ITEM |
Yes |
Yes |
Yes |
Yes |
REST Endpoint for Omnichannel/Retail Store Details
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve store locations details. The list of Stores that are being pulled depend upon the Retailer’s Organization Hierarchy setup.
Attributes for this service are pulled from data cache table MERCHAPI_RETAIL_STORE. Data Pre-Processing logic populates this table using MERCHAPI_RETAIL_STORE_SQL.
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 Id’s of particular node level. Ex: 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 10000. |
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. |
|
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 which 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 contained. |
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", "storeid": 1111, "storename": "Rebuild with refresh N NO ICL Charlotte *", "storename10": "Charlotte", "manager": "Don Wright", "phonenumber": "704-555-2121", "faxnumber": null, "email": null, "totalsqfeet": 64400, "sellingsqfeet": 59500, "currencycode": "USD", "vatregion": 1000, "stockholding": "Y", "integratedpos": "Y", "contactname": "Sue Glass", "address1": "123 Street", "address2": "Anytown", "address3": null, "city": "Anycity", "state": "MN", "country": "US", "postalcode": "50250" } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/location/retailstore?before=2021-05-12T17%3A30%3A45.385517%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>:<portnumber>/MerchIntegrations/services/foundation/omnichannel/location/retailstore?before=2021-05-12T17%3A30%3A45.385517%2B05%3A30&nodelevel=COMPANY&limit=1&nodeid=1&offsetkey=1111&since=1970-01-01T00%3A00%3A00.001Z", "rel": "next" } ] }"
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_ASYNC_REQUEST |
Yes |
No |
No |
No |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
ICL_RMS_STORE |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_ADDR |
Yes |
No |
Yes |
Yes |
ADDR |
Yes |
No |
No |
No |
STORE |
Yes |
No |
No |
No |
MERCHAPI_RETAIL_STORE |
Yes |
Yes |
Yes |
Yes |
MERCHAPI_ORG_HIER |
No |
No |
Yes |
No |
V_MERCHAPI_RETAIL_STORE_JSON |
Yes |
No |
No |
No |
SYSTEM_OPTIONS |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/Dimension Type details
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Item Dimension Type Details. Dimension Systems are a structure in Oracle Retail Xstore Point of Service for items and supports up to three dimensions of style characteristics, such as color, size, and fabric. Dimension Types are the diff types associated with a style item in Merchandising. This ReST service is pulled from data cache table MERCHAPI_ITEM_DIFF_TYPE. Data Pre-Processing logic populates this table using MERCHAPI_ITEM_DIMENSION_SQL.
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. Ex: item number, location number. |
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, 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 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", "itemaction": null, "dimensionsystem": "1000023212", "dimension": "C_3815", "description": "Smoke Diff Group Clr", "seq": 1 } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/dimensiontype?before=2021-05-11T17%3A41%3A38.052402%2B00%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/dimensiontype?before=2021-05-11T17%3A41%3A38.052402%2B00%3A00&limit=1&offsetkey=0430.PD.1%2C1%2CC_3815&since=1970-01-01T00%3A00%3A00.001Z", "rel": "next" } ] }"
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_ASYNC_REQUEST |
Yes |
No |
No |
No |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
MERCHAPI_ITEM_DIFF_TYPE |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_ITEM_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_DIM_TYPE |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/Dimension Value details
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Item Dimension Value Details. Dimension Systems are a structure in Oracle Retail Xstore Point of Service for items and supports up to three dimensions of style characteristics such as color, size, and fabric. Dimension Values are the diff values associated with each dimension within a dimension system (parent item). This ReST service is pulled from data cache table MERCHAPI_ITEM_DIFF_VALUE. Data Pre-Processing logic populates this table using MERCHAPI_ITEM_DIMENSION_SQL.
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. Ex: item number, location number. |
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, 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 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", "itemaction": "NO_CHANGE", "dimensionsystem": "1000012345", "dimension": "C_3815", "value": "BLACK_8742", "description": "Auto Black BLACK_8742", "displayseq": 1 } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/dimensionvalue?before=2021-05-11T17%3A51%3A17.671921%2B00%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/dimensionvalue?before=2021-05-11T17%3A51%3A17.671921%2B00%3A00&limit=1&offsetkey=0430.PD.1%2CC_3815%2CBLACK_8742&since=1970-01-01T00%3A00%3A00.001Z", "rel": "next" } ] }"
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_ASYNC_REQUEST |
Yes |
No |
No |
No |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
MERCHAPI_ITEM_DIFF_VALUE |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_ITEM_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_DIM_VALUE |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/Future Inventory
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Future Inventory aggregated at an item level across customer orderable locations. This ReST service is pulled from data cache table MERCHAPI_FUTURE_AVAIL_CO_INV. Data Pre-Processing logic populates this table using MERCHAPI_FUTURE_AVL_CO_INV_SQL.
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. Ex: item |
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. |
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 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. |
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_ASYNC_REQUEST |
Yes |
No |
No |
No |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
MERCHAPI_BOOKMARK |
Yes |
Yes |
Yes |
Yes |
V_BDI_CO_FUTURE_AVAIL |
Yes |
No |
No |
No |
MERCHAPI_FUTURE_AVAIL_CO_INV |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_FUTURE_AVAIL_CO_INV |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/Item Image
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Item Image details. This ReST service is pulled from data cache table MERCHAPI_ITEM_IMAGE. Data Pre-Processing logic populates this table using MERCHAPI_ITEM_IMAGE_SQL.
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 ‘S’tore or ‘W’arehouse. |
nodeid |
No |
BigDecimal |
Node Id. Valid Values are Valid stores present in STORE table or Valid Warehouse from WH table. |
offsetkey |
No |
String |
Offset Key. Valid Value are Combination of valid Item and a valid Image Name separated by comma. Ex: item, imageName |
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. |
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, etc.). |
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(es) and N(o) 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 to the item per priority. |
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", "item": "100200042", "imagename": "image1", "imageaddr": "http://www.oracle.com/", "imageuri": "http://www.oracle.com/image1", "imagedesc": "image1Desc", "imagetype": "T", "primaryind": "Y", "displaypriority": 1 } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/image?before=2021-05-06T17%3A32%3A13.265046%2B08%3A00&limit=1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/image?before=2021-05-06T17%3A32%3A13.265046%2B08%3A00&limit=1&offsetkey=100200042%2Cimage1&since=1970-01-01T00%3A00%3A00.001Z", "rel": "next" } ] }"
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_ASYNC_REQUEST |
Yes |
No |
No |
No |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
MERCHAPI_BOOKMARK |
Yes |
Yes |
Yes |
Yes |
ICL_RMS_ITEM_IMAGE |
Yes |
Yes |
Yes |
Yes |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_IMAGE |
Yes |
No |
No |
No |
MERCHAPI_ITEM_IMAGE |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_ITEM_IMAGE_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_ITEM_IMAGE |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/Item Initial Price Details
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Item Initial Price details. This ReST service is pulled from data cache table MERCHAPI_ITEM_LOC. Data Pre-Processing logic populates this table using MERCHAPI_ITEM_LOC_SQL.
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 ‘S’tore or ‘W’arehouse. |
nodeid |
No |
BigDecimal |
Node Id. Valid Values are Valid stores present in STORE table or Valid Warehouse from WH table. |
offsetkey |
No |
String |
Offset Key. Valid Value are Combination of valid Item and a valid Location separated by comma. Ex: item number, location number. |
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, 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 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 Date on which the unit retail price became or will become active. |
source |
String |
This field specifies source of the initial unit retail price of each item. |
eventid |
String |
This field specifies eventid. |
resetind |
String |
This field specifies reset indicator. |
clearanceind |
String |
This field Indicates if item is on clearance at the store. |
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", "loctype": "S", "location": 121, "item": "100000104", "pricetype": "INITIAL", "price": 12.1, "effective": null, "source": "direct", "eventid": null, "resetind": null, "clearanceind": 0 } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/initialprice?before=2021-05-11T17%3A23%3A22.208547%2B00%3A00&nodelevel=COMPANY&limit=1&nodeid=9118&since=1970-01-01T00%3A00%3A00.001Z", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/initialprice?before=2021-05-11T17%3A23%3A22.208547%2B00%3A00&nodelevel=COMPANY&limit=1&nodeid=9118&offsetkey=S%2C121%2C100000104&since=1970-01-01T00%3A00%3A00.001Z", "rel": "next" } ] }"
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_ASYNC_REQUEST |
Yes |
No |
No |
No |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
ICL_RMS_ITEM_LOC |
Yes |
Yes |
Yes |
Yes |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_LOC |
Yes |
No |
No |
No |
MERCHAPI_ITEM_LOC |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_ITEM_LOC_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_INITIAL_ITEM_PRICE |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/Item Location Details
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve Item Location Details. In a VAT environment, this service will also include the VAT details for the item/location. This service supports integration for specific location number or can be used to integrate all item/location combinations. This ReST service is pulled from data cache table MERCHAPI_ITEM_LOC. Data Pre-Processing logic populates this table using MERCHAPI_ITEM_LOC_SQL.
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 ‘S’tore or ‘W’arehouse. |
nodeid |
No |
BigDecimal |
Node Id. Valid Values are Valid stores present in STORE table or Valid Warehouse from WH table. |
offsetkey |
No |
String |
Offset Key. Contains Combination of valid Item and a valid Location separated by comma. Ex: item number, location number. |
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, 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 unique alphanumeric value that identifies the item |
sellingunitretail |
Number |
This field specifies 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 selling unit of measure for an items single-unit retail. |
taxableind |
String |
This field Indicates if item is taxable at the store. |
localitemdesc |
String |
This field specifies selling local description of the item. This field will default to the items description but will be over-ridable. This value will be downloaded to the POS |
status |
String |
This field specifies Current status of item at the store. |
qtykeyoptions |
String |
This field specifies whether the qty key on a POS should be used for this item at the location. Valid values are in the code_type RPO. Current values include R - required, P - Prohibited, and O - Optional. Additional values can be added to the code type as needed. This value will be downloaded to the POS as needed. |
manualpriceentry |
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 of the packaging in items sold by weight at the location. Fixed tare is the tare of the packagine used to (i.e. if the tare item is bulk candy, this is weight of the bag and twist tie). The only processing RMS 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 RMS, etc. 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 RMS 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 RMS, etc. 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 weather 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. |
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 if the item is a merchandise item. |
clearanceind |
String |
This field Indicates if item is on clearance at the store. |
crosssell |
String |
This field Indicates if substitute item exists for the main item. |
attacheditem |
String |
This field Indicates if Cross/Up Sell items attached to the main item. |
vatcodes |
String |
This field contains Vat Code information for the item in JSON array. |
vatcodes JSON Output
Name | Data Type | Description |
---|---|---|
code |
String |
This field contains vat code which is used to uniquely identify a VAT rate. |
date |
Date |
This filed contains date on which VAT rate become active. Format: YYYY-MM-DD |
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", "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"}]" } ], "hasMore": true, "limit": 1, "count": 1, "links": [ { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/itemlocation?before=2021-05-03T15%3A50%3A19.189562000%2B00%3A00&nodelevel=COMPANY&limit=2&nodeid=1&offsetkey=S%2C1111%2C100550000%26since%3D1970-01-01T00%3A00%3A00.001Z&since=1970-01-01T00%3A00%3A00.001000000%2B00%3A00", "rel": "self" }, { "href": "http://<hostname>/MerchIntegrations/services/foundation/omnichannel/item/itemlocation?before=2021-05-03T15%3A50%3A19.189562000%2B00%3A00&nodelevel=COMPANY&limit=2&nodeid=1&offsetkey=S%2C1151%2C100000067%26since%3D1970-01-01T00%3A00%3A00.001Z&since=1970-01-01T00%3A00%3A00.001000000%2B00%3A00", "rel": "next" } ] }"
Table Impact
The list of table includes the data pre-processing for this service along with the table/views queried during the ReST call.
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
MERCHAPI_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_CONSUMER_CONFIG |
Yes |
No |
No |
No |
MERCHAPI_ASYNC_REQUEST |
Yes |
No |
No |
No |
MERCH_BATCH_PARAM |
Yes |
No |
No |
No |
ICL_RMS_ITEM_LOC |
Yes |
Yes |
Yes |
Yes |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_LOC |
Yes |
No |
No |
No |
MERCHAPI_ITEM_LOC |
Yes |
Yes |
Yes |
Yes |
V_MERCHAPI_ITEM_LOC_JSON |
Yes |
No |
No |
No |
V_MERCHAPI_ITEM_LOC |
Yes |
No |
No |
No |
REST Endpoint for Omnichannel/VAT
Business Overview
This ReST service will be used by Omni Channel Applications to retrieve VAT information. This service is only applicable for VAT environment. This ReST service is pulled from data cache table MERCHAPI_VAT. Data Pre-Processing logic populates this table using MERCHAPI_VAT_SQL.
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. Ex: vatregion, vatcode, activedate |
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. |
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 the RMS. |
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 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", "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"": [] } }"
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.
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": [] } } ]
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.
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. |
Book Transfer ReSTful Web Service
This section describes the Book Transfer ReSTful Web Service
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.
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:
|
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 |
Code Detail Service
Business Overview
Code Detail service allows user to retrieve code details for a selected code and code type.
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": []
}
}
Create Inventory Transfer Services
This section describes the inventory transfer services.
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.
-
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.
-
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.
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.
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" : [ ] } }
Create Purchase Order Services
This section describes the Create Purchase Order Services section.
Functional Area
Procurement
Business Overview
The primary role of this service is to create purchase orders and send them to Merchandising.
Order Number
This section describes the Order Number.
Terms
This section describes the valid terms.
Business Overview
Retrieves all valid terms; valid terms are enabled with flag set to Yes and within the start and end active date.
Search Supplier
This section describes the Search Supplier service.
Business Overview
Supplier search can be, by entering either full or partial supplier site ID (numeric) or by a full or partial supplier site description in the search string.
Returned suppliers are constrained by the following criteria:
-
Only active supplier sites are returned.
-
When items are sent as input, then only supplier sites that are common amongst the items are returned.
-
When locations are sent as input, then only suppliers that are valid for the Org Units associated with the input locations are returned.
ReST URL
/PurchaseOrders/supplier?supplierSearchString={supplierSearchString}&locations={locations}&items={items}&pageSize={pageSize}&pageNumber={pageNumber}
Input Parameters
Parameter Name | Required | Description |
---|---|---|
SupplierSearchString |
Yes |
Search string for Supplier's ID or Name. |
Item |
No |
Comma Separated values for items. |
Locations |
No |
Comma Separated values for locations. |
PageSize |
No |
Maximum number of suppliers to retrieve per page. |
PageNumber |
No |
Result page to retrieve. |
Output
PoSupSearchResultRDO
Parameter Name | Data Type |
---|---|
supplier |
BigDecimal |
supplierName |
String |
supplierCurrency |
String |
terms |
String |
defaultItemLeadTime |
BigDecimal |
supplierSearchItemRDO |
List<PoSupItemResultRDO> |
supplierSearchItemLocRDO |
List<PoSupItemLocResultRDO> |
PoSupItemResultRDO
Parameter Name | Data Type |
---|---|
item |
String |
originCountryId |
String |
leadTime |
BigDecimal |
PoSupItemLocResultRDO
Parameter Name | Data Type |
---|---|
item |
String |
location |
BigDecimal |
pickupLeadTime |
BigDecimal |
PagedResultsRDO
Parameter Name | Data Type |
---|---|
totalRecordCount |
BigDecimal |
Next Page URL |
String |
Previous Page URL |
String |
JSON Structure: "{ ""links"": [], ""totalRecordCount"": 1, ""results"": [ { ""links"": [], ""supplier"": 2200, ""supplierName"": ""Our Supplier"", ""supplierCurrency"": ""USD"", ""terms"": ""04"", ""defaultItemLeadTime"": 2, ""supplierSearchItemRDO"": [ { ""links"": [], ""item"": ""100001887"", ""originCountryId"": ""US"", ""leadTime"": 2, ""hyperMediaContent"": { ""linkRDO"": [] } } ], ""supplierSearchItemLocRDO"": [ { ""links"": [], ""item"": ""100001887"", ""location"": 363640301, ""pickupLeadTime"": null, ""hyperMediaContent"": { ""linkRDO"": [] } } ], ""hyperMediaContent"": { ""linkRDO"": [] } } ], ""hyperMediaContent"": { ""linkRDO"": [] } }"
Load Supplier
This section describes the load supplier service.
Business Overview
Loading supplier Web service allows a user to refresh the selected supplier records.
Input Parameters
Parameter Name | Required | Description |
---|---|---|
Supplier |
Yes |
Supplier's ID. |
Item |
No |
Comma Separated values for items. |
Locations |
No |
Comma Separated values for locations. |
Output
PoSupSearchResultRDO
Parameter Name | Data Type |
---|---|
supplier |
BigDecimal |
supplierName |
String |
supplierCurrency |
String |
terms |
String |
defaultItemLeadTime |
BigDecimal |
supplierSearchItemRDO |
List<PoSupItemResultRDO> |
supplierSearchItemLocRDO |
List<PoSupItemLocResultRDO> |
PoSupItemResultRDO
Parameter Name | Data Type |
---|---|
item |
String |
originCountryId |
String |
leadTime |
BigDecimal |
PoSupItemLocResultRDO
Parameter Name | Data Type |
---|---|
item |
String |
location |
BigDecimal |
pickupLeadTime |
BigDecimal |
JSON Structure: "{ ""links"": [], ""totalRecordCount"": 1, ""results"": [ { ""links"": [], ""supplier"": 2200, ""supplierName"": ""Our Supplier"", ""supplierCurrency"": ""USD"", ""terms"": ""04"", ""defaultItemLeadTime"": 2, ""supplierSearchItemRDO"": [ { ""links"": [], ""item"": ""100001887"", ""originCountryId"": ""US"", ""leadTime"": 2, ""hyperMediaContent"": { ""linkRDO"": [] } } ], ""supplierSearchItemLocRDO"": [ { ""links"": [], ""item"": ""100001887"", ""location"": 363640301, ""pickupLeadTime"": null, ""hyperMediaContent"": { ""linkRDO"": [] } } ], ""hyperMediaContent"": { ""linkRDO"": [] } } ], ""hyperMediaContent"": { ""linkRDO"": [] } }"
Search Items
This section describes the Search Items service.
Business Overview
This service retrieves items applicable for Purchase Order. Item can be searched by either Item or VPN. 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
-
When search type is VPN, the search string can be a VPN or partial VPN.
The items returned are constrained by the following criteria:
-
Approved status.
-
Transaction-level items.
-
Orderable items.
-
Pack items with Order Type as Each are filtered out.
-
Only items belonging to Normal Merchandise Purchase Type as Department are retuned.
-
When a supplier is sent as input then:
-
Only items supplied by the input supplier are returned.
-
The item information is based on the Item/Supplier/Primary Origin Country.
-
-
When supplier is not sent as input, then item information is based on the primary supplier and primary origin country.
-
If the system_options.dept_level_orders is set to"Y" and the Department ID is sent as input, then only the input department items are returned.
-
Items set for deletion are filtered out.
ReST URL
/PurchaseOrders/item?itemSearchType={itemSearchType}&searchString={searchString}&dept={dept}&supplier={supplier}&locations={locations}&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 |
supplier |
No |
Selected Supplier ID. |
NA |
Locations |
No |
Comma Separated values for selected locations' ID. |
NA |
PageSize |
No |
Maximum number of items to retrieve per page. |
NA |
PageNumber |
No |
Result page to retrieve. |
NA |
Output
PoItemSearchResultRDO
Parameter Name | Data Type |
---|---|
item |
String |
itemDesc |
String |
supplier |
BigDecimal |
originCountry |
String |
suppPackSize |
BigDecimal |
unitCost |
BigDecimal |
supplierCurrency |
String |
baseUnitRetail |
BigDecimal |
retailCurrency |
String |
baseRetailUnitOfMeasure |
String |
itemImageUrl |
String |
dept |
BigDecimal |
itemSearchLocRDO |
List<PoItemSearchRstLocRDO> |
PoItemSearchRstLocRDO
Parameter Name | Data Type |
---|---|
location |
BigDecimal |
locationType |
String |
unitRetail |
BigDecimal |
retailCurrency |
String |
unitRetailUnitOfMeasure |
String |
itemLocStatus |
String |
PagedResultsRDO
Parameter Name | Data Type |
---|---|
totalRecordCount |
BigDecimal |
Next Page URL |
String |
Previous Page URL |
String |
JSON Structure: "{ ""links"": [], ""totalRecordCount"": 1, ""results"": [ { ""links"": [], ""item"": ""100001887"", ""itemDesc"": ""DIT Test 12:Black:Medium"", ""supplier"": 2200, ""originCountry"": ""US"", ""suppPackSize"": 1, ""unitCost"": 5, ""supplierCurrency"": ""USD"", ""baseUnitRetail"": 7.26, ""retailCurrency"": ""USD"", ""baseRetailUnitOfMeasure"": ""EA"", ""itemImageUrl"": null, ""dept"": 1102, ""itemSearchLocRDO"": [ { ""links"": [], ""location"": 363640301, ""locationType"": ""W"", ""unitRetail"": 7.26, ""retailCurrency"": ""USD"", ""unitRetailUnitOfMeasure"": ""CKG"", ""itemLocStatus"": ""A"", ""hyperMediaContent"": { ""linkRDO"": [] } } ], ""hyperMediaContent"": { ""linkRDO"": [] } } ], ""hyperMediaContent"": { ""linkRDO"": [] } }"
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
DAILY_PURGE |
Yes |
No |
No |
No |
DEPS |
Yes |
No |
No |
No |
ITEM_LOC |
Yes |
No |
No |
No |
ITEM_IMAGE |
Yes |
No |
No |
No |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_SUPPLIER |
Yes |
No |
No |
No |
ITEM_SUPP_COUNTRY |
Yes |
No |
No |
No |
MV_CURRENCY_CONVERSION_RATES |
Yes |
No |
No |
No |
RPM_MERCH_RETAIL_DEF_EXPL |
Yes |
No |
No |
No |
RPM_ZONE |
Yes |
No |
No |
No |
V_ITEM_MASTER |
Yes |
No |
No |
No |
V_PACKSKU_QTY |
Yes |
No |
No |
No |
V_SUPS |
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
The primary use of loading items Web service is to refresh already selected PO items records.
Input Parameters
Parameter Name | Required | Description |
---|---|---|
Items |
Yes |
Comma Separated values for selected items' ID. |
Supplier |
No |
Selected Supplier ID. |
Locations |
No |
Comma Separated values for selected locations' ID. |
Output
PoItemSearchResultRDO
Parameter Name | Data Type |
---|---|
item |
String |
itemDesc |
String |
supplier |
BigDecimal |
originCountry |
String |
suppPackSize |
BigDecimal |
unitCost |
BigDecimal |
supplierCurrency |
String |
baseUnitRetail |
BigDecimal |
retailCurrency |
String |
baseRetailUnitOfMeasure |
String |
itemImageUrl |
String |
dept |
BigDecimal |
itemSearchLocRDO |
List<PoItemSearchRstLocRDO> |
PoItemSearchRstLocRDO
Parameter Name | Data Type |
---|---|
location |
BigDecimal |
locationType |
String |
unitRetail |
BigDecimal |
retailCurrency |
String |
unitRetailUnitOfMeasure |
String |
itemLocStatus |
String |
PagedResultsRDO
Parameter Name | Data Type |
---|---|
totalRecordCount |
BigDecimal |
Next Page URL |
String |
Previous Page URL |
String |
JSON Structure: "{ ""links"": [], ""totalRecordCount"": 1, ""results"": [ { ""links"": [], ""item"": ""100001887"", ""itemDesc"": ""DIT Test 12:Black:Medium"", ""supplier"": 2200, ""originCountry"": ""US"", ""suppPackSize"": 1, ""unitCost"": 5, ""supplierCurrency"": ""USD"", ""baseUnitRetail"": 7.26, ""retailCurrency"": ""USD"", ""baseRetailUnitOfMeasure"": ""EA"", ""itemImageUrl"": null, ""dept"": 1102, ""itemSearchLocRDO"": [ { ""links"": [], ""location"": 363640301, ""locationType"": ""W"", ""unitRetail"": 7.26, ""retailCurrency"": ""USD"", ""unitRetailUnitOfMeasure"": ""CKG"", ""itemLocStatus"": ""A"", ""hyperMediaContent"": { ""linkRDO"": [] } } ], ""hyperMediaContent"": { ""linkRDO"": [] } } ], ""hyperMediaContent"": { ""linkRDO"": [] } }"
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
DAILY_PURGE |
Yes |
No |
No |
No |
DEPS |
Yes |
No |
No |
No |
ITEM_LOC |
Yes |
No |
No |
No |
ITEM_IMAGE |
Yes |
No |
No |
No |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_SUPPLIER |
Yes |
No |
No |
No |
ITEM_SUPP_COUNTRY |
Yes |
No |
No |
No |
MV_CURRENCY_CONVERSION_RATES |
Yes |
No |
No |
No |
RPM_MERCH_RETAIL_DEF_EXPL |
Yes |
No |
No |
No |
RPM_ZONE |
Yes |
No |
No |
No |
V_ITEM_MASTER |
Yes |
No |
No |
No |
V_PACKSKU_QTY |
Yes |
No |
No |
No |
V_SUPS |
Yes |
No |
No |
No |
WH |
Yes |
No |
No |
No |
JOB_AUDIT_LOGS |
No |
Yes |
No |
No |
JOB_AUDIT_PAYLOAD |
No |
Yes |
No |
No |
Search Locations
This section describes the Search Location service.
Business Overview
The Web service enables location search applicable for PO. Location can be searched by either 'S'tore or 'W'arehouse. 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:
-
Only stockholding locations are returned.
-
When search type is Warehouse then:
-
Only virtual warehouses are returned.
-
Internal finishers are filtered out.
-
-
When search type is store then only the following stores are returned:
-
Company stores.
-
Open stores.
-
-
When system_options.org_unit_ind is set as 'Y' then:
-
When supplier is sent as input then only locations with same org_unit_id are returned.
-
When Org Unit ID is sent as input then only locations with same org_unit_id are returned.
-
ReST URL
/PurchaseOrders/location?locationType={locationType}&searchString={searchString}&supplier={supplier}&orgUnitId={orgUnitId}&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 |
Supplier |
No |
Selected Supplier ID. |
NA |
OrgUnitId |
No |
Selected locations' Org unit ID. |
NA |
PageSize |
No |
Maximum number of locations to retrieve per page. |
NA |
PageNumber |
No |
Result page to retrieve. |
NA |
Output
PoLocSearchResultRDO
Parameter Name | Data Type |
---|---|
location |
BigDecimal |
locType |
String |
locName |
String |
locationCurrency |
String |
orgUnitId |
BigDecimal |
PagedResultsRDO
Parameter Name | Data Type |
---|---|
totalRecordCount |
BigDecimal |
Next Page URL |
String |
Previous Page URL |
String |
JSON Structure: "{ ""links"": [ { ""href"": ""/PurchaseOrders/location?searchString=e&pageSize=1&pageNumber=2"", ""rel"": ""next"", ""type"": ""GET"", ""methodType"": null } ], ""totalRecordCount"": 100, ""results"": [ { ""links"": [], ""location"": 292919862, ""locType"": ""S"", ""locName"": ""ALLOC_FD_Store_1_292919862"", ""locationCurrency"": ""USD"", ""orgUnitId"": 1111111111, ""hyperMediaContent"": { ""linkRDO"": [] } } ], ""hyperMediaContent"": { ""linkRDO"": [ { ""href"": ""/PurchaseOrders/location?searchString=e&pageSize=1&pageNumber=2"", ""rel"": ""next"", ""type"": ""GET"", ""methodType"": null } ] } }"
Load Locations
This section describes the Load Locations service.
Business Overview
This Web service allows the user to refresh already selected PO locations records.
Input Parameters
Parameter Name | Required | Description |
---|---|---|
Locations |
Yes |
Comma Separated values for selected locations' ID. |
Supplier |
No |
Selected Supplier ID. |
Output
PoLocSearchResultRDO
Parameter Name | Data Type |
---|---|
location |
BigDecimal |
locType |
String |
locName |
String |
locationCurrency |
String |
orgUnitId |
BigDecimal |
JSON Structure: " { ""links"": [], ""location"": 292919862, ""locType"": ""S"", ""locName"": ""ALLOC_FD_Store_1_292919862"", ""locationCurrency"": ""USD"", ""orgUnitId"": 1111111111, ""hyperMediaContent"": { ""linkRDO"": [] } }"
Create Purchase Order
This section describes the Create Purchase Order service.
Business Overview
This Web service calls the existing Merchandising XOrder API directly with input parameters. For more information on Merchandising XOrder API, see the sections addressing both the Store Order Subscription API and the PO Subscription API.
Input Parameters
Example json RDO input:
{ "links" : [ ], "itemRDOs" : [ { "links" : [ ], "item" : null, "location" :null, "unitCost" : null, "referenceItem" : null, "originCountryId" : null, "suppPackSize" : null, "qtyOrdered" : null, "locationType" : null, "cancelInd" : null, "reInstateInd" : null, "hyperMediaContent" : { "linkRDO" : [ ] } } ], "orderNo" : null, "supplier" : null, "currencyCode" : null, "terms" : null, "notBeforeDate" : null, "notAfterDate" : null, "status" : "A", "writtenDate" : null, "origInd" : null, "user_id" : null, "dept" : null, "exchangeRate" : null, "includeOnOrdInd" : null, "ediPoInd" : null, "preMarkInd" : null, "comment" : null, "otbEowDate" : null, "hyperMediaContent" : { "linkRDO" : [ ] } }
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.
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": [] } } ]
Customer Order Services
This section describes the Customer Order Fulfillment Services:
Cancel Customer Order Fulfillment Service
Business Overview
This service is used to process Customer Order Fulfillment cancellation requests from an order management system (OMS). Merchandising supports three integration methods for processing Customer Order Fulfillment messages from OMS - either through RIB, SOAP service or REST service. At implementation time, you should decide on either RIB or web service for the integration method, but not both. However, if you choose web service, you can choose to call the SOAP service or the REST service or do a load share by splitting service calls between REST and SOAP calls. The same core logic is used to validate and persist customer orders in all three methods. In a web service implementation, the REST service is used to cancel a customer order in Merchandising.
-
Success response: 200
-
Error response: 400
This service:
-
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 cancelled due to validation errors.
In a web service implementation, confirmation messages will be sent in a collection as part of the response object. This is the web service version of the same logic supported in the RIB version of the API. See Customer Order Fulfillment Subscription API in RIB Subscription Designs for more information.
Input Parameters
Table 5-1 fulfilOrdColRef - Collection of customer fulfillment order cancellation request
Parameter Name | Required | Data Type | Description |
---|---|---|---|
fulfillOrderReferences |
Yes |
Collection of Record |
References a collection of cancellation records |
Table 5-2 fulfillOrderReferences – Customer fulfillment order Reference
Parameter Name | Required | Data Type | Description |
---|---|---|---|
customerOrderNo |
Yes |
String |
Holds the master customer order number from OMS. |
fulfillOrderNo |
Yes |
String |
Unique number from OMS related to the fulfillment details. One or more fulfillment orders could relate back to a single customer order in OMS. |
sourceLocType |
No |
String |
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. |
sourceLocId |
No |
Number |
Indicates the supplier, store or warehouse number associated with sourcing the customer order. Only populated for vendor, warehouse or multi-site fulfillment orders. |
fulfillLocType |
No |
String |
This would be either 'S' (for physical store) or 'V' (for virtual store). |
fulfillLocId |
Yes |
Number |
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. |
orderDetails |
Yes |
Collection of Record |
Indicates the customer order fulfillment cancellation detail. |
Table 5-3 orderDetails – Customer fulfillment order details
Parameter Name | Required | Data Type | Description |
---|---|---|---|
item |
Yes |
String |
Indicates the item ordered by the customer. |
referenceItem |
No |
String |
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. |
cancelQtySuom |
Yes |
Number |
Indicates the quantity that should be cancelled from the order in item's standard unit of measure. |
standardUom |
No |
String |
Indicates item's standard unit of measure. |
transactionUom |
No |
String |
Indicates the original transaction unit of measure the order is placed in. |
itemLineNo |
No |
Number |
Indicates the detail item line number on the order. |
Sample Input Message
{
"fulfillOrderReferences": [
{
"customerOrderNo": "123252156",
"fulfillOrderNo": "1231213",
"sourceLocType": "ST",
"sourceLocId": 6000,
"fulfillLocType": "S",
"fulfillLocId": 1311,
"orderDetails": [
{
"item": "101450060",
"referenceItem": "",
"cancelQtySuom": 3,
"standardUom": "EA",
"transactionUom": "EA",
"itemLineNo": 1
}
]
}
]
}
Output
Response Code: 200 – Success
Table 5-4 invocationSuccess – Webservice invocation success response
Parameter Name | Required | Data Type | Description |
---|---|---|---|
message |
Yes |
String |
Message indicating the call was successful |
Example
{
"message": "string"
}
Output
Response Code: 400 – Error
Table 5-5 RetailRestValidationException – Exception Record
Parameter Name | Required | Data Type | Description |
---|---|---|---|
message |
Yes |
String |
Error Message |
errors |
Yes |
Collection of String |
Details of the errors |
Example
{
"message": "string",
"errors": [
"Additional information 1",
"Additional information 2"
]
}
Create Customer Order Fulfillment Service
Business Overview
This service is used to process Customer Order Fulfillment requests from an order management system (OMS). Merchandising supports three integration methods for processing Customer Order Fulfillment messages from OMS - either through RIB, SOAP service or REST service. At implementation time, you should decide on either RIB or web service as the integration method, but not both. However, if you choose web service, you can choose to call the SOAP service, or the REST service, or do a load share by splitting service calls between REST and SOAP calls. The same core logic is used to validate and persist customer orders in all three methods. In a web service implementation, this REST service is used to create a customer order in Merchandising.
-
Success response: 200
-
Error response: 400
This service:
-
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
-
In a web service implementation, confirmation messages will be sent in a collection as part of the response object.
This is the web service version of the same logic as is supported in the RIB version of the API. See Customer Order Fulfillment Subscription API in RIB Subscription Designs for more information.
Input Parameters
Table 5-6 fulfilOrdColDesc - Collection of Customer order fulfillment order records
Parameter Name | Required | Data Type | Description |
---|---|---|---|
customerOrderNo |
Yes |
String |
Holds the master customer order number from OMS. |
fulfillOrderNo |
Yes |
String |
Unique number from OMS related to the fulfillment details. One or more fulfillment orders could relate back to a single customer order in OMS. |
sourceLocType |
No |
String |
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. |
sourceLocId |
No |
Number |
Indicates the supplier, store or warehouse number associated with sourcing the customer order. Only populated for vendor, warehouse or multi-site fulfillment orders. |
fulfillLocType |
No |
String |
This would be either 'S' (for physical store) or 'V' (for virtual store). |
fulfillLocId |
Yes |
Number |
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 |
Indicates if the order can be picked and shipped partially ('N') or if it should be shipped only when complete ('Y'). |
deliveryType |
No |
String |
Indicates the fulfillment method - ship to customer or store pickup. Expected values are 'S' (ship direct) and 'C' (customer pickup). |
carrierCode |
No |
String |
Indicates the carrier the order is to be shipped with, if specified on the order. |
carrierServiceCode |
No |
String |
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. The format should be yyyy-mm-dd |
consumerDeliveryTime |
No |
Date |
Indicates the desired time the delivery is required by the customer. This will be the GMT time. The format should be yyyy-mm-ddThh:mi:ssZ |
deliveryCharges |
No |
Number |
Contains the delivery charges on drop ship. Mostly relevant for Brazil. |
deliveryChargesCurr |
No |
String |
Contains the currency of the delivery charges. |
comments |
No |
String |
Any comments sent by OMS about the order. |
customerDetail |
No |
Record |
Reference object for customer information related to the order. |
orderDetails |
Yes |
Collection of Record |
References a collection of customer order fulfillment details. |
orderPlacedStore |
No |
Number |
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-7 orderDetails – Customer fulfillment order details
Parameter Name | Required | Data Type | Description |
---|---|---|---|
item |
Yes |
String |
Indicates the item ordered by the customer. |
referenceItem |
No |
String |
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. |
orderQtySuom |
Yes |
Number |
Indicates the quantity of the item ordered by the customer in item's standard unit of measure. |
standardUom |
No |
String |
Indicates item's standard unit of measure. |
transactionUom |
No |
String |
Indicates the original transaction unit of measure the order is placed in. |
substituteInd |
Yes |
String |
Indicates if substitutes are allowed on a customer order. This will only be used by orders passed to SIM. |
unitRetail |
No |
Number |
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 |
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 |
Used to indicate any special instructions for the item, such as services (monograms, engrave, etc). |
itemLineNo |
No |
Number |
Indicates the detail item line number on the order. |
Table 5-8 customerDetail – Customer information record
Parameter Name | Required | Data Type | Description |
---|---|---|---|
customerNo |
No |
String |
Indicates the number that uniquely identifies the customer in OMS. |
deliverFirstName |
No |
String |
Contains the first name for the delivery address on the order. |
deliverPhoneticFirst |
No |
String |
Contains the phonetic first name for the delivery address on the order. |
deliverLastName |
No |
String |
Contains the last name for the delivery address on the order. |
deliverPhoneticLast |
No |
String |
Contains the phonetic last name for the delivery address on the order. |
deliverPreferredName |
No |
String |
Contains the preferred name for the delivery address on the order. |
deliverCompanyName |
No |
String |
Contains the company name for the delivery address on the order. |
deliverAddress1 |
No |
String |
First line of the delivery address for the customer. |
deliverAddress2 |
No |
String |
Second line of the delivery address for the customer. |
deliverAddress3 |
No |
String |
Third line of the delivery address for the customer. |
deliverCounty |
No |
String |
County portion of the delivery address. |
deliverCity |
No |
String |
City portion of the delivery address. |
deliverState |
No |
String |
State portion of the delivery address. |
deliverCountryId |
No |
String |
Country portion of the delivery address. |
deliverPost |
No |
String |
Postal code portion of the delivery address. |
deliverJurisdiction |
No |
String |
Identifies the jurisdiction code for the delivery country-state relationship. |
deliverPhone |
No |
String |
Contains the delivery phone number. |
deliverEmail |
No |
String |
Contains the delivery email. |
billFirstName |
No |
String |
Contains the first name for the billing address on the order. |
billPhoneticFirst |
No |
String |
Contains the phonetic first name for the billing address on the order. |
billLastName |
No |
String |
Contains the last name for the billing address on the order. |
billPhoneticLast |
No |
String |
Contains the phonetic last name for the billing address on the order. |
billPreferredName |
No |
String |
Contains the preferred name for the billing address on the order. |
billCompanyName |
No |
String |
Contains the company name for the billing address on the order. |
billAddress1 |
No |
String |
First line of the billing address for the customer. |
billAddress2 |
No |
String |
Second line of the billing address for the customer. |
billAddress3 |
No |
String |
Third line of the billing address for the customer. |
billCounty |
No |
String |
County portion of the billing address. |
billCity |
No |
String |
City portion of the billing address. |
billState |
No |
String |
State portion of the billing address. |
billCountryId |
No |
String |
Country portion of the billing address. |
billPost |
No |
String |
Postal code portion of the billing address. |
billJurisdiction |
No |
String |
Identifies the jurisdiction code for the billing country-state relationship. |
billPhone |
No |
String |
Contains the billing phone number. |
billEmail |
No |
String |
Contains the billing email. |
Sample Input Message
{
"fulfillOrders": [
{
"customerOrderNo": "12342132156",
"fulfillOrderNo": "123123213",
"sourceLocType": "ST",
"sourceLocId": 6000,
"fulfillLocType": "S",
"fulfillLocId": 1311,
"partialDeliveryInd": "N",
"deliveryType": "S",
"carrierCode": "30",
"carrierServiceCode": "D",
"consumerDeliveryDate": "2022-12-31",
"consumerDeliveryTime": "2022-12-31T23:59:59.000Z",
"deliveryCharges": 3,
"deliveryChargesCurrency": "USD",
"comments": "commentDesc",
"customerDetail": {
"customerNo": "123456",
"deliverFirstName": "First",
"deliverPhoneticFirst": "First",
"deliverLastName": "Last",
"deliverPhoneticLast": "Last",
"deliverPreferredName": "Preferred Name",
"deliverCompanyName": "Company Name",
"deliverAddress1": "101 First Street",
"deliverAddress2": "201 Second Street",
"deliverAddress3": "301 Third Street",
"deliverCounty": "Some County",
"deliverCity": "Minneapolis",
"deliverState": "MN",
"deliverCountryId": "US",
"deliverPost": "55555-1234",
"deliverJurisdiction": "",
"deliverPhone": "1800800800",
"deliverEmail": "someone@email.com",
"billFirstName": "First",
"billPhoneticFirst": "First",
"billLastName": "Last",
"billPhoneticLast": "Last",
"billPreferredName": "billPreferredName",
"billCompanyName": "billCompanyName",
"billAddress1": "101 First Street",
"billAddress2": "201 Second Street",
"billAddress3": "301 Third Street",
"billCounty": "Some County",
"billCity": "Minneapolis",
"billState": "MN",
"billCountryId": "US",
"billPost": "55555-1234",
"billJurisdiction": "",
"billPhone": "1800800800",
"billEmail": "someone@email.com"
},
"orderDetails": [
{
"item": "101450060",
"referenceItem": "",
"orderQtySuom": 3,
"standardUom": "EA",
"transactionUom": "EA",
"substituteInd": "N",
"unitRetail": 12,
"retailCurrrency": "USD",
"comments": "commentDesc",
"itemLineNo": 1
}
],
"orderPlacedStore": 1311
}
]
}
Output
Response Code: 200 – Success
Table 5-9 fulfilOrdCfmCol - Customer fulfillment order confirmation collection
Parameter Name | Required | Data Type | Description |
---|---|---|---|
collectionSize |
No |
Number |
Number of records in the collection |
fulfillOrderConfirmations |
No |
Collection of Record |
Array of fulfillment order confirmation response |
Table 5-10 fulfillOrderConfirmations – Customer fulfillment order confirmation record
Parameter Name | Required | Data Type | Description |
---|---|---|---|
customerOrderNo |
Yes |
String |
Holds the master customer order number from OMS. |
fulfillOrderNo |
Yes |
String |
Unique number from OMS related to the fulfillment details. One or more fulfillment orders could relate back to a single customer order in OMS. |
confirmType |
Yes |
String |
Contains the confirmation type. 'P' - Order Partially Created; 'X' - Order Could not be Created; 'C' - Order Completely Created. |
confirmNo |
No |
Number |
Contains the PO or Transfer number in RMS related to the fulfillment order line. Required if fulfillment status is 'P'. |
orderDetails |
No |
Collection of Record |
References a collection of customer order confirmation item details. |
fulfillLocId |
No |
Number |
Contains the fulfillment location for the order. |
systemCode |
No |
String |
The code identifying the system associated with the location. |
Table 5-11 orderDetails - Customer order confirmation item details
Parameter Name | Required | Data Type | Description |
---|---|---|---|
item |
Yes |
String |
Indicates the item ordered by the customer. |
referenceItem |
No |
String |
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. |
confirmQty |
Yes |
Number |
Indicates the quantity of the item that can be sourced or fulfilled on the order. |
confirmQtyUom |
Yes |
String |
Indicates the unit of measure of the confirmation quantity. |
itemLineNo |
No |
Number |
Indicates the detail item line number on the order. |
Success Output Example
{
"collectionSize": 1,
"fulfillOrderConfirmations": [
{
"customerOrderNo": "123456",
"fulfillOrderNo": "123456",
"confirmType": "P",
"confirmNo": 9999999,
"orderDetails": [
{
"item": "100100076",
"referenceItem": "",
"confirmQty": 3,
"confirmQtyUom": "EA",
"itemLineNo": 1
}
],
"fulfillLocId": 6000,
"systemCode": "INV"
}
]
}
Output
Response Code: 400 – Error
Table 5-12 RetailRestValidationException – Exception Record
Parameter Name | Required | Data Type | Description |
---|---|---|---|
message |
Yes |
String |
Error Message |
errors |
Yes |
Collection of String |
Details of the errors |
Error Output Example
{
"message": "string",
"errors": [
"Additional information 1",
"Additional information 2"
]
}
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.
ReSTURL
https://<host:port>/RetailAppsDataPrivServicesRESTApp/rest/privatedata/getPersonalInfo?customer_id={entityName}::{entityType}::{entityId}::{fullName}:: {phone}::{email}
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:
|
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:
|
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. |
|
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:
|
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:
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. |
|
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)
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.
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}
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:
|
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:
|
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. |
|
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).
Diff Detail Service
This section describes the Diff Detail service.
Business Overview
Diff Detail service allows user to retrieve Diff description for a selected Diff Id.
Output
RestDiffIdsRecRDO
Parameter Name | Data Type |
---|---|
industrySubgroup |
String |
diffGroupDesc |
String |
diffType |
String |
diffDesc |
String |
industryCode |
String |
diffGroupId |
String |
diffTypeDesc |
String |
JSON Structure { "industrySubgroup": null, "diffGroupDesc": null, "diffType": null, "diffDesc": "null, "industryCode": null, "diffGroupId": null, "diffTypeDesc": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
EOW Run Signal Service
Business Overview
This service is used to determine whether the Vdate is an End of Week Date or Not.
If Vdate is at EOW, it returns 'Y', else 'N'.
Half Data Budget Service
Business Overview
The primary role of this service is to modify half data budgets and send them to Merchandising.
Modify Half Data Budget
Business Overview
This service modifies half data budget by calling the SVCPROV_HDB package to load input data to the staging tables and then calling the core half data budget package to validate and insert data to the Merchandising tables.
Input Parameters
SvcprovHdbdescRecRDO
Parameter Name | Data Type |
---|---|
dept |
BigDecimal |
halfNo |
BigDecimal |
locType |
String |
location |
BigDecimal |
setOfBooksId |
BigDecimal |
cumMarkonPct |
BigDecimal |
shrinkagePct |
BigDecimal |
markdownPct |
BigDecimal |
JSON Structure: [ { "dept": null, "halfNo": null, "locType": null, "location": null, "setOfBooksId": null, "cumMarkonPct": null, "shrinkagePct": null, "markdownPct": null } ]
Output
SvcprovHdbStatusRecRDO
Parameter Name | Data Type |
---|---|
statusMsg |
String |
hdbErrTbl |
List< SvcprovFailHdbRecRDO> |
SvcprovFailHdbRecRDO
Parameter Name | Data Type |
---|---|
dept |
BigDecimal |
halfNo |
BigDecimal |
locType |
String |
location |
BigDecimal |
setOfBooksId |
BigDecimal |
errorMsg |
String |
The output will contain the status of the request including validation errors, if any.
JSON Structure: { "statusMsg": null, " hdbErrTbl ": [ { "dept": null, "halfNo": null, "locType": null, "location": null, "setOfBooksId": null, "errorMsg": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "links": [], "hyperMediaContent": { "linkRDO": [] } }
Inventory Adjustment Service
This section describes the Inventory Adjustment service.
Business Overview
The primary role of this service is to create inventory adjustment and send them to Merchandising.
Inventory Adjustment
Business Overview
This service creates inventory adjustment by calling the package SVCPROV_INVADJ to load input data to the staging tables and then calling the core inventory adjustment package to validate and insert data to the Merchandising tables.
Input Parameters
SvcprovInvadjdescRecRDO
Parameter Name | Data Type |
---|---|
location |
BigDecimal |
Invadjdtl |
List<SvcprovInvadjdescdtlRecRDO> |
SvcprovInvadjdescdtlRecRDO
Parameter Name | Data Type |
---|---|
unitQty |
BigDecimal |
toDisposition |
String |
adjReasonCode |
BigDecimal |
docType |
String |
toWipCode |
String |
item |
String |
poNbr |
String |
auxReasonCode |
String |
weight |
BigDecimal |
toTroubleCode |
String |
fromWipCode |
String |
weightUom |
String |
unitCost |
BigDecimal |
fromTroubleCode |
String |
transshipmentNumber |
String |
fromDisposition |
String |
transactionCode |
BigDecimal |
adjTranDate |
Date (Format: ‘YYYY-MM-DD’) |
JSON Structure:
[ {"location":null, "invadjdtl":[ { "unitQty":null, "toDisposition":null, "adjReasonCode":null, "docType":null, "toWipCode":null, "item":null, "poNbr":null, "auxReasonCode":null, "weight":null, "toTroubleCode":null, "fromWipCode":null, "weightUom":null, "unitCost":null, "fromTroubleCode":null, "transshipmentNumber":null, "fromDisposition":null, "transactionCode":null, "adjTranDate":null } ] } ]
Output
SvcprovInvadjStatusRecRDO
Parameter Name | Data Type |
---|---|
statusMsg |
String |
invadjErrTbl |
List< SvcprovFailInvadjRecRDO > |
SvcprovFailInvadjRecRDO
Parameter Name | Data Type |
---|---|
location |
BigDecimal |
unitQty |
BigDecimal |
adjReasonCode |
BigDecimal |
item |
String |
errorMsg |
String |
The output will contain the status of the request including validation errors, if any.
JSON Structure:
{ "statusMsg": null, " invadjErrTbl ": [ { " location": null, "unitQty": null, " adjReasonCode": null, " item": null, "errorMsg": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "links": [], "hyperMediaContent": { "linkRDO": [] } }
Item Detail Service
This section describes the Item Detail service.
Output
RestItemRecRDO
Parameter Name | Data Type |
---|---|
itemGrandparent |
String |
itemParent |
String |
item |
String |
itemDesc |
String |
shortDesc |
String |
packInd |
String |
status |
String |
itemLevel |
BigDecimal |
tranLevel |
BigDecimal |
dept |
BigDecimal |
classAttribute |
BigDecimal |
subclass |
BigDecimal |
diff1 |
String |
diff2 |
String |
diff3 |
String |
diff4 |
String |
primaryRefItemInd |
String |
originalRetail |
BigDecimal |
sellableInd |
String |
orderableInd |
String |
inventoryInd |
String |
packitemBreakout |
List<RestPackitemBreakoutRecRDO> |
itemSupplier |
List<RestItemSupplierRecRDO> |
itemSupplierCountry |
List<RestItemSupplierCountryRecRDO> |
vatItem |
List<RestVatItemRecRDO> |
RestPackitemBreakoutRecRDO
Parameter Name | Data Type |
---|---|
item |
String |
seqNo |
BigDecimal |
packItemQty |
BigDecimal |
RestItemSupplierRecRDO
Parameter Name | Data Type |
---|---|
supplier |
BigDecimal |
vpn |
String |
primarySuppInd |
String |
directShipInd |
String |
RestItemSupplierCountryRecRDO
Parameter Name | Data Type |
---|---|
originCountryId |
String |
primaryCountryInd |
String |
unitCost |
BigDecimal |
suppPackSize |
BigDecimal |
innerPackSize |
BigDecimal |
leadTime |
BigDecimal |
pickupLeadTime |
BigDecimal |
RestVatItemRecRDO
Parameter Name | Data Type |
---|---|
vatRegion |
BigDecimal |
vatType |
String |
vatCode |
String |
vatRate |
BigDecimal |
activeDate |
Timestamp |
JSON Structure: { "itemGrandparent": null, "itemParent": null, "item": null, "itemDesc": null, "shortDesc": null, "packInd": null, "status": null, "itemLevel": null, "tranLevel": null, "dept": null, "classAttribute": null, "subclass": null, "diff1": null, "diff2": null, "diff3": null, "diff4": null, "primaryRefItemInd": null, "originalRetail": null, "sellableInd": null, "orderableInd": null, "inventoryInd": null, "packitemBreakout": [], "itemSupplier": [ { "primarySuppInd": null, "itemSupplierCountry": [ { "unitCost": null, "leadTime": null, "suppPackSize": null, "originCountryId": null, "primaryCountryInd": null, "pickupLeadTime": null, "innerPackSize": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "supplier": null, "vpn": null, "directShipInd": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "vatItem": [ { "vatRegion": null, "activeDate": null, "vatType": null, "vatCode": null, "vatRate": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "links": [], "hyperMediaContent": { "linkRDO": [] } }
Item Loc Inventory Detail Service
This section describes the Item Loc Inventory Detail service.
Business Overview
Item Loc Inventory Detail service allows user to retrieve Item Location and Item Location Stock on Hand information for a selected item and location. If location and location type are not specified, all locations for the item will be retrieved. If location type is specified but not the location, all locations for the item and location type will be retrieved.
ReST URL
ItemlocInvDtl/itemlocInvDetail?item={itemNumber}&location={locationNumber}&locationType={locationType}
Input Parameters
Parameter Name | Required | Description |
---|---|---|
Item |
Yes |
Item ID |
Location |
No |
Location ID. |
Location Type |
No |
Location Type. |
Output
RestItemlocInvDtlRecRDO
Parameter Name | Data Type |
---|---|
item |
String |
itemParent |
String |
loc |
BigDecimal |
locType |
String |
unitRetail |
BigDecimal |
sellingUom |
String |
clearInd |
String |
taxableInd |
String |
localItemDesc |
String |
status |
String |
primarySupp |
BigDecimal |
primaryCntry |
String |
avCost |
BigDecimal |
unitCost |
BigDecimal |
stockOnHand |
BigDecimal |
sohUpdateDatetime |
Timestamp |
inTransitQty |
BigDecimal |
packCompSoh |
BigDecimal |
packCompResv |
BigDecimal |
packCompExp |
BigDecimal |
rtvQty |
BigDecimal |
customerResv |
BigDecimal |
sellingUnitRetail |
BigDecimal |
localShortDesc |
String |
packCompIntran |
BigDecimal |
tsfReservedQty |
BigDecimal |
tsfExpectedQty |
BigDecimal |
nonSellableQty |
BigDecimal |
customerBackorder |
BigDecimal |
packCompCustResv |
BigDecimal |
packCompCustBack |
BigDecimal |
packCompNonSellable |
BigDecimal |
firstReceived |
Timestamp |
lastReceived |
Timestamp |
JSON Structure: { "item": null, "itemParent": null, "loc": null, "locType": null, "unitRetail": null, "sellingUom": null, "clearInd": null, "taxableInd": null, "localItemDesc": null, "status": null, "primarySupp": null, "primaryCntry": null, "avCost": null, "unitCost": null, "stockOnHand": null, "sohUpdateDatetime": null, "inTransitQty": null, "packCompSoh": null, "packCompResv": null, "packCompExp": null, "rtvQty": null, "customerResv": null, "sellingUnitRetail": null, "localShortDesc": null, "packCompIntran": null, "tsfReservedQty": null, "tsfExpectedQty": null, "nonSellableQty": null, "customerBackorder": null, "packCompCustResv": null, "packCompCustBack": null, "packCompNonSellable": null, "firstReceived": null, "lastReceived": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
MerchHierarchy Detail Service
This section describes the MerchHierarchy Detail service.
Business Overview
MerchHierarchyDetail service allows user to retrieve full merchandising hierarchy information.
Output
RestMerchHierarchyRecRDO
Parameter Name | Data Type |
---|---|
profitCalcType |
BigDecimal |
deptVatInclInd |
String |
classAttribute |
BigDecimal |
division |
BigDecimal |
classVatInd |
String |
subclass |
BigDecimal |
buyer |
BigDecimal |
dept |
BigDecimal |
className |
String |
subName |
String |
groupNo |
BigDecimal |
otbCalcType |
String |
groupName |
String |
divName |
String |
purchaseType |
BigDecimal |
merch |
BigDecimal |
deptName |
String |
JSON Structure { "profitCalcType": null, "deptVatInclInd": null, "classAttribute": null, "division": null, "classVatInd": null, "subclass": null, "buyer": null, "dept": null, "className": null, "subName": null, "groupNo": null, "otbCalcType": null, "groupName": null, "divName": null, "purchaseType": null, "merch": null, "deptName": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
Obligations Upload Services
This section describes the Obligations Upload Services.
Business Overview
The primary role of these services is to support requests from trading partners or suppliers for bulk uploads of obligations to send to Merchandising.
Create Obligation
Business Overview
This service creates obligations by calling the SVCPROV_OBLIGATION package and then calling the core obligation package to validate and insert data into the Merchandising tables.
This service creates obligations with required fields. At least one component is needed to create a successful obligation. If the obligation level is 'PO' or 'POIT', then component locations can be added. Reallocation to ALC will be done after obligation creation. If an obligation is created in approved status, then an invoice will be created.
Service Type
Post
ReST URL
/ObligationUpload/createObligation
Input Parameters
RestObligationRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
obligationLevel |
String |
keyValue1 |
String |
keyValue2 |
String |
keyValue3 |
String |
keyValue4 |
String |
keyValue5 |
String |
keyValue6 |
String |
status |
String |
partnerType |
String |
partnerId |
String |
supplierSite |
String |
invoice |
String |
invoiceDate |
Timestamp |
qty |
BigDecimal |
qtyUom |
String |
currency |
String |
exchangeRate |
BigDecimal |
checkAuthNo |
String |
paidAmt |
BigDecimal |
paidDate |
Timestamp |
comments |
String |
obligationCompTbl |
List<RestObligationCompRecRDO> |
RestObligationCompRecRDO
Parameter Name | Data Type |
---|---|
compId |
String |
allocateToAlc |
String |
allocationType |
String |
allocationBasisUom |
String |
amt |
BigDecimal |
rate |
BigDecimal |
perCount |
BigDecimal |
perCountUom |
String |
obligationCompLocTbl |
List<RestObligationCompLocRecRDO> |
RestObligationCompLocRecRDO
Parameter Name | Data Type |
---|---|
action |
String |
locType |
String |
locId |
BigDecimal |
qty |
BigDecimal |
amt |
BigDecimal |
JSON Structure
invoiceDate and paidDate will take input in strings the 'YYYY-MM-DD' format that will be converted to Timestamp format and inserted into tables.
[{ "obligationKey": null, "obligationLevel":null , "keyValue1":null, "keyValue2":null, "keyValue3":null, "keyValue4":null, "keyValue5":null, "keyValue6":null, "status":null, "partnerType":null, "partnerId":null, "supplierSite":null, "invoice":null, "invoiceDate":null, "qty":null, "qtyUom":null, "exchangeRate":null, "currency":null, "paymentMethod":null, "checkAuthNo":null, "paidAmt":null, "paidDate":null, "comments":null, "obligationCompTbl" : [{ "compId":null, "allocateToAlc":null, "allocationType":null, "allocationBasisUom": null, "amt":null, "rate":null, "perCount":null, "perCountUom":null, "obligationCompLocTbl":[{ "action":null, "locType":null, "locId": null, "qty":null, "amt":null}] }] }]
Output
RestObligationStatusRecRDO
Parameter Name | Data Type |
---|---|
successObligationTbl |
List<RestObligationSuccessRecRDO> |
successObligationCount |
BigDecimal |
failObligationTbl |
List<RestObligationFailRecRDO> |
failObligationCount |
BigDecimal |
RestObligationSuccessRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
RestObligationFailRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
errorMessage |
String |
The output will contain the status of the request including validation error, if any.
It will insert data into the obligation, obligation_comp and obligation_comp_loc tables, based on obligation levels. It will also insert data to ALC tables. For an approved obligation, it will insert data to INVC tables.
For Success:
{ "successObligationTbl": [ { "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "successObligationCount": null, "failObligationTbl": [], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
For Failure:
{ "successObligationTbl": [], "successObligationCount": null, "failObligationTbl": [ { "errorMessage": null, "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
OBLIGATION |
No |
Yes |
No |
No |
OBLIGATION_COMP |
No |
Yes |
No |
No |
OBLIGATION_COMP_LOC |
No |
Yes |
No |
No |
ORDHEAD |
Yes |
No |
No |
No |
ORDSKU |
Yes |
No |
No |
No |
ORDLOC |
Yes |
No |
No |
No |
TRANSPORTATION |
Yes |
No |
No |
No |
SHIPMENT |
Yes |
No |
No |
No |
SHIPSKU |
Yes |
No |
No |
No |
V_PACKSKU_QTY |
Yes |
No |
No |
No |
ITEM_SUPP_COUNTRY |
Yes |
No |
No |
No |
ORDLOC_EXP |
Yes |
No |
No |
No |
CE_HEAD |
Yes |
No |
No |
No |
ELC_COMP |
Yes |
No |
No |
No |
RTM_UNIT_OPTIONS |
Yes |
No |
No |
No |
ALC_HEAD |
Yes |
Yes |
Yes |
No |
ALC_COMP_LOC |
Yes |
Yes |
Yes |
No |
INVC_HEAD |
No |
Yes |
No |
No |
INVC_NON_MERCH |
No |
Yes |
No |
No |
INVC_XREF |
No |
Yes |
No |
No |
Create Obligation Component
Business Overview
This service creates obligation components for existing pending obligations by calling the SVCPROV_OBLIGATION package and then calling the core obligation package to validate and insert data into the Merchandising tables.
This service accepts an obligation key, or supplier/invoice, or partner type/partner/invoice combination to identify the existing obligation. Add component details which user wants to create. For obligation levels 'PO' and 'POIT', the user can also add location details. Based on validations, components will also be created. Reallocation to ALC will be done after component creation.
Service Type
Post
ReST URL
/ObligationUpload/createObligationComp
Input Parameters
RestObligationRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
obligationLevel |
String |
keyValue1 |
String |
keyValue2 |
String |
keyValue3 |
String |
keyValue4 |
String |
keyValue5 |
String |
keyValue6 |
String |
Status |
String |
partnerType |
String |
partnerId |
String |
supplierSite |
String |
invoice |
String |
invoiceDate |
Timestamp |
Qty |
BigDecimal |
qtyUom |
String |
Currency |
String |
exchangeRate |
BigDecimal |
checkAuthNo |
String |
paidAmt |
BigDecimal |
paidDate |
Timestamp |
Comments |
String |
obligationCompTbl |
List<RestObligationCompRecRDO> |
RestObligationCompRecRDO
Parameter Name | Data Type |
---|---|
compId |
String |
allocateToAlc |
String |
allocationType |
String |
allocationBasisUom |
String |
Amt |
BigDecimal |
Rate |
BigDecimal |
perCount |
BigDecimal |
perCountUom |
String |
obligationCompLocTbl |
List<RestObligationCompLocRecRDO> |
RestObligationCompLocRecRDO
Parameter Name | Data Type |
---|---|
Action |
String |
locType |
String |
locId |
BigDecimal |
Qty |
BigDecimal |
Amt |
BigDecimal |
JSON Structure: The same RDO 'RestObligationRecRDO' will be used for createObligationComp, but only the below parameters will be considered for the request. The rest of the parameters will be ignored.
[{ "obligationKey": null, "partnerType":null, "partnerId":null, "supplierSite":null, "invoice":null, "obligationCompTbl" : [ { "compId":null, "allocateToAlc":null, "allocationType":null, "allocationBasisUom": null, "amt":null, "rate":null, "perCount":null, "perCountUom":null, "obligationCompLocTbl":[ { "action":null, "locType":null, "locId": null, "qty":null, "amt":null}] }] }]
Output
RestObligationStatusRecRDO
Parameter Name | Data Type |
---|---|
successObligationTbl |
List<RestObligationSuccessRecRDO> |
successObligationCount |
BigDecimal |
failObligationTbl |
List<RestObligationFailRecRDO> |
failObligationCount |
BigDecimal |
RestObligationSuccessRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
RestObligationFailRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
errorMessage |
String |
The output will contain the status of the request including validation errors, if any.
It will insert data into the tables obligation_comp and obligation_comp_loc (only for 'PO' and 'POIT'). It will also insert data to into ALC tables.
For Success:
{ "successObligationTbl": [ { "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "successObligationCount": null, "failObligationTbl": [], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
For Failure:
{ "successObligationTbl": [], "successObligationCount": null, "failObligationTbl": [ { "errorMessage": null, "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
OBLIGATION |
Yes |
No |
No |
No |
OBLIGATION_COMP |
Yes |
Yes |
No |
No |
OBLIGATION_COMP_LOC |
Yes |
Yes |
No |
No |
ORDHEAD |
Yes |
No |
No |
No |
ORDSKU |
Yes |
No |
No |
No |
ORDLOC |
Yes |
No |
No |
No |
SHIPMENT |
Yes |
No |
No |
No |
SHIPSKU |
Yes |
No |
No |
No |
V_PACKSKU_QTY |
Yes |
No |
No |
No |
ITEM_SUPP_COUNTRY |
Yes |
No |
No |
No |
ORDLOC_EXP |
Yes |
No |
No |
No |
ELC_COMP |
Yes |
No |
No |
No |
ALC_HEAD |
Yes |
Yes |
Yes |
No |
ALC_COMP_LOC |
Yes |
Yes |
Yes |
No |
Create Obligation Component Location
Business Overview
This service creates obligation component locations for existing pending obligations by calling the SVCPROV_OBLIGATION package and then calling the core obligation package to validate and insert data into the Merchandising tables.
This service accepts an obligation key, or supplier/invoice, or partner type/partner/invoice combination to identify the existing obligation. Add the component ID for which the user wants to create locations. Add valid location details. Reallocation to ALC will be done after successful location creation.
Service Type
Post
ReST URL
/ObligationUpload/createObligationCompLoc
Input Parameters
RestObligationRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
obligationLevel |
String |
keyValue1 |
String |
keyValue2 |
String |
keyValue3 |
String |
keyValue4 |
String |
keyValue5 |
String |
keyValue6 |
String |
status |
String |
partnerType |
String |
partnerId |
String |
supplierSite |
String |
invoice |
String |
invoiceDate |
Timestamp |
qty |
BigDecimal |
qtyUom |
String |
currency |
String |
exchangeRate |
BigDecimal |
checkAuthNo |
String |
paidAmt |
BigDecimal |
paidDate |
Timestamp |
comments |
String |
obligationCompTbl |
List<RestObligationCompRecRDO> |
RestObligationCompRecRDO
Parameter Name | Data Type |
---|---|
compId |
String |
allocateToAlc |
String |
allocationType |
String |
allocationBasisUom |
String |
amt |
BigDecimal |
rate |
BigDecimal |
perCount |
BigDecimal |
perCountUom |
String |
obligationCompLocTbl |
List<RestObligationCompLocRecRDO> |
RestObligationCompLocRecRDO
Parameter Name | Data Type |
---|---|
action |
String |
locType |
String |
locId |
BigDecimal |
qty |
BigDecimal |
amt |
BigDecimal |
JSON Structure: Same RDO 'RestObligationRecRDO' will be used for createObligationComp, but only the below parameters will be considered for the request. The rest of the parameters will be ignored.
[{ "obligationKey": null, "partnerType":null, "partnerId":null, "supplierSite":null, "invoice":null, "obligationCompTbl" : [{ "compId":null, "obligationCompLocTbl":[{ "action":null, "locType":null, "locId": null, "qty":null, "amt":null}] }] }]
Output
RestObligationStatusRecRDO
Parameter Name | Data Type |
---|---|
successObligationTbl |
List<RestObligationSuccessRecRDO> |
successObligationCount |
BigDecimal |
failObligationTbl |
List<RestObligationFailRecRDO> |
failObligationCount |
BigDecimal |
RestObligationSuccessRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
RestObligationFailRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
errorMessage |
String |
The output will contain the status of the request, including validation errors, if any.
For Success:
{ "successObligationTbl": [ { "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "successObligationCount": null, "failObligationTbl": [], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
For Failure:
{ "successObligationTbl": [], "successObligationCount": null, "failObligationTbl": [ { "errorMessage": null, "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
OBLIGATION |
Yes |
No |
No |
No |
OBLIGATION_COMP |
Yes |
No |
No |
No |
OBLIGATION_COMP_LOC |
Yes |
Yes |
No |
No |
ORDHEAD |
Yes |
No |
No |
No |
ORDSKU |
Yes |
No |
No |
No |
ORDLOC |
Yes |
No |
No |
No |
SHIPMENT |
Yes |
No |
No |
No |
SHIPSKU |
Yes |
No |
No |
No |
V_PACKSKU_QTY |
Yes |
No |
No |
No |
ITEM_SUPP_COUNTRY |
Yes |
No |
No |
No |
ORDLOC_EXP |
Yes |
No |
No |
No |
ALC_HEAD |
Yes |
Yes |
Yes |
No |
ALC_COMP_LOC |
Yes |
Yes |
Yes |
No |
Modify Obligation
Business Overview
This service updates obligation header records by calling the SVCPROV_OBLIGATION package and then calling the core obligation package to validate and update data in the Obligation table.
This service accepts an obligation key, or supplier/invoice, or partner type/partner/invoice combination to identify the existing obligation. The user can modify the mandatory fields below when the obligation is in pending status. Reallocation to ALC will be performed for pending obligations. If the user updates the status to approved, then an invoice will be created.
-
Status
-
Partner Type
-
Partner ID
-
Supplier Site
-
Invoice
-
Invoice Date
-
Quantity
-
Quantity UOM
-
Currency
-
Exchange Rate
The below fields, which are not mandatory, can be updated in pending as well as approved status.
-
Payment Method
-
Check Authorization No.
-
Amount Paid
-
Paid Date
-
Comments
Service Type
Post
ReST URL
/ObligationUpload/modifyObligation
RestObligationRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
obligationLevel |
String |
keyValue1 |
String |
keyValue2 |
String |
keyValue3 |
String |
keyValue4 |
String |
keyValue5 |
String |
keyValue6 |
String |
status |
String |
partnerType |
String |
partnerId |
String |
supplierSite |
String |
invoice |
String |
invoiceDate |
Timestamp |
qty |
BigDecimal |
qtyUom |
String |
currency |
String |
exchangeRate |
BigDecimal |
checkAuthNo |
String |
paidAmt |
BigDecimal |
paidDate |
Timestamp |
comments |
String |
obligationCompTbl |
List<RestObligationCompRecRDO> |
RestObligationCompRecRDO
Parameter Name | Data Type |
---|---|
compId |
String |
allocateToAlc |
String |
allocationType |
String |
allocationBasisUom |
String |
amt |
BigDecimal |
rate |
BigDecimal |
perCount |
BigDecimal |
perCountUom |
String |
obligationCompLocTbl |
List<RestObligationCompLocRecRDO> |
RestObligationCompLocRecRDO
Parameter Name | Data Type |
---|---|
action |
String |
locType |
String |
locId |
BigDecimal |
qty |
BigDecimal |
amt |
BigDecimal |
JSON Structure: Same RDO 'RestObligationRecRDO' will be used for modifyObligation but only the below parameters will be considered for the request. The rest of the parameters will be ignored.
invoiceDate and paidDate will take input in a string with the 'YYYY-MM-DD' format, which will be converted to Timestamp format and insert into the tables.
[{ "obligationKey": null, "status":null, "partnerType":null, "partnerId":null, "supplierSite":null, "invoice":null, "invoiceDate":null, "qty":null, "qtyUom":null, "exchangeRate":null, "currency":null, "paymentMethod":null, "checkAuthNo":null, "paidAmt":null, "paidDate":null, "comments":null }]
Output
RestObligationStatusRecRDO
Parameter Name | Data Type |
---|---|
successObligationTbl |
List<RestObligationSuccessRecRDO> |
successObligationCount |
BigDecimal |
failObligationTbl |
List<RestObligationFailRecRDO> |
failObligationCount |
BigDecimal |
RestObligationSuccessRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
RestObligationFailRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
errorMessage |
String |
The output will contain the status of the request, including validation errors, if any.
NULL values will be ignored for mandatory fields. Non-mandatory fields can be updated to NULL.
For Success:
{ "successObligationTbl": [ { "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "successObligationCount": null, "failObligationTbl": [], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
For Failure:
{ "successObligationTbl": [], "successObligationCount": null, "failObligationTbl": [ { "errorMessage": null, "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
OBLIGATION |
Yes |
No |
No |
No |
OBLIGATION_COMP |
Yes |
No |
No |
No |
OBLIGATION_COMP_LOC |
Yes |
No |
No |
No |
ORDHEAD |
Yes |
No |
No |
No |
ORDSKU |
Yes |
No |
No |
No |
ORDLOC |
Yes |
No |
No |
No |
SHIPMENT |
Yes |
No |
No |
No |
SHIPSKU |
Yes |
No |
No |
No |
V_PACKSKU_QTY |
Yes |
No |
No |
No |
ITEM_SUPP_COUNTRY |
Yes |
No |
No |
No |
ORDLOC_EXP |
Yes |
No |
No |
No |
ALC_HEAD |
Yes |
Yes |
Yes |
No |
ALC_COMP_LOC |
Yes |
Yes |
Yes |
No |
INVC_HEAD |
No |
Yes |
No |
No |
INVC_NON_MERCH |
No |
Yes |
No |
No |
INVC_XREF |
No |
Yes |
No |
No |
Modify Obligation Comp
Business Overview
This service updates existing obligation component records which are in pending status by calling the SVCPROV_OBLIGATION package and then calling the core obligation package to validate and update data in the obligation_comp table.
This service accepts an obligation key, or supplier/invoice, or partner type/partner/invoice combination to identify the existing obligation. The user can modify component level fields. Reallocation to ALC will be done after update.
Service Type
Post
ReST URL
/ObligationUpload/modifyObligationComp
Input Parameters
RestObligationRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
obligationLevel |
String |
keyValue1 |
String |
keyValue2 |
String |
keyValue3 |
String |
keyValue4 |
String |
keyValue5 |
String |
keyValue6 |
String |
status |
String |
partnerType |
String |
partnerId |
String |
supplierSite |
String |
invoice |
String |
invoiceDate |
Timestamp |
qty |
BigDecimal |
qtyUom |
String |
currency |
String |
exchangeRate |
BigDecimal |
checkAuthNo |
String |
paidAmt |
BigDecimal |
paidDate |
Timestamp |
comments |
String |
obligationCompTbl |
List<RestObligationCompRecRDO> |
RestObligationCompRecRDO
Parameter Name | Data Type |
---|---|
compId |
String |
allocateToAlc |
String |
allocationType |
String |
allocationBasisUom |
String |
amt |
BigDecimal |
rate |
BigDecimal |
perCount |
BigDecimal |
perCountUom |
String |
obligationCompLocTbl |
List<RestObligationCompLocRecRDO> |
RestObligationCompLocRecRDO
Parameter Name | Data Type |
---|---|
action |
String |
locType |
String |
locId |
BigDecimal |
qty |
BigDecimal |
amt |
BigDecimal |
JSON Structure: The same RDO 'RestObligationRecRDO' will be used for modifyObligationComp, but only the below parameters will be considered for the request. The rest of the parameters will be ignored.
[{ "obligationKey": null, "partnerType":null, "partnerId":null, "supplierSite":null, "invoice":null, "obligationCompTbl" : [{"compId":null, "allocateToAlc":null, "allocationType":null, "allocationBasisUom": null, "amt":null, "rate":null, "perCount":null, "perCountUom":null, }] }]
Output
RestObligationStatusRecRDO
Parameter Name | Data Type |
---|---|
successObligationTbl |
List<RestObligationSuccessRecRDO> |
successObligationCount |
BigDecimal |
failObligationTbl |
List<RestObligationFailRecRDO> |
failObligationCount |
BigDecimal |
RestObligationSuccessRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
RestObligationFailRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
errorMessage |
String |
The output will contain the status of the request, including validation errors, if any.
For Success:
{ "successObligationTbl": [ { "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "successObligationCount": null, "failObligationTbl": [], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
For Failure:
{ "successObligationTbl": [], "successObligationCount": null, "failObligationTbl": [ { "errorMessage": null, "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
OBLIGATION |
Yes |
No |
No |
No |
OBLIGATION_COMP |
Yes |
No |
No |
No |
OBLIGATION_COMP_LOC |
Yes |
No |
No |
No |
ORDHEAD |
Yes |
No |
No |
No |
ORDSKU |
Yes |
No |
No |
No |
ORDLOC |
Yes |
No |
No |
No |
SHIPMENT |
Yes |
No |
No |
No |
SHIPSKU |
Yes |
No |
No |
No |
V_PACKSKU_QTY |
Yes |
No |
No |
No |
ITEM_SUPP_COUNTRY |
Yes |
No |
No |
No |
ORDLOC_EXP |
Yes |
No |
No |
No |
ALC_HEAD |
Yes |
Yes |
Yes |
No |
ALC_COMP_LOC |
Yes |
Yes |
Yes |
No |
Modify Obligation Component Location
Business Overview
This service updates existing obligation component records which are in pending status by calling the SVCPROV_OBLIGATION package and then calling the core obligation package to validate and update data in the obligation_comp table.
This service accepts an obligation key, or supplier/invoice, or partner type/partner/invoice combination to identify the existing obligation. The user can modify component level fields. Reallocation to ALC will be done after the update.
Service Type
Post
ReST URL
/ObligationUpload/modifyObligationCompLoc
Input Parameters
RestObligationRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
obligationLevel |
String |
keyValue1 |
String |
keyValue2 |
String |
keyValue3 |
String |
keyValue4 |
String |
keyValue5 |
String |
keyValue6 |
String |
status |
String |
partnerType |
String |
partnerId |
String |
supplierSite |
String |
invoice |
String |
invoiceDate |
Timestamp |
qty |
BigDecimal |
qtyUom |
String |
currency |
String |
exchangeRate |
BigDecimal |
checkAuthNo |
String |
paidAmt |
BigDecimal |
paidDate |
Timestamp |
comments |
String |
obligationCompTbl |
List<RestObligationCompRecRDO> |
RestObligationCompRecRDO
Parameter Name | Data Type |
---|---|
compId |
String |
allocateToAlc |
String |
allocationType |
String |
allocationBasisUom |
String |
amt |
BigDecimal |
rate |
BigDecimal |
perCount |
BigDecimal |
perCountUom |
String |
obligationCompLocTbl |
List<RestObligationCompLocRecRDO> |
RestObligationCompLocRecRDO
Parameter Name | Data Type |
---|---|
action |
String |
locType |
String |
locId |
BigDecimal |
qty |
BigDecimal |
amt |
BigDecimal |
JSON Structure: The same RDO 'RestObligationRecRDO' will be used for modifyObligationCompLoc but only the below parameters will be considered for the request. The rest of the parameters will be ignored.
[{ "obligationKey": null, "partnerType":null, "partnerId":null, "supplierSite":null, "invoice":null, "obligationCompTbl" : [{ "compId":null, "obligationCompLocTbl":[{ "action":null, "locType":null, "locId": null, "qty":null, "amt":null}] }] }]
Output
RestObligationStatusRecRDO
Parameter Name | Data Type |
---|---|
successObligationTbl |
List<RestObligationSuccessRecRDO> |
successObligationCount |
BigDecimal |
failObligationTbl |
List<RestObligationFailRecRDO> |
failObligationCount |
BigDecimal |
RestObligationSuccessRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
RestObligationFailRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
errorMessage |
String |
The output will contain the status of the request, including validation errors, if any.
The action field is mandatory here. Valid value for this are MOD/DEL. MOD is to update a location and DEL to delete a location.
For Success:
{ "successObligationTbl": [ { "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "successObligationCount": null, "failObligationTbl": [], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
For Failure:
{ "successObligationTbl": [], "successObligationCount": null, "failObligationTbl": [ { "errorMessage": null, "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
OBLIGATION |
Yes |
No |
No |
No |
OBLIGATION_COMP |
Yes |
No |
Yes |
No |
OBLIGATION_COMP_LOC |
Yes |
No |
Yes |
No |
ORDHEAD |
Yes |
No |
No |
No |
ORDSKU |
Yes |
No |
No |
No |
ORDLOC |
Yes |
No |
No |
No |
SHIPMENT |
Yes |
No |
No |
No |
SHIPSKU |
Yes |
No |
No |
No |
V_PACKSKU_QTY |
Yes |
No |
No |
No |
ITEM_SUPP_COUNTRY |
Yes |
No |
No |
No |
ORDLOC_EXP |
Yes |
No |
No |
No |
ALC_HEAD |
Yes |
No |
Yes |
No |
ALC_COMP_LOC |
Yes |
No |
Yes |
No |
Delete Obligation
Business Overview
This service deletes existing obligation records with pending status by calling the SVCPROV_OBLIGATION package and then calling the core obligation package to validate and delete entire obligation records from Merchandising tables.
This service accepts an obligation key, or supplier/invoice, or partner type/partner/invoice combination to identify the obligation. This service will delete the entire obligation record.
Service Type
Post
ReST URL
/ObligationUpload/deleteObligation
Input Parameters
RestObligationRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
obligationLevel |
String |
keyValue1 |
String |
keyValue2 |
String |
keyValue3 |
String |
keyValue4 |
String |
keyValue5 |
String |
keyValue6 |
String |
status |
String |
partnerType |
String |
partnerId |
String |
supplierSite |
String |
invoice |
String |
invoiceDate |
Timestamp |
qty |
BigDecimal |
qtyUom |
String |
currency |
String |
exchangeRate |
BigDecimal |
checkAuthNo |
String |
paidAmt |
BigDecimal |
paidDate |
Timestamp |
comments |
String |
obligationCompTbl |
List<RestObligationCompRecRDO> |
RestObligationCompRecRDO
Parameter Name | Data Type |
---|---|
compId |
String |
allocateToAlc |
String |
allocationType |
String |
allocationBasisUom |
String |
amt |
BigDecimal |
rate |
BigDecimal |
perCount |
BigDecimal |
perCountUom |
String |
obligationCompLocTbl |
List<RestObligationCompLocRecRDO> |
RestObligationCompLocRecRDO
Parameter Name | Data Type |
---|---|
action |
String |
locType |
String |
locId |
BigDecimal |
qty |
BigDecimal |
amt |
BigDecimal |
JSON Structure: The same RDO 'RestObligationRecRDO' will be used for deleteObligation but only the below parameters will be considered for the request. The rest of the parameters will be ignored.
[{ "obligationKey": null, "partnerType":null, "partnerId":null, "supplierSite":null, "invoice":null }]
Output
RestObligationStatusRecRDO
Parameter Name | Data Type |
---|---|
successObligationTbl |
List<RestObligationSuccessRecRDO> |
successObligationCount |
BigDecimal |
failObligationTbl |
List<RestObligationFailRecRDO> |
failObligationCount |
BigDecimal |
RestObligationSuccessRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
RestObligationFailRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
errorMessage |
String |
The output will contain the status of the request, including validation errors, if any.
For Success:
{ "successObligationTbl": [ { "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "successObligationCount": null, "failObligationTbl": [], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
For Failure:
{ "successObligationTbl": [], "successObligationCount": null, "failObligationTbl": [ { "errorMessage": null, "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
OBLIGATION |
Yes |
No |
No |
Yes |
OBLIGATION_COMP |
Yes |
No |
No |
Yes |
OBLIGATION_COMP_LOC |
Yes |
No |
No |
Yes |
ALC_HEAD |
Yes |
No |
No |
Yes |
ALC_COMP_LOC |
Yes |
No |
No |
Yes |
Delete Obligation Component
Business Overview
This service deletes obligation components for existing obligations by calling the SVCPROV_OBLIGATION package and then calling the core obligation package to validate and delete data from Merchandising tables.
This service accepts obligation key, or supplier/invoice, or partner type/partner/invoice combination to identify the obligation. Pass the component ID which the user wants to delete. This service will delete the component. If locations are attached to the components, then that will be deleted as well. Reallocation to ALC will be done after deletion.
Service Type
Post
ReST URL
/ObligationUpload/deleteObligationComp
Input Parameters
RestObligationRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
obligationLevel |
String |
keyValue1 |
String |
keyValue2 |
String |
keyValue3 |
String |
keyValue4 |
String |
keyValue5 |
String |
keyValue6 |
String |
status |
String |
partnerType |
String |
partnerId |
String |
supplierSite |
String |
invoice |
String |
invoiceDate |
Timestamp |
qty |
BigDecimal |
qtyUom |
String |
currency |
String |
exchangeRate |
BigDecimal |
checkAuthNo |
String |
paidAmt |
BigDecimal |
paidDate |
Timestamp |
comments |
String |
obligationCompTbl |
List<RestObligationCompRecRDO> |
RestObligationCompRecRDO
Parameter Name | Data Type |
---|---|
compId |
String |
allocateToAlc |
String |
allocationType |
String |
allocationBasisUom |
String |
amt |
BigDecimal |
rate |
BigDecimal |
perCount |
BigDecimal |
perCountUom |
String |
obligationCompLocTbl |
List<RestObligationCompLocRecRDO> |
RestObligationCompLocRecRDO
Parameter Name | Data Type |
---|---|
action |
String |
locType |
String |
locId |
BigDecimal |
qty |
BigDecimal |
amt |
BigDecimal |
JSON Structure: The same RDO 'RestObligationRecRDO' will be used for deleteObligationComp, but only the below parameters will be considered for the request. The rest of the parameters will be ignored.
[{ "obligationKey": null, "partnerType":null, "partnerId":null, "supplierSite":null, "invoice":null, "obligationCompTbl" : [{ "compId":null }] }]
Output
RestObligationStatusRecRDO
Parameter Name | Data Type |
---|---|
successObligationTbl |
List<RestObligationSuccessRecRDO> |
successObligationCount |
BigDecimal |
failObligationTbl |
List<RestObligationFailRecRDO> |
failObligationCount |
BigDecimal |
RestObligationSuccessRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
RestObligationFailRecRDO
Parameter Name | Data Type |
---|---|
obligationKey |
BigDecimal |
status |
String |
invoice |
String |
errorMessage |
String |
The output will contain the status of the request, including validation errors, if any.
For Success:
{ "successObligationTbl": [ { "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "successObligationCount": null, "failObligationTbl": [], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
For Failure:
{ "successObligationTbl": [], "successObligationCount": null, "failObligationTbl": [ { "errorMessage": null, "status": null, "invoice": null, "obligationKey": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "failObligationCount": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
OBLIGATION |
Yes |
No |
No |
Yes |
OBLIGATION_COMP |
Yes |
No |
No |
Yes |
OBLIGATION_COMP_LOC |
Yes |
No |
No |
Yes |
ORDHEAD |
Yes |
No |
No |
Yes |
ORDSKU |
Yes |
No |
No |
Yes |
ORDLOC |
Yes |
No |
No |
Yes |
SHIPMENT |
Yes |
No |
No |
Yes |
SHIPSKU |
Yes |
No |
No |
Yes |
V_PACKSKU_QTY |
Yes |
No |
No |
Yes |
ITEM_SUPP_COUNTRY |
Yes |
No |
No |
Yes |
ORDLOC_EXP |
Yes |
No |
No |
Yes |
ALC_HEAD |
Yes |
No |
Yes |
Yes |
ALC_COMP_LOC |
Yes |
No |
Yes |
Yes |
Purchase Order Detail Service
This section describes the Purchase Order Detail Service.
Business Overview
Purchase Order Detail service allows user to retrieve purchase order information for a selected order.
Output
RestPoRecRDO
Parameter Name | Data Type |
---|---|
orderNumber |
BigDecimal |
orderType |
String |
group |
BigDecimal |
division |
BigDecimal |
dept |
BigDecimal |
buyer |
BigDecimal |
supplier |
BigDecimal |
supplierStatus |
String |
locationType |
String |
location |
BigDecimal |
writtenDate |
Date |
notBeforeDate |
Date |
notAfterDate |
Date |
otbEndofWeekDate |
Date |
earliestShipDate |
Date |
latestShipDate |
Date |
closeDate |
Date |
terms |
String |
freightTerms |
String |
originIndicator |
BigDecimal |
shipmentMethod |
String |
purchaseType |
String |
status |
String |
currencyCode |
String |
masterPurchaseOrderNumber |
BigDecimal |
poItemTbl |
List<RestPoItemRecRDO> |
RestPoItemRecRDO
Parameter Name | Data Type |
---|---|
item |
String |
refernceItem |
String |
packItem |
String |
originCountryId |
String |
earliestShipDate |
Date |
latestShipDate |
Date |
supplierPackSize |
BigDecimal |
location |
BigDecimal |
locationType |
String |
physicalWarehouse |
BigDecimal |
unitRetail |
BigDecimal |
quantityOrdered |
BigDecimal |
quantityPrescaled |
BigDecimal |
quantityReceived |
BigDecimal |
lastReceivedQuantity |
BigDecimal |
lastRoundQuantity |
BigDecimal |
lastGroupRoundedQunatity |
BigDecimal |
quantityCancelled |
BigDecimal |
cancelCode |
String |
cancelDate |
Date |
unitCost |
BigDecimal |
costSource |
String |
nonScaleIndicator |
String |
estimatedStockDate |
Date |
restPoItemExpTbl |
List<RestPoItemExpRecRDO> |
RestPoItemExpRecRDO
Parameter Name | Data Type |
---|---|
item |
String |
packItem |
String |
location |
BigDecimal |
locationType |
String |
componentId |
String |
componentDecsiption |
String |
alwaysDefaultIndicator |
String |
componentRate |
BigDecimal |
componentCurrency |
String |
exchangeRate |
BigDecimal |
estimatedExpenceValue |
BigDecimal |
JSON Structure: { "orderNumber": null, "orderType": null, "group": null, "division": null, "dept": null, "buyer": null, "supplier": null, "supplierStatus": null, "locationType": null, "location": null, "writtenDate": null, "notBeforeDate": null, "notAfterDate": null, "otbEndOfWeekDate": null, "earliestShipDate": null, "latestShipDate": null, "closeDate": null, "terms": null, "freightTerms": null, "originIndicator": null, "shipmentmethod": null, "purchaseType": null, "status": null, "currencyCode": null, "masterPurchaseOrderNumber": null, "poItemTbl": [ { "item": null, "referenceItem": null, "originCountryId": null, "earliestShipDate": null, "latestShipDate": null, "supplierPackSize": null, "location": null, "locationType": null, "physicalWarehouse": null, "unitRetail": null, "quantityOrdered": null, "quantityPrescaled": null, "quantityReceived": null, "lastReceivedQuantity": null, "lastRoundQuantity": null, "lastGroupRoundedQuantity": null, "quantityCancelled": null, "cancelCode": null, "unitCost": null, "costSource": null, "nonScaleIndicator": null, "estimatedStockDate": null, "poItemExpTbl": [ { "item": null, "packItem": null, "location": null, "locationType": null, "componentId": null, "componentDescription": null, "alwaysDefaultIndicator": null, "componentRate": null, "componentCurrency": null, "exchangeRate": null, "estimatedExpenceValue": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "links": [], "hyperMediaContent": { "linkRDO": [] } } "links": [], "hyperMediaContent": { "linkRDO": [] } }
Recent Inventory Transfer Services
This section describes the Recent Inventory Transfer services.
Business Overview
The primary role of these services is to approve or reject Merchandising's transfers.
Transfer Location Search
This section describes the transfer location search service.
Business Overview
The web service enables location search applicable for Transfers. Locations can be searched by either 'S'tore or 'W'arehouse, with the subsequent entry of 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 then:
-
Internal finishers are filtered out
-
-
When search type is store then:
-
Only company stores are returned
-
Only stockholding stores are returned
-
ReST URL
/Transfer/recent/transferLocSearch?searchString={searchString}&locType={locType}&pageSize={pageSize}&pageNumber={pageNumber}
Input Parameters
Parameter Name | Required | Description | Valid values |
---|---|---|---|
SearchString |
No |
search string for locations Id or Name |
NA |
LocType |
No |
Location type Store or warehouse |
S, W |
PageSize |
No |
Maximum number of locations to retrieve per page |
NA |
PageNumber |
No |
Result page to retrieve |
NA |
Output
PagedResultsRDO
Parameter Name | Data Type |
---|---|
totalRecordCount |
BigDecimal |
results |
List<RtsfLocSearchResultRDO> |
RtsfLocSearchResultRDO
Parameter Name | Data Type |
---|---|
location |
BigDecimal |
locationType |
String |
locationName |
String |
currency |
String |
JSON Structure: { "totalRecordCount": 1, "results": [ { "location": null, "locationType": null, "locationName": null, "currency": null, "links": [ ], "hyperMediaContent": { "linkRDO": [ ] } } ], "links": [ ], "hyperMediaContent": { "linkRDO": [ ] } }
Transfer Location Load
This section describes the Transfer Location Load service.
Business Overview
This web service allows the user to refresh already selected Transfer locations records.
Input Parameters
Parameter Name | Required | Description |
---|---|---|
Locations |
No |
Comma Separated values for selected locations' ID |
Transfer Status List
This section describes the Transfer Status List service.
Transfer Type List
This section describes the Transfer Type List service.
Search Transfer User IDs
This section describes the Search Transfer User IDs.
Business Overview
The Search Transfer User IDs service retrieves for all User IDs that created transfers.
ReST URL
/Transfer/recent/searchUserIds?searchString={searchString}&pageSize={pageSize}&pageNumber={pageNumber}
Input Parameters
Parameter Name | Required | Description |
---|---|---|
SearchString |
Yes |
search string for User Id |
PageSize |
No |
Maximum number of transfer user IDs to retrieve per page |
PageNumber |
No |
Result page to retrieve |
Output
PagedResultsRDO
Parameter Name | Data Type |
---|---|
totalRecordCount |
BigDecimal |
results |
List<VarcharIdRDO> |
VarcharIdRDO
Parameter Name | Data Type |
---|---|
id |
String |
JSON Structure: { "totalRecordCount": null, "results": [ { "id": null, "links": [ ], "hyperMediaContent": { "linkRDO": [ ] } } ], "links": [ ], "hyperMediaContent": { "linkRDO": [ ] } }
Transfer Search
This section describes the Transfer Search service.
Business Overview
The web services in this area enables search for applicable transfers. Transfers can be searched by their status, transfer types, transfer number, create date, delivery date, create ID, item department and/or locations.The transfers returned are constrained by the following criteria:
-
Customer Orders and Book Transfers are filtered out.
-
Only Transfers with transfer details are returned.
ReST URL
/Transfer/recent/transferSearch?statuses={statuses}&transferTypes={transferTypes}&createIds={createIds}&startCreateDate={startCreateDate}&endCreateDate={endCreateDate}&startDeliveryDate={startDeliveryDate}&endDeliveryDate={endDeliveryDate}&transferNumber={transferNumber}&locations={locations}&departments={departments}&pageSize={pageSize}&pageNumber={pageNumber}
Input Parameters
Parameter Name | Required | Description | Valid values |
---|---|---|---|
Statuses |
No |
Comma Separated values for selected transfer statuses |
|
TransferTypes |
No |
Comma Separated values for selected transfer types |
|
CreateIds |
No |
Comma Separated values for selected transfer create ID |
|
StartCreateDate |
No |
Start of the range of transfer create dates |
|
EndCreateDate |
No |
End of the range of transfer create dates |
|
StartDeliveryDate |
No |
Start of the range of transfer create dates |
|
EndDeliveryDate |
No |
End of the range of transfer create dates |
|
TransferNumber |
No |
Transfer Number |
|
Locations |
No |
Comma Separated values for selected Location IDs |
|
Departments |
No |
Comma Separated values for selected Department IDs |
|
PageSize |
No |
Maximum number of locations to retrieve per page |
|
PageNumber |
No |
Result page to retrieve |
Output
PagedResultsRDO
Parameter Name | Data Type |
---|---|
totalRecordCount |
BigDecimal |
results |
List<RtsfSearchResRDO> |
RtsfSearchResRDO
Parameter Name | Data Type |
---|---|
transferNumber |
BigDecimal |
tsfType |
String |
fromLocation |
BigDecimal |
fromLocationType |
String |
fromLocationName |
String |
toLocation |
BigDecimal |
toLocationType |
String |
toLocationName |
String |
status |
String |
totalCost |
BigDecimal |
currency |
String |
deliveryDate |
Long |
JSON Structure: { "totalRecordCount": null, "results": [ { "transferNumber": null, "tsfType": null, "fromLocation": null, "fromLocationType": null, "fromLocationName": null, "toLocation": null, "toLocationType": null, "toLocationName": null, "status": null, "totalCost": null, "currency": null, "deliveryDate": null, "links": [ ], "hyperMediaContent": { "linkRDO": [ ] } } ], "links": [ ], "hyperMediaContent": { "linkRDO": [ ] } }
Get Transfer Detail
This section describes the Get Transfer Detail service.
Business Overview
Get Transfer Detail service allow user to retrieve Transfer information for a selected transfer number.
ReST URL
/Transfer/recent/transferDetail?transferNumber={transferNumber}&pageSize={pageSize}&pageNumber={pageNumber}
Input Parameters
Parameter Name | Required | Description |
---|---|---|
TransferNumber |
Yes |
Transfer Number ID |
PageSize |
No |
Maximum number of items to retrieve per page |
PageNumber |
No |
Result page to retrieve |
Output
PagedResultsRDO
Parameter Name | Data Type |
---|---|
totalRecordCount |
BigDecimal |
results |
List<RtsfTsfDtlRDO> |
RtsfTsfDtlRDO
Parameter Name | Data Type |
---|---|
transferNumber |
BigDecimal |
status |
String |
fromLocation |
BigDecimal |
fromLocationName |
String |
finisher |
BigDecimal |
finisherName |
String |
toLocation |
BigDecimal |
toLocationName |
String |
transferType |
String |
totalCost |
BigDecimal |
totalRetail |
BigDecimal |
currency |
String |
deliveryDate |
Long |
createId |
String |
createDate |
Long |
transferItemsTable |
List<RtsfTsfDtlItemRDO> |
RtsfTsfDtlItemRDO
Parameter Name | Data Type |
---|---|
item |
String |
itemDescription |
String |
transferQuantity |
BigDecimal |
JSON Structure: { "totalRecordCount": null, "results": [ { "transferNumber": null, "status": null, "fromLocation": null, "fromLocationName": null, "finisher": null, "finisherName": null, "toLocation": null, "toLocationName": null, "transferType": null, "totalCost": null, "totalRetail": null, "currency": null, "deliveryDate": null, "createId": null, "createDate": null, "transferItemsTable": [ { "item": null, "itemDescription": null, "transferQuantity": null, "links": [ ], "hyperMediaContent": { "linkRDO": [ ] } } ], "links": [ ], "hyperMediaContent": { "linkRDO": [ ] } } ], "links": [], "hyperMediaContent": { "linkRDO": [ ] } }
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
ITEM_LOC |
Yes |
No |
No |
No |
ITEM_LOC_SOH |
Yes |
No |
No |
No |
TSF_ITEM_INV_FLOW |
Yes |
No |
No |
No |
V_EXTERNAL_FINISHER |
Yes |
No |
No |
No |
V_INTERNAL_FINISHER |
Yes |
No |
No |
No |
V_ITEM_MASTER |
Yes |
No |
No |
No |
V_LOCATION |
Yes |
No |
No |
No |
V_STORE |
Yes |
No |
No |
No |
V_TSFDETAIL |
Yes |
No |
No |
No |
V_TSFHEAD |
Yes |
No |
No |
No |
V_WH |
Yes |
No |
No |
No |
JOB_AUDIT_LOGS |
No |
Yes |
No |
No |
JOB_AUDIT_PAYLOAD |
No |
Yes |
No |
No |
Update Transfer Status
This section describes the Update Transfer Status service.
ReST URL
/Transfer/recent/updateTransferStatus?newStatus={newStatus}&transferNumbers={transferNumbers}
Input Parameters
Parameter Name | Required | Description | Valid values |
---|---|---|---|
NewStatus |
Yes |
New status of the transfer. May only be 'A'pproved or 'I'nput. |
A, I |
TransferNumbers |
Yes |
Comma Separated values for selected locations' ID |
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
TSFHEAD |
Yes |
No |
Yes |
No |
TSFDETAIL |
Yes |
Yes |
Yes |
Yes |
ITEM_LOC |
Yes |
No |
No |
No |
ITEM_LOC_SOH |
Yes |
No |
Yes |
No |
ITEM_MASTER |
Yes |
No |
No |
No |
PACKITEM_BREAKOUT |
Yes |
No |
No |
No |
STORE |
Yes |
No |
No |
No |
SYSTEM_OPTIONS |
Yes |
No |
No |
No |
V_TSFHEAD |
Yes |
No |
No |
No |
WH |
Yes |
No |
No |
No |
JOB_AUDIT_LOGS |
No |
Yes |
No |
No |
JOB_AUDIT_PAYLOAD |
No |
Yes |
No |
No |
Recent Purchase Order Services
This section describes the Recent Purchase Order services.
Business Overview
The primary role of this service is to approve, reject, or cancel Merchandising's purchase orders.
Cancel Reason Code List
This section describes the Cancel Reason Code List service.
Origin Code List
This section describes the Origin Code List service.
Purchase Order Status List
This section describes the Purchase Order Status list.
Search Purchase Order User ID
This section describes the Search Purchase Order User ID.
Business Overview
This service retrieves a list of user IDs associated with creating a purchase order.
ReST URL
/PurchaseOrders/recent/searchUserIds?searchString={searchString}&pageSize={pageSize}&pageNumber={pageNumber}
Output
VarcharIdRDO
Parameter Name | Data Type |
---|---|
id |
String |
PagedResultsRDO
Parameter Name | Data Type |
---|---|
totalRecordCount |
BigDecimal |
Next Page URL |
String |
Previous Page URL |
String |
JSON Structure: { "totalRecordCount": null, "results": [ { "id": null, "links": [ ], "hyperMediaContent": { "linkRDO": [ ] } } ], "links": [ ], "hyperMediaContent": { "linkRDO": [ ] } }
Purchase Order Search
This section describes the Purchase Order Search service.
Business Overview
This service retrieves summary information on all none closed purchase orders that match input criteria.
ReST URL
/PurchaseOrders/recent/purchaseOrderSearch?statuses={statuses}&createIds={createIds}&startCreateDate={startCreateDate}&endCreateDate={endCreateDate}&orderNumber={orderNumber}&suppliers={suppliers}&originCodes={originCodes}&departments={departments}&pageSize={pageSize}&pageNumber={pageNumber}
Input Parameters
Parameter Name | Required | Description | Valid values |
---|---|---|---|
statuses |
No |
List of order status |
A, S, W |
createIds |
No |
List of user IDs who created the PO |
|
startCreateDate |
No |
Long format date for starting period |
|
endCreateDate |
No |
Long format date for end period |
|
orderNumber |
No |
Order number to retrieve |
|
suppliers |
No |
List of order suppliers |
|
originCodes |
No |
List of valid Origin codes |
|
departments |
No |
List of valid order/item departments |
|
pageSize |
Maximum number of orders to retrieve per page |
||
pageNumber |
Result page to retrieve |
Output
RpoSearchResRDO
Parameter Name | Data Type |
---|---|
orderNumber |
BigDecimal |
status |
String |
supplier |
BigDecimal |
supplierName |
String |
notBeforeDate |
Long |
notAfterDate |
Long |
totalCost |
BigDecimal |
currency |
String |
previouslyApprovedIndicator |
String |
editableIndicator |
String |
PagedResultsRDO
Parameter Name | Data Type |
---|---|
totalRecordCount |
BigDecimal |
Next Page URL |
String |
Previous Page URL |
String |
JSON Structure: "{ "type": "paginationRDO", "totalRecordCount": 252, "hyperMediaContent": {}, "links": [], "results": [{ "orderNumber": 12453253, "statusId" : "W", "supplierId": 124121, "supplierName": "Some Supplier Site", "notBeforeDate": 35235252, "notAfterDate": 325235252351, "totalCost": 243.231, "currencyCode": "USD" }] }"
Get Purchase Order Summary
This section describes the Get Purchase Order Summary service.
Output
RpoOrderSumRDO
Parameter Name | Data Type |
---|---|
orderNumber |
BigDecimal |
status |
String |
supplier |
BigDecimal |
supplierName |
String |
notBeforeDate |
Long |
notAfterDate |
Long |
otbEowDate |
Long |
terms |
String |
termsCode |
String |
termsDescription |
String |
totalCost |
BigDecimal |
totalRetail |
BigDecimal |
Currency |
String |
createId |
String |
writtenDate |
Long |
defaultDisplayLevel |
String |
previouslyApprovedIndicator |
String |
editableIndicator |
String |
otbTable |
List<RpoOrderSumOtbRDO> |
RpoOrderSumOtbRDO
Parameter Name | Data Type |
---|---|
department |
BigDecimal |
classId |
BigDecimal |
subclassId |
BigDecimal |
subclassName |
String |
orderAmount |
BigDecimal |
budgetAmount |
BigDecimal |
receivedAmount |
BigDecimal |
approvedAmount |
BigDecimal |
outstandingAmount |
BigDecimal |
JSON Structure: "{ “orderNumber":12345, “statusId":"W", “supplierId":12345, “supplierName": “Supplier 12345", “notBeforeDate": 1234567, “notAfterDate": 236573, "terms":"01", "termsCode":"01234", "termsDescription":"Letter Of Credit", “totalCost": 123.45, “totalRetail": 456.78, “currencyCode": “CAD", “createdBy": “BUYER", “writtenDate": 1234567, "otbResults": [{ "department" : 12345, "classId": 12345, "subClassId" : 12345, "subClassName": "subClassName" "budgetAmount": 12345.545, "orderAmount": 12345.545, "receivedAmount": 12345.545, "approvedAmount": 12345.545 }] }"
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
COST_ZONE_GROUP_LOC |
Yes |
No |
No |
No |
COUNTRY_ATTRIB |
Yes |
No |
No |
No |
DEPS |
Yes |
No |
No |
No |
ELC_COMP |
Yes |
No |
No |
No |
ITEM_COST_HEAD |
Yes |
No |
No |
No |
ITEM_EXP_DETAIL |
Yes |
No |
No |
No |
ITEM_EXP_HEAD |
Yes |
No |
No |
No |
ITEM_LOC |
Yes |
No |
No |
No |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_SUPP_COUNTRY |
Yes |
No |
No |
No |
MV_CURRENCY_CONVERSION_RATES |
Yes |
No |
No |
No |
ORDHEAD |
Yes |
No |
No |
No |
ORDLOC |
Yes |
No |
No |
No |
ORDLOC_EXP |
Yes |
No |
No |
No |
ORDSKU |
Yes |
No |
No |
No |
ORDSKU_HTS |
Yes |
No |
No |
No |
ORDSKU_HTS_ASSESS |
Yes |
No |
No |
No |
OTB |
Yes |
No |
No |
No |
PERIOD |
Yes |
No |
No |
No |
PRODUCT_CONFIG_OPTIONS |
Yes |
No |
No |
No |
STORE |
Yes |
No |
No |
No |
SUPS |
Yes |
No |
No |
No |
V_ORDHEAD |
Yes |
No |
No |
No |
V_PACKSKU_QTY |
Yes |
No |
No |
No |
V_SUBCLASS_TL |
Yes |
No |
No |
No |
V_SUPS |
Yes |
No |
No |
No |
V_TERMS_HEAD_TL |
Yes |
No |
No |
No |
WH |
Yes |
No |
No |
No |
JOB_AUDIT_LOGS |
No |
Yes |
No |
No |
JOB_AUDIT_PAYLOAD |
No |
Yes |
No |
No |
Get Purchase Order Items
This section describes the Get Purchase Order Items service.
Business Overview
This service retrieves items details for an order number. Based on the display level, the items record aggregates to the level specified when applicable.
ReST URL
/PurchaseOrders/recent/PurchaseOrderItems?orderNumber={orderNumber}&itemDisplayLevel={itemDisplayLevel}&pageSize={pageSize}&pageNumber={pageNumber}
Input Parameters
Order Number - Required
Item Display Level - Optional - valid values PARENT_LEVEL, PARENT_DIFF_LEVEL, or TRAN_LEVEL
Page Size - Optional
Page Number - Optional
Output
RpoOrderSumItemRDO
Parameter Name | Data Type |
---|---|
item |
String |
ItemDescription |
String |
diff1 |
String |
diff1Description |
String |
diff2 |
String |
diff2Description |
String |
diff3 |
String |
diff3Description |
String |
diff4 |
String |
diff4Description |
String |
quantityOrdered |
BigDecimal |
totalCost |
BigDecimal |
currency |
String |
itemImageUrl |
String |
PagedResultsRDO
Parameter Name | Data Type |
---|---|
totalRecordCount |
BigDecimal |
Next Page URL |
String |
Previous Page URL |
String |
JSON Structure: "{ "type": "paginationRDO", "totalRecordCount": 252, "hyperMediaContent": {}, "links": [], "orderNumber": 1212131, "results": [{ "itemId": 1234 "itemDescription": "some item", "firstDiffId": 123424, "firstDiffDescription": "desc", "secondDiffId": 12345 "secondDiffDescription" : "desc", "thirdDiffId": 1234324 "thirdDiffDescription" : "desc", "fourthDiffId" : 1324, "fourthDiffDescription" : "desc", "quanityOrdered": 100, "totalCost" : 12345.353, "currencyCode": "USD", "itemImageUrl": "http://..." }] }"
Get Purchase Order Item Locations
This section describes the Get Purchase Order Item Locations service.
Business Overview
This service retrieves item location details for an order number. The location record aggregates based on the display level when applicable.
ReST URL
/PurchaseOrders/recent/PurchaseOrderItemLocations?orderNumber={orderNumber}&item={item}&itemDisplayLevel={itemDisplayLevel}&diff1={diff1}&diff2={diff2}&diff3={diff3}&diff4={diff4}&pageSize={pageSize}&pageNumber={pageNumber}
Input Parameters
Parameter Name | Required | Description | Valid values |
---|---|---|---|
orderNumber |
Yes |
Order number |
|
item |
Yes |
Item Id |
|
itemDisplayLevel |
No |
Item display level |
PARENT_LEVEL PARENT_DIFF_LEVEL TRAN_LEVEL |
diff1 |
No |
Diff1 Id |
|
diff2 |
No |
Diff2 Id |
|
diff3 |
No |
Diff3 Id |
|
diff4 |
No |
Diff4 Id |
|
pageSize |
No |
Maximum number of items to retrieve per page |
|
pageNumber |
No |
Result page to retrieve |
Output
RpoOrderItemLocRDO
Parameter Name | Data Type |
---|---|
location |
BigDecimal |
locationName |
String |
quantityOrdered |
BigDecimal |
totalCost |
BigDecimal |
currency |
String |
PagedResultsRDO
Parameter Name | Data Type |
---|---|
totalRecordCount |
BigDecimal |
Next Page URL |
String |
Previous Page URL |
String |
JSON Structure: "{ "locations" : [ { "locationId" : 12345, "locationName" : "some location", "orderedQuantity" : 1000, "totalCost" : 12345.234, "currencyCode" : "USD" }, { "locationId" : 12345, "locationName" : "some location", "orderedQuantity" : 1000, "totalCost" : 12345.234, "currencyCode" : "USD" } ] }"
Update Purchase Orders Date
This section describes the Update Purchase Orders Date service.
Business Overview
This service update list of purchase order dates. If no date is sent or sent as null then the assumption is there is no change on the current record date.
ReST URL
/PurchaseOrders/recent/updatePurchaseOrderDate?notBeforeDate={notBeforeDate}¬AfterDate={notAfterDate}&otbEowDate={otbEowDate}&orderNumbers={orderNumbers}
Input Parameters
Order Numbers - Required - comma separated list
Not Before Date - Optional - in a long format
Not After Date - Optional - in a long format
OTB EWO Date - Optional - in a long format
Output
RpoStatusRDO
Parameter Name | Data Type |
---|---|
successOrdersCount |
BigDecimal |
successOrdersTable |
List<BigDecimal> |
failOrdersCount |
BigDecimal |
failOrdersTable |
List<RpoFailRDO> |
RpoFailRDO
Parameter Name | Data Type |
---|---|
orderNumber |
BigDecimal |
errorMessage |
String |
JSON Structure: { "successOrdersCount": 0, "successOrdersTable": [], "failOrdersCount": 2, "failOrdersTable": [ { "orderNumber": 123, "errorMessage": "Invalid Reason Code.", "links": [], "hyperMediaContent": { "linkRDO": [] } }, { "orderNumber": 987, "errorMessage": "Invalid Reason Code.", "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "links": [], "hyperMediaContent": { "linkRDO": [] } }
Cancel Purchase Orders
This section describes the Cancel Purchase Orders service.
Output
RpoStatusRDO
Parameter Name | Data Type |
---|---|
successOrdersCount |
BigDecimal |
successOrdersTable |
List<BigDecimal> |
failOrdersCount |
BigDecimal |
failOrdersTable |
List<RpoFailRDO> |
RpoFailRDO
Parameter Name | Data Type |
---|---|
orderNumber |
BigDecimal |
errorMessage |
String |
JSON Structure: { "successOrdersCount": 0, "successOrdersTable": [], "failOrdersCount": 2, "failOrdersTable": [ { "orderNumber": 123, "errorMessage": "Invalid Reason Code.", "links": [], "hyperMediaContent": { "linkRDO": [] } }, { "orderNumber": 987, "errorMessage": "Invalid Order Number.", "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "links": [], "hyperMediaContent": { "linkRDO": [] } }
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
ALLOC_DETAIL |
Yes |
No |
Yes |
No |
ALLOC_HEADER |
Yes |
No |
Yes |
No |
APPT_DETAIL |
Yes |
No |
No |
No |
APPT_HEAD |
Yes |
No |
No |
No |
CODE_DETAIL |
Yes |
No |
No |
No |
DEAL_CALC_QUEUE |
No |
No |
No |
Yes |
ORDHEAD |
Yes |
No |
Yes |
No |
ORDLOC |
Yes |
No |
Yes |
No |
OTB |
No |
No |
Yes |
No |
SHIPMENT |
Yes |
No |
Yes |
No |
SHIPSKU |
Yes |
No |
Yes |
No |
SYSTEM_OPTIONS |
Yes |
No |
No |
No |
WH |
Yes |
No |
No |
No |
JOB_AUDIT_LOGS |
No |
Yes |
No |
No |
JOB_AUDIT_PAYLOAD |
No |
Yes |
No |
No |
Approve Purchase Orders
This section describes the Approve Purchase Orders service.
Output
RpoStatusRDO
Parameter Name | Data Type |
---|---|
successOrdersCount |
BigDecimal |
successOrdersTable |
List<BigDecimal> |
failOrdersCount |
BigDecimal |
failOrdersTable |
List<RpoFailRDO> |
RpoFailRDO
Parameter Name | Data Type |
---|---|
orderNumber |
BigDecimal |
errorMessage |
String |
JSON Structure: { "successOrdersCount": 0, "successOrdersTable": [], "failOrdersCount": 2, "failOrdersTable": [ { "orderNumber": 123, "errorMessage": " Invalid Order Number.", "links": [], "hyperMediaContent": { "linkRDO": [] } }, { "orderNumber": 987, "errorMessage": "Invalid Order Number.", "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "links": [], "hyperMediaContent": { "linkRDO": [] } }
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
ALC_HEAD_TEMP |
No |
No |
No |
Yes |
ALLOC_CHRG_TEMP |
No |
No |
No |
Yes |
ALLOC_DETAIL |
Yes |
No |
Yes |
No |
ALLOC_DETAIL_TEMP |
No |
No |
No |
Yes |
ALLOC_HEADER |
Yes |
No |
Yes |
No |
ALLOC_HEADER_TEMP |
No |
No |
No |
Yes |
CONTRACT_COST_HIST |
Yes |
Yes |
No |
No |
CONTRACT_DETAIL |
Yes |
No |
Yes |
No |
CONTRACT_HEADER |
Yes |
No |
Yes |
No |
DEAL_ACTUALS_FORECAST |
No |
No |
No |
Yes |
DEAL_ACTUALS_ITEM_LOC |
No |
No |
No |
Yes |
DEAL_COMP_PROM |
No |
No |
No |
Yes |
DEAL_DETAIL |
No |
No |
No |
Yes |
DEAL_HEAD |
No |
No |
No |
Yes |
DEAL_HEAD_CFA_EXT |
No |
No |
No |
Yes |
DEAL_ITEMLOC_DCS |
No |
No |
No |
Yes |
DEAL_ITEMLOC_DIV_GRP |
No |
No |
No |
Yes |
DEAL_ITEMLOC_ITEM |
No |
No |
No |
Yes |
DEAL_ITEMLOC_PARENT_DIFF |
No |
No |
No |
Yes |
DEAL_QUEUE |
No |
No |
No |
Yes |
DEAL_THRESHOLD |
No |
No |
No |
Yes |
DEAL_THRESHOLD_REV |
No |
No |
No |
Yes |
DOC |
Yes |
No |
No |
No |
DOC_LINK |
Yes |
No |
No |
No |
ITEM_LOC |
Yes |
No |
Yes |
No |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_SUPP_COUNTRY |
Yes |
No |
No |
No |
ITEM_TICKET |
Yes |
No |
No |
No |
LC_ACTIVITY |
Yes |
No |
No |
No |
LC_AMENDMENTS |
Yes |
Yes |
No |
No |
LC_DETAIL |
Yes |
Yes |
No |
No |
LC_HEAD |
Yes |
No |
Yes |
No |
LC_ORDAPPLY |
No |
Yes |
No |
Yes |
ORD_INV_MGMT |
Yes |
No |
No |
Yes |
ORD_LC_AMENDMENTS |
Yes |
No |
No |
No |
ORDCUST |
Yes |
No |
No |
No |
ORDCUST_DETAIL |
Yes |
Yes |
No |
Yes |
ORDDIST_ITEM_TEMP |
No |
No |
No |
Yes |
ORDHEAD |
Yes |
No |
No |
No |
ORDHEAD_REV |
No |
Yes |
No |
No |
ORDLC |
Yes |
No |
Yes |
No |
ORDLOC |
Yes |
No |
Yes |
No |
ORDLOC_DISCOUNT |
No |
No |
No |
Yes |
ORDLOC_DISCOUNT_TEMP |
No |
No |
No |
Yes |
ORDLOC_EXP_TEMP |
No |
No |
No |
Yes |
ORDLOC_REV |
No |
Yes |
No |
No |
ORDLOC_TEMP |
No |
No |
No |
Yes |
ORDLOC_WKSHT |
Yes |
No |
No |
Yes |
ORDSKU |
Yes |
No |
No |
No |
ORDSKU_HTS |
Yes |
No |
No |
No |
ORDSKU_HTS_ASSESS_TEMP |
No |
No |
No |
Yes |
ORDSKU_HTS_TEMP |
No |
No |
No |
Yes |
ORDSKU_REV |
No |
Yes |
No |
No |
ORDSKU_TEMP |
No |
No |
No |
Yes |
OTB |
Yes |
Yes |
Yes |
No |
OTB_CASCADE_STG |
No |
Yes |
No |
No |
PARTNER_ORG_UNIT |
Yes |
No |
No |
No |
POP_TERMS_DEF |
No |
No |
No |
Yes |
POP_TERMS_FULFILLMENT |
No |
No |
No |
Yes |
PROCUREMENT_UNIT_OPTIONS |
Yes |
No |
No |
No |
REPL_RESULTS_TEMP |
No |
No |
No |
Yes |
REQ_DOC |
Yes |
Yes |
No |
No |
REQ_DOC_TEMP |
No |
No |
No |
Yes |
REV_ORDERS |
No |
No |
No |
Yes |
RTM_UNIT_OPTIONS |
Yes |
No |
No |
No |
STORE |
Yes |
No |
No |
No |
SUP_AVAIL |
Yes |
No |
Yes |
No |
SUPS |
Yes |
No |
No |
No |
SYSTEM_CONFIG_OPTIONS |
Yes |
No |
No |
No |
TAX_CALC_EVENT |
Yes |
Yes |
No |
No |
TAX_EVENT_RUN_TYPE |
Yes |
No |
No |
No |
TICKET_REQUEST |
No |
Yes |
No |
No |
TIMELINE_TEMP |
No |
No |
No |
Yes |
TRANSIT_TIMES |
Yes |
No |
No |
No |
V_PACKSKU_QTY |
Yes |
No |
No |
No |
WH |
Yes |
No |
No |
No |
WO_DETAIL_TEMP |
No |
No |
No |
Yes |
WO_HEAD_TEMP |
No |
No |
No |
Yes |
JOB_AUDIT_LOGS |
No |
Yes |
No |
No |
JOB_AUDIT_PAYLOAD |
No |
Yes |
No |
No |
Reject Purchase Orders
This section describes the Reject Purchase Orders service.
Output
RpoStatusRDO
Parameter Name | Data Type |
---|---|
successOrdersCount |
BigDecimal |
successOrdersTable |
List<BigDecimal> |
failOrdersCount |
BigDecimal |
failOrdersTable |
List<RpoFailRDO> |
RpoFailRDO
Parameter Name | Data Type |
---|---|
orderNumber |
BigDecimal |
errorMessage |
String |
JSON Structure: { "successOrdersCount": 0, "successOrdersTable": [], "failOrdersCount": 2, "failOrdersTable": [ { "orderNumber": 123, "errorMessage": " Invalid Order Number.", "links": [], "hyperMediaContent": { "linkRDO": [] } }, { "orderNumber": 987, "errorMessage": "Invalid Order Number.", "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "links": [], "hyperMediaContent": { "linkRDO": [] } }
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
ALLOC_DETAIL |
No |
No |
Yes |
No |
ALLOC_HEADER |
Yes |
No |
Yes |
No |
CONTRACT_DETAIL |
Yes |
No |
Yes |
No |
CONTRACT_HEADER |
Yes |
No |
Yes |
No |
ITEM_MASTER |
Yes |
No |
No |
No |
LC_ORDAPPLY |
No |
No |
No |
Yes |
ORDHEAD |
Yes |
No |
Yes |
No |
ORDLOC |
Yes |
No |
No |
No |
OTB |
No |
No |
Yes |
No |
SHIPMENT |
Yes |
No |
No |
No |
SHIPSKU |
Yes |
No |
No |
No |
SYSTEM_OPTIONS |
Yes |
No |
No |
No |
JOB_AUDIT_LOGS |
No |
Yes |
No |
No |
JOB_AUDIT_PAYLOAD |
No |
Yes |
No |
No |
Reclass Detail Service
This section describes the Reclass Detail service.
Output
RestReclassRecRDO
Parameter Name | Data Type |
---|---|
toClass |
BigDecimal |
reclassDate |
Timestamp |
reclassDesc |
String |
toSubclass |
BigDecimal |
reclassNo |
BigDecimal |
toDept |
toDept |
JSON Structure: [ { "toClass": null, "reclassDate": null, "reclassDesc": null, "toSubclass": null, "reclassNo": null, "toDept": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ]
Replenishment Schedule Services
This section describes the Replenishment Schedule service.
Business Overview
The primary role of these services is to create, modify, and delete scheduled replenishments and send them to Merchandising.
Create Replenishment Schedule
This section describes the Create Replenishment Schedule service.
Business Overview
This service creates scheduled replenishments by calling the SVCPROV_REPL package to load input data to the staging tables and then calling the core replenishment package to validate and insert data to the Merchandising tables.
Input Parameters
ReplSchedCreModRDO
Parameter Name | Data Type |
---|---|
replAttrId |
BigDecimal |
schRplDesc |
String |
scheduledActiveDate |
Long |
replAction |
String |
item |
String |
diff1 |
String |
diff2 |
String |
diff3 |
String |
diff4 |
String |
dept |
BigDecimal |
class1 |
BigDecimal |
subclass |
BigDecimal |
loc |
BigDecimal |
locType |
String |
autoRangeInd |
String |
activateDate |
Long |
deactivateDate |
Long |
presStock |
BigDecimal |
demoStock |
BigDecimal |
stockCat |
String |
replOrderCtrl |
String |
sourcingWh |
BigDecimal |
supplier |
BigDecimal |
originCountryId |
String |
pickupLeadTime |
BigDecimal |
whLeadTime |
BigDecimal |
replMethodInd |
String |
replMethod |
String |
minStock |
BigDecimal |
maxStock |
BigDecimal |
incrPct |
BigDecimal |
minSupplyDays |
BigDecimal |
maxSupplyDays |
BigDecimal |
timeSupplyHorizon |
BigDecimal |
addLeadTimeInd |
String |
invSellingDays |
BigDecimal |
serviceLevelType |
String |
serviceLevel |
BigDecimal |
serviceLevelFloatingStd |
String |
lostSalesFactor |
BigDecimal |
terminalStockQty |
BigDecimal |
seasonId |
BigDecimal |
phaseId |
BigDecimal |
rejectStoreOrdInd |
String |
multRunsPerDayInd |
String |
tsfZeroSohInd |
String |
nonScalingInd |
String |
maxScaleValue |
BigDecimal |
sizeProfileInd |
String |
reviewCycle |
String |
updateDaysInd |
String |
mondayInd |
String |
tuesdayInd |
String |
wednesdayInd |
String |
thursdayInd |
String |
fridayInd |
String |
saturdayInd |
String |
sundayInd |
String |
primaryPackNo |
String |
defaultPackInd |
String |
removePackInd |
String |
mraUpdate |
String |
mraRestore |
String |
JSON Structure: [ {"replAttrId": null, "schRplDesc": null, "scheduledActiveDate": null, "replAction": null, "item": null, "diff1": null, "diff2": null, "diff3": null, "diff4": null, "dept": null, "class1": null, "subclass": null, "loc": null, "locType": null, "autoRangeInd": null, "activateDate": null, "deactivateDate": null, "presStock": null, "demoStock": null, "stockCat": null, "replOrderCtrl": null, "sourcingWh": null, "supplier": null, "originCountryId": null, "pickupLeadTime": null, "whLeadTime": null, "replMethodInd": null, "replMethod": null, "minStock": null, "maxStock": null, "incrPct": null, "minSupplyDays": null, "maxSupplyDays": null, "timeSupplyHorizon": null, "addLeadTimeInd": null, "invSellingDays": null, "serviceLevelType": null, "serviceLevel": null, "serviceLevelFloatingStd": null, "lostSalesFactor": null, "terminalStockQty": null, "seasonId": null, "phaseId": null, "rejectStoreOrdInd": null, "multRunsPerDayInd": null, "tsfZeroSohInd": null, "nonScalingInd": null, "maxScaleValue": null, "sizeProfileInd": null, "reviewCycle": null, "updateDaysInd": null, "mondayInd": null, "tuesdayInd": null, "wednesdayInd": null, "thursdayInd": null, "fridayInd": null, "saturdayInd": null, "sundayInd": null, "primaryPackNo": null, "defaultPackInd": null, "removePackInd": null, "mraUpdate": null, "mraRestore": null} ]
Output
ReplStatusRDO
Parameter Name | Data Type |
---|---|
statusMsg |
String |
failReplTable |
List<ReplFailRDO> |
ReplFailRDO
Parameter Name | Data Type |
---|---|
replAttrId |
BigDecimal |
item |
String |
dept |
BigDecimal |
class1 |
BigDecimal |
subclass |
BigDecimal |
loc |
BigDecimal |
locType |
String |
effectiveDate |
Long |
errorMsg |
String |
The output will contain the status of the request including validation errors, if any.
JSON Structure: { "statusMsg": null, "failReplTable": [ { "replAttrId": null, "item": null, "dept": null, "class1": null, "subclass": null, "loc": null, "locType": null, "effectiveDate": null, "errorMsg": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "links": [], "hyperMediaContent": { "linkRDO": [] } }
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
REPL_ATTR_UPDATE_HEAD |
Yes |
Yes |
No |
No |
REPL_ATTR_UPDATE_ITEM |
Yes |
Yes |
No |
No |
REPL_ATTR_UPDATE_LOC |
Yes |
Yes |
No |
No |
SVC_PROCESS_TRACKER |
Yes |
Yes |
Yes |
No |
CORESVC_REPL_ERR |
No |
Yes |
No |
No |
SVC_REPL_ATTR_UPDATE |
Yes |
Yes |
No |
Yes |
REPL_ITEM_LOC |
Yes |
No |
No |
No |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_SUPP_COUNTRY |
Yes |
No |
No |
No |
ITEM_LOC |
Yes |
No |
No |
No |
SYSTEM_OPTIONS |
Yes |
No |
No |
No |
V_STORE |
Yes |
No |
No |
No |
V_WH |
Yes |
No |
No |
No |
JOB_AUDIT_LOGS |
No |
Yes |
No |
No |
JOB_AUDIT_PAYLOAD |
No |
Yes |
No |
No |
Modify Replenishment Schedule
This section describes the Modify Replenishment service.
Business Overview
This service modifies scheduled replenishments by calling the SVCPROV_REPL package to load input to the staging tables and then calling the core replenishment package to validate and process data to the Merchandising tables.
Input Parameters
ReplSchedCreModRDO
Parameter Name | Data Type |
---|---|
replAttrId |
BigDecimal |
schRplDesc |
String |
scheduledActiveDate |
Long |
replAction |
String |
item |
String |
diff1 |
String |
diff2 |
String |
diff3 |
String |
diff4 |
String |
dept |
BigDecimal |
class1 |
BigDecimal |
subclass |
BigDecimal |
loc |
BigDecimal |
locType |
String |
autoRangeInd |
String |
activateDate |
Long |
deactivateDate |
Long |
presStock |
BigDecimal |
demoStock |
BigDecimal |
stockCat |
String |
replOrderCtrl |
String |
sourcingWh |
BigDecimal |
supplier |
BigDecimal |
originCountryId |
String |
pickupLeadTime |
BigDecimal |
whLeadTime |
BigDecimal |
replMethodInd |
String |
replMethod |
String |
minStock |
BigDecimal |
maxStock |
BigDecimal |
incrPct |
BigDecimal |
minSupplyDays |
BigDecimal |
maxSupplyDays |
BigDecimal |
timeSupplyHorizon |
BigDecimal |
addLeadTimeInd |
String |
invSellingDays |
BigDecimal |
serviceLevelType |
String |
serviceLevel |
BigDecimal |
serviceLevelFloatingStd |
String |
lostSalesFactor |
BigDecimal |
terminalStockQty |
BigDecimal |
seasonId |
BigDecimal |
phaseId |
BigDecimal |
rejectStoreOrdInd |
String |
multRunsPerDayInd |
String |
tsfZeroSohInd |
String |
nonScalingInd |
String |
maxScaleValue |
BigDecimal |
sizeProfileInd |
String |
reviewCycle |
String |
updateDaysInd |
String |
mondayInd |
String |
tuesdayInd |
String |
wednesdayInd |
String |
thursdayInd |
String |
fridayInd |
String |
saturdayInd |
String |
sundayInd |
String |
primaryPackNo |
String |
defaultPackInd |
String |
removePackInd |
String |
mraUpdate |
String |
mraRestore |
String |
JSON Structure: [ { "replAttrId": null, "schRplDesc": null, "scheduledActiveDate": null, "replAction": null, "item": null, "diff1": null, "diff2": null, "diff3": null, "diff4": null, "dept": null, "class1": null, "subclass": null, "loc": null, "locType": null, "autoRangeInd": null, "activateDate": null, "deactivateDate": null, "presStock": null, "demoStock": null, "stockCat": null, "replOrderCtrl": null, "sourcingWh": null, "supplier": null, "originCountryId": null, "pickupLeadTime": null, "whLeadTime": null, "replMethodInd": null, "replMethod": null, "minStock": null, "maxStock": null, "incrPct": null, "minSupplyDays": null, "maxSupplyDays": null, "timeSupplyHorizon": null, "addLeadTimeInd": null, "invSellingDays": null, "serviceLevelType": null, "serviceLevel": null, "serviceLevelFloatingStd": null, "lostSalesFactor": null, "terminalStockQty": null, "seasonId": null, "phaseId": null, "rejectStoreOrdInd": null, "multRunsPerDayInd": null, "tsfZeroSohInd": null, "nonScalingInd": null, "maxScaleValue": null, "sizeProfileInd": null, "reviewCycle": null, "updateDaysInd": null, "mondayInd": null, "tuesdayInd": null, "wednesdayInd": null, "thursdayInd": null, "fridayInd": null, "saturdayInd": null, "sundayInd": null, "primaryPackNo": null, "defaultPackInd": null, "removePackInd": null, "mraUpdate": null, "mraRestore": null } ]
Output
ReplStatusRDO
Parameter Name | Data Type |
---|---|
statusMsg |
String |
failReplTable |
List<ReplFailRDO> |
ReplFailRDO
Parameter Name | Data Type |
---|---|
replAttrId |
BigDecimal |
item |
String |
dept |
BigDecimal |
class1 |
BigDecimal |
subclass |
BigDecimal |
loc |
BigDecimal |
locType |
String |
effectiveDate |
Long |
errorMsg |
String |
The output will contain the status of the request including validation errors, if any.
JSON Structure: { "statusMsg": null, "failReplTable": [ { "replAttrId": null, "item": null, "dept": null, "class1": null, "subclass": null, "loc": null, "locType": null, "effectiveDate": null, "errorMsg": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "links": [], "hyperMediaContent": { "linkRDO": [] } }
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
REPL_ATTR_UPDATE_HEAD |
Yes |
Yes |
No |
No |
REPL_ATTR_UPDATE_ITEM |
Yes |
Yes |
No |
No |
REPL_ATTR_UPDATE_LOC |
Yes |
Yes |
No |
No |
SVC_PROCESS_TRACKER |
Yes |
Yes |
Yes |
No |
CORESVC_REPL_ERR |
No |
Yes |
No |
No |
SVC_REPL_ATTR_UPDATE |
Yes |
Yes |
No |
Yes |
REPL_ITEM_LOC |
Yes |
No |
No |
No |
ITEM_MASTER |
Yes |
No |
No |
No |
ITEM_SUPP_COUNTRY |
Yes |
No |
No |
No |
ITEM_LOC |
Yes |
No |
No |
No |
SYSTEM_OPTIONS |
Yes |
No |
No |
No |
V_STORE |
Yes |
No |
No |
No |
V_WH |
Yes |
No |
No |
No |
JOB_AUDIT_LOGS |
No |
Yes |
No |
No |
JOB_AUDIT_PAYLOAD |
No |
Yes |
No |
No |
Delete Replenishment Schedule
This section describes the Delete Replenishment Schedule service.
Business Overview
This service deletes scheduled replenishments by calling the SVCPROV_REPL package to load input to the staging tables and then calling the core replenishment package to validate and delete data from the Merchandising tables.
Input Parameters
ReplSchedDelRDO
Parameter Name | Data Type |
---|---|
replAttrId |
BigDecimal |
item |
String |
dept |
BigDecimal |
class1 |
BigDecimal |
subclass |
BigDecimal |
loc |
BigDecimal |
locType |
String |
JSON Structure: [ { "replAttrId": null, "item": null, "dept": null, "class1": null, "subclass": null, "loc": null, "locType": null } ]
Output
ReplStatusRDO
Parameter Name | Data Type |
---|---|
statusMsg |
String |
failReplTable |
List<ReplFailRDO> |
ReplFailRDO
The output will contain the status of the request including validation errors, if any.
Parameter Name | Data Type |
---|---|
replAttrId |
BigDecimal |
item |
String |
dept |
BigDecimal |
class1 |
BigDecimal |
subclass |
BigDecimal |
loc |
BigDecimal |
locType |
String |
effectiveDate |
Long |
errorMsg |
String |
JSON Structure: { "statusMsg": null, "failReplTable": [ { "replAttrId": null, "item": null, "dept": null, "class1": null, "subclass": null, "loc": null, "locType": null, "effectiveDate": null, "errorMsg": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "links": [], "hyperMediaContent": { "linkRDO": [] } }
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
REPL_ATTR_UPDATE_HEAD |
Yes |
Yes |
No |
Yes |
REPL_ATTR_UPDATE_ITEM |
Yes |
Yes |
No |
Yes |
REPL_ATTR_UPDATE_LOC |
Yes |
Yes |
No |
Yes |
SVC_PROCESS_TRACKER |
Yes |
Yes |
Yes |
No |
CORESVC_REPL_ERR |
No |
Yes |
No |
No |
SVC_REPL_ATTR_UPDATE |
Yes |
Yes |
No |
Yes |
JOB_AUDIT_LOGS |
No |
Yes |
No |
No |
JOB_AUDIT_PAYLOAD |
No |
Yes |
No |
No |
Shipment Detail Service
This section describes the Shipment Detail Service.
Business Overview
Shipment Detail service allows user to retrieve shipment and shipment item details for a given distro (transfer or allocation) or purchase order (PO).
ReST URL
Shipment/shipmentDetail?orderNumber={orderNumber}&distroNumber={distroNumber}&distroType={distroType}
Input Parameters
Parameter Name | Required | Description |
---|---|---|
orderNumber |
No |
Order Number. If none is specified, then Distro Number and Distro Type are required. |
distroNumber |
No |
Distro Number. If none is specified, then Order Number is required. |
distroType |
No |
Distro Type. If none is specified, then Order Number is required. |
Output
RestShipmentRecRDO
Parameter Name | Data Type |
---|---|
shipment |
BigDecimal |
bolNo |
String |
asn |
String |
shipDate |
Timestamp |
receiveDate |
Timestamp |
estArrDate |
Timestamp |
shipOrigin |
String |
statusCode |
String |
toLoc |
BigDecimal |
toLocType |
String |
fromLoc |
BigDecimal |
fromLocType |
String |
parentShipment |
BigDecimal |
seqNo |
BigDecimal |
item |
String |
refItem |
String |
carton |
String |
invStatus |
BigDecimal |
shipskuStatusCode |
String |
qtyReceived |
BigDecimal |
unitCost |
BigDecimal |
unitRetail |
BigDecimal |
qtyExpected |
BigDecimal |
adjustType |
String |
actualReceivingStore |
BigDecimal |
reconcileUserId |
String |
reconcileDate |
Timestamp |
tamperedInd |
String |
dispositionedInd |
String |
JSON Structure: { "shipment":null, "bolNo":null, "asn":null, "shipDate":null, "receiveDate":null, "estArrDate":null, "shipOrigin":null, "statusCode":null, "toLoc":null, "toLocType":null, "fromLoc":null, "fromLocType":null, "parentShipment":null, "seqNo":null, "item":null, "refItem":null, "carton":null, "invStatus":null, "shipskuStatusCode":null, "qtyReceived":null, "unitCost":null, "unitRetail":null, "qtyExpected":null, "adjustType":null, "actualReceivingStore":null, "reconcileUserId":null, "reconcileDate":null, "tamperedInd":null, "dispositionedInd":null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
Stock Count Detail Service
This section describes the Stock Count Detail service.
Business Overview
Stock Count Detail service allows user to retrieve open stock count details for a given item and/or store.
ReST URL
StockCount/stockCountDetail?cycleCount={cycleCount}&locationType={locationType}&location={location}&item={item}&stocktakeDate={stocktakeDate}&pageSize={pageSize}&pageNumber={pageNumber}
Input Parameters
Parameter Name | Required | Description |
---|---|---|
Item |
No |
Item |
Location |
No |
Location |
Location Type |
No |
Location Type |
Cycle Count |
No |
Cycle Count |
Stocktake Date |
No |
Stocktake Date (always optional) |
Output
RestStockCountRecRDO
Parameter Name | Data Type |
---|---|
cycleCount |
BigDecimal |
cycleCountDesc |
String |
stocktakeDate |
Timestamp |
stocktakeType |
String |
stakeSkuLoc |
List<RestStakeSkuLocRecRDO> |
RestStakeSkuLocRecRDO
Parameter Name | Data Type |
---|---|
item |
String |
location |
BigDecimal |
locType |
String |
snapshotOnHandQty |
BigDecimal |
snapshotInTransitQty |
BigDecimal |
snapshotUnitCost |
BigDecimal |
snapshotUnitRetail |
BigDecimal |
processed |
String |
physicalCountQty |
BigDecimal |
packCompQty |
BigDecimal |
inTransitAmt |
BigDecimal |
depositItemType |
String |
xformItemType |
String |
distributeQty |
BigDecimal |
JSON Structure: { "cycleCount":null, "cycleCountDesc":null, "stocktakeDate":null, "stocktakeType":null, "stakeSkuLoc": [ { "item":null, "location":null, "locType":null, "snapshotOnHandQty":null, "snapshotInTransitQty":null, "snapshotUnitCost":null, "snapshotUnitRetail":null, "processed":null, "physicalCountQty":null, "packCompQty":null, "inTransitAmt":null, "depositItemType":null, "xformItemType":null, "distributeQty":null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "links": [], "hyperMediaContent": { "linkRDO": [] } }
Store Day User Service
This section describes the Store Day User service.
Business Overview
The primary role of this service is to create or delete store day user and send them to Merchandising.
Create Store Day User
Business Overview
This service creates store day user by calling the SVCPROV_STOREDAYUSER package to load input data to the staging tables and then calling the core store day user package to validate and insert data to the Merchandising tables.
Input Parameters
SvcprovSdudescRecRDO
Parameter Name | Data Type |
---|---|
store |
BigDecimal |
businessDate |
String |
userId |
String |
JSON Structure
[{"store": null, " businessDate": null, " userId": null}]
BusinessDate will take input in string with the format as 'DD-MON-YYYY' and later converted to Timestamp format and insert in table.
Output
SvcprovSduStatusRecRDO
Parameter Name | Data Type |
---|---|
statusMsg |
String |
sduErrTbl |
List< SvcprovFailSduRecRDO > |
SvcprovFailSduRecRDO
Parameter Name | Data Type |
---|---|
store |
BigDecimal |
businessDate |
String |
userId |
String |
errorMsg |
String |
The output will contain the status of the request including validation errors, if any.
JSON Structure:
{ "statusMsg": null, " sduErrTbl ": [ { " store": null, " businessDate": null, " userId": null, "errorMsg": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "links": [], "hyperMediaContent": { "linkRDO": [] } }
Delete Store Day User
Business Overview
This service deletes store day user by calling the SVCPROV_SDU package to load input data to the staging tables and then calling the core store day user package to validate and delete data to the Merchandising tables.
Input Parameters
SvcprovSdudescRecRDO
Parameter Name | Data Type |
---|---|
store |
BigDecimal |
businessDate |
String |
userId |
String |
JSON Structure
[{"store": null, " businessDate": null, " userId": null}]
BusinessDate will take input in string with the format as 'DD-MON-YYYY' and later converted to Timestamp format and delete from table.
Output
SvcprovSduStatusRecRDO
Parameter Name | Data Type |
---|---|
statusMsg |
String |
sduErrTbl |
List< SvcprovFailSduRecRDO > |
SvcprovFailSduRecRDO
Parameter Name | Data Type |
---|---|
store |
BigDecimal |
businessDate |
String |
userId |
String |
errorMsg |
String |
The output will contain the status of the request including validation errors, if any.
JSON Structure
{ "statusMsg": null, " sduErrTbl ": [ { " store": null, " businessDate": null, " userId": null, "errorMsg": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "links": [], "hyperMediaContent": { "linkRDO": [] } }
Store Detail Service
This section describes the Store Detail service.
Business Overview
Store Detail service allows user to retrieve Store information for a selected store or for all stores.
Input Parameters
Parameter Name | Required | Description |
---|---|---|
Store |
No |
Store ID. If none is specified, all stores will be retrieved. |
Output
RestStoreRecRDO
Parameter Name | Data Type |
---|---|
store |
BigDecimal |
storeName |
String |
storeName10 |
String |
storeName3 |
String |
storeNameSecondary |
String |
storeClass |
String |
storeOpenDate |
Timestamp |
storeCloseDate |
Timestamp |
acquiredDate |
Timestamp |
remodelDate |
Timestamp |
vatRegion |
BigDecimal |
vatIncludeInd |
String |
stockholdingInd |
String |
channelId |
BigDecimal |
transferZone |
BigDecimal |
defaultWh |
BigDecimal |
stopOrderDays |
BigDecimal |
startOrderDays |
BigDecimal |
currencyCode |
String |
lang |
BigDecimal |
dunsNumber |
String |
dunsLoc |
String |
sisterStore |
BigDecimal |
tsfEntityId |
BigDecimal |
orgUnitId |
BigDecimal |
storeType |
String |
wfCustomerId |
BigDecimal |
timezoneName |
String |
customerOrderLocInd |
String |
company |
BigDecimal |
chain |
BigDecimal |
area |
BigDecimal |
region |
BigDecimal |
district |
BigDecimal |
add1 |
String |
add2 |
String |
add3 |
String |
city |
String |
state |
String |
countryId |
String |
post |
String |
contactName |
String |
contactPhone |
String |
contactEmail |
String |
JSON Structure: { "store": null, "storeName": null, "storeName10": null, "storeName3": null, "storeNameSecondary": null, "storeClass": null, "storeOpenDate": null, "storeCloseDate": null, "acquiredDate": null, "remodelDate": null, "vatRegion": null, "vatIncludeInd": null, "stockholdingInd": null, "channelId": null, "transferZone": null, "defaultWh": null, "stopOrderDays": null, "startOrderDays": null, "currencyCode": null, "lang": null, "dunsNumber": null, "dunsLoc": null, "sisterStore": null, "tsfEntityId": null, "orgUnitId": null, "storeType": null, "wfCustomerId": null, "timezoneName": null, "customerOrderLocInd": null, "company": null, "chain": null, "area": null, "region": null, "district": null, "add1": null, "add2": null, "add3": null, "city": null, "state": null, "countryId": null, "post": null, "contactName": null, "contactPhone": null, "contactEmail": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
Supplier Detail Service
This section describes the Supplier Detail service.
Business Overview
Supplier Detail service allows user to retrieve Supplier information for a selected supplier.
Output
RestSupplierRecRDO
Parameter Name | Data Type |
---|---|
supplier |
BigDecimal |
sup_name |
String |
sup_name_secondary |
String |
supplier_parent |
BigDecimal |
sup_status |
String |
currency_code |
String |
terms |
String |
freight_terms |
String |
vat_region |
BigDecimal |
external_ref_id |
String |
Supplier_address |
List<RestSupplierAddressRecRDO> |
RestSupplierAddressRecRDO
Parameter Name | Data Type |
---|---|
add_1 |
String |
add_2 |
String |
add_3 |
String |
city |
String |
state |
String |
country_id |
String |
post |
String |
contact_name |
String |
contact_phone |
String |
contact_email |
String |
JSON Structure: [ { "supplierAddress": [ { "countryId": null, "add2": null, "add3": null, "city": null, "add1": null, "state": null, "contactEmail": null, "contactName": null, "contactPhone": null, "post": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }, { "countryId": null, "add2": null, "add3": null, "city": null, "add1": null, "state": null, "contactEmail": null, "contactName": null, "contactPhone": null, "post": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }, { "countryId": null, "add2": null, "add3": null, "city": null, "add1": null, "state": null, "contactEmail": null, "contactName": null, "contactPhone": null, "post": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }, { "countryId": null, "add2": null, "add3": null, "city": null, "add1": null, "state": null, "contactEmail": null, "contactName": null, "contactPhone": null, "post": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }, { "countryId": null, "add2": null, "add3": null, "city": null, "add1": null, "state": null, "contactEmail": null, "contactName": null, "contactPhone": null, "post": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "supNameSecondary": null, "supplierParent":null, "terms": null, "supStatus": null, "currencyCode": null, "supplier": null, "supName": null, "freightTerms": null, "vatRegion": null, "externalRefId": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ]
Transfer Detail Service
This section describes the Transfer Detail service.
Output
RestTsfheadRecRDO
Parameter Name | Data Type |
---|---|
tsfNo |
BigDecimal |
tsfParentNo |
BigDecimal |
fromLocType |
String |
fromLoc |
BigDecimal |
toLocType |
String |
toLoc |
BigDecimal |
expDcDate |
Timestamp |
dept |
BigDecimal |
inventoryType |
String |
tsfType |
String |
status |
String |
deliveryDate |
Timestamp |
closeDate |
Timestamp |
notAfterDate |
Timestamp |
contextType |
String |
contextValue |
String |
wfOrderNo |
BigDecimal |
tsfdetail |
List<RestTsfdetailRecRDO> |
RestTsfdetailRecRDO
Parameter Name | Data Type |
---|---|
tsfSeqNo |
BigDecimal |
item |
String |
invStatus |
BigDecimal |
tsfPrice |
BigDecimal |
tsfQty |
BigDecimal |
fillQty |
BigDecimal |
shipQty |
BigDecimal |
receivedQty |
BigDecimal |
reconciledQty |
BigDecimal |
distroQty |
BigDecimal |
selectedQty |
BigDecimal |
cancelledQty |
BigDecimal |
suppPackSize |
BigDecimal |
tsfCost |
BigDecimal |
publishInd |
String |
JSON Structure: { "tsfNo": null, "tsfParentNo": null, "fromLocType": null, "fromLoc": null, "toLocType": null, "toLoc": null, "expDcDate": null, "dept": null, "inventoryType": null, "tsfType": null, "status": null, "deliveryDate": null, "closeDate": null, "notAfterDate": null, "contextType": null, "contextValue": null, "wfOrderNo": null, "tsfdetail": [ { "tsfSeqNo": null, "item": null, "invStatus": null, "tsfPrice": null, "tsfQty": null, "fillQty": null, "shipQty": null, "receivedQty": null, "reconciledQty": null, "distroQty": null, "selectedQty": null, "cancelledQty": null, "suppPackSize": null, "tsfCost": null, "publishInd": null, "links": [], "hyperMediaContent": { "linkRDO": [] } } ], "links": [], "hyperMediaContent": { "linkRDO": [] } }
VAT Detail Service
This section describes the VAT Detail service.
Business Overview
VAT Detail service allows user to retrieve VAT information for a selected department.
Output
RestVatRecRDO
Parameter Name | Data Type |
---|---|
vatRegion |
BigDecimal |
vatRegionName |
String |
vatRegionType |
String |
vatType |
String |
vatCode |
String |
vatCodeDesc |
String |
vatRate |
BigDecimal |
JSON Structure: { "vatRegion": null, "vatRegionName": null, "vatRegionType": null, "vatType": null, "vatCode": null, "vatCodeDesc": null, "vatRate": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
Warehouse Detail Service
This section describes the Warehouse Detail service.
Business Overview
Warehouse Detail service allows user to retrieve Warehouse information for a selected warehouse or for all warehouses.
Input Parameters
Parameter Name | Required | Description |
---|---|---|
Warehouse |
No |
Warehouse Number. If none is specified, all warehouses will be retrieved. |
Output
RestWhRecRDO
Parameter Name | Data Type |
---|---|
warehouse |
BigDecimal |
warehouseName |
String |
warehouseSecondaryName |
String |
vatRegion |
BigDecimal |
organizationHierarchyType |
BigDecimal |
organizationHierarchyValue |
BigDecimal |
currencyCode |
String |
physicalWarehouse |
BigDecimal |
primaryVirtualWarehouse |
BigDecimal |
channelId |
BigDecimal |
stockholdingIndicator |
String |
breakPackIndicator |
String |
redistributeWarehouseIndicator |
String |
restrictedIndicator |
String |
protectedIndicator |
String |
transferEntityId |
BigDecimal |
finisherInd |
String |
inboundHandlingDays |
BigDecimal |
organizationalUnitId |
BigDecimal |
virtualWarehouseType |
String |
customerOrderLocationIndicator |
String |
address1 |
String |
address2 |
String |
address3 |
String |
city |
String |
state |
String |
countryId |
String |
post |
String |
contactName |
String |
contactPhone |
String |
contactEmail |
String |
JSON Structure: { "warehouse": null, "warehouseName": null, "warehouseSecondaryName": null, "vatRegion": "null, "organizationHierarchyType": null, "organizationHierarchyValue": null, "currencyCode": null, "physicalWarehouse": null, "primaryVirtualWarehouse": null, "channelId": null, "stockholdingIndicator": null, "breakPackIndicator": null, "redistributeWarehouseIndicator": null, "restrictedIndicator": null, "protectedIndicator": null, "transferEntityId": null, "finisherIndicator": null, "inboundHandlingDays": null, "organizationalUnitId" :null, "virtualWarehouseType" :null, "customerOrderLocationIdicator" :null, "address1": null, "address2": null, "address3": null, "city": null, "state": null, "countryId": null, "post": null, "contactName": null, "contactPhone": null, "contactEmail": null, "links": [], "hyperMediaContent": { "linkRDO": [] } }
Sales Audit ReSTful Web Services
Summary of Open Store Days
Business Overview
This service provides, at a glance, the number of open stores for which the sales audit manager is responsible. The stores for which the user is responsible are those associated with the user in Sales Audit's employee maintenance via location traits.
Summary of Errors
Business Overview
This service provides, at a glance, the number outstanding errors on the specified days for stores for which the sales audit manager is responsible. An outstanding error is defined as an error that exists against a store day that has not been overridden.
Summary of Over/Short Amount
Business Overview
This service provides at a glance the sums of all overages and all shortages for all open stores on a given day for which the sales audit manager is responsible. If all locations to which the user is responsible have the same local currency, all monetary values will be displayed in the local currency. Otherwise, all monetary values will be displayed in the retailer's primary currency. If the Over/Short value for the store day is a positive value it is considered an overage, if the Over/Short value for the store day is a negative value it is a shortage.
Output
Record Type --DATE, OLDER, ALL
-
For record type DATE: Five records of type date are displayed for today minus 1 through today minus 5
-
One record type OLDER: is for store days older than today minus 5
-
One record type ALL: for all store days
Record Date --Date of date type rows
Over Amount
Short Amount
Currency Code
Summary of Over/Short Count
Business Overview
This service provides, at a glance, the count of overages and the count of shortages for all open stores on a given day for which the sales audit manager is responsible. If the Over/Short value for the store day is a positive value it is considered an overage, if the Over/Short value for the store day is a negative value it is a shortage.
Output
Record Type --DATE, OLDER, ALL
-
For record type DATE: five records of type date are displayed for today minus 1 through today minus 5
-
One record type OLDER: is for store days older than today minus 5
-
One record type ALL: for all store days
Record Date --Date of date type rows
Over Count
Short Count
Get Store Days
Business Overview
The service displays a list of open stores to which the user is assigned, for a single day, for 'OLDER' days, or for 'ALL' days.
ReST URL
/getStoreDays?store={store}&recordType={recordType}&recordDate={recordDate}&sortAttrib={sortAttrib}&sortDirection={sortDirection}&pageSize={pageSize}&pageNumber={pageNumber}
Input Parameters
Parameter Name | Required | Description | Valid values |
---|---|---|---|
RecordType |
Yes |
Record Type |
ALL, OLDER, DATE |
RecordDate |
No |
Record Date, required when recordType is DATE |
NA |
Store |
No |
Store ID |
NA |
SortAttrib |
No |
Sort Attribute |
STORENAME, AUDITOR, OSVALUE, ERRORCNT, DATASTATUS, OPENDAYS, OSDAYS and OSSUMS |
SortDirection |
No |
Sort Direction |
ASC, DESC |
PageSize |
No |
Maximum number of locations to retrieve per page |
NA |
PageNumber |
No |
Result page to retrieve |
NA |
Output
Store
Store Day Seq No
Auditors
Business Date
Store Name
Chain
Chain Name
Data Status
Data Status Description
Audit Status
Audit Status Description
Audit Changed Datetime
Fuel Status
Fuel Status Description
Over Short Amount
Currency Code
Error Count
Transaction Count
Loaded File Count
Expected File Count
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
LOC_TRAITS_MATRIX |
Yes |
No |
No |
No |
SA_ERROR |
Yes |
No |
No |
No |
SA_HQ_VALUE |
Yes |
No |
No |
No |
SA_POS_VALUE |
Yes |
No |
No |
No |
SA_STORE_DATA |
Yes |
No |
No |
No |
SA_STORE_DAY |
Yes |
No |
No |
No |
SA_SYS_VALUE |
Yes |
No |
No |
No |
SA_SYSTEM_OPTIONS |
Yes |
No |
No |
No |
SA_TOTAL |
Yes |
No |
No |
No |
SA_TRAN_HEAD |
Yes |
No |
No |
No |
SA_USER_LOC_TRAITS |
Yes |
No |
No |
No |
V_CHAIN |
Yes |
No |
No |
No |
V_CODE_DETAIL |
Yes |
No |
No |
No |
V_STORE |
Yes |
No |
No |
No |
Get Store Errors
Get Store Aggregations
Business Overview
Retrieves aggregated store day information for all dates or store days older than vdate -5.
ReST URL
/getStoreAggregations?allOlderInd={allOlderInd}&stores={stores}&sortAttrib={sortAttrib}&sortDirection={sortDirection}&pageSize={pageSize}&pageNumber={pageNumber}
Input Parameters
Parameter Name | Required | Description | Valid values |
---|---|---|---|
AllOlderInd |
Yes |
Search string for locations ID or Name |
ALL, OLDER |
Stores |
No |
Comma-separated values for stores |
NA |
SortAttrib |
No |
Sort Attribute |
STORENAME, AUDITOR, OSVALUE, ERRORCNT, DATASTATUS, OPENDAYS, OSDAYS and OSSUMS |
SortDirection |
No |
Sort Direction |
ASC, DESC |
PageSize |
No |
Maximum number of locations to retrieve per page |
NA |
PageNumber |
No |
Result page to retrieve |
NA |
Store Search
ReST URL
/storeSearch?searchString={searchString}&searchFilter={searchFilter}&sortAttrib={sortAttrib}&sortDirection={sortDirection}&pageSize={pageSize}&pageNumber={pageNumber}
Input Parameters
Parameter Name | Required | Description | Valid values |
---|---|---|---|
SearchString |
Yes |
Search string for locations ID or Name |
NA |
SearchFilter |
Yes |
Search all stores or assigned stores |
ALL, ASSIGN |
SortAttrib |
No |
Sort Attribute |
STORENAME, AUDITOR, OSVALUE, ERRORCNT, DATASTATUS, OPENDAYS, OSDAYS and OSSUMS |
SortDirection |
No |
Sort Direction |
ASC, DESC |
PageSize |
No |
Maximum number of locations to retrieve per page |
NA |
PageNumber |
No |
Result page to retrieve |
NA |
Output
Store
Store Name
Chain
Chain Name
Auditors
Open Days
Over Days
Short Days
Over Amount
Short Amount
Currency Code
Error Count
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
LOC_TRAITS_MATRIX |
Yes |
No |
No |
No |
SA_ERROR |
Yes |
No |
No |
No |
SA_HQ_VALUE |
Yes |
No |
No |
No |
SA_POS_VALUE |
Yes |
No |
No |
No |
SA_STORE_DATA |
Yes |
No |
No |
No |
SA_STORE_DAY |
Yes |
No |
No |
No |
SA_SYS_VALUE |
Yes |
No |
No |
No |
SA_TOTAL |
Yes |
No |
No |
No |
SA_TRAN_HEAD |
Yes |
No |
No |
No |
SA_USER_LOC_TRAITS |
Yes |
No |
No |
No |
V_CHAIN |
Yes |
No |
No |
No |
V_STORE |
Yes |
No |
No |
No |
Get Store Day Date Indicator
Business Overview
This web service allows the user to find which store days have records that needs attention.
Output
Record Type --DATE, OLDER, ALL
-
For record type DATE: five records of type date are displayed for today minus 1 through today minus 5
-
One record type OLDER: is for store days older than today minus 5
-
One record type ALL: for all store days
Record Date --Date of date type rows
Store Has Value indicator
Data Privacy Access Service
This section describes the Data Privacy Access service for Sales Audit.
Business Overview
This query service provides access to data stored in Sales Audit that contain personally identifiable information.
ReSTURL
https://<host:port>/RetailAppsDataPrivServicesRESTApp/rest/privatedata/getPersonalInfo?customer_id={entityName}::{entityType}::{entityId}::{fullName}:: {phone}::{email}
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 Sales Audit are:
|
Entity Type |
Used if the entity name is CUSTOMER. The value here should indicate the type of customer being queried. Valid values for this input can be found on the Codes table where code type is 'CIDT'. |
Entity ID |
The ID of the entity being queried. For example, the employee ID. |
Full Name |
The full name to be searched for the selected entity. |
Phone |
The phone number to be searched for the selected entity. |
|
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 EMPLOYEE, all instances where the employee, name, phone, and email match the data sent will be returned. If any of these parameters are not sent (e.g. employee), 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
|
Entity Type |
If the entity name is CUSTOMER, the value here indicates the type of customer being queried. Valid values for this input can be found on the Codes table where code type is 'CIDT'. 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. |
|
The email address associated with the entity. |
Sample Response
{ "Personal Information": { "list": [], "Get Personal Information": { "list": [ [ { "ENTITY_NAME": "EMPLOYEE", "ENTITY_TYPE": "null", "ENTITY_ID": "1414", "FULL_NAME": "Harry Adams", "PHONE": "2349989", "FAX": "null", "TELEX": "null", "PAGER": "null", "EMAIL": "hadams@email.com" } ] ] } } } }
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)
Data Privacy Forget Service
This section describes the Data Privacy Forget service for Sales Audit.
Business Overview
This service supports updating personal information stored in Sales Audit. 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.
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}
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 Sales Audit are:
|
Entity Type |
Required if the entity name is CUSTOMER. The value here should indicate the type of customer. Valid values for this input can be found on the Codes table where code type is 'CIDT'. |
Entity ID (required) |
The ID of the entity to be updated. For example, the employee ID. |
Full Name |
The value to update the full name with. If a null value is passed to this parameter that is a required field in the table, the field will be updated to 'XXXXX'. |
Phone |
The value to update the phone number with. If a null value is passed to this parameter that is a required field in the table, the field will be updated to 'XXXXX'. |
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. |
|
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 (for example, configuration errors, SQL errors, and so on).