Jump to

• Request
• Response
• Examples

Get one program

get

/fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}

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.

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

Body ()

Root Schema : channelPrograms-item-response

Type: object

Show Source

• alternateSupplierSites: array Alternate Supplier Sites
  Title: Alternate Supplier Sites

  The Alternate Supplier Sites resource manages alternate supplier sites of a supplier rebate program.
• ApplyManuallyToOrderFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the channel program is not automatically applied on sales orders even if the eligibility criteria is met. If false, then the channel program is automatically applied on sales orders upon eligibility evaluation. The value is defaulted from program type.
• AvailableAmount: number
  Read Only: true

  Available amount in the channel program.
• BusinessUnit: string
  Name of the business unit.
• BusinessUnitId: integer (int64)
  Value that uniquely identifies the business unit.
• CalculationMethod: string
  Method used for calculating accruals in the channel program. A list of accepted values is defined in the lookup type ORA_CJM_TIER_CALC_METHOD.
• CalculationMethodCode: string
  Maximum Length: 30

  Abbreviation that identifies the calculation method used for calculating accruals in the channel program.
• 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.
• Currency: string
  Name of the currency used for the channel program.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that identifies the currency used for the channel program.
• Description: string
  Maximum Length: 1000

  Description of the channel program.
• DFF: array Descriptive Flexfields for Channel Programs
  Title: Descriptive Flexfields for Channel Programs

  The Descriptive Flexfields for Channel Programs resource manages additional details for a program.
• EarnedAmount: number
  Read Only: true

  Earned amount in the channel program.
• EffectiveDateTypeCode: string
  Maximum Length: 30

  Default Value: FROM

  Abbreviation that identifies the sales order date type used for evaluating channel program eligibility. A list of accepted values is defined in the lookup type ORA_CJM_PRICING_APP_DATE_TYPE.
• FromDate: string (date)
  Date from when the program is applicable.
• InitiatedBy: string
  Value that identifies if the program was created by the supplier contact or the internal distributor user.
• InitiatedByCode: string
  Maximum Length: 20

  Abbreviation that identifies if the program was created by the supplier contact or the internal distributor user.
• InProgressAmount: number
  Read Only: true

  In-progress amount in the channel program.
• 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.
• marketRules: array Market Rules
  Title: Market Rules

  The Market Rules resource manages rules for identifying eligible customers for a program.
• OpenAmount: number
  Read Only: true

  Open amount in the channel program.
• OverrideProgramFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the channel programs that are automatically applied on sales orders can be overridden. If false, then the channel programs applied on sales orders cannot be overridden. The value is defaulted from program type.
• Owner: string
  Name of the person who owns the channel program. This attribute defaults to the name of the person who creates the program.
• OwnerId: integer (int64)
  Value that uniquely identifies the person who owns the channel program.
• OwnerPersonNumber: string
  Maximum Length: 255

  Number that uniquely identifies the person who owns the channel program.
• PaidAmount: number
  Read Only: true

  Paid amount in the channel program.
• productRules: array Product Rules
  Title: Product Rules

  The Product Rules resource manages rules for identifying eligible products for a program.
• ProgramCode: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the channel program.
• ProgramId: integer (int64)
  Value that uniquely identifies the channel program. It is a primary key that the application generates when it creates the program.
• ProgramName: string
  Title: Name

  Maximum Length: 240

  Name of the channel program.
• programRules: array Program Rules
  Title: Program Rules

  The Program Rules resource manages mandatory market rules for a program.
• ProgramTemplate: string
  Name of the predefined program template on which the channel program is based. A list of accepted values is defined in the lookup type ORA_CJM_PROGRAM_TYPE.
• ProgramTemplateCode: string
  Maximum Length: 30

  Abbreviation that identifies the predefined program template on which the channel program is based.
• ProgramType: string
  Type of program on which the channel program is based.
• ProgramTypeId: integer (int64)
  Value that uniquely identifies the type of program on which the channel program is based.
