1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Price Books

Get one price book.

get

/fscmRestApi/resources/11.13.18.05/priceBooks/{PriceBookNumber}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : priceBooks-item-response
Type: object
Show Source
Nested Schema : Price Book Dimension
Type: array
Title: Price Book Dimension
Information about the parameters used in filtering items or calculating the prices that appear in the price book.
Show Source
Nested Schema : Price Book Line
Type: array
Title: Price Book Line
Information about the items that are priced in a price book.
Show Source
Nested Schema : Price Book Publication
Type: array
Title: Price Book Publication
Information about the parameters used to publish price book data.
Show Source
Nested Schema : priceBooks-dimensions-item-response
Type: object
Show Source
Nested Schema : priceBooks-lines-item-response
Type: object
Show Source
Nested Schema : Price Book Charge Component
Type: array
Title: Price Book Charge Component
Information about the types of charges that are used to price a line in a price book.
Show Source
Nested Schema : priceBooks-lines-chargeComponents-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 1000
    Explanation message. Stores the pricing message based on the values for the component, the calculation type, and the calculation component fields.
  • Links
  • Read Only: true
    Value for which one will be charged for an item.
  • Read Only: true
    Value that uniquely identifies the price book charge component. Oracle Pricing automatically assigns this value.
  • Read Only: true
    Value that uniquely identifies the price book charge. Oracle Pricing automatically assigns this value.
  • Read Only: true
    Maximum Length: 1000
    Reference used to designate a type of charge.
  • Read Only: true
    Maximum Length: 30
    Code that identifies the element reference to the price elements setup. For example, QP_LIST_PRICE, QP_NET_PRICE.
  • Read Only: true
    Maximum Length: 80
    Name of pricing element for a charge component.
  • Read Only: true
    Maximum Length: 30
    Value that uniquely identifies the lowest level pricing source. For example, price list or discount rule.
  • Read Only: true
    Maximum Length: 30
    Code that identifies the type of the pricing source. For example, price list charge, rate plan charge, tiered pricing rule. A list of accepted values is defined in the lookup type ORA_QP_SOURCE_TYPES.
Nested Schema : priceBooks-publications-item-response
Type: object
Show Source
Links
deletePriceBook
Parameters:
  • PriceBookNumber: $request.path.PriceBookNumber
Deletes one price book and its contents based on a set of parameters.
dimensions
Parameters:
  • PriceBookNumber: $request.path.PriceBookNumber
Information about the parameters used in filtering items or calculating the prices that appear in the price book.
generatePriceBook
Parameters:
  • PriceBookNumber: $request.path.PriceBookNumber
Generates a precalculated collection of prices based on a set of input parameters.
lines
Parameters:
  • PriceBookNumber: $request.path.PriceBookNumber
Information about the items that are priced in a price book.
publications
Parameters:
  • PriceBookNumber: $request.path.PriceBookNumber
Information about the parameters used to publish price book data.
Back to Top

Examples

This example describes how to get one price book.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/priceBooks/PriceBookNumber

Example Response Body

The following example includes the contents of the response body in JSON format:
{
  "PriceBookId" : "300100639346697",
  "Name" : "RM_TEST",
  "PriceBookNumber" : "RM_PB_TEST",
  "Description" : "RM_PB_TEST Testing updated",
  "BusinessUnitId" : "204",
  "BusinessUnit" : "Vision Operations",
  "CurrencyCode" : "USD",
  "Currency" : "US Dollar",
  "StartDate" : "2025-07-07T00:00:00+00:00",
  "CreatedBy" : "PRICING_MGR_OPERATIONS",
  "EndDate" : null,
  "PricingDate" : "2025-07-07T00:00:00+00:00",
  "CreationDate" : "2025-07-24T05:20:00+00:00",
  "LastUpdateDate" : "2025-07-31T11:33:56.004+00:00",
  "LastUpdateLogin" : "39AD42326F4268BDE063FC79060ADF5A",
  "LastUpdatedBy" : "SCMOPERATIONS",
  "StatusCode" : "ORA_QP_PB_DRAFT"
}
Back to Top