What is sent in the integration to Rule
About this article
If you have an integration with Rule you might ask yourself – What info is being sent from Centra to Rule. And below you find the answer on all the parameters that are sent and not sent in the different scenarios.
Custom attributes
Orders with custom attributes will have them sent over to Rule as well. The name of the fields sent to Rule will depend on the names of custom attributes and their elements. The naming convention is as follows: Order.<attribute>_<element>. For example a custom attribute attribute with element element will push field Order.attribute_element to Rule. A more realistic example of attribute order_attr and element eternal_id will yield a field Order.order_attr_external_id in Rule.
Parameters that are sent:
Order.Number
Order.Firstname
Order.Lastname Not for RefundCompleted and ReturnCompleted
Order.Date
Customer.Number
Customer.Language
Order.Street
Order.City
Order.Zipcode
Order.State
Order.Country
Order.Company
Order.Tele
Order.Subtotal
Order.Discount
Order.Shipping
Order.Total
Order.Vat
Order.Vatpercent
Order.PaymentMethod
Order.DeliveryMethod
Order.HandlingAmount
Order.TaxDeductionAmount
Order.SubtotalAmount
Order.DiscountAmount
Order.ShippingAmount
Order.TotalAmount
Order.VatAmount
Order.Currency
Order.<attribute>_<element>If we have tax deduct:
Order.TaxDeduction Depending on setting in plugin if it is OrderCreated
Order.CartUrl If we have a delivery (OrderShipped)
Order.Carrier
Order.Trackinglink
Order.Trackingno Only for OrderCompleted
Order.Handling
Order.BillingFirstname
Order.BillingLastname
Order.BillingStreet
Order.BillingCity
Order.BillingZipcode
Order.BillingState
Order.BillingCountry
Order.BillingTele
Order.BillingCompany Only for RefundCompleted and ReturnCompleted
Order.RefundValueTotal
Order.RefundHandlingCost
Order.RefundHandlingCostAmount
Order.RefundReturnCost
Order.RefundReturnCostAmount
Order.RefundCurrency
Order.RefundValueTotalAmount
Order.RefundValuePcsAmount
Order.RefundDateFor every item
Order.Brands
Order.Types
Order.Sizes
Order.ProductCount
Order.IndividualProductCount
Order.Names
Order.Variations
Order.Collections
Order.Skus
Order.Products
brand
name [value depends on rulemailer_short_product_desc]
comment
image
price
priceAmount
qty
subtotal
subtotalAmount(list of optional fields)
sku
productSku
brandName
brandUri
collection
collectionName
collectionUri
variantName
countryOrigin
excerpt
stockUnit
category
centraProduct
centraVariant
priceAsNumber
priceBeforeDiscount
priceBeforeDiscountAsNumber
discountPercent
taxPercent
tax
taxAmount
priceWithoutTax
priceWithoutTaxAmount
subtotalTax
subtotalTaxAmount
subtotalWithoutTax
subtotalWithoutTaxAmount
showAsOnSale
showAsNew
available
categoryName
categoryUri
skuKeyword
createdAt
modifiedAt
subscriptionPlans(only for returns)
Order.RefundValuePcs Newsletter, all might be empty depending on how the signup happens (if there is a separate choice for “I want to sign up for the newsletter” on the site, where they only fill out their email, or if they choose to signup from the order checkout)
Contact.Language
Address.Firstname
Address.Lastname
Address.Street
Address.City
Address.Zipcode
Address.State
Address.Country CustomerRegistered
Customer.Firstname
Customer.Lastname
Customer.Language
Customer.Tele
Customer.City
Customer.Country
Customer.Zipcode
Customer.Address1
Customer.Address2OrderCancellation Additional order fields:
Order.AdditionalMessage
Order.CompanyUrlGiftCertificate Common Order fields + GiftCertificate fields:
GiftCertificate.Name
GiftCertificate.Code
GiftCertificate.Link
GiftCertificate.Message
GiftCertificate.Date
GiftCertificate.DueDate
GiftCertificate.Description
GiftCertificate.Friend
GiftCertificate.Currency
GiftCertificate.Value
GiftCertificate.ValueAsNumberForgotPassword
Customer.Firstname
Customer.Lastname
Customer.Language
Customer.Tele
Customer.City
Customer.Country
Customer.Zipcode
Customer.Address1
Customer.Address2
Customer.PasswordRestoreLinkBack in Stock notification
When a customer subscribes to a back-in-stock notification powered by Rule, Centra is now sending product data in addition to sending product data upon triggering the back-in-stock notification. This will allow sending back-in-stock subscription confirmation emails that include information on the products customers subscribed to. Read more about how to set it up here.