|
|
||
Interface ID |
Type of Integration |
Functional Spec |
Functional Description - Short |
RMS |
|
|
|
Service |
This real-time inventory availability lookup facility provided by RMS can be used by external systems, such as an on-line order capture system (OOC) and order management system (OMS), to retrieve item/location inventory based on RMS’s view of inventory at a point in time. RMS will provide this information for any warehouse or store which is valid for customer order sourcing/fulfillment via a web service. |
||
Service |
Once an external system, such as an OMS, has determined the best location from which to fulfill the customer order, a fulfillment order will be created. These fulfillment orders are communicated from the external system to RMS via this web service. Additionally, this web service is also used to send approved fulfillment order cancellations to RMS. There can be one or more fulfillment orders that exist for a single customer order, depending on the number of locations involved in fulfilling the order for the customer. These fulfillment orders will be published to RMS in the form of a Customer Order Request for fulfillment. |
||
Service |
Retailers selling through ecommerce channels often take customer orders, even if inventory is not available, with the expectation of future inventory being available to fill the order. If an order is captured against future inventory, the order is placed in ‘backordered’ status in the order management system (OMS). This web service is used for an external OMS to send backorder reserve requests to RMS when a customer fulfillment is made and backorder release requests when inventory is made available at the fulfillment location. |
||
Service |
RMS provides an interface to update the credit status for a franchise customer in RMS. A credit check for the franchisee will be performed before a franchisee order can be approved. In RMS, the credit status is an indicator held at the customer level which determines whether customer has good credit. Valid values are ‘Y’ and ‘N’. This web service is used to process updates to that indicator from an external financial application. |
||
Service |
When a store is picking inventory to fulfill a customer order it may choose to fulfill the order with a substitute item, if the order indicates that substitutions are allowed for the item and if the inventory of the item ordered does not meet quality standards or is unavailable. If that occurs, SIM has the ability to substitute items on the customer order with another predefined ‘substitute item’. In such cases, SIM notifies an order management system (OMS) that an alternative item has been pushed into the order. Based on the notification from SIM, OMS updates the customer order. OMS also notifies RMS with the same details received from SIM so that RMS updates the inventory and customer order details. Based on OMS notification RMS updates the cancelled quantity for the original item and also creates the customer order reservation for the substitute item by updating the customer reserve inventory. This service is used for OMS to update RMS of substitution that occurred as part of the fulfillment process. |
||
Service |
This web service is used by RMS to expose pricing cost information to external systems. The primary user of this information is assumed to be an order management system (OMS) that manages wholesale customer orders and needs visibility to cost information as part of the negotiation process for margin visibility. This API supports providing cost information for an item/location or item/supplier/location. |
||
Service |
rms-SupplierService.FunctionalDescription=RMS subscribes supplier information from external financial applications via this web service. The Supplier Service Provider is used by external financial systems to send RMS the supplier information that includes supplier addresses and the operating unit. The header record contains information about the supplier as a whole. The address records identify the addresses associated with the supplier and the operating unit records specify the operating units associated with the supplier. |
||
Service |
RMS subscribes payment terms information from external financial applications using this web service. The header record contains information about a payment term as a whole. The detail records identify the rates, dues days, enabled flag, start/end date, etc. |
||
RWMS |
|
|
|
Service |
This is the Container Status communications from the Manifest System (Kewill) to RWMS. The RWMS status communicated from Manifest System are (M)anifested and (S)hipped. |
||
Service |
This is the communication that provides the Return Merchandise Authorization (RMA) information to RWMS so the Customer Return can be processed in the warehouse. |
||
Interface ID |
|
Functional Spec |
Functional Description |
POS |
|
|
|
|
|
||
Interface ID |
|
Functional Spec |
Functional Description |
SIM |
|
|
|
Service |
A real-time inventory availability lookup facility is provided by SIM that can be used by external systems, such as OOC and OMS, to retrieve item/location inventory based on SIM’s view of inventory at a point in time. This provides the capability to lookup several items at one time, and determines the locations the items may be available at. |
||
Service |
Once an external system such as an OMS has determined the best location from which to fulfill the customer order, based on customer preferences, lead times, cost, etc., a fulfillment order will be created. There can be one or more fulfillment orders that exist for a single customer order, depending on the number of locations involved in fulfilling the order for the customer. These fulfillment orders will be published to SIM in the form of a Store Fulfillment Order Request |
||
Service |
SIM contains activity locking functionality to allow only one user to update a transaction at a time. Activity locking is used throughout the SIM application and is used to check to see if another user is already processing the same transaction and if so will provide back a message. In order to maintain data integrity, this service must be used by any external system to acquire a lock prior to taking any action with other services. This includes the ability to take over a lock currently held by another user or remove a lock when the transaction is completed. |
||
Service |
When customers place orders, prompt delivery of the order becomes imperative to maintaining a high level of customer satisfaction. To manage this process, SIM provides this service to external systems, to return a list of customer order deliveries, lookup details for a particular delivery as well as managing the deliveries. |
||
Service |
When customers place orders, prompt delivery of the order becomes imperative to maintaining a high level of customer satisfaction. To manage this process, SIM provides this service to external systems, to return a list of customer order deliveries, lookup details for a particular delivery as well as managing the deliveries. |
||
Service |
There are times in which a customer has changed their mind and cancelled an order. The system provides a way to efficiently manage returning this product back to the shelves in order for the products to become available for other customers in a timely fashion. This service provided by SIM can be used by external systems to return a list of the orders needing to be returned to the product shelf and includes looking up details of the previously picked customer order and handles the reverse picking process. |
||
Service |
Periodically, stock levels need to be adjusted when an item has been broken, spoiled or a variety of other reasons. The inventory adjustment feature is SIM provides a way to manage those changes in inventory as they occur. This service can be used by external systems to merely inquire on an adjustment or to create, copy, edit, cancel, save or approve and adjustment. This includes using inventory adjustment templates for recurring transactions. |
||
Service |
SIM provides the capability to manage scanning multiple items into a basket and printing out a ticket to aid a retailer with line busting. This service provides the ability to return a list of items in a basket as well as managing the items in the basket. This service can be used by a POS system to facilitate scanning a barcode to return the associated items to the POS. |
||
Service |
This near real time SIM service accepts the sales and order information from the POS or any external system. When the POS system invokes the service, it validates minimum information and uploads the data into staging tables for processing the transactions and updating the inventory in SIM. |
||
Service |
When items are returned because of damage or variety of other reasons, this SIM service is provided to support the supplier or warehouse return features in SIM from any external system. This service can be used to provide basic information on a collection of returns as well as provide details for a specific return. This includes returning information about a bill of lading attached to a return as well as managing the creating, editing, cancelling, submitting, approving and dispatching of a return. |
||
Service |
Many items such as cell phone devices provide serial numbers and need to be activated in many POS system or other external systems. The system may need to validate a particular serial number is available for sale or update the status for a particular serial number such as when is has been sold or returned. In some cases, serial numbers are not included on the product, but rather can be automatically generated by the system with this SIM service. |
||
Service |
This SIM service is provided to external systems to enable a user to find markdowns for a specific store. This can be useful when preparing new shelf labels as well as resetting a display. |
||
Service |
To manage the shipping process, after the containers have left the store, SIM will allow an external system to indicate the containers have been picked up and close the manifest shipments. |
||
Service |
To manage the shipment and delivery process for purchases, a manifesting system is typically used to obtain customer or other delivery information. SIM provides a service for external systems such as a manifesting system, to obtain shipment information for a customer order. This information is used to print off a shipping label, a bill of lading for the transportation and other information without the need to source additional information in SIM. |
||
Service |
When products are transferred between locations, this can be used to find open and available transfer information to work in, retrieve detailed transfer information and update or potentially dispatch a transfer. This can be a transfer created in an external system or be an existing transfer in SIM. |
||
Interface ID |
|
Functional Spec |
Functional Description |
RFI |
|
|
|
Service |
Oracle General Ledger (GL) is the system of record for chart of accounts segment combinations. Chart of accounts (segments) combinations are set up manually in Oracle Retail Merchandising System (RMS), Retail Invoice Matching (ReIM), and Retail Sales Audit (ReSA). This manual setup enables assignment of transaction data in sales audit, stock ledger, and invoice match to specific account codes. ReIM also creates segment combinations dynamically during the invoice match transaction processing. While creating the valid segment combinations, Oracle Retail validates each created combination individually against Oracle GL. Any valid segment combination in Oracle Retail must exist as a valid combination in Oracle GL. Oracle Retail publishes the segment combination to Oracle GL for validation. Oracle GL verifies the combination and returns the status to Oracle Retail. If the combination is valid, the combination is stored in the Oracle retail database tables for future validation purpose. |
||
External (RM) |
|
|
|
Service |
A service for Evaluating the returns information. RM uses messages to communicate item and transaction level return information between the Store Point of Service and Returns Management. Information about the item(s) being returned, the customer performing the return and the store where the item(s) is being returned is sent from POS to RM. RM evaluates the information against a set of item and transaction rules. The resulting approval or denial message is sent from RM to POS to manipulate the return behavior at POS. |
||
External (MMS) |
|
|
|
Service |
A third-party shipment manifesting system |
||
External (OOC) |
|
|
|
Service |
This service is used by ORPOS to query valid shipping options and their associated fees from an online order capture (OOC) application when a customer order is being placed in the store via ORPOS that will be sourced and/or fulfilled from another location. |
||
Interface ID |
|
Functional Spec |
Functional Description |
External (OMS) |
|
|
|
Service |
This service is used by ORPOS to query inventory information from an order management system (OMS) when a customer order is being placed in the store via ORPOS that will be sourced and/or fulfilled from another location. |
||
Service |
This service is used by ORPOS to communicate details about customer orders with OMS and serves several functions throughout the lifecycle of the order. The first is the creation of the order that was captured at ORPOS for a customer order is being placed in the store via ORPOS that will be sourced and/or fulfilled from another location. This service also allows orders to be queried at ORPOS when processing a customer pickup, customer cancellation in store, or customer order return in the store. |
||
Service |
ASN Out is a message that is published on the RIB by SIM and RWMS when a stock order (transfer or allocation) is shipped from a location. As part of the customer order management process, it is assumed that an order management system (OMS) will also need to be updated when this shipment occurs, such that customers can be apprised of the latest status and OMS can perform any additional processing required based on the status updates. This web service is used to transform the RIB messages published by SIM and RWMS into a form that can be consumed by OMS. |
||
Service |
If a customer order cancellation is initiated by an order management system (OMS) that is being fulfilled from a store, it is assumed that prior to cancelling the order a confirmation is needed from the store that the order can in fact be cancelled. In some cases, it may be considered too late to cancel because the customer has already picked up the order or SIM has already shipped it, but the update was not yet processed by OMS. So, enforcing a confirmation prior to canceling the order and reimbursing the customer is intended to prevent possible fraud. This service is used by OMS to process a cancellation confirmation sent by SIM. If the order was considered ‘cancelable’, then OMS would next send the approved cancellation onto RMS to release inventory. |
||
Service |
Oracle Retail supports two methods of communicating fulfillment order messages between an order management system (OMS) and RMS, via RIB or via web service. In a web service implementation, a confirmation message is able to be sent automatically as part of the architecture of a web service upon processing a fulfillment order request. However, in a RIB implementation, this confirmation cannot be sent as the RIB is considered a ‘fire and forget’ type architecture. So, in order to ensure that OMS is notified if a customer order cannot be fulfilled based on the information sent to RMS, a confirmation RIB message is generated to communicate any issues. This service takes the RIB message generated by RMS and transforms it into a web service that is readable by OMS. |
||
Service |
This web service is used by RWMS to update an order management system (OMS) on the receipt of a customer order return into the warehouse. Two different types of returns can be processed through this service – a pending return and a detailed return. A pending return simply means that a box has been received at the warehouse for the order, but the contents haven’t been verified or checked in. The detailed return would mean that the warehouse has completed processing the return and is expected to contain details on the items returned and the disposition of those items. |
||
Service |
Stock Order Status is a message that is published on the RIB by SIM and RWMS that gives an update on the status of a stock order (transfer or allocation) when it is in the process of being picked and shipped. As part of the customer order management process, it is assumed that an order management system (OMS) will also need an update on the status of stock orders that relate to customer order fulfillment, such that customers can be apprised of the latest status and OMS can perform any additional processing required based on the status updates. This web service is used to transform the RIB messages published by SIM and RWMS into a form that can be consumed by OMS. |
||
Service |
For customer orders that are sourced from a supplier, a purchase order (PO) is created in RMS and communicated to the supplier. This could be for an order that is shipped directly to the customer from the supplier (also called drop ship) or a fulfillment order sourced from the supplier but shipped to a store for fulfillment to the customer. This web service is used to process a shipment notification sent from the vendor in the form of an Advanced Shipment Notification (ASN) and send it to an order management system (OMS) for processing updates to a customer order. |
||
External (CM) |
|
|
|
Service |
This service is used by ORPOS to query customer information from the customer management application. This service is used as part of the process for creating a customer order in the store via ORPOS that will be sourced and/or fulfilled from another location. This service supports both creating and updating customer information. |
||
Interface ID |
|
Functional Spec |
Functional Description |
IGS |
|
|
|
Service |
This Web Service will accept the RIB GLCOA Business Object and publish it to the RIB JMS topics for processing by the RIB RMS GLCOA Subscriber. |
||
Service |
This Web Service will accept the RIB CurRate Object and publish it to the RIB JMS topics for processing by the RIB RMS CurRate Subscriber. |
||
Service |
This Web Service will accept the RIB FreightTerms Object and publish it to the RIB JMS topics for processing by the RIB RMS FreightTerms Subscriber. |
||
Service |
This Web Service will accept the RIB PayTerms Business Object and publish it to the RIB JMS topics for processing by the RIB RMS Payterms Subscriber. |
||
Service |
Web Service will accept the RIB Vendor Object and publish it to the RIB JMS topics for processing by the RIB RMS Vendor Subscriber |
||
Service |
This Web Service will accept the RIB XItem Object and publish it to the RIB JMS topics for processing by the RIB RMS XItem Subscriber. |
||
Service |
This Web Service will accept the RIB XItem Location Object and publish it to the RIB JMS topics for processing by the RIB RMS XItem Location Subscriber. |
||
Service |
This Web Service will accept the RIB Xstore Object and publish it to the RIB JMS topics for processing by the RIB RMS Xstore Subscriber. |
||
Service |
This Web Service will accept the RIB XAlloc Object and publish it to the RIB JMS topics for processing by the RIB RMS XAlloc Subscriber. |
||
Service |
This Web Service will accept the RIB XCostChg Object and publish it to the RIB JMS topics for processing by the RIB RMS XCostChg Subscriber. |
||
Service |
This Web Service will accept the RIB XOrder Object and publish it to the RIB JMS topics for processing by the RIB RMS XOrder Subscriber. |
||
Service |
This Web Service will accept the RIB XTransfers Object and publish it to the RIB JMS topics for processing by the RIB RMS Xtransfers Subscriber. |
||
Service |
This Web Service will accept the RIB InvAdjust Object and publish it to the RIB JMS topics for processing by the RIB RMS InvAdjust Subscriber. |
||
Service |
This Web Service will accept the RIB InvReq Object and publish it to the RIB JMS topics for processing by the RIB RMS InvReq Subscriber. |
||
Service |
This Web Service will accept the RIB Receiving Object and publish it to the RIB JMS topics for processing by the RIB RMS Receiving Subscriber |
||
Service |
This Web Service will accept the RIBRTV Object and publish it to the RIB JMS topics for processing by the RIB RMS RTV Subscriber. |
||
Service |
This Web Service will accept the RIB ASNIn Object and publish it to the RIB JMS topics for processing by the RIB RMS ASNIn Subscriber. |
||
Service |
igs-ASNOutPublishingService |
Web Service will accept the RIB ASNOut Object and publish it to the RIB JMS topics for processing by the RIB RMS ASNOut Subscriber. |
|
Service |
This Web Service will accept the RIB FulfillOrd Object and publish it to the RIB JMS topics for processing by the RIB RMS and SIM Subscribers. |