• PurchasedAmount: number
  Read Only: true

  Purchase amount in the channel program.
• Status: string
  Status of the channel program.
• StatusId: integer (int64)
  Value that uniquely identifies the status of the channel program.
• Supplier: string
  Name of the supplier supporting the channel program.
• SupplierAuthorizationNumber: string
  Maximum Length: 30

  Number that identifies the authorization provided by supplier.
• SupplierContact: string
  Person who represents the supplier when communicating with the buyer.
• SupplierContactId: integer (int64)
  Value that uniquely identifies the supplier contact.
• SupplierId: integer (int64)
  Value that uniquely identifies the supplier.
• SupplierNumber: string
  Number that identifies the supplier.
• SupplierQuoteNumber: string
  Maximum Length: 30

  Number that indicates the quote provided by supplier.
• SupplierSite: string
  Value that identifies the supplier site.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the supplier site.
• ToDate: string (date)
  Date until when the program is applicable.
• volumeRules: array Volume Rules
  Title: Volume Rules

  The Volume Rules resource manages volume rules of a volume program.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Owner":{
            "type":"string",
            "description":"Name of the person who owns the channel program. This attribute defaults to the name of the person who creates the program.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DFF":{
            "title":"Descriptive Flexfields for Channel Programs",
            "type":"array",
            "description":"The Descriptive Flexfields for Channel Programs resource manages additional details for a program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AvailableAmount":{
            "type":"number",
            "description":"Available amount in the channel program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "productRules":{
            "title":"Product Rules",
            "type":"array",
            "description":"The Product Rules resource manages rules for identifying eligible products for a program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-productRules-item-response"
            }
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency used for the channel program.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Currency":{
            "type":"string",
            "description":"Name of the currency used for the channel program.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramType":{
            "type":"string",
            "description":"Type of program on which the channel program is based.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OpenAmount":{
            "type":"number",
            "description":"Open amount in the channel program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of the channel program.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProgramTemplateCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the predefined program template on which the channel program is based.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ApplyManuallyToOrderFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the channel program is not automatically applied on sales orders even if the eligibility criteria is met. If false, then the channel program is automatically applied on sales orders upon eligibility evaluation. The value is defaulted from program type.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program. It is a primary key that the application generates when it creates the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the channel program.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PaidAmount":{
            "type":"number",
            "description":"Paid amount in the channel program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of program on which the channel program is based.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "BusinessUnit":{
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "type":"string",
            "description":"Value that identifies the supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the status of the channel program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FromDate":{
            "type":"string",
            "description":"Date from when the program is applicable.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveDateTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the sales order date type used for evaluating channel program eligibility. A list of accepted values is defined in the lookup type ORA_CJM_PRICING_APP_DATE_TYPE.",
            "nullable":false,
            "default":"FROM",
            "x-queryable":false
        },
        "PurchasedAmount":{
            "type":"number",
            "description":"Purchase amount in the channel program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the channel program.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "EarnedAmount":{
            "type":"number",
            "description":"Earned amount in the channel program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculationMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the calculation method used for calculating accruals in the channel program.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierContact":{
            "type":"string",
            "description":"Person who represents the supplier when communicating with the buyer.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierQuoteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that indicates the quote provided by supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who owns the channel program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "marketRules":{
            "title":"Market Rules",
            "type":"array",
            "description":"The Market Rules resource manages rules for identifying eligible customers for a program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-marketRules-item-response"
            }
        },
        "OverrideProgramFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the channel programs that are automatically applied on sales orders can be overridden. If false, then the channel programs applied on sales orders cannot be overridden. The value is defaulted from program type.",
            "nullable":true,
            "x-queryable":true
        },
        "volumeRules":{
            "title":"Volume Rules",
            "type":"array",
            "description":"The Volume Rules resource manages volume rules of a volume program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-volumeRules-item-response"
            }
        },
        "Supplier":{
            "type":"string",
            "description":"Name of the supplier supporting the channel program.",
            "nullable":true,
            "x-queryable":true
        },
        "alternateSupplierSites":{
            "title":"Alternate Supplier Sites",
            "type":"array",
            "description":"The Alternate Supplier Sites resource manages alternate supplier sites of a supplier rebate program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-alternateSupplierSites-item-response"
            }
        },
        "InitiatedByCode":{
            "maxLength":"20",
            "type":"string",
            "description":"Abbreviation that identifies if the program was created by the supplier contact or the internal distributor user.",
            "nullable":true,
            "x-queryable":true
        },
        "InitiatedBy":{
            "type":"string",
            "description":"Value that identifies if the program was created by the supplier contact or the internal distributor user.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerPersonNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that uniquely identifies the person who owns the channel program.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "type":"string",
            "description":"Number that identifies the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the channel program.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InProgressAmount":{
            "type":"number",
            "description":"In-progress amount in the channel program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculationMethod":{
            "type":"string",
            "description":"Method used for calculating accruals in the channel program. A list of accepted values is defined in the lookup type ORA_CJM_TIER_CALC_METHOD.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierAuthorizationNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the authorization provided by supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "ToDate":{
            "type":"string",
            "description":"Date until when the program is applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramTemplate":{
            "type":"string",
            "description":"Name of the predefined program template on which the channel program is based. A list of accepted values is defined in the lookup type ORA_CJM_PROGRAM_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "programRules":{
            "title":"Program Rules",
            "type":"array",
            "description":"The Program Rules resource manages mandatory market rules for a program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-programRules-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Alternate Supplier Sites

Type: array

Title: Alternate Supplier Sites

The Alternate Supplier Sites resource manages alternate supplier sites of a supplier rebate program.

Show Source

• Array of: object channelPrograms-alternateSupplierSites-item-response

{
    "title":"Alternate Supplier Sites",
    "type":"array",
    "description":"The Alternate Supplier Sites resource manages alternate supplier sites of a supplier rebate program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-alternateSupplierSites-item-response"
    }
}

Nested Schema : Descriptive Flexfields for Channel Programs

Type: array

Title: Descriptive Flexfields for Channel Programs

The Descriptive Flexfields for Channel Programs resource manages additional details for a program.

Show Source

• Array of: object channelPrograms-DFF-item-response

{
    "title":"Descriptive Flexfields for Channel Programs",
    "type":"array",
    "description":"The Descriptive Flexfields for Channel Programs resource manages additional details for a program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-DFF-item-response"
    },
    "x-cardinality":"1"
}

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 : Market Rules

Type: array

Title: Market Rules

The Market Rules resource manages rules for identifying eligible customers for a program.

Show Source

• Array of: object channelPrograms-marketRules-item-response

{
    "title":"Market Rules",
    "type":"array",
    "description":"The Market Rules resource manages rules for identifying eligible customers for a program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-marketRules-item-response"
    }
}

Nested Schema : Product Rules

Type: array

Title: Product Rules

The Product Rules resource manages rules for identifying eligible products for a program.

Show Source

• Array of: object channelPrograms-productRules-item-response

{
    "title":"Product Rules",
    "type":"array",
    "description":"The Product Rules resource manages rules for identifying eligible products for a program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-productRules-item-response"
    }
}

Nested Schema : Program Rules

Type: array

Title: Program Rules

The Program Rules resource manages mandatory market rules for a program.

Show Source

• Array of: object channelPrograms-programRules-item-response

{
    "title":"Program Rules",
    "type":"array",
    "description":"The Program Rules resource manages mandatory market rules for a program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-programRules-item-response"
    }
}

