Jump to

• Request
• Response

Get one price book line.

get

/fscmRestApi/resources/11.13.18.05/priceBooks/{PriceBookNumber}/child/lines/{PriceBookChargeId}

Request

Path Parameters

• PriceBookChargeId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• PriceBookNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : priceBooks-lines-item-response

Type: object

Show Source

• Charge: string
  Read Only: true

  Maximum Length: 80

  Component of price for an item. Multiple charges are possible, such as sales, shipping, tax.
• chargeComponents: array Price Book Charge Component
  Title: Price Book Charge Component

  Information about the types of charges that are used to price a line in a price book.
• ChargeDefinitionCode: string
  Read Only: true

  Maximum Length: 30

  Code that identifies the definition for the pricing charge.
• Description: string
  Read Only: true

  Maximum Length: 240

  Item Description.
• InventoryItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item.
• InventoryOrgId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization.
• Item: string
  Read Only: true

  Maximum Length: 300

  Number used on the price book line to refer to the item.
• ItemType: string
  Read Only: true

  Maximum Length: 30

  Type of item.
• ItemTypeCode: string
  Read Only: true

  Maximum Length: 30

  BOM item type. Values include 1, 2, and 4.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListPrice: number
  Read Only: true

  Starting unit price in the price book.
• NetPrice: number
  Read Only: true

  Price that's adjusted for discounts after calculation in generating the price book.
• PriceBookChargeId: integer (int64)
  Read Only: true

  Value that uniquely identifies the price book charge. Oracle Pricing automatically assigns this value.
• PriceBookId: integer
  Read Only: true

  Value that uniquely identifies the price book.
• PriceBookLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the price book line.
• ShipMethod: string
  Read Only: true

  Maximum Length: 522

  Name of the ship method.
• ShipMethodId: integer (int64)
  Read Only: true

  Value that uniquely identifies the shipping method.
• Strategy: string
  Read Only: true

  Maximum Length: 80

  Combination for factors used to segment population of customers for pricing.
• StrategyId: integer (int64)
  Read Only: true

  Value that uniquely identifies the pricing strategy. Oracle Pricing automatically assigns this value.
• UOM: string
  Read Only: true

  Maximum Length: 25

  Unit of measure for item which the price is calculated in the price book.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Unit of measure for which the price is calculated.

{
    "type":"object",
    "properties":{
        "Charge":{
            "maxLength":80,
            "type":"string",
            "description":"Component of price for an item. Multiple charges are possible, such as sales, shipping, tax.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the definition for the pricing charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Item Description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryOrgId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Number used on the price book line to refer to the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"BOM item type. Values include 1, 2, and 4.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"Starting unit price in the price book.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NetPrice":{
            "type":"number",
            "description":"Price that's adjusted for discounts after calculation in generating the price book.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceBookChargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price book charge. Oracle Pricing automatically assigns this value.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceBookId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price book.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceBookLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price book line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipMethod":{
            "maxLength":522,
            "type":"string",
            "description":"Name of the ship method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipMethodId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipping method.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Strategy":{
            "maxLength":80,
            "type":"string",
            "description":"Combination for factors used to segment population of customers for pricing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StrategyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the pricing strategy. Oracle Pricing automatically assigns this value.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UOM":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure for item which the price is calculated in the price book.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure for which the price is calculated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "chargeComponents":{
            "title":"Price Book Charge Component",
            "type":"array",
            "description":"Information about the types of charges that are used to price a line in a price book.",
            "items":{
                "$ref":"#/components/schemas/priceBooks-lines-chargeComponents-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Price Book Charge Component

Type: array

Title: Price Book Charge Component

Information about the types of charges that are used to price a line in a price book.

Show Source

• Array of: object priceBooks-lines-chargeComponents-item-response

{
    "title":"Price Book Charge Component",
    "type":"array",
    "description":"Information about the types of charges that are used to price a line in a price book.",
    "items":{
        "$ref":"#/components/schemas/priceBooks-lines-chargeComponents-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : priceBooks-lines-chargeComponents-item-response

Type: object

Show Source

• ExplanationMessage: string
  Read Only: true

  Maximum Length: 1000

  Explanation message. Stores the pricing message based on the values for the component, the calculation type, and the calculation component fields.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Price: number
  Read Only: true

  Value for which one will be charged for an item.
• PriceBookChargeComponentId: integer
  Read Only: true

  Value that uniquely identifies the price book charge component. Oracle Pricing automatically assigns this value.
• PriceBookChargeId: integer (int64)
  Read Only: true

  Value that uniquely identifies the price book charge. Oracle Pricing automatically assigns this value.
• PriceElement: string
  Read Only: true

  Maximum Length: 1000

  Reference used to designate a type of charge.
• PriceElementCode: string
  Read Only: true

  Maximum Length: 30

  Code that identifies the element reference to the price elements setup. For example, QP_LIST_PRICE, QP_NET_PRICE.
• PriceElementName: string
  Read Only: true

  Maximum Length: 80

  Name of pricing element for a charge component.
• PricingSourceId: string
  Read Only: true

  Maximum Length: 30

  Value that uniquely identifies the lowest level pricing source. For example, price list or discount rule.
• PricingSourceTypeCode: string
  Read Only: true

  Maximum Length: 30

  Code that identifies the type of the pricing source. For example, price list charge, rate plan charge, tiered pricing rule. A list of accepted values is defined in the lookup type ORA_QP_SOURCE_TYPES.

{
    "type":"object",
    "properties":{
        "ExplanationMessage":{
            "maxLength":1000,
            "type":"string",
            "description":"Explanation message. Stores the pricing message based on the values for the component, the calculation type, and the calculation component fields.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Price":{
            "type":"number",
            "description":"Value for which one will be charged for an item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceBookChargeComponentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price book charge component. Oracle Pricing automatically assigns this value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceBookChargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price book charge. Oracle Pricing automatically assigns this value.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceElement":{
            "maxLength":1000,
            "type":"string",
            "description":"Reference used to designate a type of charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceElementCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the element reference to the price elements setup. For example, QP_LIST_PRICE, QP_NET_PRICE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceElementName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of pricing element for a charge component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PricingSourceId":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the lowest level pricing source. For example, price list or discount rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PricingSourceTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the type of the pricing source. For example, price list charge, rate plan charge, tiered pricing rule. A list of accepted values is defined in the lookup type ORA_QP_SOURCE_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

chargeComponents

Operation: /fscmRestApi/resources/11.13.18.05/priceBooks/{PriceBookNumber}/child/lines/{PriceBookChargeId}/child/chargeComponents

Parameters:

• PriceBookChargeId: $request.path.PriceBookChargeId
• PriceBookNumber: $request.path.PriceBookNumber

Information about the types of charges that are used to price a line in a price book.

Back to Top