Getting started with OrderCloud

Getting started with OrderCloud
Using the portal

Using the portal

Accessing the API console

Access the API console by opening your marketplace app in the Sitecore Cloud Portal. Click the API console link in the top nav.

Explore your region and environment

In the top-right nav, an expandable panel will show you details about your current marketplace. If you selected a Marketplace, requests are made as your Portal user. If you selected a specific user from the context selector, the interface indicates you are making requests as that user.

Portal user context and default users

The default user you are authenticated as does not exist in the system. Your Marketplace is new and contains no users. To verify this, navigate to Seller > Admin Users in the left resources menu to open the "Get a list of admin users" request. Click Send to see an empty list response:

json

{
  "Meta": {
    "Page": 1,
    "PageSize": 20,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [
      1,
      0
    ]
  },
  "Items": []
}

You are not interacting with the OrderCloud API as you would in a production implementation. To create actual users and define how they interact with your Marketplace, create core users and establish their access definitions.

Self-service tools

Introducing search index tools for portal

The premium search feature now includes self-service tools for viewing and rebuilding search indexes. These tools enable marketplace administrators to investigate and resolve basic search indexing errors without requiring additional support.

Search index concepts

Core functionality

Premium search endpoints use Elasticsearch
Caches Product and submitted Order data
Provides enhanced search capabilities
Delivers improved performance

Index management

Manual rebuilds create new indexes
Old index remains active until rebuild completes
Automatic maintenance optimizations occur
Resource limitations apply

Common scenarios

Manual rebuilds required after:

Toggling Active on:
- Buyers
- Suppliers
- Catalogs
- Categories
Toggling ViewAllProducts on:
- Catalogs
- Categories
Updating SupplierID

Troubleshooting tools

Portal access

Available to registered users
Marketplace-specific visibility
Product and Order index views

Index details

Status indicators:

Active: Current production index
Building: Initial creation
Rebuilding: Manual refresh
WaitingToBuild: Queued
Failed: Build error
Canceled: User terminated
Invalid: Schema issues

Error logging

Schema error details
Affected item IDs
Problem field identification
Value type conflicts
Limited to 100 documents

Visibility requirements

Resource items must exist
Premium search enabled
Orders must be submitted
API calls required

Schema error handling

Common issues

Most frequent error: Inconsistent extended property (xp) data types within resources.

Example scenario

Different value types for same property:

javascript

product1.xp.FreeShipping: false  // boolean
product2.xp.FreeShipping: 0      // integer

Error message:

Failed to parse field [xp.FreeShipping] of type [boolean] in document with id 'product2'. Preview of field's value: '0'

Impact

Search results inconsistency
Direct lookups work (GET v1/products/product2)
List operations fail (GET v1/products)

Resolution steps

Ensure consistent xp types
Update incorrect values
Rebuild index if schema changes

SDK support

Type consistency tools:

Javascript SDK
.NET C# SDK
Strong typing support
Schema validation

Index rebuilding

Process overview

Ensure consistent xp types
Navigate to active index
Locate rebuild button
Trigger rebuild operation
Monitor build progress

Usage limits

Production/Staging environments:

3 rebuilds per hour
5 rebuilds per week

Sandbox environments:

10 rebuilds per hour
30 rebuilds per week

Requirements

Active index only
Administrator access
No concurrent rebuilds
Cannot cancel in progress

Build considerations

Resource-intensive operation
Build time varies by data volume
Progress tracking available
Error retention: 24 hours

Contact OrderCloud support for persistent issues.

Portal self-service

Features:

Manual subscription processing
Administrator-only access
Development debugging support
Enhanced control

Processing limits:

Environment	Hourly Job Limit
Sandbox	10
Staging	10
Production	3

App access for OrderCloud with Sitecore Cloud Portal

This guide explains OrderCloud access management through Sitecore Cloud Portal organization and app access controls.

Organization access levels

Organization-level access determines overall system permissions:

Owner/Admin privileges:

Full access to all Sitecore apps
FullAccess data permissions
Complete impersonation rights
User management capabilities:
- Team member invitations
- Access level configuration
- User access modification
- Account deletion

App access roles

Each OrderCloud marketplace (app) supports these access roles:

App Role	Description
Full Access	Highest access level with complete feature availability (subject to data access configuration)
Admin	Configurable administrator role with customizable data access
Custom Group 1	First custom role with defined data permissions
Custom Group 2	Second custom role with defined data permissions
Custom Group 3	Third custom role with defined data permissions
Custom Group 4	Fourth custom role with defined data permissions

Custom group configuration

Access control capabilities

OrderCloud enables granular access control through custom role groups:

Flexible permission configuration
Precise data access control
Role-based authorization

Configuration requirements:

Owner/Admin organization access required
Up to 4 custom role groups available
Customizable admin role settings

Permission components

Each custom role group includes:

Data access levels
Impersonation permissions
API role assignments

Access inheritance

Role permissions affect:

Personal API console access
Impersonation capabilities
Data visibility restrictions

Note: Available roles during impersonation represent the intersection of:

Impersonated user's roles
Impersonating user's permissions

Access assignment process

User invitation workflow

Organization administrators can assign roles during team member invitations:

Implementation recommendations

Before user invitations:

Define app access configurations
Configure role permissions
Establish access hierarchies
Document permission structures

This preparation ensures proper access assignment during onboarding.

If you have suggestions for improving this article, let us know!