Table of Contents
- Title and Copyright Information
- Send Us Your Comments
- Preface
- 1 Introduction
-
2
RIB Publication Designs
- Allocations Publication API
- ASN Outbound Publication API
- Available Inventory for Store and Warehouse Publication API
- Available Inventory for Store Publication API
- Banner and Channel Publication API
- Code and Diff Type Publication API
- Company Closed Publication API
- Country Publication API
- Customer Order Fulfillment Confirmation Publication API
- Delivery Slot Publication API
- Differentiator Group Publication API
- Differentiator Publication API
- Item Location Publication API
-
Item Publication API
- Functional Area
- Business Overview
- Error Handling
- Message XSD
- Merchandise Hierarchy Publication API
- Order Publication API
- Organizational Hierarchy Publication API
- Partner Publication API
- Receiver Unit Adjustment Publication API
- RTV Request Publication API
- Season and Phase Publication API
- Store Publication API
- Transfers Publication API
- UDA Publication API
- Vendor Publication API
- Warehouse Publication API
- Work Orders In Publication API
- Work Orders Out Publication API
-
3
RIB Subscription Designs
- Allocation Subscription API
- Appointment Subscription API
- ASN Outbound Subscription API
- Cost Change Subscription API
- Currency Exchange Rate Subscription API
- Customer Order Fulfillment Subscription API
- Differentiator Group Subscription API
- Differentiator Subscription API
- DSD Deals Subscription API
- DSD Receipt Subscription API
- Freight Term Subscription API
- General Ledger Chart of Accounts Subscription API
- GL Chart of Account Validation Service
- Inbound ASN Subscription API
- Inventory Adjustment Subscription API
- Inventory Request Subscription API
-
Item Subscription API
- Functional Area
-
Business Overview
- Creating Items
- Updating Items
- Deleting Items
- Creating an Item Supplier
- Updating an Item Supplier
- Deleting an Item Supplier
- Creating an Item Supplier Country
- Updating an Item Supplier Country
- Deleting an Item Supplier Country
- Creating Item Supplier Manufacturing Country
- Updating Item Supplier Manufacturing Country
- Deleting Item Supplier Manufacturing Country
- Creating Item Supplier Country Location
- Updating Item Supplier Country Locations
- Deleting Item Supplier Country Locations
- Creating Item Supplier Country Dimensions
- Updating Item Supplier Country Dimensions
- Deleting Item Supplier Country Dimensions
- Creating Item VAT
- Deleting Item VAT
- Creating Item UDA
- Updating Item UDA
- Deleting Item UDA
- Creating Item Season
- Deleting Item Season
- Creating Item Images
- Updating Item Images
- Deleting Item Images
- Creating HTS and Assessments
- Updating HTS and Assessments
- Deleting HTS and Assessements
- Creating Expenses
- Updating Expenses
- Deleting Expenses
- Creating Tickets
- Updating Tickets
- Deleting Tickets
- Creating Up-charges
- Deleting Up-charges
- Updating Up-charges Detail
- Creating Item Country
- Deleting Item Country
- Flex Attributes
- Translated Language
- Error Handling
- Message XSD
- Item Location Subscription API
- Item Reclassification Subscription API
- Location Trait Subscription API
- Merchandise Hierarchy Reclassification Subscription API
-
Merchandise Hierarchy Subscription API
- Functional Area
-
Business Overview
- Creating a Company
- Updating a Company
- Creating Divisions
- Updating Divisions
- Deleting Divisions
- Creating Groups
- Updating Groups
- Deleting Groups
- Creating Departments
- Updating Departments
- Deleting Departments
- Creating VAT Information for Departments
- Updating VAT Information for Departments
- Creating Up-charges for Departments
- Updating Up-charges for Departments
- Deleting Up-charges for Departments
- Creating Classes
- Updating Classes
- Deleting Classes
- Creating Subclasses
- Updating Subclasses
- Deleting Subclasses
- Flex Attributes
- Error Handling
- Message XSD
-
Order Subscription API
- Functional Area
-
Business Overview
- Creating Purchase Orders
- Updating Purchase Orders
- Deleting Purchase Orders
- Creating a Purchase Order Letter of Credit
- Updating a Purchase Order Letter of Credit
- Deleting a Purchase Order Letter of Credit
- Creating Expenses
- Updating Expenses
- Deleting Expenses
- Creating HTS and Assessments
- Updating HTS and Assessments
- Deleting HTS and Assessments
- Publishing Updates
- Flex Attributes
- Error Handling
- Message XSD
- Organizational Hierarchy Subscription API
- Payment Terms Subscription API
- Receiving Subscription API
- RTV Subscription API
- Stock Count Schedule Subscription API
- Stock Order Status Subscription API
- Store Subscription API
- Transfer Subscription API
- Vendor Subscription API
- Work Order Status Subscription API
-
4
SOAP Web Services
- Using SOAP Services During Batch Window
- Common Characteristics of Merchandising SOAP Services
-
Provider Services
- Allocation Service
- Average Cost Service
- Cost Change Service
- Customer Credit Check Service
- Customer Order Fulfillment Service
- Customer Order Item Substitution Service
- Diff Management Service
- Inventory Back Order Service
- Inventory Lookup Service
- Item Management Service
- Pay Term Service
- Pricing Cost Service
- Purchase Order Management Service
- Report Locator Service
- Store Order Service
- Supplier Service
- Transfer Service
- Consumer Services
-
5
ReSTful Web Services
- Introduction
- Common Characteristics
- File Transfer Services (FTS)
-
Merchandising Omni Integration
- REST Endpoint for Omni Channel/Diff Group
- REST Endpoint for Omni Channel/Diff IDs
- REST Endpoint for Omni Channel/Inventory/Store Details
- REST Endpoint for Omni Channel/Inventory/Warehouse Details
- REST Endpoint for Omni Channel/Item Details
- REST Endpoint for Omni Channel/Item UPC Details
- REST Endpoint for Omni Channel/Merchandise Hierarchy Details
- REST Endpoint for Omni Channel/Org Hier Descendant’s Details
- REST Endpoint for Omni Channel/Org Hierarchy Details
- REST Endpoint for Omni Channel/Refresh Date
- REST Endpoint for Omni Channel/Warehouse Details
- REST Endpoint for Omnichannel/Related Item
- REST Endpoint for Omnichannel/Retail Store Details
- REST Endpoint for Omnichannel/Dimension Type details
- REST Endpoint for Omnichannel/Dimension Value details
- REST Endpoint for Omnichannel/Future Inventory
- REST Endpoint for Omnichannel/Item Image
- REST Endpoint for Omnichannel/Item Initial Price Details
- REST Endpoint for Omnichannel/Item Location Details
- REST Endpoint for Omnichannel/VAT
-
Merchandising ReSTful Web Services
- Merchandising Common Services
- Allocation Detail Service
- Allocation Publish Services
- Background Process Configuration
- Book Transfer ReSTful Web Service
- Code Detail Service
-
Cost Change Service
- Functional Area
- Business Overview
- Service Type
- ReST URL
- Input Parameters – Cost Change Header Record
- Input Parameters – Cost Change Detail Record
- Input Parameters – Cost Change Detail Location Record
- Input Parameters – Custom Flex Attribute Record
- Output – Cost Change Response Object
- Output – Cost Change Response Record
- Table Impact
- Create Inventory Transfer Services
- Create Purchase Order Services
- Currency Rates Service
- Customer Order Services
- Data Privacy Access Service
- Data Privacy Forget Service
- Diff Detail Service
-
Diff Group Publish Services
- Endpoints
- Functional Area
- Business Overview
- Service Type
- ReST URL
- Input Parameters for MerchIntegrations/services/foundation/diffgroup
- Input Parameters for MerchIntegrations/services/foundation/diffgroup/{diffGroupId}
- Output – Diff Group Head
- Output – Diff Group Details
- Elements in JSON Output
- Table Impact
- Diff ID Publish Services
- Diff Type Publish Services
- EOW Run Signal Service
- Get Rejected Transactions Since Previous Query
- Half Data Budget Service
- Inventory Adjustment Service
- Item Detail Service
- Item Loc Inventory Detail Service
- Item Publish Services
- Item VAT Publish Services
- Load Transactions
- MerchHierarchy Detail Service
-
Merchandise Hierarchy Publication Services
- Endpoints
- Functional Area
- Business Overview
- Service Type
- ReST URL for Division
- ReST URL for Groups
- ReST URL for Department
- ReST URL for Class
- ReST URL for Subclass
- Input Parameters
- Output - Division
- Output - Groups
- Output - Department
- Output - Class
- Output - Subclass
- Output - Custom Flex Attribute
- Elements in JSON Output
- Table Impact
- Obligations Upload Services
- Order Publish Services
-
Organizational Hierarchy Publish Services
- Endpoints
- Functional Area
- Business Overview
- Service Type
- ReST URL
- Input Parameters for MerchIntegrations/services/foundation/orghier
- Input Parameters for MerchIntegrations/services/foundation/orghier/{orgLevel}
- Input Parameters for MerchIntegrations/services/foundation/orghier/{param1}/{param2}
- Output - Diff ID
- Table Impact
-
Partner Publish Services
- Endpoints
- Functional Area
- Business Overview
- Service Type
- ReST URL
- Input Parameters for ​​MerchInegrations/services/foundation/partner
- Input Parameters for ​​MerchInegrations/services/foundation/parner/{partnerId}
- Output - Partner
- Output - Address
- Output - Custom Flex Attribute
- Elements in JSON Output
- Table Impact
- Purchase Order Detail Service
- Purchase Order Work Order Publish Services
- Recent Inventory Transfer Services
-
Recent Purchase Order Services
- Functional Area
- Business Overview
- Cancel Reason Code List
- Origin Code List
- Purchase Order Status List
- Search Purchase Order User ID
- Purchase Order Search
- Get Purchase Order Summary
- Get Purchase Order Items
- Get Purchase Order Item Locations
- Update Purchase Orders Date
- Cancel Purchase Orders
- Approve Purchase Orders
- Reject Purchase Orders
- Reclass Detail Service
- Replenishment Schedule Services
-
RTV Publish Services
- Endpoints
- Functional Area
- Business Overview
- Service Type
- ReST URL
- Input Parameters for MerchIntegrations/services/inventory/rtv
- Input Parameters for MerchIntegrations/services/inventory/rtv/{rtvOrderNo}
- Output - RTV Head
- Output - RTV Details
- Output - Custom Flex Attributes
- Elements in JSON Output
- Table Impact
- RUA Publish Services
- Shipment Detail Service
- Stock Count Detail Service
- Store Day User Service
- Store Detail Service
- Store Publish Services
- Supplier Detail Service
- Supplier Publish Services
- Tran Data Upload Service
- Transfer Detail Service
- Transfer Publish Services
-
Transfer Work Order Publish Services
- Endpoints
- Functional Area
- Business Overview
- Service Type
- ReST URL
- Input Parameters for MerchIntegrations/services/inventory/woout
- Input Parameters for MerchIntegrations/services/inventory/woout/{workOrderId}
- Output - WO Out Head
- Output - WO Activity Details
- Output - WO Transformation Details
- Output - WO Packing Details
- Elements in JSON Output
- Table Impact
- UDA Publish Services
- VAT Detail Service
- Warehouse Detail Service
- Warehouse Publish Services
- Fiscal Document Generation Services
- Sales Audit ReSTful Web Services
-
6
Scheduled Integration
- File-based Integration Overview
- Bulk Data Integration Overview
-
Outbound Scheduled Integration
-
Foundation Data
- Brand Publication API (BDI_Brand_Fnd_PF_From_RMS_EOW_JOB)
- Calendar Publication API (BDI_Calendar_Fnd_PF_From_RMS_EOW_JOB)
- Code Detail Publication API (BDI_CodeDetail_Fnd_PF_From_RMS_JOB)
- Code Head Publication API (BDI_CodeHead_Fnd_PF_From_RMS_JOB)
- Company-wide Closings and Company Closed Exceptions (BDI_CompanyClosed_Fnd_PF_From_RMS_JOB)
- Currency Conversion Rates Publication API (BDI_CurrConvRates_Fnd_PF_From_RMS_EOW_JOB)
- Delivery Slot Publication API (BDI_DeliverySlot_Fnd_PF_From_RMS_JOB)
- Diff Group Export (export_diffgrp.ksh)
- Diff Group Publication API (BDI_DiffGrp_Fnd_PF_From_RMS_JOB)
- Diff ID and Type Export (export_diffs.ksh)
- Diff ID Publication API (BDI_Diff_Fnd_PF_From_RMS_JOB)
- Finisher Address Publication API (BDI_FinisherAddr_Fnd_PF_From_RMS_JOB)
- Location Closed Publication API (BDI_LocClosed_Fnd_PF_From_RMS_JOB)
- Merch Hierarchy Publication API (BDI_MerchHier_Fnd_PF_From_RMS_JOB)
- Merchandise Hierarchy Export (export_merchhier.ksh)
- Organization Hierarchy Publication API (BDI_OrgHier_Fnd_PF_From_RMS_JOB)
- Organizational Hierarchy Export (export_orghier.ksh)
- Partner Address Publication API (BDI_PartnerAddr_Fnd_PF_From_RMS_JOB)
- Partner Org Unit Publication API (BDI_PartOrgUnit_Fnd_PF_From_RMS_JOB)
- Partner Publication API (BDI_Partner_Fnd_PF_From_RMS_JOB)
- Store Address Publication API (BDI_StoreAddr_Fnd_PF_From_RMS_JOB)
- Store Hours Publication API (BDI_StoreHours_Fnd_PF_From_RMS_JOB)
- Store Publication API (BDI_Store_Fnd_PF_From_RMS_JOB)
- Stores Export (export_stores.ksh)
- Supplier Address Publication API (BDI_SupplierAddr_Fnd_PF_From_RMS_JOB)
- Sups Publication API (BDI_Supplier_Fnd_PF_From_RMS_JOB)
- Tax Download - Brazil (taxdnld)
- Ticket Download (tcktdnld)
- UDA Publication API (BDI_Uda_Fnd_PF_From_RMS_JOB)
- UDA Values Publication API (BDI_UdaValues_Fnd_PF_From_RMS_JOB)
- UOM Class Publication API (BDI_UomClass_Fnd_PF_From_RMS_JOB)
- UOM Conversion Publication API (BDI_UomConversion_Fnd_PF_From_RMS_JOB)
- VAT Codes, Regions, and Rates Export (export_vat.ksh)
- VAT Publication API (BDI_Vat_Fnd_PF_From_RMS_JOB)
- Warehouse (BDI_Wh_Fnd_PF_From_RMS_JOB)
- Warehouse Address Publication API (BDI_WhAddr_Fnd_PF_From_RMS_JOB)
-
Items
- Item Image Publication API (BDI_ItemImage_Fnd_PF_From_RMS_JOB)
- Item Location Export (export_itemloc.ksh)
- Item Location Publication API (BDI_ItemLoc_Fnd_PF_From_RMS_JOB)
- Item Master Export (export_itemmaster.ksh)
- Item Master Publication API (BDI_ItemHdr_Fnd_PF_From_RMS_JOB)
- Item Supplier Country Dimensions Publication API (BDI_ItSupCtryDim_Fnd_PF_From_RMS_JOB)
- Item Supplier Country Publication API (BDI_ItSupCtry_Fnd_PF_From_RMS_JOB)
- Item Supplier Manufacturing Country Publication API (BDI_ItSupManCtry_Fnd_PF_From_RMS_JOB)
- Item Supplier Publication API (BDI_ItemSupp_Fnd_PF_From_RMS_JOB)
- Item Supplier UOM Publication API (BDI_ItemSuppUom_Fnd_PF_From_RMS_JOB)
- Item VAT Rates Export (export_itemvat.ksh)
- Pack Item Publication API (BDI_PckitemBrkout_Fnd_PF_From_RMS_JOB)
- POS Configuration Data to 3rd Party POS (poscdnld)
- Price History Publication API (BDI_PriceHist_Fnd_PF_From_RMS_JOB)
- Related Items Export (export_relitem.ksh)
- Related Item Publication API (BDI_RelatedItem_Fnd_PF_From_RMS_JOB)
- UDA Item Date Publication API (BDI_UdaItemDate_Fnd_PF_From_RMS_JOB)
- UDA Item FF Publication API (BDI_UdaItemFF_Fnd_PF_From_RMS_JOB)
- UDA Item LOV Publication API (BDI_UdaItemLov_Fnd_From_RMS_JOB)
-
Financials
- Daily or Weekly Donwload of Stock Ledger Data (stlgdnld)
- Finance General Ledger to RFI (BDI_RFI_FinGenLdgr_Tx_PF_From_RMS_JOB)
- Fixed Deal Income (dealfinc)
- Franchise Billing Extract (wfbillex.ksh)
- Item/Location Daily Stock Ledger Transactions (fifgldn1)
- Monthly Stock Ledger Transactions (fifgldn3)
- Open to Buy Download Stock Ledger (otbdlsal)
- Rolled Up Daily Stock Ledger Transactions (fifgldn2)
- Stage G/L Extracts (gl_extract.ksh)
- Tran Data Publication (BDI_TranData_Tx_PF_From_RMS_EOW_JOB)
-
Ordering and Inventory
-
Purchasing
- Download Contracts to Suppliers (edidlcon)
- Download Current & Future OTB by Subclass (otbdnld)
- Download Purchase Orders to Suppliers (edidlord)
- Download Summary of Outstanding Orders on OTB by Subclass (otbdlord)
- On Order Publication API (BDI_OnOrder_Tx_PF_From_RMS_EOW_JOB)
- Replenishment Item Location Publication API (BDI_ReplItemLoc_Fnd_PF_From_RMS_JOB)
- Import Management
- Invoices
-
Inventory
- Download Sales and Stock on Hand to Suppliers (edidlprd)
- Future Available Inventory Publication API (BDI_COFutureAvail_Tx_PF_From_RMS_JOB)
- Inventory Publication API (BDI_Inventory_Tx_PF_From_RMS_EOW_JOB)
- Item Location History (BDI_ItemLocHist_Tx_PF_From_RMS_JOB)
- Reject POSU Transactions (salesgenrej.ksh)
- Store Available Inventory Publication API (BDI_InvAvailStore_Tx_PF_From_RMS_JOB)
- Warehouse Inventory Publication API (BDI_InvAvailWh_Tx_PF_From_RMS_JOB)
-
Purchasing
-
Planning and Forecasting
- Brand Extract to Planning (BDI_RPAS_Brand_Fnd_PF_From_RMS_JOB)
- Calendar Extract to Planning and Forecasting (BDI_RPAS_Calendar_Fnd_PF_From_RMS_JOB)
- Currency Rates Extract to Planning and Forecasting (BDI_RPAS_CurrConvRates_Fnd_PF_From_RMS_JOB)
- Differentiator Extract to Planning (BDI_RPAS_Diff_Fnd_PF_From_RMS_JOB)
- Inventory Extract to Planning (BDI_MFP_Inventory_Tx_PF_From_RMS_JOB)
- Merchandise Hierarchy and Item Extract to Planning and Forecasting (BDI_RPAS_MerchHier_Fnd_PF_From_RMS_JOB)
- On Order Extract to Planning (BDI_MFP_OnOrder_Tx_PF_From_RMS_JOB)
- Organization Hierarchy Extract to Planning and Forecasting (BDI_RPAS_OrgHier_Fnd_PF_From_RMS_JOB)
- Out of Stock Extract to Forecasting (BDI_RDF_StockOut_Tx_PF_From_RMS_JOB)
- Store Extract to Planning and Forecasting (BDI_RPAS_Store_Fnd_PF_From_RMS_JOB)
- Supplier Extract to Planning (BDI_RPAS_Supplier_Fnd_PF_From_RMS_JOB)
- Transaction Data Extract to Planning (BDI_MFP_TranData_Tx_PF_From_RMS_JOB)
- UDA Extract to Planning (BDI_RPAS_UdaAndUdaValues_Fnd_PF_From_RMS_JOB)
- UDA Item Extract to Planning and Forecasting (BDI_RDF_UdaItemLov_Fnd_From_RMS_JOB)
- Weekly Sales Extract to Forecasting (BDI_RDF_WeeklySales_Tx_PF_From_RMS_JOB)
-
Sales Audit
- Download from Sales Audit to Account Clearing House (ACH) System (saexpach)
- Download of Escheated Vouchers from Sales Audit for Payment (saescheat)
- Export DSD and Escheatment from Sales Audit to Invoice Matching (saexpim)
- Export from Sales Audit to Oracle Retail Analytics (saexport_sales_to_dw)
-
Export from Sales Audit to Oracle Retail Insights (saexpdw)
- Schedule
- Design Overview
- Restart/Recovery
- I/O Specification
-
Sales Audit - File Layout - Retail Analytics
- RDWT File
- Transaction Item Information Produced by saexpdw.pc after Translation by resa2dw
- RDWF File
- Retail Analytics Form of Payment File after Translation by resa2dw
- RDWS File
- Store Totals Information after Translation by resa2dw
- RDWC File
- Cashier/ Register Totals Information after Translation by resa2dw
- Design Assumptions
- Export Inventory Reservation/Release for In Store Customer Order & Layaway Transactions (saordinvexp)
- Export of POS transactions from Sales Audit to Merchandising (saexprms)
- Export of Revised Sale/Return Transactions from ReSA to SIM/SIOCS (saexpsim)
- Export to Universal Account Reconciliation System from Sales Audit (saexpuar)
- Extract of POS Transactions by Store/Date from Sales Audit for Web Search (ang_saplgen)
- Post User Defined Totals from Sales Audit to General Ledger (saexpgl)
-
Foundation Data
-
Inbound Scheduled Integration
- Item, Cost, and Price
-
Ordering and Inventory
- Purchasing
-
Import Management
- Harmonized Tariff Schedule Upload (htsupld)
- Letter of Credit Confirmation Upload (lcupld)
- Letter of Credit Drawdowns and Charges Upload (lcup798)
- SWIFT File Conversion - Letter of Credit Confirmation (lcmt730)
- SWIFT File Conversion - Letter of Credit Drawdowns and Charges (lcmt798)
- Transportation Upload (tranupld)
- Stock Counts
- Franchise
- Other Inventory
-
Sales Processing
- Sales Audit
- Sales Posting
- Forecasting