Update a pricebook
patch
/crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}
Request
Path Parameters
-
priceBookHeaders_Id(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=
Header Parameters
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DefaultPricebookFlag: boolean
Title:
Default Price Book
Maximum Length:1
Default Value:false
Indicates if it is the default price book for the currency. -
Description: string
Title:
Description
Maximum Length:1999
A brief description of the price book. -
HeaderExternalKey: string
Title:
Header External Key
Maximum Length:120
The external key value for the price book. -
HeaderExternalSource: string
Title:
Header External Source
Maximum Length:120
Default Value:PB_HEADER
The source for the external key of the price book. -
Name: string
Title:
Name
Maximum Length:150
The name of the price book. -
PriceBookItem: array
Price Book Items
Title:
Price Book Items
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. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The code indicating the status of the price book. For example, Draft, Active, or Expired. -
StatusSearchLovVA: array
Status Search
Title:
Status Search
The Status Search resource lets you search for the status of a pricebook.
Nested Schema : Price Book Items
Type:
array
Title:
Price Book Items
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.
Show Source
Nested Schema : Status Search
Type:
array
Title:
Status Search
The Status Search resource lets you search for the status of a pricebook.
Show Source
Nested Schema : priceBookHeaders-PriceBookItem-item-patch-request
Type:
Show Source
object
-
CurrencyCode: string
Maximum Length:
15
The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area. -
InvItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of the item selected in the price book. -
InvOrgId: integer
(int64)
The unique identifier of the inventory organization associated with the item selected in the price book.
-
ItemDescription: string
Title:
Name
A brief description of the price book item. -
ItemExternalKey: string
Title:
External Key
Maximum Length:120
The external key value for the price book item. -
ItemExternalSource: string
Title:
External Source
Maximum Length:120
Default Value:PB_LINE
The source for the external key of the price book item. -
ListPrice: number
Title:
List Price
Default Value:0
The price of the item. -
PricebookId: integer
(int64)
The unique identifier of the price book.
-
PriceUOMCode: string
Title:
UOM
Maximum Length:30
The unit of measurement of the item.
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.
Root Schema : priceBookHeaders-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DefaultPricebookFlag: boolean
Title:
Default Price Book
Maximum Length:1
Default Value:false
Indicates if it is the default price book for the currency. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the price book can be deleted. The default value is true. -
Description: string
Title:
Description
Maximum Length:1999
A brief description of the price book. -
HeaderExternalKey: string
Title:
Header External Key
Maximum Length:120
The external key value for the price book. -
HeaderExternalSource: string
Title:
Header External Source
Maximum Length:120
Default Value:PB_HEADER
The source for the external key of the price book. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:150
The name of the price book. -
PricebookCode: string
Title:
Price Book Code
Maximum Length:80
The code indicating the price book. This value is auto-generated when a pricebook is created. -
PricebookId: integer
(int64)
Title:
Price Book ID
The unique identifier of the price book. -
PriceBookItem: array
Price Book Items
Title:
Price Book Items
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. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The code indicating the status of the price book. For example, Draft, Active, or Expired. -
StatusSearchLovVA: array
Status Search
Title:
Status Search
The Status Search resource lets you search for the status of a pricebook. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the price book can be updated. The default value is true.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Price Book Items
Type:
array
Title:
Price Book Items
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.
Show Source
Nested Schema : Status Search
Type:
array
Title:
Status Search
The Status Search resource lets you search for the status of a pricebook.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : priceBookHeaders-PriceBookItem-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
CurrencyCode: string
Maximum Length:
15
The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area. -
InvItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of the item selected in the price book. -
InvOrgId: integer
(int64)
The unique identifier of the inventory organization associated with the item selected in the price book.
-
ItemDescription: string
Title:
Name
A brief description of the price book item. -
ItemExternalKey: string
Title:
External Key
Maximum Length:120
The external key value for the price book item. -
ItemExternalSource: string
Title:
External Source
Maximum Length:120
Default Value:PB_LINE
The source for the external key of the price book item. -
ItemNumber: string
Read Only:
true
Maximum Length:300
The item of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_ITEM. Review and update the profile option using the Setup and Maintenance work area. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListPrice: number
Title:
List Price
Default Value:0
The price of the item. -
PricebookCode: string
Title:
Price Book Code
Maximum Length:80
-
PricebookId: integer
(int64)
The unique identifier of the price book.
-
PricebookItemId: integer
(int64)
The unique identifier of the price book item.
-
PriceUOMCode: string
Title:
UOM
Maximum Length:30
The unit of measurement of the item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : priceBookHeaders-StatusSearchLovVA-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupCode: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
The code indicating the type of FND Lookup. A list of valid values is defined in the lookup ORA_QSC_PRICE_BOOK_STATUS. -
LookupType: string
Title:
Lookup Type
Read Only:true
Maximum Length:30
The type of the FND Lookup. -
Meaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
The meaning of the lookup. -
Tag: string
Title:
Tag
Read Only:true
Maximum Length:150
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- PriceBookItem
-
Operation: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/PriceBookItemParameters:
- priceBookHeaders_Id:
$request.path.priceBookHeaders_Id
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. - priceBookHeaders_Id:
- StatusCodeLovForUIVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_QSC_PRICE_BOOK_STATUS
The list of different status codes associated with the price book. The maximum value for this attribute is 30.
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- StatusSearchLovVA
-
Operation: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/StatusSearchLovVAParameters:
- priceBookHeaders_Id:
$request.path.priceBookHeaders_Id
The Status Search resource lets you search for the status of a pricebook. - priceBookHeaders_Id:
- YesNoPricebookFlagFndLookupsVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values to indicate whether the pricebook is the default for a currency. The valid values are Y and N.
The following properties are defined on the LOV link relation:- Source Attribute: DefaultPricebookFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
The following example shows how to update a pricebook header by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/priceBookHeaders/300100062007997
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "Description" : "Test Pricebook ONE" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "PricebookId" : 300100062007997, "PricebookCode" : "93c1bea1-21f9-402c-9c2e-45e9faf8dcc8", "CurrencyCode" : "USD", "Name" : "Test", "Description" : "Test Pricebook ONE", "StatusCode" : "DRAFT", "ObjectVersionNumber" : 2, "CreatedBy" : "SALES_ADMIN", "CreationDate" : "2016-02-04T12:08:32-08:00", "LastUpdateDate" : "2016-03-01T05:50:00-08:00", "LastUpdateLogin" : "2CF7673ED2203829E0531A78F00A3DEE", "LastUpdatedBy" : "SALES_ADMIN", "UpdateFlag" : true, "DeleteFlag" : true, "links" : [ { . . . } ] }