Get Price Book
get
/rest/v16/priceBooks/{variableName}
This action retrieves the specified Price Book
Request
Path Parameters
-
variableName(required): string
Unique name for Price Book
Response
Default Response
Root Schema : priceBooks
Type:
Show Source
object
-
dateAdded:
string
Title:
Date Added
System field indicating the date on which the Resource was created. -
dateModified:
string
Title:
Date Modified
System field indicating the date on which the Resource was last modified. -
description:
string
Title:
Description
Description -
id:
integer
Title:
Id
Primary Key of BM_PRICE_BOOK -
name:
string
Title:
Name
Price book name -
orderNumber:
integer
Title:
Order Number
Order Number -
priceBookLink:
object priceBookLink
-
priceBookTranslationLinks:
object priceBookTranslationLinks
-
status:
object Status
Title:
Status
Price book status -
variableName:
string
Title:
Variable Name
Unique name for price book
Nested Schema : priceBookTranslationLinks
Type:
Show Source
object
-
link:
string
Link to Price Book translations.
Nested Schema : Status
Type:
object
Title:
Status
Price book status
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Examples
The following example shows how to retrieve a specified Price Book by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json" https://sitename.oracle.com/rest/v16/priceBooks
Response Body Sample
{ "id": 4125467, "dateModified": "2018-05-03T11:07:28.000Z", "status": 3, "variableName": "_default_price_book", "description": "Default Price Book. this is default", "orderNumber": 1, "name": "Base Price", "refId": -1, "dateAdded": "2005-11-15T20:56:15.000Z", "companyId": 4118171, "partnerPriceBookId": null, "multiplierValue": 1, "refType": 1 }