You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 21
Next »
POST customer_events/bulk/achievements/create
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 |
Referred Parameter Objects
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 (semi-optional) | Accounts receivable Identifier | The related accounts receivable. The allowed accounts receivable identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the accounts receivable | number (semi-optional) | String | The number of the accounts receivable | name (semi-optional) | String | The name of the accounts receivable |
|
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the rewards participant | number (semi-optional) | String | The number of the rewards participant |
|
classification_identifier (mandatory) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the customer event classification | name (semi-optional) | String | The name of the customer event classification | alternative_code (semi-optional) | String | The alternative code of the customer event classification |
|
performed_by_unit_identifier (mandatory) | Unit Identifier | The unit that initiated the customer event. The allowed unit identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the Unit | name (semi-optional) | String | The name of the Unit | alternative_code (semi-optional) | String | The alternative code of the Unit |
|
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 |
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
Name | Type | Description |
|---|
processed_customer_events_set | Set of Processed customer Events Objects | A set that contains the ID and the number of the customer events that were created |
| unprocessed_customer_events_set | Set of Unprocessed customer Events Objects | A set that contains the customer events that were not created due to an error. Each row includes the unique request identifier , as provided by the caller, along with an error code and error description. |
Referred Objects Response Data
processed customer event object response data
Name | Type | Description |
|---|
| request_unique_identifier | String | A unique identifier of the request, as provided by the caller, in order to identify the successful results. |
id | String | The ID of the customer event that was created |
| number | String | The number of the customer event that was created |
unprocessed customer event object response data
Name | Type | Description |
|---|
| request_unique_identifier | String | A unique identifier of the request, as provided by the caller, in order to identify the failed results. |
| error_code | String | The code of the error that was raised |
| error_description | String | The description of the error that was raised |
Examples
Example 1
HTTP Method: POST
Request:
Body:
{
"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":"224",
"accounts_receivable_identifier":{"number":"ACR0097"},
"classification_identifier":{"name":"Customer Feedback 3"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00"
}
]
}
Response:
{
"data": {
"unprocessed_customer_events_set": [
{
"error_description": "Error:Account (ACR000177) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "223"
},
{
"error_description": "Error:Account (ACR0097) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "224"
}
],
"processed_customer_events_set": [
{
"number": "45",
"id": "A4340AC3F973495E81F69A75D2D32BD3",
"request_unique_identifier": "221"
},
{
"number": "46",
"id": "AF2546A34840400AA2F0437470CBA5AB",
"request_unique_identifier": "222"
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST customer_events/bulk/purchases/create
This method is used to create multiple purchase customer events within a single Web API method call. Note that the maximum number of purchase customer events that can be created is 1000
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
purchase_customer_events_set (mandatory) | Set of Purchases Customer Event Objects | The set of purchases customer events that will be created by this Web API method. Note that the maximum number of purchases customer events that can be specified within a single Web API call is 1000 |
intended_currency_identifier (optional) | Currency Identifier | The currency that the user was intended to use for the customer events. If specified then it is validated against the currency of the related performed by unit (i.e. the default currency) and if they don't match then an error is throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the currency | code (semi-optional) | String | The code of the currency |
|
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 |
Referred Parameter Objects
bulk purchase 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 (semi-optional) | Accounts receivable Identifier | The related accounts receivable. The allowed accounts receivable identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the accounts receivable | number (semi-optional) | String | The number of the accounts receivable | name (semi-optional) | String | The name of the accounts receivable |
|
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the rewards participant | number (semi-optional) | String | The number of the rewards participant |
|
classification_identifier (optional) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the customer event classification | name (semi-optional) | String | The name of the customer event classification | alternative_code (semi-optional) | String | The alternative code of the customer event classification |
|
performed_by_unit_identifier (mandatory) | Unit Identifier | The unit that initiated the customer event. The allowed unit identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the Unit | name (semi-optional) | String | The name of the Unit | alternative_code (semi-optional) | String | The alternative code of the Unit |
|
performed_on (mandatory) | Date | The date that the customer event was actually performed |
description (optional) | String | A description of the customer event |
reference_number (mandatory) | String | The reference number of the retrieved purchase customer event |
payment_medium_brand_identifier (optional) | Payment Medium Brand Identifier | The identifier of the payment medium brand with which the purchase customer event has been made. The allowed payment medium brand identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the payment medium brand | name (semi-optional) | String | The name of the payment medium brand | alternative_code (semi-optional) | String | The alternative code of the payment medium brand |
|
payment_medium_type_identifier (optional) | Payment Medium Type Identifier | The payment medium type with which the purchase customer event has been made. The allowed payment medium type identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the payment medium type | name (semi-optional) | String | The name of the payment medium type | alternative_code (semi-optional) | String | The alternative code of the payment medium type |
|
payment_medium_identifier (optional) | String | The payment medium identifier with which the purchase customer event has been made |
invoice_identifier (optional) | Invoice Identifier | The CRM.COM invoice related with the purchase. The allowed invoice identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the invoice | number (semi-optional) | String | The number of the invoice | reference_number (semi-optional) | String | The reference number of the invoice | back_office_code (semi-optional) | String | The back office code of the invoice |
|
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 |
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_string_9 (optional) | String | User Defined Field of type String |
udf_string_10 (optional) | String | User Defined Field of type String |
udf_string_11 (optional) | String | User Defined Field of type String |
udf_string_12 (optional) | String | User Defined Field of type String |
udf_string_13 (optional) | String | User Defined Field of type String |
udf_string_14 (optional) | String | User Defined Field of type String |
udf_string_15 (optional) | String | User Defined Field of type String |
udf_string_16 (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 |
products_set (mandatory) | Set of Purchase Product Objects | The purchased products, along with the total amount, net amount and VAT amount for each product |
Referred Parameter Objects
purchase customer event product parameter object data
Name | Type | Description |
product_identifier (mandatory) | Products Identifier | The purchased product. The allowed product identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product | code (semi-optional) | String | The code of the product | alternative_code (semi-optional) | String | The alternative code of the product |
|
quantity (optional) | Number | The quantity of the specified purchase customer event product. If not specified then it automatically defaults to 1
|
net_amount (mandatory) | Number | The net amount of the specified purchase customer event product |
vat_amount (mandatory) | Number | The VAT amount of the specified purchase customer event product |
total_amount (mandatory) | Number | The total amount of the specified purchase customer event product |
Response Data
Name | Type | Description |
|---|
processed_customer_events_set | Set of Processed customer Events Objects | A set that contains the ID and the number of the customer events that were created |
| unprocessed_customer_events_set | Set of Unprocessed customer Events Objects | A set that contains the customer events that were not created due to an error. Each row includes the unique request identifier , as provided by the caller, along with an error code and error description. |
Referred Objects Response Data
processed customer event object response data
Name | Type | Description |
|---|
| request_unique_identifier | String | A unique identifier of the request, as provided by the caller, in order to identify the successful results. |
id | String | The ID of the customer event that was created |
| number | String | The number of the customer event that was created |
unprocessed customer event object response data
Name | Type | Description |
|---|
| request_unique_identifier | String | A unique identifier of the request, as provided by the caller, in order to identify the failed results. |
| error_code | String | The code of the error that was raised |
| error_description | String | The description of the error that was raised |
Examples
Example 1
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"purchase_customer_events_set":
[
{
"request_unique_identifier":"31",
"accounts_receivable_identifier":{"number":"ACR0000000228"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"reference_number":"RF01",
"products_set":
[
{
"product_identifier":{"code":"Serendipity"},
"total_amount":60,
"net_amount":50,
"vat_amount":10
},
{
"product_identifier":{"code":"Bronze"},
"total_amount":180,
"net_amount":160,
"vat_amount":20
}
]
}
,
{
"request_unique_identifier":"32",
"accounts_receivable_identifier":{"number":"ACR0000000228"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"reference_number":"RF01",
"products_set":
[
{
"product_identifier":{"code":"Serendipity"},
"total_amount":60,
"net_amount":50,
"vat_amount":10
},
{
"product_identifier":{"code":"Bronze"},
"total_amount":180,
"net_amount":160,
"vat_amount":20
}
]
},
{
"request_unique_identifier":"33",
"accounts_receivable_identifier":{"number":"ACR00008"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"reference_number":"RF01",
"products_set":
[
{
"product_identifier":{"code":"Serendipity"},
"total_amount":60,
"net_amount":50,
"vat_amount":10
},
{
"product_identifier":{"code":"Bronze"},
"total_amount":180,
"net_amount":160,
"vat_amount":20
}
]
},
{
"request_unique_identifier":"34",
"accounts_receivable_identifier":{"number":"ACR0000058"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"reference_number":"RF01",
"products_set":
[
{
"product_identifier":{"code":"Serendipity"},
"total_amount":60,
"net_amount":50,
"vat_amount":10
},
{
"product_identifier":{"code":"Bronze"},
"total_amount":180,
"net_amount":160,
"vat_amount":20
}
]
}
]
}
Response:
{
"data": {
"unprocessed_customer_events_set": [
{
"error_description": "Error:Account (ACR00008) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "33"
},
{
"error_description": "Error:Account (ACR0000058) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "34"
}
],
"processed_customer_events_set": [
{
"number": "123",
"id": "C6F33A7C8A38446FA1A58ACDF105AFE8",
"request_unique_identifier": "31"
},
{
"number": "124",
"id": "DFB1ED07A8DB45F6A9205E3CCFCDC14E",
"request_unique_identifier": "32"
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST customer_events/bulk/referrals/create
This method is used to create multiple referral customer events within a single Web API method call. Note that the maximum number of referral customer events that can be created is 1000
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
referral_customer_events_set (mandatory) | Set of Referral Customer Event Objects | The set of Referral customer events that will be created by this Web API method. Note that the maximum number of referral 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 |
Referred Parameter Objects
bulk referral 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 |
classification_identifier (optional) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the customer event classification | name (semi-optional) | String | The name of the customer event classification | alternative_code (semi-optional) | String | The alternative code of the customer event classification |
|
performed_by_unit_identifier (mandatory) | Unit Identifier | The unit that initiated the customer event. The allowed unit identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the Unit | name (semi-optional) | String | The name of the Unit | alternative_code (semi-optional) | String | The alternative code of the Unit |
|
performed_on (mandatory) | Date | The date that the customer event was actually performed |
description (optional) | String | A description of the customer event |
referred_rewards_participant_identifier (mandatory) | Rewards Participant Identifier | The referred rewards participant. The allowed rewards participant identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the rewards participant | number (semi-optional) | String | The number of the rewards participant |
|
referred_by_rewards_participant_identifier (mandatory) | Rewards Participant Identifier | The rewards participant that provided the referral. The allowed rewards participant identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the rewards participant | number (semi-optional) | String | The number of the rewards participant |
|
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 |
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
Name | Type | Description |
|---|
processed_customer_events_set | Set of Processed customer Events Objects | A set that contains the ID and the number of the customer events that were created |
| unprocessed_customer_events_set | Set of Unprocessed customer Events Objects | A set that contains the customer events that were not created due to an error. Each row includes the unique request identifier , as provided by the caller, along with an error code and error description. |
Referred Objects Response Data
processed customer event object response data
Name | Type | Description |
|---|
| request_unique_identifier | String | A unique identifier of the request, as provided by the caller, in order to identify the successful results. |
id | String | The ID of the customer event that was created |
| number | String | The number of the customer event that was created |
unprocessed customer event object response data
Name | Type | Description |
|---|
| request_unique_identifier | String | A unique identifier of the request, as provided by the caller, in order to identify the failed results. |
| error_code | String | The code of the error that was raised |
| error_description | String | The description of the error that was raised |
Examples
Example 1
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"referral_customer_events_set":
[
{
"request_unique_identifier":"125",
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"referred_rewards_participant_identifier":{"number":"RP0000000017"},
"referred_by_rewards_participant_identifier":{"number":"RP0000000010"}
},
{
"request_unique_identifier":"124",
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"referred_rewards_participant_identifier":{"number":"RP0000000014"},
"referred_by_rewards_participant_identifier":{"number":"RP0000000012"}
},
{
"request_unique_identifier":"123",
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"referred_rewards_participant_identifier":{"number":"RP0000000004"},
"referred_by_rewards_participant_identifier":{"number":"RP0000000010"}
}
]
}
Response:
{
"data": {
"unprocessed_customer_events_set": [
{
"error_description": "Error:Participant RP0000000004 Was Already Referred by Another Participant. - Description:The participant was already referred by another participant.",
"error_code": "ReferredByAnotherParticipantException",
"request_unique_identifier": "123"
}
],
"processed_customer_events_set": [
{
"number": "8",
"id": "D49D8CD39786431F882341CBDE5A254A",
"request_unique_identifier": "125"
},
{
"number": "9",
"id": "94E44BDAF7724C2E97B5C2B533371497",
"request_unique_identifier": "124"
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST customer_events/bulk/social_media/create
This method is used to create multiple social media customer events within a single Web API method call. Note that the maximum number of social media customer events that can be created is 1000
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
social_media_customer_events_set (mandatory) | Set of Social Media Customer Event Objects | The set of social media customer events that will be created by this Web API method. Note that the maximum number of social media 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 |
bulk social media 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 (semi-optional) | Accounts receivable Identifier | The related accounts receivable. The allowed accounts receivable identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the accounts receivable | number (semi-optional) | String | The number of the accounts receivable | name (semi-optional) | String | The name of the accounts receivable |
|
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the rewards participant | number (semi-optional) | String | The number of the rewards participant |
|
classification_identifier (optional) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the customer event classification | name (semi-optional) | String | The name of the customer event classification | alternative_code (semi-optional) | String | The alternative code of the customer event classification |
|
performed_by_unit_identifier (mandatory) | Unit Identifier | The unit that initiated the customer event. The allowed unit identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the Unit | name (semi-optional) | String | The name of the Unit | alternative_code (semi-optional) | String | The alternative code of the Unit |
|
performed_on (mandatory) | Date | The date that the customer event was actually performed |
description (optional) | String | A description of the customer event |
social_media (mandatory) | String | The social media related with the customer event, which can be one of the following: FACEBOOK |
profile (mandatory) | String | The social media profile related with the customer event |
action (mandatory) | String | The social media action that was performed. The following actions per social media are supported (if the social media is set to Facebook) LIKE |
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 |
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
Name | Type | Description |
|---|
processed_customer_events_set | Set of Processed customer Events Objects | A set that contains the ID and the number of the customer events that were created |
| unprocessed_customer_events_set | Set of Unprocessed customer Events Objects | A set that contains the customer events that were not created due to an error. Each row includes the unique request identifier , as provided by the caller, along with an error code and error description. |
Referred Objects Response Data
processed customer event object response data
Name | Type | Description |
|---|
| request_unique_identifier | String | A unique identifier of the request, as provided by the caller, in order to identify the successful results. |
id | String | The ID of the customer event that was created |
| number | String | The number of the customer event that was created |
unprocessed customer event object response data
Name | Type | Description |
|---|
| request_unique_identifier | String | A unique identifier of the request, as provided by the caller, in order to identify the failed results. |
| error_code | String | The code of the error that was raised |
| error_description | String | The description of the error that was raised |
Examples
Example 1
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"social_media_customer_events_set":
[
{
"request_unique_identifier":"16",
"accounts_receivable_identifier":{"number":"ACR0000000164"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"social_media":"FACEBOOK",
"profile":"www.facebook.com/polina",
"action":"LIKE"
},
{
"request_unique_identifier":"17",
"accounts_receivable_identifier":{"number":"ACR0000000050"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:05:02",
"social_media":"FACEBOOK",
"profile":"www.facebook.com/katerina",
"action":"LIKE"
},
{
"request_unique_identifier":"18",
"accounts_receivable_identifier":{"number":"ACR00045750"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:19:22",
"social_media":"FACEBOOK",
"profile":"www.facebook.com/marios",
"action":"LIKE"
},
{
"request_unique_identifier":"19",
"accounts_receivable_identifier":{"number":"ACR00670000"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:15:42",
"social_media":"FACEBOOK",
"profile":"www.facebook.com/yiannis",
"action":"LIKE"
}
]
}
Response:
{
"data": {
"unprocessed_customer_events_set": [
{
"error_description": "Error:Account (ACR00045750) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "18"
},
{
"error_description": "Error:Account (ACR00670000) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "19"
}
],
"processed_customer_events_set": [
{
"number": "14",
"id": "49A9DF458B6E4DE69CDC7F5E330F34D9",
"request_unique_identifier": "16"
},
{
"number": "15",
"id": "CB54467A5FA445359962283134E1473D",
"request_unique_identifier": "17"
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST customer_events/bulk/web/create
This method is used to create multiple web customer events within a single Web API method call. Note that the maximum number of web customer events that can be created is 1000
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
web_customer_events_set (mandatory) | Set of Web Customer Event Objects | The set of web customer events that will be created by this Web API method. Note that the maximum number of web 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 |
Referred Parameter Objects
bulk web 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 (semi-optional) | Accounts receivable Identifier | The related accounts receivable. The allowed accounts receivable identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the accounts receivable | number (semi-optional) | String | The number of the accounts receivable | name (semi-optional) | String | The name of the accounts receivable |
|
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the rewards participant | number (semi-optional) | String | The number of the rewards participant |
|
classification_identifier (optional) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the customer event classification | name (semi-optional) | String | The name of the customer event classification | alternative_code (semi-optional) | String | The alternative code of the customer event classification |
|
performed_by_unit_identifier (mandatory) | Unit Identifier | The unit that initiated the customer event. The allowed unit identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the Unit | name (semi-optional) | String | The name of the Unit | alternative_code (semi-optional) | String | The alternative code of the Unit |
|
performed_on (mandatory) | Date | The date that the customer event was actually performed |
description (optional) | String | A description of the customer event |
website (mandatory) | String | The website URL related with 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 |
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
Name | Type | Description |
|---|
processed_customer_events_set | Set of Processed customer Events Objects | A set that contains the ID and the number of the customer events that were created |
| unprocessed_customer_events_set | Set of Unprocessed customer Events Objects | A set that contains the customer events that were not created due to an error. Each row includes the unique request identifier , as provided by the caller, along with an error code and error description. |
Referred Objects Response Data
processed customer event object response data
Name | Type | Description |
|---|
| request_unique_identifier | String | A unique identifier of the request, as provided by the caller, in order to identify the successful results. |
id | String | The ID of the customer event that was created |
| number | String | The number of the customer event that was created |
unprocessed customer event object response data
Name | Type | Description |
|---|
| request_unique_identifier | String | A unique identifier of the request, as provided by the caller, in order to identify the failed results. |
| error_code | String | The code of the error that was raised |
| error_description | String | The description of the error that was raised |
Examples
Example 1
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"web_customer_events_set":
[
{
"request_unique_identifier":"06",
"accounts_receivable_identifier":{"number":"ACR0000000020"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"website":"www.crm.com"
},
{
"request_unique_identifier":"07",
"accounts_receivable_identifier":{"number":"ACR0000000077"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:05:02",
"website":"www.crm.com"
},
{
"request_unique_identifier":"08",
"accounts_receivable_identifier":{"number":"ACR00045000"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:19:22",
"website":"www.crm.com"
},
{
"request_unique_identifier":"09",
"accounts_receivable_identifier":{"number":"ACR00670040"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:15:42",
"website":"www.crm.com"
}
]
}
Response:
{
"data": {
"unprocessed_customer_events_set": [
{
"error_description": "Error:Account (ACR00045000) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "08"
},
{
"error_description": "Error:Account (ACR00670040) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "09"
}
],
"processed_customer_events_set": [
{
"number": "4",
"id": "B50A2C66D9934BF1AC92FB0F963B5654",
"request_unique_identifier": "06"
},
{
"number": "5",
"id": "F85AFE4F8FF64CB4A6C35F234684C8FF",
"request_unique_identifier": "07"
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST customer_events/bulk/financial_achievements/create
This method is used to create multiple financial achievements customer events within a single Web API method call. Note that the maximum number of financial achievements customer events that can be created is 1000
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
financial_achievement_customer_events_set (mandatory) | Set of Financial Achievement Customer Event Objects | The set of financial achievement customer events that will be created by this Web API method. Note that the maximum number of financial 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 |
Referred Parameter Objects
bulk purchase 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 (semi-optional) | Accounts receivable Identifier | The related accounts receivable. The allowed accounts receivable identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the accounts receivable | number (semi-optional) | String | The number of the accounts receivable | name (semi-optional) | String | The name of the accounts receivable |
|
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the rewards participant | number (semi-optional) | String | The number of the rewards participant |
|
classification_identifier (mandatory) | Customer Event Classification Identifier | The classification of the customer event. Only financial achievement classifications are allowed to be specified. The allowed customer event classification identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the customer event classification | name (semi-optional) | String | The name of the customer event classification | alternative_code (semi-optional) | String | The alternative code of the customer event classification |
|
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: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product | code (semi-optional) | String | The code of the product | alternative_code (semi-optional) | String | The alternative code of the product |
|
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: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the payment medium type | name (semi-optional) | String | The name of the payment medium type | alternative_code (semi-optional) | String | The alternative code of the payment medium type |
|
payment_medium_type_identifier (optional) | Payment Medium Type 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: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the payment medium brand | name (semi-optional) | String | The name of the payment medium brand | alternative_code (semi-optional) | String | The alternative code of the payment medium brand |
|
payment_medium_identifier (optional) | String | The payment medium identifier of the customer event. |
performed_by_unit_identifier (mandatory) | Unit Identifier | The unit that initiated the customer event. The allowed unit identifier fields are the following:
Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the Unit | name (semi-optional) | String | The name of the Unit | alternative_code (semi-optional) | String | The alternative code of the Unit |
|
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 |
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
Name | Type | Description |
|---|
processed_customer_events_set | Set of Processed customer Events Objects | A set that contains the ID and the number of the customer events that were created |
| unprocessed_customer_events_set | Set of Unprocessed customer Events Objects | A set that contains the customer events that were not created due to an error. Each row includes the unique request identifier , as provided by the caller, along with an error code and error description. |
Referred Objects Response Data
processed customer event object response data
Name | Type | Description |
|---|
| request_unique_identifier | String | A unique identifier of the request, as provided by the caller, in order to identify the successful results. |
id | String | The ID of the customer event that was created |
| number | String | The number of the customer event that was created |
unprocessed customer event object response data
Name | Type | Description |
|---|
| request_unique_identifier | String | A unique identifier of the request, as provided by the caller, in order to identify the failed results. |
| error_code | String | The code of the error that was raised |
| error_description | String | The description of the error that was raised |
Examples
Example 1
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"financial_achievement_customer_events_set":
[
{
"request_unique_identifier":"61",
"accounts_receivable_identifier":{"number":"ACR0000000218"},
"classification_identifier":{"name":"Financial Achievement 1"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00"
},
{
"request_unique_identifier":"62",
"accounts_receivable_identifier":{"number":"ACR0000000226"},
"classification_identifier":{"name":"Financial Achievement 3"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:05:02"
},
{
"request_unique_identifier":"63",
"accounts_receivable_identifier":{"number":"ACR45000"},
"classification_identifier":{"name":"Financial Achievement 1"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:19:22"
},
{
"request_unique_identifier":"64",
"accounts_receivable_identifier":{"number":"ACR040"},
"classification_identifier":{"name":"Financial Achievement 2"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:15:42"
}
]
}
Response:
{
"data": {
"unprocessed_customer_events_set": [
{
"error_description": "Error:Account (ACR45000) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "63"
},
{
"error_description": "Error:Account (ACR040) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "64"
}
],
"processed_customer_events_set": [
{
"number": "42",
"id": "B920CF7635644ED18517DDC0040E4181",
"request_unique_identifier": "61"
},
{
"number": "43",
"id": "A991B0F040DC4F13B6074BFF5191B85C",
"request_unique_identifier": "62"
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}