Price Book Lines
The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.
|
Resource Plural Label |
Price Book Lines |
|
Resource Name |
PriceBookItem |
Get All Price Book Items
Request: GET
URI: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookId}/child/PriceBookItem
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
priceBookId |
Integer |
The unique identifier of the Price Book. |
Request Query Parameters
Use the listed finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
PrimaryKey |
Finds a Price Book Item with the specified primary key. Finder Variables:
|
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Create a Price Book Item
Request: POST
URI: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookId}/child/PriceBookItem
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
priceBookId |
Integer |
The unique identifier of the Price Book. |
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Get a Price Book Item
Request: GET
URI: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookId}/child/PriceBookItem/{priceBookItemId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
priceBookId |
Integer |
The unique identifier of the Price Book. |
|
priceBookItemId |
Integer |
The unique identifier of the Price Book Item. |
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Update a Price Book Item
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookId}/child/PriceBookItem/{priceBookItemId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
priceBookId |
Integer |
The unique identifier of the Price Book. |
|
priceBookItemId |
Integer |
The unique identifier of the Pricebook Item. |
Request Body
This table summarizes the request path parameters:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Replace a Price Book Item
Request: PUT
URI: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookId}/child/PriceBookItem/{priceBookItemId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
priceBookId |
Integer |
The unique identifier of the Price Book. |
|
priceBookItemId |
Integer |
The unique identifier of the Price Book Item. |
Request Body
This table summarizes the request path parameters:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Delete a Price Book Item
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookId}/child/PriceBookItem/{priceBookItemId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
priceBookId |
Integer |
The unique identifier of the Price Book. |
|
priceBookItemId |
Integer |
The unique identifier of the Price Book Item. |
Request Body
There are no elements in the request body for this task.
Response Body
There are no elements in the response body for this task.
List of Values
This table lists all the list of values of the resource.
| LOV Name | Source Attribute in LOV | Target Attribute in Resource |
|---|---|---|
|
SalesCatalogProductsLovVA |
Description |
ItemDescription |
|
SalesCatalogProductsLovVA |
InventoryItemId |
InvItemId |
|
SalesCatalogProductsLovVA |
InvOrgId |
InvOrgId |
|
SalesCatalogProductsLovVA |
PrimaryUomCode |
PriceUOMCode |
|
ItemUnitOfMeasureLovVA |
UOMCode |
PriceUOMCode |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
PricebookItemId |
integer |
The unique item identifier of the price book. |
|
PricebookId |
integer |
The unique identifier of the price book. |
|
InvItemId |
integer |
The unique identifier of the item selected in the price book. |
|
ItemDescription |
string |
The description of the item. UI Label: Name |
|
InvOrgId |
integer |
The unique identifier of the inventory organistation. |
|
ListPrice |
integer |
The price of the item. UI Label: List Price |
|
CreatedBy |
string |
The user who created the price book item. Properties: The maximum length is 64. |
|
CreationDate |
datetime |
The date and time when the price book item was created. |
|
LastUpdateDate |
datetime |
The date and time when the price book item was last updated. |
|
LastUpdateLogin |
string |
The login of the user who last updated the price book item. Properties: The maximum length is 32. |
|
LastUpdatedBy |
string |
The user who last updated the price book item. Properties: The maximum length is 64. |
|
CurrencyCode |
string |
The currency the price book amount is based on. |
|
PriceUOMCode |
string |
The unit of measurement of the item. Properties: The maximum length is 30. UI Label: UOM |
|
ItemExternalSource |
string |
The source for the external key of the price book item. Properties: The maximum length is 120. UI Label: External Source |
|
ItemExternalKey |
string |
The external key value for the price book item. Properties: The maximum length is 120. UI Label: External Key |
|
__ORACO__Tax1Amount_c |
number |
The actual tax amount for the first tax. UI Label: Tax 1 Amount |
|
__ORACO__Tax1Percentage_c |
number |
The actual tax percentage for the first tax. UI Label: Tax 1 Percentage |
|
__ORACO__Tax2Amount_c |
number |
The actual tax amount for the second tax. UI Label: Tax 2 Amount |
|
__ORACO__Tax2Percentage_c |
number |
The actual tax percentage for the second tax. UI Label: Tax 2 Percentage |