Nested Schema : Volume Rules

Type: array

Title: Volume Rules

The Volume Rules resource manages volume rules of a volume program.

Show Source

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

{
    "title":"Volume Rules",
    "type":"array",
    "description":"The Volume Rules resource manages volume rules of a volume program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-volumeRules-item-response"
    }
}

Nested Schema : channelPrograms-alternateSupplierSites-item-response

Type: object

Show Source

• AlternateSupplierSiteId: integer (int64)
  Value that uniquely identifies the alternate supplier site.
• 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.
• ProcurementBusinessUnit: string
  Name of the procurement business unit.
• ProcurementBusinessUnitId: integer
  Value that uniquely identifies the procurement business unit.
• Supplier: string
  Name of the alternate supplier supporting the channel program.
• SupplierId: integer
  Value that uniquely identifies the alternate supplier.
• SupplierNumber: string
  Number that identifies the alternate supplier.
• SupplierSite: string
  Maximum Length: 240

  Name of the alternate supplier site.
• SupplierSiteAddress: string
  Maximum Length: 4000

  Address of the alternate supplier site.
• SupplierSiteId: integer (int64)
  Value that identifies the alternate supplier site.

{
    "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
        },
        "ProcurementBusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "type":"string",
            "description":"Number that identifies the alternate supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBusinessUnit":{
            "type":"string",
            "description":"Name of the procurement business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteAddress":{
            "maxLength":"4000",
            "type":"string",
            "description":"Address of the alternate supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "AlternateSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate supplier site.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that identifies the alternate supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the alternate supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "type":"string",
            "description":"Name of the alternate supplier supporting the channel program.",
            "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"
    }
}

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-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Descriptive flexfield context name for product rule.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for product rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramHeaderId: integer (int64)
  Value that uniquely identifies the channel program.

