Jump to

• Request
• Response

Get one volume rule

get

/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.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : channelPrograms-volumeRules-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DiscountTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of discount.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "tiers":{
            "title":"Tiers",
            "type":"array",
            "description":"The Tiers resource manages the tier definition of a volume program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-volumeRules-tiers-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TierType":{
            "type":"string",
            "description":"Tier types supported in the channel program. A list of accepted values is defined in the lookup type ORA_CJM_TIER_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "TierTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the tier type.",
            "nullable":false,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "VolumeRuleName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the volume rule.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VolumeRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the volume rule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "products":{
            "title":"Products",
            "type":"array",
            "description":"The Products resource manages the eligible products for a volume program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-volumeRules-products-item-response"
            }
        },
        "DiscountType":{
            "type":"string",
            "description":"Type of discount. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login credentials that the user used to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Products

Type: array

Title: Products

The Products resource manages the eligible products for a volume program.

Show Source

• Array of: object channelPrograms-volumeRules-products-item-response

{
    "title":"Products",
    "type":"array",
    "description":"The Products resource manages the eligible products for a volume program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-volumeRules-products-item-response"
    }
}

Nested Schema : Tiers

Type: array

Title: Tiers

The Tiers resource manages the tier definition of a volume program.

Show Source

• Array of: object channelPrograms-volumeRules-tiers-item-response

{
    "title":"Tiers",
    "type":"array",
    "description":"The Tiers resource manages the tier definition of a volume program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-volumeRules-tiers-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : channelPrograms-volumeRules-products-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryCode":{
            "type":"string",
            "description":"Abbreviation that identifies the category.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineLevel":{
            "type":"string",
            "description":"Level at which discounts are defined. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Category":{
            "type":"string",
            "description":"Name of the category.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product line.",
            "nullable":false,
            "x-queryable":true
        },
        "exclusions":{
            "title":"Exclusions",
            "type":"array",
            "description":"The Exclusions resource manages the product or category exclusions from the volume program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-volumeRules-products-exclusions-item-response"
            }
        },
        "ItemId":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "type":"string",
            "description":"Description of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "VolumeRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the volume rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LineNumber":{
            "type":"number",
            "description":"Number that identifies the product line.",
            "nullable":true,
            "x-queryable":true
        },
        "LineLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the level at which discounts are defined.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludeVolumeExcludeDiscountFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Item":{
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CategoryDescription":{
            "type":"string",
            "description":"Description of the category.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierItemDescription":{
            "type":"string",
            "description":"Description of the supplier item.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierItem":{
            "type":"string",
            "description":"Name of the supplier item.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Exclusions

Type: array

Title: Exclusions

The Exclusions resource manages the product or category exclusions from the volume program.

Show Source

• Array of: object channelPrograms-volumeRules-products-exclusions-item-response

{
    "title":"Exclusions",
    "type":"array",
    "description":"The Exclusions resource manages the product or category exclusions from the volume program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-volumeRules-products-exclusions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : channelPrograms-volumeRules-products-exclusions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryCode":{
            "type":"string",
            "description":"Abbreviation that identifies the category.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineLevel":{
            "type":"string",
            "description":"Level at which discounts are defined. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Category":{
            "type":"string",
            "description":"Name of the category.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemId":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the item in the inventory.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemDescription":{
            "type":"string",
            "description":"Description of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "type":"number",
            "description":"Number that identifies the product line.",
            "nullable":true,
            "x-queryable":true
        },
        "LineLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the level at which discounts are defined.",
            "nullable":false,
            "x-queryable":true
        },
        "ExclusionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the exclusion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Item":{
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CategoryDescription":{
            "type":"string",
            "description":"Description of the category.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierItemDescription":{
            "type":"string",
            "description":"Description of the supplier item.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierItem":{
            "type":"string",
            "description":"Name of the supplier item.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : channelPrograms-volumeRules-tiers-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VolumeRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the volume rule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TierNumber":{
            "type":"number",
            "description":"Number that identifies the tier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TierDiscount":{
            "type":"number",
            "description":"Value of the tier discount.",
            "nullable":false,
            "x-queryable":true
        },
        "TierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the tier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TierTo":{
            "type":"number",
            "description":"Value till the tier is eligible",
            "nullable":true,
            "x-queryable":true
        },
        "PreQualifyingTierFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TierName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the tier.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TierFrom":{
            "type":"number",
            "description":"Value from which the tier is eligible.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

products

Operation: /fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/volumeRules/{VolumeRuleId}/child/products

Parameters:

• ProgramId: $request.path.ProgramId
• VolumeRuleId: $request.path.VolumeRuleId

The Products resource manages the eligible products for a volume program.

tiers

Operation: /fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/volumeRules/{VolumeRuleId}/child/tiers

Parameters:

• ProgramId: $request.path.ProgramId
• VolumeRuleId: $request.path.VolumeRuleId

The Tiers resource manages the tier definition of a volume program.

Back to Top