Create a default price
post
/crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/DefaultPrices
Request
Path Parameters
-
InventoryItemId(required): integer(int64)
The unique identifier of the inventory item. This value is generated when the product is created.
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:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
CurrencyCode: string
Title:
Currency
Maximum Length:15
The code for the Currency of the default price. -
ItemNumber: string
Title:
Product Number
Maximum Length:300
The unique alternate identifier of the product. -
ListPrice: number
Title:
List Price
Default Value:0
The List Price for the combination of product, currency and UOM. -
PricebookId: integer
(int64)
The unique identifier of the price book associated with the default price
-
PriceUOMCode: string
Title:
UOM
Maximum Length:30
The unit of measurement code of the default price.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : products-DefaultPrices-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the default price. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the default price was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The code for the Currency of the default price. -
DefaultPriceId: integer
(int64)
Read Only:
true
The unique identifier of the default price. This value is generated when the default price is created. -
InvItemId: integer
(int64)
Title:
Inventory Item ID
Read Only:true
The unique identifier of the inventory item associated with the default price -
InvOrgId: integer
(int64)
Read Only:
true
The unique identifier of the inventory organization associated with the default price. -
ItemNumber: string
Title:
Product Number
Maximum Length:300
The unique alternate identifier of the product. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the default price was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the default price. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the default price. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListPrice: number
Title:
List Price
Default Value:0
The List Price for the combination of product, currency and UOM. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row. -
PricebookId: integer
(int64)
The unique identifier of the price book associated with the default price
-
PriceBookName: string
Title:
Name
Read Only:true
Maximum Length:150
The name of the Price book associated with the Default Price. -
PriceUOMCode: string
Title:
UOM
Maximum Length:30
The unit of measurement code of the default price.
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.