Definitions for Limio-generated Salesforce Platform Events

The LFS managed package features a custom platform event published by Limio for various order types: i42as__OrderEvent__e. This event allows for additional logic to be built in the Salesforce org using a platform-event triggered flow. The fields in the event payload vary based on the order type.

This document lists all the field sets for the available order types:
- NEW_ORDER
- CHANGE_OFFER
- CANCEL_REQUEST
- ADD_OFFER
- CHANGE_PAYMENT_REQUEST
- NEW_GIFT_ORDER
- REFUND
- REQUEST_RENEWAL
- CHANGED_DELIVERY_ADDRESS
- UPDATE_CUSTOMER
- UPDATE_SUBSCRIPTION

NEW_ORDER

Field	Data Type	Length	Populated?	Conditions/Details
i42as__OrderType	Text	40	Yes
i42as__ChangeType	Text	40	Yes
i42as__OrderNumber	Text	40	Yes
i42as__PurchaseDate	DateTime		Yes
i42as__EffectiveDate	DateTime		Yes
i42as__SubscriptionId	Text	100	Yes
i42as__Source	Text	40	Yes	Populated as "Limio".
i42as__InitiatedSource	Text	40	Yes	Either "shop" or "salesforce".
i42as__OrderSource	Text	40	Yes	Either "shop" or "salesforce".
i42as__ContactId	Text	18	Conditional	Populated in orders triggered from Salesforce.
i42as__AccountId	Text	18	Conditional
i42as__CaseId	Text	18	Conditional
i42as__GiftCode	Text	40	Conditional	Populated if a gift code is present on the order.
i42as__InitiatedByLimioId	Text	70	Yes
i42as__InitiatedByExternalId	Text	150	Yes
i42as__LimioOrder	LongTextArea		Configurable	Can be added to the payload upon request. See How can Limio Commerce update my Salesforce data? for more details. You can see a typical Limio Order in our API docs (Get Object > Get Order Response)
i42as__OfferId	Text	40	Yes
i42as__OfferType	Text	40	Yes
i42as__TermLengthUnits	Text	40	Yes
i42as__TermLengthValue	Text	40	Yes
i42as__OfferDisplayName	Text	100	Conditional	Populated if available in the offer setup.
i42as__DisplayPrice	Text	150	Conditional
i42as__Description	Text	100	Conditional
i42as__ProductCode	Text	40	Yes
i42as__ProductName	Text	40	Yes
i42as__StudentCourse	Text	100	Conditional	Populated when student_offer = true and student fields were included at checkout.
i42as__StudentUniversity	Text	100	Conditional
i42as__StudentGraduationYear	Text	4	Conditional

CHANGE_OFFER

Field	Data Type	Length	Populated?	Conditions/Details
i42as__OrderType	Text	40	Yes
i42as__ChangeType	Text	40	Yes
i42as__OrderNumber	Text	40	Yes
i42as__PurchaseDate	DateTime		Yes
i42as__EffectiveDate	DateTime		Yes
i42as__Reason	Text	200	Conditional	Populated if provided in the online order.
i42as__SubscriptionId	Text	100	Yes
i42as__Source	Text	40	Yes	Populated as "Limio".
i42as__OrderSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__InitiatedSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__ContactId	Text	18	Conditional	Populated in orders triggered from Salesforce.
i42as__AccountId	Text	18	Conditional
i42as__CaseId	Text	18	Conditional
i42as__InitiatedByLimioId	Text	70	Yes
i42as__InitiatedByExternalId	Text	150	Yes
i42as__LimioOrder	LongTextArea		Configurable	Can be added to the payload by Limio team upon request.
i42as__OfferId	Text	40	Yes
i42as__OfferType	Text	40	Yes
i42as__TermLengthUnits	Text	40	Yes
i42as__TermLengthValue	Text	40	Yes
i42as__OfferDisplayName	Text	100	Conditional	Populated if available in the offer setup.
i42as__DisplayPrice	Text	150	Conditional
i42as__Description	Text	100	Conditional
i42as__ProductCode	Text	40	Yes
i42as__ProductName	Text	40	Yes

