Overview
In this guide, we will explain how to set up Magento Meta/Property Mapping.
You can create mappings to the data for each order. This includes standard data items in Mintsoft, as well as ad-hoc data.
Standard Order level data in Mintsoft can be mapped from either Order Level or Order Item Level, as following:
Concatenated Text - values are concatenated:
- Gift Message
- Delivery message
- Packing Notes
Single Values - value is set to first available:
- Delivery Date
- EORI Number (the unique ID code, used to track and register customs information in the EU)
- Required Despatch Date
- IOSS (electronic system designed to improve the process in which VAT is paid on goods being sold to the EU)
Ad-Hoc data can also be mapped at Order Level or Order Item Level. To retrieve ad-hoc data, use the PersonalisationOption
Mapping an Item
1. Click Dashboard (left menu) > Connect > Order Integrations
2. Click Magento
3. Click Property Mappings
4. Enter the following:
- JSON Path -example provided below
- Data Level - 'OrderItem', for example
- Mapped Field - 'GiftMessage', for example
5. Once done, click Create
Order JSON Example:
Path - $.extension_attributes.swissup_checkout_fields[?(@.code=='giftcard_note')].value
"items": [
{
}
],
"billing_address": {
"address_type": "Billing",
"city": "Loughborough",
"country_id": "GB",
"email": "support@mintsoft.co.uk",
"entity_id": 1,
"firstname": "Mintsoft",
"lastname": "Support",
"parent_id": 1,
"postcode": "LE1 1AA",
"region": "Leicestershire",
"region_code": "Leicestershire",
"street": [
"123 Support Street"
],
"amount_ordered": 1
},
"extension_attributes": {
"shipping_assignments": [
{
}
],
"payment_additional_info": [
{
"key": "instructions",
"value": "null"
}
],
"applied_taxes": [],
"item_applied_taxes": [],
"swissup_checkout_fields": [
{
"code": "giftcard_note",
"label": "Gift Note",
"value": "Happy Birthday Mintsoft"
}
]
}
}
Path Breakdown:
- $ - Start
- . (Full Stop) - Separator
- extension_attributes - Root of the Section
- swissup_checkout_fields - Nested Section (Narrowed Down)
- [] - The Subscript
- ?() - Filter the section
- @ - Current Section/ Object
- code== - The Line where the data can be found
- Value - Where the information is found
Result - Happy Birthday Mintsoft
Please Note: the path shown above may not be the same for your mapping. You may wish to use the evaluator below, to help build the JSON Path
Please Note: for Order Item Level data, please specify the path from the item, rather than the root. For Example,using the online evaluator specify items[0].additional_data to access the additional_data value for the first Item. In the JSON Path field specify additional_data.
Viewing Ad-Hoc Data
To view Ad-Hoc Order Items details:
1. Click Dashboard > Orders > Overview
2. Find the sales order using the filters or search bar provided
3. Click Actions > Details > Extra Info, to view Order Items details
To view Ad-Hoc Order Level Items details:
1. Click Dashboard > Orders > Overview
2. Find the sales order using the filters or search bar provided
3. Click Actions > Details > Items, to view Order Level Items details.
Need more help?
If you need more help, no problem. Please raise via our 3PL Ticket Desk, and the Team will be happy to help.