Shoprenter

1 Short description
2 Order confirmation data send to Maileon
3 Order status changes sending to Maileon
- 3.1 shoprenter_orders_status_changed_v1 fields:
- 3.2 order.items fields:
4 Sending abandoned cart data to Maileon
- 4.1 shoprenter_abandoned_carts_v1 fields
- 4.2 cart.items fields:
5 Contact fields
6 Shoprenter loyality points

Short description

This middleware enables real-time transmission of order data from Shoprenter to Maileon. The order information is recorded as contact events in Maileon, making it easy to trigger automated email campaigns based on customer activity.

Order confirmation data send to Maileon

shoprenter_orders_v1 fields:

Name	Data type	Description

Name	Data type	Description
`order.id`	string	Shoprenter order id
`order.date`	datetime (Y-m-d H:i:s)	Order timestamp
`order.status`	string	Order status
`order.items`	json	Ordered items (details below)
`order.total`	float	Total order amount (gross)
`order.total_no_shipping`	float	Total order amount excluding shipping (gross)
`order.total_tax`	float	Order VAT amount
`order.total_fees`	float	Order other fees amount
`order.fees`	json	Description of other order fees
`order.currency`	string	Order currency
`payment.method.id`	string	Payment method ID
`payment.method.name`	string	Payment method name
`discount.code`	string	Discount coupon code
`discount.total`	float	Discount coupon amount (gross)
`customer.fullname`	string	Customer full name
`customer.firstname`	string	Customer firstname
`customer.lastname`	string	Customer lastname
`customer.id`	string	Customer Shoprenter ID
`billing.address.firstname`	string	Billing address lastname
`billing.address.lastname`	string	Billing address firstname
`billing.address.street`	string	Billing address street, hnr
`billing.address.zip`	string	Billing address zip
`billing.address.city`	string	Billing address city
`billing.address.region`	string	Billing address region
`billing.address.country`	string	Billing address country
`shipping.address.firstname`	string	Shipping address firstname
`shipping.address.lastname`	string	Shipping address lastname
`shipping.address.street`	string	Shipping address street, hnr
`shipping.address.zip`	string	Shipping address zip
`shipping.address.city`	string	Shipping address city
`shipping.address.region`	string	Shipping address region
`shipping.address.country`	string	Shipping address country
`shipping.service.id`	string	Shipping service ID
`shipping.service.name`	string	Shipping service name
`shipping.service.tracking.code`	string	Pick Pack pont code

order.items fields:

Name	Data type	Description

Name	Data type	Description
`id`	string	Shoprenter product ID
`sku`	string	Product SKU
`single_price`	float	Product price (net)
`total`	float	Ordered products total amount
`name`	string	Product title
`tax_rate`	float	Product VAT amount
`image_url`	string	Product image url
`quantity`	integer	Product ordered quantity
`categories`	string	Product categories comma separated list

shoprenter_ordered_products_v1 fields:

Name	Data type	Description

Name	Data type	Description
`order.id`	string	Shoprenter order ID
`order.date`	datetime (Y-m-d H:i:s)	Order timestamp
`order.status`	string	Order status
`product.sku`	string	Product SKU
`product.id`	string	Product Shoprenter ID
`product.name`	string	Product title
`product.image_url`	string	Product image url
`product.quantity`	integer	Product ordered quantity
`product.single_price`	float	Product price (net)
`product.total`	float	Ordered products total amount
`product.categories`	string	Product categories comma separated list
`order.total`	float	Total order amount (gross)
`order.currency`	string	Order currency
`payment.method.id`	string	Payment method ID
`payment.method.name`	string	Payment method name

Order status changes sending to Maileon

shoprenter_orders_status_changed_v1 fields:

Name	Data type	Description

Name	Data type	Description
`order.id`	string	Order Shoprenter ID
`order.date`	datetime (Y-m-d H:i:s)	Order timestamp
`order.status`	string	Order státusz
`order.items`	json	Ordered items (details below)
`order.total`	float	Total order amount (gross)
`order.total_no_shipping`	float	Total order amount excluding shipping (gross)
`order.total_tax`	float	Order VAT amount
`order.total_fees`	float	Order other fees amount
`order.fees`	json	Description of other order fees
`order.currency`	string	Order currency
`payment.method.id`	string	Payment method ID
`payment.method.name`	string	Payment method name
`discount.code`	string	Discount coupon code
`discount.total`	float	Discount coupon amount (gross)
`customer.fullname`	string	Customer full name
`customer.firstname`	string	Customer firstname
`customer.lastname`	string	Customer lastname
`customer.id`	string	Customer Shoprenter ID
`billing.address.firstname`	string	Billing address firstname
`billing.address.lastname`	string	Billing address lastname
`billing.address.street`	string	Billing address street, hnr
`billing.address.zip`	string	Billing address zip
`billing.address.city`	string	Billing address city
`billing.address.region`	string	Billing address region
`billing.address.country`	string	Billing address country
`shipping.address.firstname`	string	Shipping address firstname
`shipping.address.lastname`	string	Shipping address lastname
`shipping.address.street`	string	Shipping address street, hnr
`shipping.address.zip`	string	Shipping address zip
`shipping.address.city`	string	Shipping address city
`shipping.address.region`	string	Shipping address region
`shipping.address.country`	string	Shipping address country
`shipping.service.id`	string	Shipping service ID
`shipping.service.name`	string	Szállítási service name
`shipping.service.tracking.code`	string	Pick Pack pont code