{
    "type":"object",
    "properties":{
        "ProgramHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for product rule.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for product rule.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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-marketRules-item-response

Type: object

Show Source

• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in market rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• conditions: array Conditions
  Title: Conditions

  The Conditions resource manages additional conditions for a market rule of a program.
• 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.
• FromDate: string (date)
  Date when the qualifier becomes applicable.
• 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.
• ProgramId: integer (int64)
  Value that uniquely identifies the channel program.
• QualifierId: integer (int64)
  Value that uniquely identifies the market rule. It is a primary key that the application generates when it creates the market rule.
• QualifierType: string
  Maximum Length: 255

  Type of qualifier used to define the eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define the eligibility of the channel program.
• QualifierValue: string
  Read Only: true

  Maximum Length: 255

  Name of the qualifier used in channel program qualification.
• QualifierValueCode: string
  Maximum Length: 240

  Abbreviation that identifies the qualifier used in channel program qualification.
• ToDate: string (date)
  Date when the qualifier is no longer applicable.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the qualifier used in channel program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "QualifierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the market rule. It is a primary key that the application generates when it creates the market rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierValueCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in channel program qualification.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierType":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of qualifier used to define the eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in market rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "QualifierTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define the eligibility of the channel program.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromDate":{
            "type":"string",
            "description":"Date when the qualifier becomes applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ToDate":{
            "type":"string",
            "description":"Date when the qualifier is no longer applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "conditions":{
            "title":"Conditions",
            "type":"array",
            "description":"The Conditions resource manages additional conditions for a market rule of a program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-marketRules-conditions-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Conditions

Type: array

Title: Conditions

The Conditions resource manages additional conditions for a market rule of a program.

Show Source

• Array of: object channelPrograms-marketRules-conditions-item-response

{
    "title":"Conditions",
    "type":"array",
    "description":"The Conditions resource manages additional conditions for a market rule of a program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-marketRules-conditions-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-marketRules-conditions-item-response

Type: object

Show Source

• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in market rule condition. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• 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.
• QualifierConditionId: integer (int64)
  Value that uniquely identifies the market rule condition. It is a primary key that the application generates when it creates the market rule condition.
• QualifierId: integer (int64)
  Value that uniquely identifies the market rule.
• QualifierType: string
  Type of qualifier used to define the eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define channel program eligibility.
• QualifierValue: string
  Read Only: true

  Maximum Length: 255

  Type of qualifier used in channel program qualification.
• QualifierValueCode: string
  Maximum Length: 240

  Abbreviation that identifies the qualifier used in channel program qualification.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of qualifier used in channel program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "QualifierTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define channel program eligibility.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierConditionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the market rule condition. It is a primary key that the application generates when it creates the market rule condition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QualifierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the market rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierValueCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in channel program qualification.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierType":{
            "type":"string",
            "description":"Type of qualifier used to define the eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in market rule condition. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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-productRules-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.
• DFF: array Descriptive Flexfields for Product Rules
  Title: Descriptive Flexfields for Product Rules

  The Descriptive Flexfields for Product Rules resource manages additional details about a product rule of a program.
• DiscountType: string
  Type of discount. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE.
• DiscountTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of discount.
• DiscountValue: number
  Value of the discount.
• FromDate: string (date)
  Date when the product rule becomes applicable.
• 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.
• ItemLevel: string
  Level at which discounts are defined. Valid values include Item and All Items. A list of accepted values is defined in the lookup type ORA_CJM_ITEM_LEVEL.
• ItemLevelCode: string
  Maximum Length: 30

  Abbreviation that identifies the level at which discounts are defined.
• 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.
• MaximumQuantity: number
  Maximum quantity allowed for each product rule.
• ProgramId: integer (int64)
  Name that identifies the qualifier used in channel program qualification.
• ProgramLineId: integer
  Value that uniquely identifies the product rule. It is a primary key that the application generates when it creates the product rule.
• SupplierItem: string
  Maximum Length: 255

  Name of the supplier item.
• SupplierItemDescription: string
  Maximum Length: 255

  Description of the supplier item.
• SupplierItemId: integer (int64)
  Value that uniquely identifies the supplier item.
• ToDate: string (date)
  Date when the product rule is no longer applicable.
• UnitOfMeasure: string
  Unit of measure of the item for pricing.
• UOMCode: string
  Maximum Length: 30

  Abbreviation that identifies the unit of measure for pricing.

{
    "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,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure of the item for pricing.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DFF":{
            "title":"Descriptive Flexfields for Product Rules",
            "type":"array",
            "description":"The Descriptive Flexfields for Product Rules resource manages additional details about a product rule of a program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-productRules-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ProgramId":{
            "type":"integer",
            "description":"Name that identifies the qualifier used in channel program qualification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaximumQuantity":{
            "type":"number",
            "description":"Maximum quantity allowed for each product rule.",
            "nullable":true,
            "x-queryable":false
        },
        "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":false
        },
        "ItemLevel":{
            "type":"string",
            "description":"Level at which discounts are defined. Valid values include Item and All Items. A list of accepted values is defined in the lookup type ORA_CJM_ITEM_LEVEL.",
            "nullable":true,
            "x-queryable":true
        },
        "Item":{
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product rule. It is a primary key that the application generates when it creates the product rule.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the level at which discounts are defined.",
            "nullable":false,
            "x-queryable":true
        },
        "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,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromDate":{
            "type":"string",
            "description":"Date when the product rule becomes applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ToDate":{
            "type":"string",
            "description":"Date when the product rule is no longer applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "DiscountValue":{
            "type":"number",
            "description":"Value of the discount.",
            "nullable":false,
            "x-queryable":false
        },
        "SupplierItemDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the supplier item.",
            "nullable":true,
            "x-queryable":false
        },
        "UOMCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for pricing.",
            "nullable":true,
            "x-queryable":false
        },
        "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":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier item.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Descriptive Flexfields for Product Rules

Type: array

Title: Descriptive Flexfields for Product Rules

The Descriptive Flexfields for Product Rules resource manages additional details about a product rule of a program.

Show Source

• Array of: object channelPrograms-productRules-DFF-item-response

{
    "title":"Descriptive Flexfields for Product Rules",
    "type":"array",
    "description":"The Descriptive Flexfields for Product Rules resource manages additional details about a product rule of a program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-productRules-DFF-item-response"
    },
    "x-cardinality":"1"
}

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-productRules-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Descriptive flexfield context name for product rule.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for product rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramLineId: integer
  Value that uniquely identifies the product rule.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product rule.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for product rule.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for product rule.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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-programRules-item-response

Type: object

Show Source

• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in program rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• 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

  User who most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Login that the user used when updating the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramId: integer (int64)
  Value that uniquely identifies the channel program.
• QualifierId: integer (int64)
  Value that uniquely identifies the program rule.
• QualifierType: string
  Type of qualifier used to define eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define channel program eligibility.
• QualifierValue: string
  Read Only: true

  Maximum Length: 255

  Name of the qualifier used in channel program qualification.
• QualifierValueCode: string
  Maximum Length: 240

  Abbreviation that identifies the qualifier used in channel program qualification.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Login that the user used when updating the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the qualifier used in channel program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "QualifierTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define channel program eligibility.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QualifierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierValueCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in channel program qualification.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierType":{
            "type":"string",
            "description":"Type of qualifier used to define eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in program rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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-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 : 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

DFF

Operation: /fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/DFF

Parameters:

• ProgramId: $request.path.ProgramId

The Descriptive Flexfields for Channel Programs resource manages additional details for a program.

alternateSupplierSites

Operation: /fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/alternateSupplierSites

Parameters:

• ProgramId: $request.path.ProgramId

The Alternate Supplier Sites resource manages alternate supplier sites of a supplier rebate program.

marketRules

Operation: /fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/marketRules

Parameters:

• ProgramId: $request.path.ProgramId

The Market Rules resource manages rules for identifying eligible customers for a program.

productRules

Operation: /fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/productRules

Parameters:

• ProgramId: $request.path.ProgramId

The Product Rules resource manages rules for identifying eligible products for a program.

programRules

Operation: /fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/programRules

Parameters:

• ProgramId: $request.path.ProgramId

The Program Rules resource manages mandatory market rules for a program.

volumeRules

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

Parameters:

• ProgramId: $request.path.ProgramId

The Volume Rules resource manages volume rules of a volume program.

Back to Top

Examples

This example describes how to get one program.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/channelPrograms/ProgramId"

For example, the following command gets one program:

curl -u username:password "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"ProgramId": 300100185773659,
	"ProgramType": "Sales Initiated",
	"ProgramTypeId": 300100185735482,
	"ProgramTemplate": "Supplier Ship and Debit",
	"ProgramTemplateCode": "SUPPLIER_SHIP_AND_DEBIT",
	"BusinessUnit": "Vision Operations",
	"BusinessUnitId": 204,
	"ProgramName": "NY Vendor Rebate",
	"ProgramCode": "SSD13000",
	"Owner": "channel_user",
	"OwnerId": 300100181693728,
	"Status": "Active",
	"StatusId": 300100183528749,
	"Currency": "US Dollar",
	"CurrencyCode": "USD",
	"Description": null,
	"CreatedBy": "channel_user",
	"CreationDate": "2020-06-03T01:58:33+00:00",
	"LastUpdatedBy": "channel_user",
	"LastUpdateDate": "2020-06-03T01:58:35.823+00:00",
	"Supplier": "CDS, Inc",
	"SupplierId": 1178,
	"SupplierNumber": "5102",
	"SupplierSite": "PITTSBURGH",
	"SupplierSiteId": 2854,
	"SupplierAuthorizationNumber": null,
	"SupplierQuoteNumber": null,
	"EffectiveDateTypeCode": "REQ_SHIP_DATE",
	"FromDate": "2020-06-03",
	"ToDate": "2021-06-03",
	"ApplyManuallyToOrderFlag": false,
	"OverrideProgramFlag": true,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659",
		"name": "channelPrograms",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659",
		"name": "channelPrograms",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659/child/DFF",
		"name": "DFF",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659/child/marketRules",
		"name": "marketRules",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659/child/productRules",
		"name": "productRules",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659/child/programRules",
		"name": "programRules",
		"kind": "collection"
	}
	]
}

Back to Top