| Tip |
|---|
Available from CRM.COM R10.0.0 |
| Excerpt |
|---|
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)
...
| Tip |
|---|
Available from CRM.COM R10.0.0 |
| Excerpt |
|---|
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: | Include Page |
|---|
| V4:currency_identifier |
|---|
| V4:currency_identifier |
|---|
|
| Tip |
|---|
Available from CRM.COM R11.0.0 |
|
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 purchases parameters |
|---|
| bulk create purchases parameters |
|---|
|
Referred Parameter Objects
| Expand |
|---|
| title | 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 (mandatory) | Accounts receivable Identifier | The related accounts receivable. The allowed accounts receivable identifier fields are the following: |
|
...
| accounts_receivable_identifier_post | | V4: |
|---|
|
|
|
...
| accounts_receivable_identifier_post |
|
|
|
...
For releases prior CRM.COM |
|
|
...
...
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
...
| Expand |
|---|
| title | 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, 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 (optional) | 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 |
|---|
|
| performed_by_business_unit_identifier (semi-optional) |
Accounts receivable | Business Unit Identifier | The |
related accounts receivablebusiness unit that initiated the customer event. The allowed |
accounts receivable identifier fields are the following |
:| Include Page |
|---|
| V4:business_unit_identifier |
|---|
| V4: |
|---|
|
|
accountsreceivableV4:accounts_receivable_identifier | rewards_participant| Tip |
|---|
Available from CRM.COM R18.0.0 |
| performed_by_unit_identifier (semi-optional) |
Rewards Participant related rewards participantunit that initiated the customer event. The allowed |
rewards participant identifier fields are the following |
| Include Page |
|---|
V4:rewards_participants_identifier | V4:rewards_participants_identifier | classification_identifier (optional) | Customer Event Classification Identifier | The classification of | 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 |
customer event classification identifier fields are the following |
:customereventclassificationcustomereventclassification_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 |
|
(mandatory) Unit Identifier | The unit that initiated the customer event. The allowed unit identifier fields are the following:| Include Page |
|---|
V4:unit_identifier | V4:unit_identifieris 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 | 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: | Include Page |
|---|
| V4:payment_medium_brand_identifier |
|---|
| V4:payment_medium_brand_identifier |
|---|
|
| 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: | Include Page |
|---|
| V4:payment_medium_type_identifier |
|---|
| V4:payment_medium_type_identifier |
|---|
|
| 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:| Include Page |
|---|
| V4:invoice_identifier |
|---|
| V4:invoice_identifier |
|---|
|
| 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_string_9 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
| udf_string_10 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
| udf_string_11 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
| udf_string_12 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
| udf_string_13 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
| udf_string_14 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
| udf_string_15 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
| udf_string_16 (optional) | String | User Defined Field of type String | Tip |
|---|
Available from CRM.COM R10.1.0 |
| 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 | spend_request (optional) | Spend Request Object | Information related with the spend request that should be created as part of the purchase customer event | Tip |
|---|
Available from CRM.COM R17.0.0 |
| products_set (mandatory) | Set of Purchase Product Objects | The purchased products, along with the total amount, net amount and VAT amount for each product |
| Anchor |
|---|
| create purchase customer event referred parameters |
|---|
| create purchase customer event referred parameters |
|---|
|
Referred Parameter Objects
| Include Page |
|---|
| V4:purchase_customer_event_spend_request_parameters |
|---|
| V4:purchase_customer_event_spend_request_parameters |
|---|
|
| Include Page |
|---|
| V4:purchase_customer_event_product_parameters |
|---|
| V4:purchase_customer_event_product_parameters |
|---|
|
|
...