Skip to main content

Magento - Meta Mapping/ Property Mapping

Tom Higgs avatar
Written by Tom Higgs
Updated over 2 months ago

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 follows.

Concatenated Text – values are concatenated:

  • Gift Message.

  • DeliveryMessage.

  • PackingNotes.

Single Values – value is set to first available:

  • Delivery Date.

  • EORI Number.

  • PID Number.

  • RequiredDespatchDate.

  • IOSS.

Adhoc data can be mapped at Order Level or at Order Item Level. To retrieve ad-hoc data use the following option: PersonalisationOption.


Mapping An Item

To add a property mapping for Magento, please follow the steps below:

  1. Go to Connect then Order Integrations.

  2. Click Magento.

  3. Then click Property Mappings.

  4. Enter the following -

    1. JSON Path.

      1. Example shown below.

    2. Data Level.

      1. Example: OrderItem.

    3. Mapped Field.

      1. Example: GiftMessage.

  5. Then press Create.

Order JSON Example

{ "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" } ] } }


JSON Path: $.extension_attributes.swissup_checkout_fields[?(@.code=='giftcard_note')].value.

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.

Note: The path shown above may not be the same for your mapping, Use the evaluator below to help build the JSON Path.

Test it using an Online Evaluator: Online Evaluator to test JSON Path expressions.

More expressions can be found here: Standard Magento JSON for an order.

For Order Item level data specify the path from the item rather than the root.
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.


Adhoc Data

View Ad hoc Order Items from:

  1. Click Orders then Overview.

  2. Find the order.

  3. Click Actions.

  4. Next Details then Extra Info.

View Ad hoc Order Level Items from:

  1. Click Orders then Overview.

  2. Find the order.

  3. Click Actions.

  4. Next Details then Items.

Did this answer your question?