Platform Events Definitions

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:

LimioOrder Payload (sendWholeOrder)

When sendWholeOrder is enabled in the Salesforce V3 plugin options, the i42as__LimioOrder field is populated with a JSON string containing a reduced version of the Limio order object. This applies to all order types that include the i42as__LimioOrder field.

Default top-level fields

The LimioOrder payload includes the following top-level order fields by default:

tracking, billingDetails, customerDetails, deliveryDetails, orderDate, orderItems, payment, payment_reference, payment_status, source, total, variant, forSubscription, originalOffer, customFields

Default order item fields

Each order item in orderItems is simplified to include:

Field	Included	Notes
name	Always
type	Always
quantity	Always	Number of units for the order item
id	Always
price (summary, currency, amount)	Always
offer (name, path, id, version, type)	Always
offer.data.attributes.price__limio	Always	Full pricing array including value, type, currencyCode, repeat_interval, etc.
products (path, attributes, record_type)	Always

Configurable fields (orderDataOptions)

Additional fields can be preserved in the LimioOrder payload by adding orderDataOptions to the Salesforce V3 plugin configuration. This allows including extra data per-customer without code changes.

Option	Level	Description	Example values
fieldsToKeep	Top-level order	Overrides the default top-level field list	["orderItems", "tracking", "country"]
itemFields	Order item	Additional fields on each order item	["parentId", "orderItemActionType"]
productDataFields	Product (within order item)	Additional fields on each product	["syncedFrom"]
offerDataFields	Offer data (offer.data)	Additional fields on the offer data object	["productBundles"]
offerAttributeFields	Offer attributes (offer.data.attributes)	Additional offer attribute fields	["display_price__limio", "term__limio"]

Note: When fieldsToKeep is specified, it replaces the entire default top-level field list. All other options add to the defaults.

Example configuration:

{
  "orderDataOptions": {
    "productDataFields": ["syncedFrom"],
    "offerDataFields": ["productBundles"]
  }
}

This example preserves syncedFrom on each product and productBundles (including rate_plan) on each offer's data, in addition to all the defaults.

Important: orderDataOptions is not user-configurable. To enable or modify this configuration, contact [email protected] or your Limio Implementation contact.

---

Platform Event Field Definitions

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 Limio Updates 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.

DATA_CAPTURE

Field Name	Data Type	Length	Populated?	Conditions/Details
i42as__Type	Text	40	Yes	Populated as "DATA_CAPTURE".
i42as__LimioOrder	LongTextArea		Yes	Contains JSON string of the form data submitted by the customer (e.g., {"firstName": "John", "companySize": "50-100"}). Only the form field values are included, not the full order metadata.
i42as__AccountId	Text	18	Conditional	Populated if the customer has an existing Salesforce Account (from previous purchase or if logged in).
i42as__ContactId	Text	18	Conditional	Populated if the customer has an existing Salesforce Contact.

Note: This event is generated when customers submit a Data Capture event from the Data Capture Form component, typically used for collecting additional information without creating a subscription (e.g., post-order data collection, change/cancel requests, feedback forms).