Jump to

• Request
• Response

Create market rules

post

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

Request

Path Parameters

• ProgramId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ChildRuleNumber: integer (int32)
  Number that identifies the trailing component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 5.2, then the rule number is 5 and the child rule number is 2.
  Validation: It must be an integer >= 0. It can't have a duplicate display line number.
• ComparisonOperator: string
  Maximum Length: 255

  Name of the comparison operator used in the market rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in the market rule.
• FromDate: string (date)
  Date when the market rule becomes applicable.
• ParentRuleId: integer (int64)
  Value that identifies the parent market rule.
• ProgramId: integer (int64)
  Value that uniquely identifies the supplier program.
• QualifierType: string
  Maximum Length: 255

  Type of qualifier used to define the eligibility of the supplier program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE for supplier ship and debit programs and the lookup type ORA_CJM_SUP_REBATE_QUAL for supplier rebate programs.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define the eligibility of the supplier program.
• QualifierValue: string
  Maximum Length: 255

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

  Abbreviation that identifies the qualifier used in the supplier program qualification.
• RuleId: integer (int64)
  Value that uniquely identifies the market rule. It's a primary key that the application generates when it creates the market rule.
• RuleNumber: integer (int32)
  Number that identifies the leading component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 3.1, then the rule number is 3 and the child rule number is 1.
• ToDate: string (date)
  Date when the market rule is no longer applicable.

