Contents

List of Figures

List of Tables

Title and Copyright Information

Send Us Your Comments

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Customer Support
• Improved Process for Oracle Retail Documentation Corrections
• Oracle Help Center
• Conventions

1 Introduction

2 Technical Design

• OCDS Topology
• Scaling OCDS
  • WebLogic Server Cluster Concepts
  • BDI Job Admin on Cluster
  • RIB Injector on Cluster
  • ORDS on Cluster
• The OCDS Database
  • Tablespaces
  • Schemas
    • Transactional Schema
    • Interface Schema

3 BDI Job Admin

• BDI Interfaces
• Scheduling BDI Data
  • Scheduled
  • One-Time Only
• WebLogic Users and Groups
  • Groups
  • Users
• Changing User Passwords
• Logging
• URL patterns
• Job Admin User Interface

4 RIB Injector

• RIB Families
• Logging
• WebLogic Users and Groups
  • Groups
  • Users
• Changing User Passwords

5 ORDS Web Services

• Performance Tuning
• REST Services
  • Authentication
  • Endpoints
• WebLogic Users and Groups
  • Groups
  • Users
  • Changing Passwords

6 Maintenance

• Data Retention
  • Purging Deleted Data

A Appendix A: V1 REST Endpoints

• diffs : Get Item Differentiators
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• diff/group : Get Item Differentiator Group
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• item : Get Item
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• item/dimensiontype : Get Item Dimension Type
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• item/dimensionvalue : Get Item Dimension Value
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• item/image : Get Item Image
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• item/itemlocation : Get Item Location
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• item/price : Get Item Price
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• item/promotion : Get Item Promotion
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• item/relateditem : Get Related Item
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• location/retailstore : Get Retail Store
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• location/warehouse : Get Warehouse
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• merchhier : Get Merchandise Hierarchy
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• orghier : Get Organization Hierarchy
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• orghier/descendant : Get Organization Hierarchy Node Descendant
  • Parameters
  • Response (items)
  • Sort:
  • Example Data
• refreshdate : Get Data Refresh Date
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• Other REST Endpoints
  • metadata-catalog : Get API Catalog
    • Parameters
    • Response (items)
    • Sorting
    • Usage

B Appendix B: V2 REST Endpoints

• v 2 Response Structure
• v2/admin/log : Get Log Entries
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/admin/version : Get OCDS Version
  • Response (items)
  • Sort
  • Example Data
• v2/diffs : Get Item Differentiators
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/diff/group : Get Differentiators Groups
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/inventory/future : Get Future Inventory
  • Parameters
  • Response (items)
  • Sort
  • Sample Data
• v2/inventory/store : Get Store Inventory
  • Parameters
  • Response (items)
  • Sort
  • Sample Data
• v2/inventory/warehouse : Get Warehouse Inventory
  • Parameters
  • Response (items)
  • Sort
  • Sample Data
• v2/item : Get Item
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/item/dimensiontype : Get Dimension Type
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/item/dimensionvalue : Get Dimension Value
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/item/image : Get Item Images
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/item/itemlocation : Get Item Location
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/item/price : Get Item Price by Type
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/item/promotion : Get Promotions
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/item/relateditem : Get Related Items
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/item/upc : Get UPC Items
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/location/retailstore : Get Retail Stores
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/location/warehouse : Get Warehouse
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/merchhier : Get Merchandise Hierarchy
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/orghier : Get Organization Hierarchy
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/orghier/descendant : Get Descendants of Organization Hierarchy Node
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/refreshdate : Get Last Refresh Date of Entity Data Feeds
  • Parameters
  • Response (items)
  • Sort
  • Example Data
• v2/vat : Get Vat Information
  • Parameters
  • Response (items)
  • Sort
  • Example Data