About the REST APIs

This document applies to R13 (update 17C).
Previous version:
R13 (update 17B)


Oracle Sales Cloud delivers a wide range of functionality to address the needs of sales executives, sales managers, sales representatives, and system administrators, and helps to engage customers and close deals.

Oracle Sales Cloud provides multiple public REST APIs that can be used to access data stored in Sales Cloud and construct integrations to other systems. These systems could be other Oracle Cloud applications or offerings, or they could be external systems in a customer or partner network. Secure access to these services requires appropriate authentication for the environment, standard HTTP methods, and JSON syntax.

APIs

The account resource is used to view, create, and update accounts.
View API Endpoints
The activity captures the task and appointment information.
View API Endpoints
The business plan represents a mutual commitment between two or more parties to work together in order to achieve common goals.
View API Endpoints
Category is a means of grouping service objects to enable easy identification and downstream reporting. For example, service requests can be categorized based on the type of service requested, such as the need for general information or help with installation, or the area in which support is required, such as billing or order tracking. Similarly, knowledge articles can be categorized based on the article's subject area, such as installation or order status.
View API Endpoints
The forms of communication by which you listen and respond to your customers. Channels refer to all of the available sources of social messaging, incoming service requests, and outgoing responses that are monitored and processed. Some examples of channels are e-mail, phone, Twitter, and Facebook.
View API Endpoints
Authenticates an End User to the Chat Service.
View API Endpoints
The competitor resource is used to view competitor details. A competitor is an organization that competes with the deploying organization in the market for sales. The object stores competitor attributes such as SWOT analysis, the products competitors sell, how they map to the deploying organization's products, win/loss reasons, and competitive literature.
View API Endpoints
The contact resource is used to view, create, or modify a contact. A contact is a person in a defined relationship with either an account or contact.
View API Endpoints
The deal registration resource is used to view, create, or modify a deal registration. Deal registration is a process by which a partner user registers a business opportunity with the brand owner in order to become eligible for benefits, such as exclusive rights to the opportunity, additional rebates, presales support, and so on.
View API Endpoints
The forecasts resource is used to view or modify a forecast territory.
View API Endpoints
The household resource is used to view, create, and update a household. Household is a group that has a relationship with either an account or a contact. A household object includes attributes that are used to store values while creating or updating a household. You can use the child resources such as addresses, relationships, addressPurposes, salesTeamMembers, and primary addresses to manage child entities of the household object.
View API Endpoints
Filters setup by the administrator to accept or reject inbound messages. For example, you can create a filter to reject messages from a specific domain.
View API Endpoints
A list of inbound messages received from customers, that need a response. For example, a message indicating that a customer's mobile camera is not functional.
View API Endpoints
The interaction resource is used to describe the interaction between a customer and an agent.
View API Endpoints
The lightbox presentation session feedback resource is used to view, create, update, and delete ratings and comments from the attendees at a Lightbox presentation session. The feedback may apply to an individual Lightbox document page, or to an overall Lightbox document presented during a presentation session.
View API Endpoints
The Lightbox presentation session resource is used to view, create, update, and delete occasions when Lightbox documents were presented to an audience. A session may be directly correlated to an activity, such as an appointment, call report or task, or may be an ad-hoc session presented at a particular date and time without any association to an activity.
View API Endpoints
The self-service role resource is used to view the roles for the self-service user who is currently logged in.
View API Endpoints
The objective represents a measureable target as well as captures the actual attainment.
View API Endpoints
The opportunities resource let view, create, and update an opportunity. An opportunity supports the full sales process, from leads, to opportunities, to sales, to follow-up analytics. Within opportunities, sales organizations can capture a wide variety of information related to an opportunity, such as account and the products to be sold.
View API Endpoints
The service used to manage partner programs.
View API Endpoints
The service used to manage partner tiers in preparation for assignment to partners and partner programs.
View API Endpoints
A partner resource is used to view, create, or modify a channel partner. A channel partner company works with your organization to sell products and services. In Oracle Sales Cloud, a partner resource is different from an account resource.
View API Endpoints
The payment batch resource is used to retrieve payment batch summary information. It is also used to retrieve the details of paysheets and payment transactions within the context of a payment batch. A payment batch generates paysheets for each incentive compensation participant who meets the payment batch selection criteria. A paysheet contains and summarizes the payment transaction amounts. Payment transactions include the payable commission and bonus incentives, payment plan draw and recovery amounts, and manual adjustments to the payable amount.
View API Endpoints
The payment transaction resource is used to retrieve participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and to create manual adjustments.
View API Endpoints
The paysheet resource is used to view the paysheet information. A payment batch generates paysheets for each incentive compensation participant who meets the payment batch criteria. The paysheet contains the participant payment transactions for the pay period. It provides summarized amounts, such as total calculated earnings, total recoverable payment plan adjustments, and total payment amount.
View API Endpoints
The Price Book Header resource is used to view, create, update, and delete the name, description, and status of a price book. It also includes the unique identifier, unique code, and the currency on which the price book amount is based.
View API Endpoints
The Product Groups resource is used to create, modify, delete, and view the product groups. It is also used to lock, unlock and publish a product group. A product group is a business object that groups related products. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog. Locking a product group makes it inaccessible or non editable by other users while you are making some changes. Unlocking releases the lock and rolls the changes back. Publishing the product group makes the changes available to the users at runtime.
View API Endpoints
The product resource is used to view, create, or modify a product. A product is an item that an organization or company intends to sell.
View API Endpoints
The service used to manage program benefits in the Benefits Library for addition to partner programs.
View API Endpoints
The program enrollments resource is used to view, create, or update partner enrollments in a program.
View API Endpoints
Queue is a list of unassigned requests awaiting assignment to members of a service team. Team members can select requests to work on or assign the requests to an appropriate team member depending on the queue. For example, queues can be based on location, such as a North America Queue or an EMEA Queue.
View API Endpoints
The resources resoure is used to view, create, and update a resource. A resource is a person within the deploying company who can be assigned work to accomplish business objectives, such as sales persons or partner members.
View API Endpoints
The sales lead resource is used to view, create, or modify a lead. A lead is a transaction record created when a party has expressed an interest in a product or service. It represents a selling opportunity.
View API Endpoints
The Lightbox document resource is used to view, create, and update Lightbox documents.
View API Endpoints
The sales order resource is used to view, create, and update sales orders. A Sales Order captures quote and order header information such as name, version, status and amount. It is used to get, create, update and delete a quote and order.
View API Endpoints
The sales promotion resource is used to view, create, modify, or delete a sales promotion. A sales promotion is a business object that is used to offer special pricing to your customers to promote products.
View API Endpoints
The sales territories resource represents the list of sales territories that the logged-in user can view. A sales territory is an organizational domain with boundaries defined by attributes of customers, products, services, resources, and so on. Sales territories can be created based on multiple criteria including postal code, area code, country, vertical market, size of company, product expertise, and geographical location.
Sales territories form the fundamental infrastructure of sales management as they define the jurisdiction that salespeople have over sales accounts, or the jurisdiction that channel sales managers have over partners and partner transactions.
View API Endpoints
A territory proposal is a container used to model territory changes without affecting the active territories. Sales executives, administrators, and managers use territory proposals to model different ways to partition their territories and view the results until they are satisfied with a model. They can then activate the preferred territory proposals.
View API Endpoints
The screen pop page is used to describe pages that is displayed as an initial starting point in a media based interaction. After identifying the contact, screen pop rules are run to determine which page is shown to the agent.
View API Endpoints
The screen pop token resource is used to pass data to screen pop pages. A token can represent a business object attribute value or can contain literal values. Tokens are interpreted by the screen pop page at run time.
View API Endpoints
The self-service registration resource is used to view, create, and update self-service registration requests.
View API Endpoints
The self-service role resource is used to view, create and delete roles for self-service users.
View API Endpoints
The self-service user resource is used to view the users associated with the self-service functionality.
View API Endpoints
Service request is a document to track a request from a customer for service from the time the customer makes the request until the request is resolved. For example, a customer calls in to log a request that the laptop battery drains faster.
View API Endpoints
Social Posts store the details of the social post received from the Oracle Social Cloud application to be reviewed and responded to, by the customer service personnel. An example of a social post from Twitter is: "oracle_support E-mail responses from our agent are not being received by our customers. Is the e-mail server down?".
View API Endpoints
The source code resource is used to track responses and leads generated by each marketing campaign execution, which helps gauge the effectiveness of each initiative. A marketing source code is a unique identifier representing a marketing campaign and its underlying execution.
View API Endpoints
The wrap up resource is used to view details of media interaction. A wrap up is created at the end of an interaction, which is a child resource of the interaction. The object tracks outcome, reasons, notes, and other details related to media channel based interactions.
View API Endpoints

You can view a list of all REST Endpoints.