...
...
| Excerpt |
|---|
This method is used to create an achievement customer event in a posted life cycle state |
...
Name | Type | Description | |||||||||||||||||||||||
token | String | The token retrieved from the login method | |||||||||||||||||||||||
accounts_receivable_identifier (mandatory) | Accounts receivable Identifier | The related accounts receivable. The allowed accounts receivable identifier fields are the following:
| |||||||||||||||||||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following:
| |||||||||||||||||||||||
classification_identifier (mandatory) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
| |||||||||||||||||||||||
product_identifier (optional) | Product Identifier | The product of the customer event. Any type of products can be specified. The allowed product identifier fields are the following:
Include Page | | V4:product_identifier | V4:product_identifier | ||||||||||||||||||||
| Tip |
|---|
|
| Tip |
|---|
Available from CRM.COM R15.0.0 |
payment_medium_type_identifier
(optional)
The payment medium type of the customer event. Only payment medium types which are allowed in the related accounts receivable can be specified.
The allowed payment medium type identifier fields are the following
| Include Page | ||||
|---|---|---|---|---|
|
| Tip |
|---|
Available from CRM.COM R15.0.0 |
| Tip |
|---|
If this parameter is not specified and accounts receivable identified is made against an access token of a credit card authentication code, then this attribute will be set as the default medium type as specified in the related access token classification Deprecated from CRM.COM R18.0.0 |
payment_medium_typebrand_identifier
(optional)
The payment medium
brand of the customer event. Only payment medium
brands which are allowed in the related accounts receivable can be specified.
If this parameter is not specified and accounts receivable identified is made against an access token of a credit card authentication code, then this attribute will be set as the default medium type as specified in the related access token classification
The allowed payment medium
brand identifier fields are the following
| Include Page | ||
|---|---|---|
|
|
The payment medium brand of the customer event. Only payment medium brands which are allowed in the related accounts receivable can be specified.
|
| Tip |
|---|
Available from CRM.COM R15.0.0 |
payment_medium_brand_identifier
(optional)
| Tip |
|---|
If this parameter is not specified and accounts receivable identified is made against an access token of a credit card authentication code, then this attribute will be set as the default |
The allowed payment medium brand identifier fields are the following:
medium |
brand as specified in the related access token classification Deprecated from CRM.COM |
R18.0.0 |
payment_medium_identifier
(optional)
The payment medium identifier of the customer event.
| Tip |
|---|
Available from CRM.COM R15.0.0 |
amount
(optional)
The achievement customer event's amounts amount
| Tip |
|---|
Available from CRM.COM R15.0.0 |
performed_by_business_unit_identifier
(semi-optional)
| Include Page | ||||
|---|---|---|---|---|
|
| Tip |
|---|
Available from CRM.COM |
R18.0.0 From CRM.COM R18.0.0, this attribute will be set automatically if the performed_by_device_identifier is specified |
performed_by_unit_identifier
(semi-optional)
| Include Page | ||||
|---|---|---|---|---|
|
| Tip |
|---|
For releases prior CRM.COM R17.0.0, this attribute was mandatory From CRM.COM R17.0.0, this attribute will be set automatically if the performed_by_device_identifier is specified Deprecated from CRM.COM R18.0.0 |
performed_by_tap_identifier
(semi-optional)
The unit's transaction acquiring point that initiated the customer event. The allowed identifier fields are the following
| Include Page | ||||
|---|---|---|---|---|
|
| Tip |
|---|
Available from CRM.COM R17.0.0 From CRM.COM R17.0.0, this attribute will be set automatically if the performed_by_unit_identifier is specified From CRM.COM R18.0.0, this attribute will be set automatically if the performed_by_business_unit_identifier is specified |
performed_on
(mandatory)
description
(optional)
external_system
(optional)
The third party system that generates the customer event
| Tip |
|---|
Available from CRM.COM R10.0.0 |
external_system_reference_number
(optional)
The external system's unique reference number of customer event
| Tip |
|---|
Available from CRM.COM R10.1.0 |
authorized_by_access_token_identifier
(optional)
The access token that was used to identify and authorized the customer. This information will be overridden if the customer was identified via an access token through this Web API call. The allowed access token identifier fields are the following:
| Include Page | ||||
|---|---|---|---|---|
|
| Tip |
|---|
Available from CRM.COM R15.0.0 Deprecated from CRM.COM R18.0.0 |
promo_code
(optional)
The effective, not expired promo code that can be used on the customer event. The promo code is validated against its related promotion campaign's settings in order to be provided.
| Tip |
|---|
Available from CRM.COM R15.0.0 |
udf_string_1
(optional)
User Defined Field of type String
udf_string_2
(optional)
String
User Defined Field of type String
udf_string_3
(optional)
String
User Defined Field of type String
udf_string_4
(optional)
String
User Defined Field of type String
udf_string_5
(optional)
String
User Defined Field of type String
udf_string_6
(optional)
String
User Defined Field of type String
udf_string_7
(optional)
String
User Defined Field of type String
udf_string_8
(optional)
String
User Defined Field of type String
udf_float_1
(optional)
Float
User Defined Field of type Float
udf_float_2
(optional)
Float
User Defined Field of type Float
udf_float_3
(optional)
Float
User Defined Field of type Float
udf_float_4
(optional)
Float
User Defined Field of type Float
udf_date_1
(optional)
Date
User Defined Field of type Date
udf_date_2
(optional)
Date
User Defined Field of type Date
udf_date_3
(optional)
Date
User Defined Field of type Date
udf_date_4
(optional)
Date
User Defined Field of type Date
fields_set
(optional)
List of Strings, comma separated
A list of fields that should be included in the results. If not specified then all the available fields will be returned
| Tip |
|---|
Available from CRM.COM R10.0.0 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...