{
    "type":"object",
    "properties":{
        "ChildRuleNumber":{
            "type":"integer",
            "description":"Number that identifies the trailing component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 5.2, then the rule number is 5 and the child rule number is 2. <br>Validation: It must be an integer >= 0. It can't have a duplicate display line number.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            }
        },
        "ComparisonOperator":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the comparison operator used in the market rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in the market rule.",
            "nullable":false
        },
        "FromDate":{
            "type":"string",
            "description":"Date when the market rule becomes applicable.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ParentRuleId":{
            "type":"integer",
            "description":"Value that identifies the parent market rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "QualifierType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of qualifier used to define the eligibility of the supplier program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE for supplier ship and debit programs and the lookup type ORA_CJM_SUP_REBATE_QUAL for supplier rebate programs.",
            "nullable":true
        },
        "QualifierTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define the eligibility of the supplier program.",
            "nullable":false
        },
        "QualifierValue":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the qualifier used in the supplier program qualification.",
            "nullable":true
        },
        "QualifierValueCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in the supplier program qualification.",
            "nullable":false
        },
        "RuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the market rule. It's a primary key that the application generates when it creates the market rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RuleNumber":{
            "type":"integer",
            "description":"Number that identifies the leading component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 3.1, then the rule number is 3 and the child rule number is 1.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            }
        },
        "ToDate":{
            "type":"string",
            "description":"Date when the market rule is no longer applicable.",
            "format":"date",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• AccountNumber: string
  Read Only: true

  Maximum Length: 255

  Number of the bill-to customer account.
• Address: string
  Read Only: true

  Maximum Length: 255

  Address for the customer. It applies if the qualifier type is Customer, Bill-to Account or Ship To.
• ChildRuleNumber: integer (int32)
  Number that identifies the trailing component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 5.2, then the rule number is 5 and the child rule number is 2.
  Validation: It must be an integer >= 0. It can't have a duplicate display line number.
• ComparisonOperator: string
  Maximum Length: 255

  Name of the comparison operator used in the market rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in the market rule.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Market Rules V2
• CreationDate: string (date-time)
  Read Only: true

  Market Rules V2
• Customer: string
  Read Only: true

  Maximum Length: 255

  Market Rules V2
• CustomQualifierFlag: boolean
  Read Only: true

  Contains one of the following values: true or false. If true, then it's a custom qualifier. If false, then it isn't a custom qualifier. The default value for this attribute is false.
• DomainDataTypeCode: string
  Read Only: true

  Maximum Length: 255

  Type of dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES.
• DomainLookupTypeCode: string
  Read Only: true

  Maximum Length: 255

  Lookup type code for the dimension of the lookup domain type.
• DomainTypeCode: string
  Read Only: true

  Maximum Length: 255

  Type of domain. Valid values include lookup, view object query, and custom. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES.
• FromDate: string (date)
  Date when the market rule becomes applicable.
• LastUpdateDate: string (date-time)
  Read Only: true

  Market Rules V2
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Market Rules V2
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MatrixDimensionId: integer
  Read Only: true

  Market Rules V2
• ParentRuleId: integer (int64)
  Value that identifies the parent market rule.
• ProgramId: integer (int64)
  Value that uniquely identifies the supplier program.
• QualifierNumberValueCode: integer
  Read Only: true

  Value of the numeric qualifier used in the supplier program qualification.
• QualifierType: string
  Maximum Length: 255

  Type of qualifier used to define the eligibility of the supplier program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE for supplier ship and debit programs and the lookup type ORA_CJM_SUP_REBATE_QUAL for supplier rebate programs.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define the eligibility of the supplier program.
• QualifierValue: string
  Maximum Length: 255

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

  Abbreviation that identifies the qualifier used in the supplier program qualification.
• RuleId: integer (int64)
  Value that uniquely identifies the market rule. It's a primary key that the application generates when it creates the market rule.
• RuleNumber: integer (int32)
  Number that identifies the leading component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 3.1, then the rule number is 3 and the child rule number is 1.
• Site: string
  Read Only: true

  Maximum Length: 255

  Name of the bill-to customer account site or the ship-to site.
• ToDate: string (date)
  Date when the market rule is no longer applicable.

{
    "type":"object",
    "properties":{
        "AccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the bill-to customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address":{
            "maxLength":255,
            "type":"string",
            "description":"Address for the customer. It applies if the qualifier type is Customer, Bill-to Account or Ship To.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChildRuleNumber":{
            "type":"integer",
            "description":"Number that identifies the trailing component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 5.2, then the rule number is 5 and the child rule number is 2. <br>Validation: It must be an integer >= 0. It can't have a duplicate display line number.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "ComparisonOperator":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the comparison operator used in the market rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":true,
            "x-queryable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in the market rule.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Market Rules V2",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Market Rules V2",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomQualifierFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then it's a custom qualifier. If false, then it isn't a custom qualifier. The default value for this attribute is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Customer":{
            "maxLength":255,
            "type":"string",
            "description":"Market Rules V2",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DomainDataTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Type of dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DomainLookupTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Lookup type code for the dimension of the lookup domain type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DomainTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Type of domain. Valid values include lookup, view object query, and custom. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FromDate":{
            "type":"string",
            "description":"Date when the market rule becomes applicable.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Market Rules V2",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Market Rules V2",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MatrixDimensionId":{
            "type":"integer",
            "description":"Market Rules V2",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentRuleId":{
            "type":"integer",
            "description":"Value that identifies the parent market rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualifierNumberValueCode":{
            "type":"integer",
            "description":"Value of the numeric qualifier used in the supplier program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualifierType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of qualifier used to define the eligibility of the supplier program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE for supplier ship and debit programs and the lookup type ORA_CJM_SUP_REBATE_QUAL for supplier rebate programs.",
            "nullable":true,
            "x-queryable":true
        },
        "QualifierTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define the eligibility of the supplier program.",
            "nullable":false,
            "x-queryable":true
        },
        "QualifierValue":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the qualifier used in the supplier program qualification.",
            "nullable":true,
            "x-queryable":true
        },
        "QualifierValueCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in the supplier program qualification.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the market rule. It's a primary key that the application generates when it creates the market rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RuleNumber":{
            "type":"integer",
            "description":"Number that identifies the leading component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 3.1, then the rule number is 3 and the child rule number is 1.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "Site":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the bill-to customer account site or the ship-to site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ToDate":{
            "type":"string",
            "description":"Date when the market rule is no longer applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Back to Top