Create one customer
post
/fscmRestApi/resources/11.13.18.05/channelCustomerPrograms/{ProgramId}/child/customers
Request
Path Parameters
-
ProgramId(required): integer(int64)
Value that uniquely identifies the customer program.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
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
Root Schema : schema
Type:
Show Source
object
-
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 customer. 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 customer. -
EndDate: string
(date)
Date when the customer is no longer applicable.
-
ParentRuleId: integer
(int64)
Value that identifies the parent customer.
-
ProgramId: integer
(int64)
Value that uniquely identifies the customer program.
-
QualifierType: string
Maximum Length:
255
Type of qualifier used to define the eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL. -
QualifierTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of qualifier used to define the eligibility of the customer program. -
QualifierValueCode: string
Maximum Length:
240
Abbreviation that identifies the qualifier used in customer program qualification. -
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. Validation: It must be an integer > 0. Cannot have duplicate display line number.
-
StartDate: string
(date)
Date when the customer becomes applicable.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : channelCustomerPrograms-customers-item-response
Type:
Show Source
object
-
AccountNumber: string
Read Only:
true
Maximum Length:255
Number of the bill-to customer account. -
Address: string
Read Only:
true
Maximum Length:255
Primary bill-to address for the customer or the address of the bill-to customer account site or the ship-to site. -
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 customer. 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 customer. -
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. -
Customer: string
Read Only:
true
Maximum Length:255
Name of the customer. -
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. -
EndDate: string
(date)
Date when the customer is no longer 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. -
MatrixDimensionId: integer
Read Only:
true
Value that uniquely identifies the dimension. -
ParentRuleId: integer
(int64)
Value that identifies the parent customer.
-
ProgramId: integer
(int64)
Value that uniquely identifies the customer program.
-
QualifierNumberValueCode: integer
Read Only:
true
Value of the numeric qualifier used in customer program qualification. -
QualifierType: string
Maximum Length:
255
Type of qualifier used to define the eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL. -
QualifierTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of qualifier used to define the eligibility of the customer program. -
QualifierValue: string
Read Only:
true
Maximum Length:255
Name of the qualifier used in customer program qualification. -
QualifierValueCode: string
Maximum Length:
240
Abbreviation that identifies the qualifier used in customer program qualification. -
RuleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer. It's a primary key that the application generates when it creates the customer. -
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. Validation: It must be an integer > 0. Cannot have duplicate display line number.
-
Site: string
Read Only:
true
Maximum Length:255
Name of the bill-to customer account site or the ship-to site. -
StartDate: string
(date)
Date when the customer becomes applicable.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.