Overview
The Price Book REST APIs retrieve a list of Price Books or a specified Price Book. Price Books provide an additional method to associate parts with price. One part can be associated with multiple Price Books.
Administration
Get Price Books|
Description |
This action retrieves the list of price books |
|---|---|
|
URI Endpoint |
/rest/v17/priceBooks |
|
Endpoint Parameters |
None |
|
HTTP Method |
GET |
|
Request Body Parameters |
None |
|
Response Body Parameters |
The response contains a list of price books. The status shows the current state of the price book:
|
https://sitename.oracle.com/rest/v17/priceBooks
{ "hasMore": false, "items": [{ "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 }, { "id": 16266857, "dateModified": "2016-05-11T22:05:44.000Z", "status": 1, "variableName": "pricebook4", "description": null, "orderNumber": 5, "name": "Pricebook 4: Custom, Exchange Rates", "refId": -1, "dateAdded": "2013-09-20T20:19:35.000Z", "companyId": 4118171, "partnerPriceBookId": null, "multiplierValue": 1, "refType": 0 } ] }
|
Description |
This action retrieves the specified price book |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/priceBooks/(priceBookVarName} |
|
|
Endpoint Parameters |
pricebookVarName |
The variable name for the default price book. |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
The response contains the requested price book. The status shows the current state of the price book:
|
|
https://sitename.oracle.com/rest/v17/priceBooks/_default_price_book
{ "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 }
Notes
For more information on the Interface Catalogs, see the topic Interface Catalog.
