Interface ID

Type of Integration

Functional Spec

Functional Description - Short

RMS

 

 

RMS200

Service

rms-InventoryDetailService

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.

RMS201

Service

rms-FulfillOrderService

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.

RMS211

Service

rms-InventoryBackOrderService

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.

RMS221

Service

rms-CustomerCreditCheckService

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.

RMS222

Service

rms-CustOrdSubstituteService

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.

RMS224

Service

rms-PricingCostService

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.

RMS226

Service

rms-SupplierService

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.

RMS227

Service

rms-PayTermService

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.

RMS230

Service

rms-StoreOrderService

This service is used to integrate SIM with RMS for store order inquiry and creation.  The service supports querying existing store orders, and the creation, modification, and deletion of store orders.

RMS231

Service

rms-ReportLocatorService

ReportLocationRef object consists of input information for finding the Report.This includes service provider name and URL.

RMS232

Service

rms-ItemManagementService

This service allows external systems like an Assortment Planning or Category Management application to reserve item numbers in RMS. The reservation request will contain these details: Item number type, Quantity, Days until expiry.  The details inserted into the reservation log for every valid web service call are sent back as part of the web service response to inform the calling application that the reservation was successful and the numbers were reserved.

RMS233

  Service

 rms.PurchaseOrderManagementService

The Purchase Order Management Service allows external sources to request order numbers from RMS to be used when initiating purchase orders in an external system.

RWMS

 

 

RWMS55

Service

rwms-ShippingManifestSelectionService

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.

RWMS61

Service

rwms-PendingReturnsService

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

RPM

 

 

RPM101

 Service

 rpm-PriceChangeService

Price changes are used by the retailer to change the price of a particular item at a location.

RPM102

Service

rpm-PriceInquiryService

Price inquiry are used by the retailer to find the price of a particular item at a location.

Interface ID

 

Functional Spec

Functional Description

SIM

 

 

SIM100

Service

sim-StoreInventoryService

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.

SIM101

Service

sim-StoreFulfillmentOrderService

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

SIM150

Service

sim-ActivityLockService

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.

SIM151

Service

sim-FulfillmentOrderDeliveryService

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.

SIM152

Service

sim-FulfillmentOrderPickService

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.

SIM153

Service

sim-FulfillmentOrderReversePickService.

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.

SIM154

Service

sim-InventoryAdjustmentService

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.

SIM155

Service

sim-ItemBasketService

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.

SIM156

Service

sim-POSTransactionService

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.

SIM158

Service

sim-StoreInventoryUinService

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.

SIM159

Service

sim-StoreItemPriceService

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.

SIM160

Service

sim-StoreItemService

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.

SIM161

Service

sim-StoreShipmentManifestService

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.

SIM163

Service

sim-ShelfReplenishmentService

Shelf Replenishment lists are used to keep the sales floor in stock.  Replenishment lists may be generated based on capacity, sales or a sales floor display.  This list generation is based on various calculations and may be setup to generate automatically within the day or at the end of the day and in some cases require sequencing to be setup.  Additionally, the store associate will pick the stock and move the inventory to the sales floor. In some cases, excess stock has been moved directly to the sales floor and needs to be moved to the backroom and constitutes reverse replenishment.  This service provides the ability to create and execute shelf replenishment and reverse replenishment.

SIM164

Service

sim-ShelfAdjustmentService

Shelf Adjustment lists are used to keep the sales floor in stock by scanning the gaps on the sales floor.  In some cases, overstock items will nee to be moved to the backroom.  This list generation is based on the scanned item and quantity entered and does not require sequencing.  Additionally, the store associate will pick the stock and move the inventory to the sales floor. In some cases, excess stock has been moved directly to the sales floor and needs to be moved to the backroom.  This service provides the ability to manage the shelf adjustment list.

SIM165

Service

sim-ItemTicketService

Specialized external systems can help SIM manage the order of printing and additional information to print on the item tickets and shelf labels based on plan-o-gram information.  An external system may generate ticket batches which can then be managed holistically by setting a ticket format and print dates and allows tickets to be managed in bulk as well as provide the ability to schedule the printing of the batch automatically.  This service generates tickets in SIM with a bulk request coming from the external system

  SIM166

  Service

  sim.ItemRequestService

The Item Request functionality gives the user the ability to request inventory for individual items using the replenishment and sourcing parameters of the merchandising system (RMS) from within the Store Inventory Management (SIM) application directly.  All items will be sourced from either a Warehouse or through Supplier Purchase Orders, depending on the sourcing parameters for the item specified in the merchandising system.

  SIM167

  Service

  sim.ProductGroupService

Product Groups are used to create lists of items and their specific attributes are used within other areas of the SIM application. Product groups are used for: Auto Ticket Print, Unit Stock Counts, Unit and Amount Stock Counts, Problem Line Stock Counts, Wastage, Item Requests and Shelf Replenishment.

  SIM168

  Service

  sim.StoreService

