Jump to

• Request
• Response
• Examples

Get Transaction Pricing

get

/rest/v16/pricingSetup/preview/{bsId}

Use this endpoint to retrieve header level pricing attribute values for the specified transaction.

Request

Path Parameters

• bsId(required): integer(int64)

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingPreviewHeader

Type: object

Show Source

• bsId: integer()
  Title: BS ID

  The Transaction Id
• currencyCode: string()
  Title: Currency Code

  Read Only: true

  Currency Code.
• customerId: string()
  Title: Customer Id

  Read Only: true

  Customer Id.
• headerAttributeValues: object Header Attribute Values
  Title: Header Attribute Values

  Read Only: true

  Header Attribute Values.
• items: Items
  Title: Items

  Read Only: true

  Transaction Line Items.
• priceBookVarName: string()
  Title: Price Book Variable

  Read Only: true

  Price Book Variable.
• returnAvailableRatePlans: boolean()
  Title: Available Rate Plans

  Read Only: true

  Available Rate Plans.

{
    "properties":{
        "currencyCode":{
            "type":"string",
            "format":"",
            "description":"Currency Code.",
            "title":"Currency Code",
            "readOnly":true
        },
        "priceBookVarName":{
            "type":"string",
            "format":"",
            "description":"Price Book Variable.",
            "title":"Price Book Variable",
            "readOnly":true
        },
        "customerId":{
            "type":"string",
            "format":"",
            "description":"Customer Id.",
            "title":"Customer Id",
            "readOnly":true
        },
        "headerAttributeValues":{
            "type":"object",
            "format":"",
            "description":"Header Attribute Values.",
            "title":"Header Attribute Values",
            "readOnly":true
        },
        "items":{
            "format":"",
            "description":"Transaction Line Items.",
            "title":"Items",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_PricingPreviewLineItem"
                }
            ]
        },
        "returnAvailableRatePlans":{
            "type":"boolean",
            "format":"",
            "description":"Available Rate Plans.",
            "title":"Available Rate Plans",
            "readOnly":true
        },
        "bsId":{
            "type":"integer",
            "format":"",
            "description":"The Transaction Id",
            "title":"BS ID"
        }
    }
}

Nested Schema : Header Attribute Values

Type: object

Title: Header Attribute Values

Read Only: true

Header Attribute Values.

Nested Schema : Items

Title: Items

Read Only: true

Transaction Line Items.

Match All

Show Source

• object PricingResourceCollection_PricingPreviewLineItem

{
    "format":"",
    "description":"Transaction Line Items.",
    "title":"Items",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_PricingPreviewLineItem"
        }
    ]
}

Nested Schema : PricingResourceCollection_PricingPreviewLineItem

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array items
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• totalResults: integer()
  Title: Total Results

  Read Only: true

  Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PricingPreviewLineItem"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object PricingPreviewLineItem

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

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : PricingPreviewLineItem

Type: object

Show Source

• bomItemName: string()
  Title: Bom Item Name

  Read Only: true

  Bom Item Name.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• documentNumber: integer()
  Title: Line Item Document Number

  Read Only: true

  Line Item Document Number.
• itemAttributeValues: object itemAttributeValues
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• partNumber: string()
  Title: Part Number

  Read Only: true

  Part Number.
• rootBomItemName: string()
  Title: Root Bom Item Name

  Read Only: true

  Root Bom Item Name.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "documentNumber":{
            "type":"integer",
            "format":"",
            "description":"Line Item Document Number.",
            "title":"Line Item Document Number",
            "readOnly":true
        },
        "partNumber":{
            "type":"string",
            "format":"",
            "description":"Part Number.",
            "title":"Part Number",
            "readOnly":true
        },
        "bomItemName":{
            "type":"string",
            "format":"",
            "description":"Bom Item Name.",
            "title":"Bom Item Name",
            "readOnly":true
        },
        "rootBomItemName":{
            "type":"string",
            "format":"",
            "description":"Root Bom Item Name.",
            "title":"Root Bom Item Name",
            "readOnly":true
        },
        "itemAttributeValues":{
            "type":"object"
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : itemAttributeValues

Type: object

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve header level pricing attribute values for the specified transaction 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/pricingSetup/preview/38635017

Response Body Sample

{
    "currencyCode": "USD",
    "priceBookVarName": "_default_price_book",
    "customerId": "300100122967029",
    "headerAttributeValues": {
        "_priceAsOf": "",
        "_buyingAccountId": ""
    },
    "bsId": 38635017
}

Back to Top