1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Price Book Headers

Get all pricebooks

get

/crmRestApi/resources/11.13.18.05/priceBookHeaders

Request

Query Parameters
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds a Pricebook by Primary key.
      Finder Variables:
      • PricebookId; integer; Finds a Pricebook using PricebookId.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CurrencyCode; string; The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
    • DefaultPricebookFlag; boolean; Indicates if it is the default price book for the currency.
    • DeleteFlag; boolean; Indicates whether the price book can be deleted. The default value is true.
    • Description; string; A brief description of the price book.
    • HeaderExternalKey; string; The external key value for the price book.
    • HeaderExternalSource; string; The source for the external key of the price book.
    • LastUpdateDate; string; The date when the record was last updated.
    • Name; string; The name of the price book.
    • PricebookCode; string; The code indicating the price book. This value is auto-generated when a pricebook is created.
    • PricebookId; integer; The unique identifier of the price book.
    • StatusCode; string; The code indicating the status of the price book. For example, Draft, Active, or Expired.
    • UpdateFlag; boolean; Indicates whether the price book can be updated. The default value is true.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • CurrencyCode; string; The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area.
    • InvItemId; integer; The unique identifier of the item selected in the price book.
    • InvOrgId; integer; The unique identifier of the inventory organization associated with the item selected in the price book.
    • ItemExternalKey; string; The external key value for the price book item.
    • ItemExternalSource; string; The source for the external key of the price book item.
    • ItemNumber; string; The item of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_ITEM. Review and update the profile option using the Setup and Maintenance work area.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the record.
    • ListPrice; number; The price of the item.
    • PriceUOMCode; string; The unit of measurement of the item.
    • PricebookCode; string
    • PricebookId; integer; The unique identifier of the price book.
    • PricebookItemId; integer; The unique identifier of the price book item.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • LookupCode; string; The code indicating the type of FND Lookup. A list of valid values is defined in the lookup ORA_QSC_PRICE_BOOK_STATUS.
    • LookupType; string; The type of the FND Lookup.
    • Meaning; string; The meaning of the lookup.
    • Tag; string
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : priceBookHeaders
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : priceBookHeaders-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Currency
    Maximum Length: 15
    The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Default Price Book
    Maximum Length: 1
    Default Value: false
    Indicates if it is the default price book for the currency.
  • Read Only: true
    Indicates whether the price book can be deleted. The default value is true.
  • Title: Description
    Maximum Length: 1999
    A brief description of the price book.
  • Title: Header External Key
    Maximum Length: 120
    The external key value for the price book.
  • Title: Header External Source
    Maximum Length: 120
    Default Value: PB_HEADER
    The source for the external key of the price book.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Name
    Maximum Length: 150
    The name of the price book.
  • Title: Price Book Code
    Maximum Length: 80
    The code indicating the price book. This value is auto-generated when a pricebook is created.
  • Title: Price Book ID
    The unique identifier of the price book.
  • Price Book Items
    Title: Price Book Items
    The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.
  • Title: Status
    Maximum Length: 30
    Default Value: DRAFT
    The code indicating the status of the price book. For example, Draft, Active, or Expired.
  • Status Search
    Title: Status Search
    The Status Search resource lets you search for the status of a pricebook.
  • Read Only: true
    Indicates whether the price book can be updated. The default value is true.
Nested Schema : Price Book Items
Type: array
Title: Price Book Items
The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.
Show Source
Nested Schema : Status Search
Type: array
Title: Status Search
The Status Search resource lets you search for the status of a pricebook.
Show Source
Nested Schema : priceBookHeaders-PriceBookItem-item-response
Type: object
Show Source
Nested Schema : priceBookHeaders-StatusSearchLovVA-item-response
Type: object
Show Source
  • Links
  • Title: Lookup Code
    Read Only: true
    Maximum Length: 30
    The code indicating the type of FND Lookup. A list of valid values is defined in the lookup ORA_QSC_PRICE_BOOK_STATUS.
  • Title: Lookup Type
    Read Only: true
    Maximum Length: 30
    The type of the FND Lookup.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    The meaning of the lookup.
  • Title: Tag
    Read Only: true
    Maximum Length: 150
Back to Top

Examples

The following example shows to get all pricebook headers by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/priceBookHeaders

Example of Response Body

The following example shows the contents of the response body in JSON format.

    {
       "items":
       [
           {
               "PricebookId": 300100036945808,
               "PricebookCode": "495ac644-2eaf-4478-9a5e-def69ffe9835",
               "CurrencyCode": "USD",
               "Name": "11111qqqqqrrr",
               "Description": null,
               "StatusCode": "ACTIVE",
               "CustomAttr_c": null,
               "TestSearch_c": null,
               "TestAttr_c": null,
               "links":
             
                   . . .
           }
       ]
    }
Back to Top