REST API Services for CPQ Cloud

Get Price Book

get

/rest/v7/priceBooks/{variableName}

This action retrieves the specified Price Book

Request

Path Parameters

variableName: string

Unique name for Price Book

Response

Default Response

Root Schema : priceBooks

Type: object

Show Source

dateAdded(optional): string

Title: Date Added

System field indicating the date on which the Resource was created.
dateModified(optional): string

Title: Date Modified

System field indicating the date on which the Resource was last modified.
description(optional): string

Title: Description

Description
id(optional): integer

Title: Id

Primary Key of BM_PRICE_BOOK
name(optional): string

Title: Name

Price book name
orderNumber(optional): integer

Title: Order Number

Order Number
priceBookLink(optional): object priceBookLink
priceBookTranslationLinks(optional): object priceBookTranslationLinks
status(optional): object Status

Title: Status

Price book status
variableName(optional): string

Title: Variable Name

Unique name for price book

{
    "type":"object",
    "properties":{
        "dateAdded":{
            "title":"Date Added",
            "description":"System field indicating the date on which the Resource was created.",
            "type":"string"
        },
        "dateModified":{
            "title":"Date Modified",
            "description":"System field indicating the date on which the Resource was last modified.",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "description":"Description",
            "type":"string"
        },
        "id":{
            "title":"Id",
            "description":"Primary Key of BM_PRICE_BOOK",
            "type":"integer"
        },
        "name":{
            "title":"Name",
            "description":"Price book name",
            "type":"string"
        },
        "orderNumber":{
            "title":"Order Number",
            "description":"Order Number",
            "type":"integer"
        },
        "status":{
            "title":"Status",
            "description":"Price book status",
            "type":"object",
            "properties":{
                "lookupCode":{
                    "title":"Lookup Code",
                    "type":"string",
                    "description":"Language independent code of the fixed list of value."
                },
                "id":{
                    "title":"Id",
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource."
                },
                "displayValue":{
                    "title":"Display Value",
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined."
                }
            }
        },
        "variableName":{
            "title":"Variable Name",
            "description":"Unique name for price book",
            "type":"string"
        },
        "priceBookLink":{
            "type":"object",
            "properties":{
                "link":{
                    "description":"Link to the Price Book.",
                    "type":"string"
                }
            }
        },
        "priceBookTranslationLinks":{
            "type":"object",
            "properties":{
                "link":{
                    "description":"Link to Price Book translations.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : priceBookLink

Type: object

Show Source

link(optional): string

Link to the Price Book.

{
    "type":"object",
    "properties":{
        "link":{
            "description":"Link to the Price Book.",
            "type":"string"
        }
    }
}

Nested Schema : priceBookTranslationLinks

Type: object

Show Source

link(optional): string

Link to Price Book translations.

{
    "type":"object",
    "properties":{
        "link":{
            "description":"Link to Price Book translations.",
            "type":"string"
        }
    }
}

Nested Schema : Status

Type: object

Title: Status

Price book status

Show Source

displayValue(optional): string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id(optional): integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode(optional): string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "title":"Status",
    "description":"Price book status",
    "type":"object",
    "properties":{
        "lookupCode":{
            "title":"Lookup Code",
            "type":"string",
            "description":"Language independent code of the fixed list of value."
        },
        "id":{
            "title":"Id",
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource."
        },
        "displayValue":{
            "title":"Display Value",
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined."
        }
    }
}

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/v7/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
}