CANCEL_REQUEST

Field	Data Type	Length	Populated?	Conditions/Details
i42as__OrderType	Text	40	Yes
i42as__ChangeType	Text	40	Yes
i42as__OrderNumber	Text	40	Yes
i42as__PurchaseDate	DateTime		Yes
i42as__EffectiveDate	DateTime		Conditional	Populated in LFS-triggered orders.
i42as__Reason	Text	200	Conditional	Populated if present in the order.
i42as__SubscriptionId	Text	100	Yes
i42as__Source	Text	40	Yes	Populated as "Limio".
i42as__OrderSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__InitiatedSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__ContactId	Text	18	Conditional	Populated in orders triggered from Salesforce.
i42as__AccountId	Text	18	Conditional
i42as__CaseId	Text	18	Conditional
i42as__InitiatedByLimioId	Text	70	Yes
i42as__InitiatedByExternalId	Text	150	Yes
i42as__LimioOrder	LongTextArea		Configurable	Can be added to the payload by Limio team upon request.

 

ADD_OFFER

Field	Data Type	Length	Populated?	Conditions/Details
i42as__OrderType	Text	40	Yes
i42as__ChangeType	Text	40	Yes
i42as__OrderNumber	Text	40	Yes
i42as__OrderValue	Number		Yes
i42as__OrderCurrency	Text	3	Yes
i42as__Status	Text	35	Yes
i42as__PurchaseDate	DateTime		Yes
i42as__EffectiveDate	DateTime		Yes
i42as__Reason	Text	200	Yes
i42as__SubscriptionId	Text	100	Yes
i42as__Source	Text	40	Yes	Populated as "Limio".
i42as__OrderSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__InitiatedSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__ContactId	Text	18	Conditional	Populated in orders triggered from Salesforce.
i42as__AccountId	Text	18	Conditional
i42as__CaseId	Text	18	Conditional
i42as__InitiatedByLimioId	Text	70	Yes
i42as__InitiatedByExternalId	Text	150	Yes
i42as__LimioOrder	LongTextArea		Configurable	Can be added to the payload by Limio team upon request.
i42as__OfferId	Text	40	Yes
i42as__OfferType	Text	40	Yes
i42as__TermLengthUnits	Text	40	Yes
i42as__TermLengthValue	Text	40	Yes
i42as__OfferDisplayName	Text	100	Conditional	Populated if available in the offer setup.
i42as__DisplayPrice	Text	150	Conditional
i42as__Description	Text	100	Conditional
i42as__ProductCode	Text	40	Yes
i42as__ProductName	Text	40	Yes

CHANGE_PAYMENT_REQUEST

Field	Data Type	Length	Populated?	Conditions/Details
i42as__OrderType	Text	40	Yes
i42as__ChangeType	Text	40	Yes
i42as__OrderNumber	Text	40	Yes
i42as__PurchaseDate	DateTime		Yes
i42as__EffectiveDate	DateTime		Yes
i42as__SubscriptionId	Text	100	Yes
i42as__Source	Text	40	Yes	Populated as "Limio".
i42as__OrderSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__InitiatedSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__ContactId	Text	18	Conditional	Populated in orders triggered from Salesforce
i42as__AccountId	Text	18	Conditional
i42as__CaseId	Text	18	Conditional
i42as__InitiatedByLimioId	Text	70	Yes
i42as__InitiatedByExternalId	Text	150	Yes
i42as__LimioOrder	LongTextArea		Configurable	Can be added to the payload by Limio team upon request.

NEW_GIFT_ORDER

