The following information only applies to our Shopify integration with Mintsoft.
1. Reviewing the Order JSON
The first step in adding a property mapping is to review the Order JSON, this will show you what data has been sent from Shopify and in what format.
To review the Order JSON please do the following:
Go to Orders then Overview.
Find a Shopify Order.
Click Actions then Details.
Click the History tab then click the Connect sub-tab.
The long string of text is your JSON.
Copy this data and paste it into a JSON validator website (Example: https://jsonlint.com/).
Find the section containing the information you want to map.
Take note of the Name field (Or Key field if you have upgraded to GraphQL) as you will need this when mapping.
2. Creating a Property Mapping
Once you have the information required to create the mapping please do the following:
Go to Connect then Order Integrations.
Click Shopify then find the connection you want to add the mapping for.
Click PropertyMappings in orange.
Enter the value you want to map in the Name field.
Select the Level.
Select the MappedField.
Click Create.
3. Attributes available to map
It's possible to map from the note attributes section of an order on Shopify.
These can be mapped to the following fields in Mintsoft:
DeliveryMessage.
GiftMessage.
PackingNotes.
EORINumber.
PIDNumber.
RequiredDespatchDate.
BundleItem.
This is used for selling options, it has to map to a Bundle SKU in Mintsoft and it'll get broken down into Components that Mintsoft has under the bundle.
NameValueAccountCode.
SingleBundleItem.
This maps directly to normal SKUs, assuming a QTY of one unit.
DeliverDate (Required Delivery Date).
This can be found in the JSON under "note_attributes" or "customAttributes".
Example 1
"note_attributes": [{
"name": "Delivery-Date",
"value": "26\/11\/2020"
}],
Example 2
"customAttributes": [{
"key": "Delivery-Date",
"value": "26\/11\/2020"
}],
You would map this in the following way:
Name: Delivery-Date.
Level: Order.
Mapped Field: Delivery Date.
This would then copy the Date into the required delivery date field against the order in Mintsoft.
4. Personalisation Mapping
If you sell personalised products on Shopify, you can map these easily using the property mapping option.
Go to Connect then Order Integrations.
Click Shopify then find the connection you want to add the mapping for.
Click PropertyMappings in orange.
Choose to map the field from Shopify either:
as a Gift message or.
as a personalisation field (which will show next to each product on the despatch note).
If all of your options are personalisation fields - you can use a quick way of mapping them all automatically by typing the following into the Name field: ALL-PROPERTIES-ARE-PERSONALISATION-OPTIONS.
Use the MappedField drop-down and select PersonalisationOption. Each value will now appear directly against products.
Alternatively, you can choose individual property mappings to map to gift messages if you do not want them related specifically to a product - which would just create an overall message on the order detail.
You can view the property name values that you need to map by viewing the JSON order feed:
https://{entershopname}.myshopify.com/admin/orders.json
Property Mapping - FAQ
"note_attributes" or "customAttributes"?
The JSON data returned from Shopify will vary slightly depending on whether you’ve upgraded to the GraphQL API. If you have upgraded, the JSON will include a "customAttributes" section containing a Key and Value for mapping. If you haven’t upgraded, the JSON will instead have a "note_attributes" section with a Name and Value for mapping.
GraphQL | Non-GraphQL |
customAttributes | note_attributes |
Key | Name |
Value | Value |