...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Available from CRM.COM R10.0.0
| Excerpt |
|---|
This method is used to create multiple achievement customer events within a single Web API method call. Note that the maximum number of achievement customer events that can be created is 1000 |
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
achievement_customer_events_set (mandatory) | Set of Achievement Customer Event Objects | The set of achievement customer events that will be created by this Web API method. Note that the maximum number of achievement customer events that can be specified within a single Web API call is 1000 |
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 |
...
| title | bulk achievement customer event parameter object data |
|---|
...
Name
...
Type
...
Description
...
request_unique_identifier
(mandatory)
...
accounts_receivable_identifier
(semi-optional)
...
The related accounts receivable. The allowed accounts receivable identifier fields are the following:
...
rewards_participant_identifier
(semi-optional)
...
classification_identifier
(mandatory)
...
performed_by_unit_identifier
(mandatory)
...
performed_on
(mandatory)
...
description
(optional)
...
external_system
(optional)
...
external_system_reference_number
(optional)
...
The unique reference number of the customer event in the external system
| Tip |
|---|
Available from CRM.COM R10.1.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
Response Data
...
Examples
...
HTTP Method: POST
Request:
Body:
...
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
...
| Tip |
|---|
Available from CRM.COM R10.0.0 |
| Excerpt |
|---|
This method is used to create multiple achievement customer events within a single Web API method call. Note that the maximum number of achievement customer events that can be created is 1000 |
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
achievement_customer_events_set (mandatory) | Set of Achievement Customer Event Objects | The set of achievement customer events that will be created by this Web API method Note that the maximum number of achievement customer events that can be specified within a single Web API call is 1000 |
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 |
| Anchor |
|---|
| bulk create achievements parameters |
|---|
| bulk create achievements parameters |
|---|
|
Referred Parameter Objects
| Expand |
|---|
| title | bulk achievement customer event parameter object data |
|---|
|
Name | Type | Description | request_unique_identifier (mandatory) | String | A unique identifier of the request, provided by the caller, in order to identify the successful or failed results. Note that this information should be unique and is not stored within CRM.COM | accounts_receivable_identifier (mandatory) | Accounts receivable Identifier | The related accounts receivable. The allowed accounts receivable identifier fields are the following: | Include Page |
|---|
| V4:accounts_receivable_identifier_post |
|---|
| V4:accounts_receivable_identifier_post |
|---|
|
| Tip |
|---|
For releases prior CRM.COM R17.0.0, this field was semi-optional From CRM.COM R17.0.0, the access token attributes are supported |
| rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following:| Include Page |
|---|
| V4:rewards_participants_identifier_post |
|---|
| V4:rewards_participants_identifier_post |
|---|
|
| Tip |
|---|
Deprecated from CRM.COM R17.0.0 |
| classification_identifier (mandatory) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:| Include Page |
|---|
| V4:customer_event_classification_identifier |
|---|
| V4:customer_event_classification_identifier |
|---|
|
| 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 |
|---|
Available from CRM.COM R15.0.0 |
| payment_medium_type_identifier (optional) | Payment Medium Type Identifier | 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 |
|---|
| V4:payment_medium_type_identifier |
|---|
| V4:payment_medium_type_identifier |
|---|
|
| Tip |
|---|
Available from CRM.COM R15.0.0 |
| payment_medium_brand_identifier (optional) | Payment Medium Brand Identifier | The payment medium brand of the customer event. Only payment medium brands which are allowed in the related accounts receivable can be specified. The allowed payment medium brand identifier fields are the following: | Include Page |
|---|
| V4:payment_medium_brand_identifier |
|---|
| V4:payment_medium_brand_identifier |
|---|
|
| Tip |
|---|
Available from CRM.COM R15.0.0 |
| payment_medium_identifier (optional) | String | The payment medium identifier of the customer event. | Tip |
|---|
Available from CRM.COM R15.0.0 |
| amount (optional) | Number | The achievement customer event's amount | Tip |
|---|
Available from CRM.COM R15.0.0 |
| performed_by_business_unit_identifier (semi-optional) | Business Unit Identifier | The business unit that initiated the customer event. The allowed identifier fields are the following| Include Page |
|---|
| V4:business_unit_identifier |
|---|
| V4:business_unit_identifier |
|---|
|
| Tip |
|---|
Available from CRM.COM R18.0.0 |
| performed_by_unit_identifier (semi-optional) | Unit Identifier | The unit that initiated the customer event. The allowed identifier fields are the following| Include Page |
|---|
| V4:unit_identifier |
|---|
| V4:unit_identifier |
|---|
|
| 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) | Transaction Acquiring Point Identifier | The unit's transaction acquiring point that initiated the customer event. The allowed identifier fields are the following | Include Page |
|---|
| V4:transaction_acquiring_point_identifier |
|---|
| V4:transaction_acquiring_point_identifier |
|---|
|
| 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) | Date | The date that the customer event was actually performed | description (optional) | String | A description of the customer event | external_system (optional) | String | The third party system that generates the customer event | external_system_reference_number (optional) | String | The unique reference number of the customer event in the external system | Tip |
|---|
Available from CRM.COM R10.1.0 |
| udf_string_1 (optional) | String | 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 |
|
Response Data
| Include Page |
|---|
| V4:bulk_customer_event_complete |
|---|
| V4:bulk_customer_event_complete |
|---|
|
Examples
| Expand |
|---|
|
HTTP Method: POST
Request: Body: | Code Block |
|---|
| language | javascript |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| {
"token":"{{token}}",
"achievement_customer_events_set":
[
{
"request_unique_identifier":"221",
"accounts_receivable_identifier":{"number":"ACR0000000077"},
"classification_identifier":{"name":"Customer Feedback 3"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00"
}
,
{
"request_unique_identifier":"222",
"accounts_receivable_identifier":{"number":"ACR0000000077"},
"classification_identifier":{"name":"Customer Feedback 3"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00"
},
{
"request_unique_identifier":"223",
"accounts_receivable_identifier":{"number":"ACR000177"},
"classification_identifier":{"name":"Customer Feedback 3"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00"
},
{
"request_unique_identifier":"221224",
"accounts_receivable_identifier":{"number":"ACR0000000077ACR0097"},
"classification_identifier":{"name":"Customer Feedback 3"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00"
}
,
:00:00"
}
]
} |
Response: | Code Block |
|---|
| language | javascript |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| {
"data": {
"unprocessed_customer_events_set": [
{
"requesterror_unique_identifierdescription":"222",
"accounts_receivable_identifier":{"number":"ACR0000000077"},
"Error:Account (ACR000177) Not Found. - Description:The specified API value was not found.",
"classificationerror_identifiercode":{ "name":"Customer Feedback 3"},
NotFoundAPIValueException",
"performed_byrequest_unitunique_identifier":{ "name":223"Admin
Unit"}, },
"performed_on":"2016-06-22T15:00:00"
{
},
{
"error_description": "Error:Account (ACR0097) Not Found. - Description:The specified API value was not found.",
"requesterror_unique_identifiercode": "223NotFoundAPIValueException",
"accountsrequest_receivableunique_identifier":{ "number":"ACR000177"},224"
}
],
"classification_identifier":{"name":"Customer Feedback 3"},processed_customer_events_set": [
{
"performed_by_unit_identifiernumber":{"name":"Admin Unit"},
"45",
"performed_onid":"2016-06-22T15:00:00" "A4340AC3F973495E81F69A75D2D32BD3",
},"request_unique_identifier": "221"
},
{ {
"request_unique_identifiernumber": "22446",
"accounts_receivable_identifier"id":{"number":"ACR0097"},
"AF2546A34840400AA2F0437470CBA5AB",
"classificationrequest_unique_identifier":{ "name":"Customer Feedback 3"},
222"
}
]
},
"performed_by_unit_identifierstatus": {
"namecode": "Admin UnitOK"},
"description": "",
"performed_onmessage":"2016-06-22T15:00:00"
""
}
]
} |
|