Field	Data Type	Length	Populated?	Conditions/Details
i42as__OrderType	Text	40	Yes
i42as__ChangeType	Text	40	Yes
i42as__OrderNumber	Text	40	Yes
i42as__OrderValue	Number		Yes
i42as__PurchaseDate	DateTime		Yes
i42as__EffectiveDate	DateTime		Yes
i42as__SubscriptionId	Text	100	Yes
i42as__Source	Text	40	Yes	Populated as "Limio".
i42as__OrderSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__InitiatedSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__ContactId	Text	18	Conditional	Populated in orders triggered from Salesforce.
i42as__AccountId	Text	18	Conditional
i42as__CaseId	Text	18	Conditional
i42as__InitiatedByLimioId	Text	70	Yes
i42as__InitiatedByExternalId	Text	150	Yes
i42as__LimioOrder	LongTextArea		Configurable	Can be added to the payload by Limio team upon request.
i42as__OfferId	Text	40	Yes
i42as__OfferType	Text	40	Yes
i42as__TermLengthUnits	Text	40	Yes
i42as__TermLengthValue	Text	40	Yes
i42as__OfferDisplayName	Text	100	Conditional	Populated if available in the offer setup.
i42as__DisplayPrice	Text	150	Conditional
i42as__Description	Text	100	Conditional
i42as__ProductCode	Text	40	Yes
i42as__ProductName	Text	40	Yes
i42as__purchaserContactId	Text	100	Yes
i42as__purchaserFirstName	Text	100	Yes
i42as__purchaserLastName	Text	100	Yes
i42as__purchaserEmail	Text	100	Yes
i42as__purchaserCountryCode	Text	50	Yes
i42as__recipientFirstName	Text	100	Yes
i42as__recipientLastName	Text	100	Yes
i42as__recipientEmail	Text	100	Yes
i42as__deliveryDate	Text	25	Conditional	Populated if included in the order.
i42as__giftMessage	Text	255	Conditional
i42as__VoucherExpiryDate	Text	25	Yes
i42as__redemptionCode	Text	11	Yes
i42as__recipientAddressLine1	Text	100	Conditional	Populated if included in the order.
i42as__recipientAddressLine2	Text	100	Conditional
i42as__recipientState	Text	100	Conditional
i42as__recipientCity	Text	100	Conditional
i42as__recipientPostcode	Text	100	Conditional
i42as__recipientCountryCode	Text	50	Conditional

REFUND

Field	Data Type	Length	Populated?	Conditions/Details
i42as__OrderType	Text	40	Yes
i42as__ChangeType	Text	40	Yes
i42as__OrderNumber	Text	40	Yes
i42as__PurchaseDate	DateTime		Yes
i42as__EffectiveDate	DateTime		Yes
i42as__Reason	Text	200	Conditional	Populated if present in the order.
i42as__SubscriptionId	Text	100	Yes
i42as__Source	Text	40	Yes	Populated as "Limio".
i42as__OrderSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__InitiatedSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__ContactId	Text	18	Conditional	Populated in orders triggered from Salesforce.
i42as__AccountId	Text	18	Conditional
i42as__CaseId	Text	18	Conditional
i42as__InitiatedByLimioId	Text	70	Yes
i42as__InitiatedByExternalId	Text	150	Yes
i42as__LimioOrder	LongTextArea		Configurable	Can be added to the payload by Limio team upon request.
i42as__OfferId	Text	40	Yes

 

REQUEST_RENEWAL

