| Oracle® Retail Merchandising Foundation Cloud Service Operations Guide Volume 2 - Message Publication and Subscription Designs Release 19.2.000 F36505-04 |
|
 Previous |
 Next |
| Oracle® Retail Merchandising Foundation Cloud Service Operations Guide Volume 2 - Message Publication and Subscription Designs Release 19.2.000 F36505-04 |
|
Previous |
Next |
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.
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.
|
Note: The services should not be used during the restricted batch window. |
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.
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
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.
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 xxx-yyy-mfcs-rhs.oracleindustry.com, where xxx-yyy is 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 Javadoc are available at:
The ReSTful Web services's WADL file is available at:
https://<hostname>/RmsReSTServices/services/private/application.wadl
The ReSTful Web services are available at:
https://<hostname>/RmsReSTServices/services/private/application.wadl
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:
To access the ReSTful web services Javadoc:
The ReSTful Web services's WADL file is available at:
https://<hostname>/ResaReSTServices/services/private/application.wadl
To access the ReSTful web services:
https://<hostname>/ResaReSTServices/services/private/Resa/<service>
Few input date and output date fields are in long format. The others are in SQL Date format.
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.
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.
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 |
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"": []
}
}"
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 |
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 |
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 |
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 |
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 |
This section describes the Book Transfer ReSTful Web Service
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.
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') |
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 |
[
{
"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
}
]
RestCobtsfStatuRDO
| Parameter Name | Data Type |
|---|---|
| successCobtsfCount | BigDecimal |
| successCobtsfTbl | List< successCobtsfRDO> |
| failCobtsfCount | BigDecimal |
| failCobtsfTable | List<failCobtsfRDO> |
SuccessCobtsfRDO
| Parameter Name | Data Type |
|---|---|
| FromLocation | BigDecimal |
| ToLocation | BigDecimal |
| TransferNumber | BigDecimal |
FailCobtsfRDO
| Parameter Name | Data Type |
|---|---|
| FromLocation | BigDecimal |
| ToLocation | BigDecimal |
| errorMessage | String |
{
"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": []
}
}
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 | Yes | 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 |
Business Overview
Code Detail service allows user to retrieve code details for a selected code and code type.
Service Type
Get
ReST URL
CodeDetail/codeDetails?code={ }&codeType={ }
Input Parameters
| Parameter Name | Required | Description | Valid values |
|---|---|---|---|
| Code | Yes | Code | NA |
| Code Type | Yes | Code Type | NA |
Output
RestCodeDetailRecRDO
| Parameter Name | Data Type |
|---|---|
| codeDesc | String |
| requiredInd | String |
| codeSeq | BigDecimal |
| codeType | String |
| codeTypeDesc | String |
| code | String |
JSON Structure
{
"codeDesc": null,
"requiredInd": null,
"codeSeq": null,
"codeType": null,
"codeTypeDesc": null,
"code": null,
"links": [],
"hyperMediaContent": {
"linkRDO": []
}
}
Table Impact
| TABLE | SELECT | INSERT | UPDATE | DELETE |
|---|---|---|---|---|
| CODE_HEAD | Yes | No | No | No |
| CODE_DETAIL | Yes | No | No | No |
| JOB_AUDIT_LOGS | No | Yes | No | No |
| JOB_AUDIT_PAYLOAD | No | Yes | No | No |
This section describes the inventory transfer services.
The primary role of these services is to create transfers and send them to Merchandising.
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
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 |
This section describes the load items.
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 |
This section describes the Search From Location service.
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.
/Transfer/fromLocation?locationType={locationType}&searchString={searchString}&tsfType={tsfType}&toLocation={toLocation}&items={items}&pageSize={pageSize}&pageNumber={pageNumber}
| 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 |
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 | 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 |
This section describes the Search To Location service.
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.
/Transfer/toLocation?locationType={locationType}&searchString={searchString}&tsfType={tsfType}&fromLocation={fromLocation}&pageSize={pageSize}&pageNumber={pageNumber}")
| 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 |
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 | 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 |
This section describes the Load Locations service.
| Parameter Name | Required | Description |
|---|---|---|
| FromLocation | No | Selected from location ID. |
| ToLocation | No | Selected to location ID. |
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 | 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 |
This section describes the Create Transfer service.
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.
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" : [ ]
}
}
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.
This section describes the Order Number.
This section describes the valid terms.
Retrieves all valid terms; valid terms are enabled with flag set to Yes and within the start and end active date.
This section describes the Search Supplier service.
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.
/PurchaseOrders/supplier?supplierSearchString={supplierSearchString}&locations={locations}&items={items}&pageSize={pageSize}&pageNumber={pageNumber}
| 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. |
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"": []
}
}"
This section describes the load supplier service.
Loading supplier Web service allows a user to refresh the selected supplier records.
| Parameter Name | Required | Description |
|---|---|---|
| Supplier | Yes | Supplier's ID. |
| Item | No | Comma Separated values for items. |
| Locations | No | Comma Separated values for locations. |
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"": []
}
}"
This section describes the Search Items service.
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.
/PurchaseOrders/item?itemSearchType={itemSearchType}&searchString={searchString}&dept={dept}&supplier={supplier}&locations={locations}&pageSize={pageSize}&pageNumber={pageNumber}
| 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 |
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 | 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 |
This section describes the load items.
The primary use of loading items Web service is to refresh already selected PO items records.
| 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. |
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 | 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 |
This section describes the Search Location service.
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.
/PurchaseOrders/location?locationType={locationType}&searchString={searchString}&supplier={supplier}&orgUnitId={orgUnitId}&pageSize={pageSize}&pageNumber={pageNumber}
| 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 |
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
}
]
}
}"
This section describes the Load Locations service.
This Web service allows the user to refresh already selected PO locations records.
| Parameter Name | Required | Description |
|---|---|---|
| Locations | Yes | Comma Separated values for selected locations' ID. |
| Supplier | No | Selected Supplier ID. |
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"": []
}
}"
This section describes the Create Purchase Order service.
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.
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" : [ ]
}
}
This section describes the Recent Inventory Transfer services.
The primary role of these services is to approve or reject Merchandising's transfers.
This section describes the transfer location search service.
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
/Transfer/recent/transferLocSearch?searchString={searchString}&locType={locType}&pageSize={pageSize}&pageNumber={pageNumber}
| 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 |
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": [ ]
}
}
This section describes the Transfer Location Load service.
This web service allows the user to refresh already selected Transfer locations records.
| Parameter Name | Required | Description |
|---|---|---|
| Locations | No | Comma Separated values for selected locations' ID |
This section describes the Transfer Status List service.
This section describes the Transfer Type List service.
This section describes the Search Transfer User IDs.
The Search Transfer User IDs service retrieves for all User IDs that created transfers.
/Transfer/recent/searchUserIds?searchString={searchString}&pageSize={pageSize}&pageNumber={pageNumber}
| 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 |
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": [ ]
}
}
This section describes the Transfer Search service.
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.
/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}
| 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 |
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": [ ]
}
}
This section describes the Get Transfer Detail service.
Get Transfer Detail service allow user to retrieve Transfer information for a selected transfer number.
/Transfer/recent/transferDetail?transferNumber={transferNumber}&pageSize={pageSize}&pageNumber={pageNumber}
| 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 |
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 | 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 |
This section describes the Update Transfer Status service.
/Transfer/recent/updateTransferStatus?newStatus={newStatus}&transferNumbers={transferNumbers}
| 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 | 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 |
This section describes the Recent Purchase Order services.
The primary role of this service is to approve, reject, or cancel Merchandising's purchase orders.
This section describes the Cancel Reason Code List service.
This section describes the Origin Code List service.
This section describes the Purchase Order Status list.
This section describes the Search Purchase Order User ID.
This service retrieves a list of user IDs associated with creating a purchase order.
/PurchaseOrders/recent/searchUserIds?searchString={searchString}&pageSize={pageSize}&pageNumber={pageNumber}
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": [ ]
}
}
This section describes the Purchase Order Search service.
This service retrieves summary information on all none closed purchase orders that match input criteria.
/PurchaseOrders/recent/purchaseOrderSearch?statuses={statuses}&createIds={createIds}&startCreateDate={startCreateDate}&endCreateDate={endCreateDate}&orderNumber={orderNumber}&suppliers={suppliers}&originCodes={originCodes}&departments={departments}&pageSize={pageSize}&pageNumber={pageNumber}
| 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 |
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"
}]
}"
This section describes the Get Purchase Order Summary service.
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 | 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 |
This section describes the Get Purchase Order Items service.
This service retrieves items details for an order number. Based on the display level, the items record aggregates to the level specified when applicable.
/PurchaseOrders/recent/PurchaseOrderItems?orderNumber={orderNumber}&itemDisplayLevel={itemDisplayLevel}&pageSize={pageSize}&pageNumber={pageNumber}
Order Number - Required
Item Display Level - Optional - valid values PARENT_LEVEL, PARENT_DIFF_LEVEL, or TRAN_LEVEL
Page Size - Optional
Page Number - Optional
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://..."
}]
}"
This section describes the Get Purchase Order Item Locations service.
This service retrieves item location details for an order number. The location record aggregates based on the display level when applicable.
/PurchaseOrders/recent/PurchaseOrderItemLocations?orderNumber={orderNumber}&item={item}&itemDisplayLevel={itemDisplayLevel}&diff1={diff1}&diff2={diff2}&diff3={diff3}&diff4={diff4}&pageSize={pageSize}&pageNumber={pageNumber}
| 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 |
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"
}
]
}"
This section describes the Update Purchase Orders Date service.
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.
/PurchaseOrders/recent/updatePurchaseOrderDate?notBeforeDate={notBeforeDate}¬AfterDate={notAfterDate}&otbEowDate={otbEowDate}&orderNumbers={orderNumbers}
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
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": []
}
}
This section describes the Cancel Purchase Orders service.
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 | 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 |
This section describes the Approve Purchase Orders service.
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 | 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 |
This section describes the Reject Purchase Orders service.
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 | 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 |
This section describes the Replenishment Schedule service.
The primary role of these services is to create, modify, and delete scheduled replenishments and send them to Merchandising.
This section describes the Create Replenishment Schedule service.
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.
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}
]
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 | 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 |
This section describes the Modify Replenishment service.
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.
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
}
]
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 | 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 |
This section describes the Delete Replenishment Schedule service.
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.
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
}
]
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 | 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 |
This section describes the Allocation Detail service.
Allocation Detail service allows user to retrieve Allocation information for a selected allocation number.
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": []
}
}
]
This section describes the Background Process Configuration.
This service is used to update the configuration for each background jobs in Merchandising.
| 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. |
This section describes the Currency Rate service.
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.
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": []
}
}
]
This section describes the Data Privacy Access service for Merchandising.
This query service provides access to data stored in Merchandising that contain personally identifiable information.
https://<host:port>/RetailAppsDataPrivServicesRESTApp/rest/privatedata/getPersonalInfo?customer_id={entityName}::{entityType}::{entityId}::{fullName}::
{phone}::{email}
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}
| 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. |
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. |
{
"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"
}
]
]
}
}
}
}
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)
This section describes the Data Privacy Forget service for Merchandising.
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.
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}
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}
| 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. |
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.
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).
This section describes the Diff Detail service.
Diff Detail service allows user to retrieve Diff description for a selected Diff Id.
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": []
}
}
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'.
The primary role of this service is to modify half data budgets and send them to Merchandising.
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.
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
}
]
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": []
}
}
This section describes the Inventory Adjustment service.
The primary role of this service is to create inventory adjustment and send them to Merchandising.
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.
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
}
]
}
]
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": []
}
}
This section describes the Item Detail service.
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": []
}
}
This section describes the Item Loc Inventory Detail service.
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.
ItemlocInvDtl/itemlocInvDetail?item={itemNumber}&location={locationNumber}&locationType={locationType}
| Parameter Name | Required | Description |
|---|---|---|
| Item | Yes | Item ID |
| Location | No | Location ID. |
| Location Type | No | Location Type. |
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": []
}
}
This section describes the MerchHierarchy Detail service.
MerchHierarchyDetail service allows user to retrieve full merchandising hierarchy information.
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": []
}
}
This section describes the Obligations Upload Services.
The primary role of these services is to support requests from trading partners or suppliers for bulk uploads of obligations to send to Merchandising.
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
This section describes the Purchase Order Detail Service.
Purchase Order Detail service allows user to retrieve purchase order information for a selected order.
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": []
}
}
This section describes the Reclass Detail service.
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": []
}
}
]
This section describes the Shipment Detail Service.
Shipment Detail service allows user to retrieve shipment and shipment item details for a given distro (transfer or allocation) or purchase order (PO).
Shipment/shipmentDetail?orderNumber={orderNumber}&distroNumber={distroNumber}&distroType={distroType}
| 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. |
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": []
}
}
This section describes the Stock Count Detail service.
Stock Count Detail service allows user to retrieve open stock count details for a given item and/or store.
StockCount/stockCountDetail?cycleCount={cycleCount}&locationType={locationType}&location={location}&item={item}&stocktakeDate={stocktakeDate}&pageSize={pageSize}&pageNumber={pageNumber}
| 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) |
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": []
}
}
This section describes the Store Day User service.
The primary role of this service is to create or delete store day user and send them to Merchandising.
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.
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.
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": []
}
}
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.
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.
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": []
}
}
This section describes the Store Detail service.
Store Detail service allows user to retrieve Store information for a selected store or for all stores.
| Parameter Name | Required | Description |
|---|---|---|
| Store | No | Store ID. If none is specified, all stores will be retrieved. |
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": []
}
}
This section describes the Supplier Detail service.
Supplier Detail service allows user to retrieve Supplier information for a selected supplier.
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": []
}
}
]
This section describes the Transfer Detail service.
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": []
}
}
This section describes the VAT Detail service.
VAT Detail service allows user to retrieve VAT information for a selected department.
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": []
}
}
This section describes the Warehouse Detail service.
Warehouse Detail service allows user to retrieve Warehouse information for a selected warehouse or for all warehouses.
| Parameter Name | Required | Description |
|---|---|---|
| Warehouse | No | Warehouse Number. If none is specified, all warehouses will be retrieved. |
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": []
}
}
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.
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.
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.
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
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.
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
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.
/getStoreDays?store={store}&recordType={recordType}&recordDate={recordDate}&sortAttrib={sortAttrib}&sortDirection={sortDirection}&pageSize={pageSize}&pageNumber={pageNumber}
| 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 |
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 | 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 |
Retrieves aggregated store day information for all dates or store days older than vdate -5.
/getStoreAggregations?allOlderInd={allOlderInd}&stores={stores}&sortAttrib={sortAttrib}&sortDirection={sortDirection}&pageSize={pageSize}&pageNumber={pageNumber}
| 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 |
/storeSearch?searchString={searchString}&searchFilter={searchFilter}&sortAttrib={sortAttrib}&sortDirection={sortDirection}&pageSize={pageSize}&pageNumber={pageNumber}
| 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 |
Store
Store Name
Chain
Chain Name
Auditors
Open Days
Over Days
Short Days
Over Amount
Short Amount
Currency Code
Error Count
| 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 |
This web service allows the user to find which store days have records that needs attention.
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
This section describes the Data Privacy Access service for Sales Audit.
This query service provides access to data stored in Sales Audit that contain personally identifiable information.
https://<host:port>/RetailAppsDataPrivServicesRESTApp/rest/privatedata/getPersonalInfo?customer_id={entityName}::{entityType}::{entityId}::{fullName}::
{phone}::{email}
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}
| 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. |
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. |
{
"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"
}
]
]
}
}
}
}
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)
This section describes the Data Privacy Forget service for Sales Audit.
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.
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}
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}
| 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. |
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.
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).
