Update one volume rule
patch
/fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/volumeRules/{VolumeRuleId}
Request
Path Parameters
-
ProgramId(required): integer(int64)
Value that uniquely identifies the channel program. It is a primary key that the application generates when it creates the program.
-
VolumeRuleId(required): integer(int64)
Value that uniquely identifies the volume rule.
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
-
products: array
Products
Title:
Products
The Products resource manages the eligible products for a volume program. -
tiers: array
Tiers
Title:
Tiers
The Tiers resource manages the tier definition of a volume program. -
TierType: string
Tier types supported in the channel program. A list of accepted values is defined in the lookup type ORA_CJM_TIER_TYPE.
-
TierTypeCode(required): string
Maximum Length:
30
Abbreviation that identifies the tier type. -
UnitOfMeasure: string
Unit of measure of the item.
-
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure. -
VolumeRuleName(required): string
Maximum Length:
240
Name of the volume rule.
Nested Schema : Products
Type:
array
Title:
Products
The Products resource manages the eligible products for a volume program.
Show Source
Nested Schema : Tiers
Type:
array
Title:
Tiers
The Tiers resource manages the tier definition of a volume program.
Show Source
Nested Schema : channelPrograms-volumeRules-products-item-patch-request
Type:
Show Source
object
-
Category: string
Name of the category.
-
CategoryCode: string
Abbreviation that identifies the category.
-
CategoryDescription: string
Description of the category.
-
exclusions: array
Exclusions
Title:
Exclusions
The Exclusions resource manages the product or category exclusions from the volume program. -
IncludeVolumeExcludeDiscountFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the product volume is considered for tier calculation but not for any discount. If false, then the product volume is considered for tier calculation and for discounts. The default value is false. -
Item: string
Name of the item in the inventory.
-
ItemDescription: string
Description of the item in the inventory.
-
ItemId: string
Maximum Length:
240
Value that uniquely identifies the item in the inventory. -
LineLevel: string
Level at which discounts are defined. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.
-
LineLevelCode: string
Maximum Length:
30
Abbreviation that identifies the level at which discounts are defined. -
SupplierItem: string
Name of the supplier item.
-
SupplierItemDescription: string
Description of the supplier item.
-
SupplierItemId: integer
(int64)
Value that uniquely identifies the supplier item.
Nested Schema : Exclusions
Type:
array
Title:
Exclusions
The Exclusions resource manages the product or category exclusions from the volume program.
Show Source
Nested Schema : channelPrograms-volumeRules-products-exclusions-item-patch-request
Type:
Show Source
object
-
Category: string
Name of the category.
-
CategoryCode: string
Abbreviation that identifies the category.
-
CategoryDescription: string
Description of the category.
-
Item: string
Name of the item in the inventory.
-
ItemDescription: string
Description of the item in the inventory.
-
ItemId: string
Maximum Length:
240
Value that uniquely identifies the item in the inventory. -
LineLevel: string
Level at which discounts are defined. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.
-
LineLevelCode: string
Maximum Length:
30
Abbreviation that identifies the level at which discounts are defined. -
LineNumber: number
Number that identifies the product line.
-
SupplierItem: string
Name of the supplier item.
-
SupplierItemDescription: string
Description of the supplier item.
-
SupplierItemId: integer
(int64)
Value that uniquely identifies the supplier item.
Nested Schema : channelPrograms-volumeRules-tiers-item-patch-request
Type:
Show Source
object
-
PreQualifyingTierFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the tier calculation starts from the corresponding tier. If false, then the tier calculation starts from the first tier. The default value is false. -
TierDiscount: number
Value of the tier discount.
-
TierFrom: number
Value from which the tier is eligible.
-
TierName: string
Maximum Length:
240
Name of the tier. -
TierTo: number
Value till the tier is eligible
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 : channelPrograms-volumeRules-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
DiscountType: string
Read Only:
true
Type of discount. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE. -
DiscountTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the type of discount. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login credentials that the user used to update the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
products: array
Products
Title:
Products
The Products resource manages the eligible products for a volume program. -
ProgramId: integer
(int64)
Read Only:
true
Value that uniquely identifies the channel program. -
tiers: array
Tiers
Title:
Tiers
The Tiers resource manages the tier definition of a volume program. -
TierType: string
Tier types supported in the channel program. A list of accepted values is defined in the lookup type ORA_CJM_TIER_TYPE.
-
TierTypeCode: string
Maximum Length:
30
Abbreviation that identifies the tier type. -
UnitOfMeasure: string
Unit of measure of the item.
-
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure. -
VolumeRuleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the volume rule. -
VolumeRuleName: string
Maximum Length:
240
Name of the volume rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Products
Type:
array
Title:
Products
The Products resource manages the eligible products for a volume program.
Show Source
Nested Schema : Tiers
Type:
array
Title:
Tiers
The Tiers resource manages the tier definition of a volume program.
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 : channelPrograms-volumeRules-products-item-response
Type:
Show Source
object
-
Category: string
Name of the category.
-
CategoryCode: string
Abbreviation that identifies the category.
-
CategoryDescription: string
Description of the category.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
exclusions: array
Exclusions
Title:
Exclusions
The Exclusions resource manages the product or category exclusions from the volume program. -
IncludeVolumeExcludeDiscountFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the product volume is considered for tier calculation but not for any discount. If false, then the product volume is considered for tier calculation and for discounts. The default value is false. -
Item: string
Name of the item in the inventory.
-
ItemDescription: string
Description of the item in the inventory.
-
ItemId: string
Maximum Length:
240
Value that uniquely identifies the item in the inventory. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LineLevel: string
Level at which discounts are defined. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.
-
LineLevelCode: string
Maximum Length:
30
Abbreviation that identifies the level at which discounts are defined. -
LineNumber: number
Number that identifies the product line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProductId: integer
Value that uniquely identifies the product line.
-
SupplierItem: string
Name of the supplier item.
-
SupplierItemDescription: string
Description of the supplier item.
-
SupplierItemId: integer
(int64)
Value that uniquely identifies the supplier item.
-
VolumeRuleId: integer
(int64)
Value that uniquely identifies the volume rule.
Nested Schema : Exclusions
Type:
array
Title:
Exclusions
The Exclusions resource manages the product or category exclusions from the volume program.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelPrograms-volumeRules-products-exclusions-item-response
Type:
Show Source
object
-
Category: string
Name of the category.
-
CategoryCode: string
Abbreviation that identifies the category.
-
CategoryDescription: string
Description of the category.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
ExclusionId: integer
(int64)
Value that uniquely identifies the exclusion.
-
Item: string
Name of the item in the inventory.
-
ItemDescription: string
Description of the item in the inventory.
-
ItemId: string
Maximum Length:
240
Value that uniquely identifies the item in the inventory. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LineLevel: string
Level at which discounts are defined. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.
-
LineLevelCode: string
Maximum Length:
30
Abbreviation that identifies the level at which discounts are defined. -
LineNumber: number
Number that identifies the product line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProductId: integer
(int64)
Value that uniquely identifies the product line.
-
SupplierItem: string
Name of the supplier item.
-
SupplierItemDescription: string
Description of the supplier item.
-
SupplierItemId: integer
(int64)
Value that uniquely identifies the supplier item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelPrograms-volumeRules-tiers-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PreQualifyingTierFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the tier calculation starts from the corresponding tier. If false, then the tier calculation starts from the first tier. The default value is false. -
TierDiscount: number
Value of the tier discount.
-
TierFrom: number
Value from which the tier is eligible.
-
TierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the tier. -
TierName: string
Maximum Length:
240
Name of the tier. -
TierNumber: number
Read Only:
true
Number that identifies the tier. -
TierTo: number
Value till the tier is eligible
-
VolumeRuleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the volume rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- products
-
Parameters:
- ProgramId:
$request.path.ProgramId
- VolumeRuleId:
$request.path.VolumeRuleId
The Products resource manages the eligible products for a volume program. - ProgramId:
- tiers
-
Parameters:
- ProgramId:
$request.path.ProgramId
- VolumeRuleId:
$request.path.VolumeRuleId
The Tiers resource manages the tier definition of a volume program. - ProgramId: