Create a pricebook item
post
/crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/PriceBookItem
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
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.
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-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 : 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.
Links
- SalesCatalogExtnProductsLovVA
-
Operation: /crmRestApi/resources/11.13.18.05/productsParameters:
- finder:
ProductList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DPRICEBOOK
The following properties are defined on the LOV link relation:- Source Attribute: ItemDescription; Target Attribute: Name
- Display Attribute: Name
- finder:
Examples
The following example shows how to create a pricebook item header by submitting a POST request on the REST resource using cURL.
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "PricebookId": 300100062008000, "InvItemId" : "300100017155641", "PriceUOMCode" : "Ea" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "PricebookItemId" : 300100062008003, "PricebookId" : 300100062008000, "InvItemId" : 300100017155641, "ItemDescription" : " Genuine Windows 7 Professional, 32-bit", "ListPrice" : 0.00, "PriceUOMCode" : "Ea", "links" : [ { ... } ] }