Jump to

• Request
• Response
• Examples

Get All Price Books

get

/rest/v16/priceBooks

This action retrieves a list of Price Books

Request

There are no request parameters for this operation.

Back to Top

Response

Default Response

Body ()

Root Schema : priceBooks-collection

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/priceBooks"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object priceBooks

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/priceBooks"
    }
}

Nested Schema : priceBooks

Type: object

Show Source

• 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

{
    "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: 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: 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: 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.

{
    "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."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve the list of Price Books 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/pricing/actions/calculatePrice

Response Body Sample

{
   "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
      }
   ]
}
         

Back to Top