This web service allows for various management and product inquiries related to stores.  Retail stores many times will be able to transfer product between specific stores that are in close proximity.  Additionally, when a customer inquires about an item that may be out of stock, the user may look to other stores for stock.

  SIM169

  Service

  sim.StockCountService

Stock counts are one of the main tools retailers have to ensure their perpetual inventory is accurate.  Stock counts may be executed by staff, but many times a retailer will hire a third party service to perform the stock count.  Retailers can perform their Ad Hoc, Unit, Problem Line or Unit and Amount stock counts using different counting methods.

  SIM170

  Service

  sim.ProductGroupScheduleService

Product Groups will create lists of items to use within various areas of the application.  The Product Groups, once created, are scheduled to create the item lists.  Product Groups may be used for one or more locations and may also be scheduled for more than one location at a time.  Additionally, there are various settings that will allow the system to automatically create the lists on a recurring basis.

  SIM171

  Service

  sim.StoreShipmentReasonService

All shipments will have a rationale for initiating and ultimately receiving the shipment. This web service provides shipment reason information for all stores which can be specified for shipments within SIM.

  SIM172

  Service

  sim.VendorShipmentService

This transaction captures the information of a shipment going from the store to a supplier. It describes the details of the containers, items, reasons and quantities for shipment. The shipment will be for a single vendor return document. Saving a container or confirming a container will update the vendor return document as well as the final dispatch of the shipment.

  SIM173

  Service

  sim-VendorReturnService

sim-VendorReturnService.FunctionalDescription=The vendor return document captures the request to return goods to a vendor (supplier) and the approval of that request. It also allows the creation of a vendor return document that skips the request and approval process and is immediately ready to ship. After approval, the document is no longer modifiable by a user but does capture the ongoing information from a shipment when a shipment is created and dispatched to the vendor.

Interface ID

 

Functional Spec

Functional Description

RFI

 

 

RFI05

Service

fin-GlAccountValidationService

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)

 

 

RM000

Service

rm-ReturnsMgmtService

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)

 

 

MMS000

Service

mms-ShipmentManifestService

A third-party shipment manifesting system

External (TPS)

 

 

TPS01

Service

tps-TicketPrintingService

Retailers have a variety of printing systems used to print item tickets and shelf labels.  The SIM ticketing feature manages the generation of item tickets and shelf labels within a ticket batch.  This service has the capability to invoke any external system and mobile applications to print item tickets and shelf labels in bulk to a third party printing service based on a set print date.

Interface ID

 

Functional Spec

Functional Description

External (OMS)

 

 

OMS03

Service

oms-InvAvailableToPromiseService

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.

OMS04

Service

oms-CustomerOrderService

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.

OMS10

Service

oms-AdvancedShipmentNotificationService

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.

OMS35

Service

oms-FulfillOrderCancelConfirmService

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.

OMS36

Service

oms-FulfillOrderConfirmService

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.

OMS24

Service

oms-OrderReturnService

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.

OMS08

Service

oms-StockOrderStatusService

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

oms-VendorShipmentNotificationService

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. 

OMS40

Service

oms-ShippingOptionsService

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.

External

(CM)

 

 

CM00

Service

cm-CustomerService

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.

CO

 

 

C001

Service

co-NotificationsMgmtService

An RTG based JAX-WS Notifications web service is deployed on the CentralOffice Application.  Applications like SIM or an OMS can talk to this service through the consumer API and send messages that can be distributed to stores.  Messages can also be created at Central Office and displayed at the store registers or mobile devices.  All the Messages are stored in the CentralOffice database at the enterprise level.

Interface ID

 

Functional Spec

Functional Description

IGS

 

 

IGS01

Service

igs-GLCOAPublishingService

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.

IGS02

Service

igs-CurRatePublishingService

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.

IGS03

Service

igs-igs-FrtTermPublishingService

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.

IGS04

Service

igs-PayTermPublishingService

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.

IGS05

Service

igs-VendorPublishingService

Web Service will accept the RIB Vendor Object and publish it to the RIB JMS topics for processing by the RIB RMS Vendor Subscriber

IGS06

Service

igs-XItemPublishingService

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.

IGS07

Service

igs-XItemLocPublishingService

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.

IGS08

Service

igs-XStorePublishingService

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.

IGS09

Service

igs-XAllocPublishingService

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.

IGS10

Service

igs-XCostChgPublishingService

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.

IGS11

Service

igs-XOrderPublishingService

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.

IGS12

Service

igs-XTsfPublishingService

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.

IGS13

Service

igs-InvAdjustPublishingService

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.

IGS14

Service

igs-InvReqPublishingService

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.

IGS15

Service

igs-ReceivingPublishingService

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

IGS16

Service

igs-RTVPublishingService

This Web Service will accept the RIBRTV Object and publish it to the RIB JMS topics for processing by the RIB RMS RTV Subscriber.

IGS17

Service

igs-ASNInPublishingService

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.

IGS18

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.

IGS19

Service

igs-FulfilOrdPublishingService

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.