Field Name	Data Type	Length	Populated?	Conditions/Details
i42as__OrderType	Text	40	Yes
i42as__ChangeType	Text	40	Yes
i42as__OrderNumber	Text	40	Yes
i42as__OrderValue	Number		Yes
i42as__OrderCurrency	Text	3	Yes
i42as__Status	Text	40	Yes
i42as__PurchaseDate	DateTime		Yes
i42as__EffectiveDate	DateTime		Yes
i42as__SubscriptionId	Text	100	Yes
i42as__Source	Text	40	Yes	Populated as "Limio".
i42as__OrderSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__InitiatedSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__ContactId	Text	18	Conditional	Populated in orders triggered from Salesforce.
i42as__AccountId	Text	18	Conditional
i42as__CaseId	Text	18	Conditional
i42as__InitiatedByLimioId	Text	70	Yes
i42as__InitiatedByExternalId	Text	150	Yes
i42as__LimioOrder	LongTextArea		Configurable	Can be added to the payload by Limio team upon request.
i42as__OfferId	Text	40	Yes
i42as__OfferType	Text	40	Yes
i42as__TermLengthUnits	Text	40	Yes
i42as__TermLengthValue	Text	40	Yes
i42as__OfferDisplayName	Text	100	Conditional	Populated if available in the offer setup
i42as__DisplayPrice	Text	150	Conditional
i42as__Description	Text	100	Conditional
i42as__ProductCode	Text	40	Yes
i42as__PreviousSubscriptionId	Text	30	Yes
i42as__CountryCode	Text	30	Yes
i42as__StudentCourse	Text	100	Conditional	Populated when student_offer = true and student fields were included at checkout.
i42as__StudentUniversity	Text	100	Conditional
i42as__StudentGraduationYear	Text	4	Conditional

CHANGED_DELIVERY_ADDRESS

Field Name	Data Type	Length	Populated?	Conditions/Details
i42as__OrderType	Text	40	Yes
i42as__ChangeType	Text	40	Yes
i42as__PurchaseDate	DateTime	40	Yes
i42as__EffectiveDate	DateTime		Yes
i42as__SubscriptionId	Text	100	Yes
i42as__Source	Text	40	Yes	Populated as "Limio".
i42as__OrderSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__InitiatedSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__ContactId	Text	18	Conditional	Populated in orders triggered from Salesforce
i42as__AccountId	Text	18	Conditional
i42as__CaseId	Text	18	Conditional
i42as__InitiatedByLimioId	Text	70	Yes
i42as__InitiatedByExternalId	Text	150	Yes
i42as__LimioOrder	LongTextArea		Configurable	Can be added to the payload by Limio team upon request.
i42as__EventTimestamp__c	Text	25	Yes

UPDATE_CUSTOMER

Field Name	Data Type	Length	Populated?	Conditions/Details
i42as__OrderType	Text	40	Yes
i42as__ChangeType	Text	40	Yes
i42as__OrderNumber	Text	40	Yes
i42as__PurchaseDate	DateTime		Yes
i42as__Source	Text	40	Yes	Populated as "Limio".
i42as__OrderSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__InitiatedSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__InitiatedByLimioId	Text	70	Yes
i42as__InitiatedByExternalId	Text	150	Yes
i42as__LimioOrder	LongTextArea		Configurable	Can be added to the payload by Limio team upon request.

UPDATE_SUBSCRIPTION

Field Name	Data Type	Length	Populated?	Conditions/Details
i42as__OrderType	Text	40	Yes
i42as__ChangeType	Text	40	Yes
i42as__OrderNumber	Text	40	Yes
i42as__PurchaseDate	DateTime		Yes
i42as__Source	Text	40	Yes	Populated as "Limio".
i42as__OrderSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__InitiatedSource	Text	40	Yes	Populated with either "shop" or "salesforce".
i42as__InitiatedByLimioId	Text	70	Yes
i42as__InitiatedByExternalId	Text	150	Yes
i42as__SubscriptionId	Text	100	Yes
i42as__NewPrice	Text	40	Yes
i42as__NewTermLength	Number		Yes
i42as__NewTermType	Text	40	Yes	Populated with either "days", "weeks", "moths" or "years
i42as__PreviousPrice	Text	40	Yes
i42as__PreviousTermLength	Number		Yes
i42as__PreviousTermType	Text	40	Yes	Populated with either "days", "weeks", "moths" or "years
i42as__Currency	Text	3	Yes
i42as__LimioOrder	LongTextArea		Configurable	Can be added to the payload by Limio team upon request.