order.items fields:

Name	Data type	Description

Name	Data type	Description
`id`	string	Product Shoprenter ID
`sku`	string	Product SKU
`single_price`	float	Product price (net)
`total`	float	Ordered products total amount
`name`	string	Product title
`tax_rate`	float	Product VAT amount
`image_url`	string	Product image url
`quantity`	integer	Product ordered quantity
`categories`	string	Product categories comma separated list

Sending abandoned cart data to Maileon

Currently, it is not possible to configure an abandoned cart event webhook directly from the application. However, it can be set up manually in the Shoprenter admin interface. The setup steps are as follows:

Name: Provide any name for the automation – the value does not matter.
Status: Set to enabled.
Schedule type: Set according to your preference.
Schedule: Set according to your preference.
Schedule unit: Set according to your preference.
Recipient: This is where you need to set the application’s endpoint that processes the webhook. The URL is:
https://shoprenter-xsic.maileon.com/api/shoprenter-app/webhooks/abandoned-cart
Format: Choose JSON.
Data to be sent: Add all available fields to the list of data fields to be sent.

Once the webhook is configured, it will send order data to Maileon for any abandoned checkout. The data will be stored in Maileon as a contact event. The contact event will be created with the following type:

shoprenter_abandoned_carts_v1: This contact event will contain the order data, and the ordered products will be stored in a JSON-type contact event field.

shoprenter_abandoned_carts_v1 fields

Name	Data type	Description

Name	Data type	Description
`cart.id`	string	Cart Shoprenter ID
`cart.date`	datetime (Y-m-d H:i:s)	Cart creation timestamp
`cart.url`	string	Cart url
`cart.items`	json	Cart items (details below)
`cart.total`	float	Cart total amount (gross)
`cart.total_no_shipping`	float	Total cart amount excluding shipping (gross)
`cart.total_tax`	float	Cart VAT amount
`cart.total_fees`	float	Cart other fees amount
`cart.fees`	json	Cart other fees name
`cart.currency`	string	Cart currency
`discount.code`	string	Cart coupon code
`discount.total`	float	Cart coupon total amount (gross)
`customer.fullname`	string	Customer full name
`customer.firstname`	string	Customer firstname
`customer.lastname`	string	Customer lastname
`customer.id`	string	Customer Shoprenter ID

cart.items fields:

Name	Data type	Description

Name	Data type	Description
`id`	string	Product Shoprenter ID
`sku`	string	Product SKU
`single_price`	float	Product price (net)
`total`	float	Products total amount (gross)
`name`	string	Product title
`tax_rate`	float	Product VAT amount
`image_url`	string	Product image url
`quantity`	integer	Product quantity
`categories`	string	Product categories comma separated list

Contact fields

Contact events can only be sent to existing contacts in Maileon. Therefore, before each contact event is submitted, we check whether a contact with the provided email address already exists in Maileon.

If the contact exists and has a permission level higher than NONE, we update the contact’s data and send the contact event.

If the contact does not exist in Maileon, or it exists but has a NONE permission level, we check whether the customer has accepted newsletter subscription in Shoprenter.

If the customer has accepted, the contact will be created in Maileon with the permission level specified in the application settings.
If the customer has not accepted, the contact will be created with a NONE permission level.

The following contact fields are used to store customer data:

Contact field	Type	Data type

Contact field	Type	Data type
Firstname	standard	string
Lastname	standard	string
Full name	standard	string
Locale	standard	string
Address	standard	string
ZIP	standard	string
City	standard	string
Country	standard	string
Region	standard	string
Shoprenter_Loyality_Points	custom	integer
Shoprenter_Transaction	custom	boolean
Shoprenter_NL	custom	boolean
Shoprenter_Phone	custom	string

Shoprenter loyality points

With every contact event submission, the contact’s loyalty point balance is updated. The loyalty points are stored in a custom contact field named:

Shoprenter_Loyality_Points