Response mapping vs. results mapping

Contents

• Response mapping
• Results mapping

Response mapping

You can add response mappings to capture data returned from an import within your flow. For flows that have multiple imports, response mappings allow you to insert the response data of an import back into your source record so that you can reference that data in subsequent steps of your flow. For example, if an application automatically assigns customer IDs to newly imported customers, and the assigned customer IDs are included in the response, you can add those field values to the source record for use in future steps.

Follow the steps below to configure response mapping:

1. Click + on the import step, and click the mappings () button on the right.

2. The field mappings you define will be added as new fields or replace existing fields if those fields already exist in the source record. Use the Import response field drop-down list in the Edit response mapping panel to select the fields from the response you want to map back to the source record.

Import response mappings expose the following fields:
• id: the ID of the record just imported.
• errors: any errors from the record that was processed in this step.
• ignored: a Boolean true or false. The value is true if the record processed through this step was ignored. Otherwise the value is false.
• statusCode: the status code that resulted from processing the record through this step.
• _json: returns the full JSON formatted response of the import. For example,when importing customers into Shopify, Shopify might return the customer record that was created in their system as part of the response, and that customer record might include an automatically-assigned sales representative ID. You can use _json to retrieve the sales representative ID. 
• dataURI: when possible, this returns the link to the data that was created or updated by the import.
• headers: the header values of the response.

3. Enter the Source record field at the right to hold the data that will be merged back into the source record for use later on in the flow. New fields will be added to the source record unless you specify an existing field. If you use a field that already exists in the source record, it will be overwritten. 
4. Click Save & close.

Results mapping

Results mapping is similar to response mapping, but instead of returning the response after an import, results mapping allows you to merge the resulting records returned by a lookup step in your flow back into the source record. The returned lookup records can then be used in steps later on in the flow.

To configure results mapping,

1. Click + on the lookup step, and click the mappings () button to the right.

2. The field mappings you define will be added as new fields or replace existing fields if those fields already exist in the source record. Click in the Lookup response field in the Edit results mapping panel to select the fields from the response you want to map back to the source record.

Lookup results mappings allow the following options:
• data: the records returned by the lookup step. 
• errors: any errors from the record that was processed in this step.
• ignored: a Boolean true or false. The value is true if the record processed through this step was ignored. Otherwise the value is false.
• statusCode: the status code that resulted from processing the record through this step.
• dataURI: when possible, this returns the link to the data that was gathered by the lookup.

3. Choose a field in the Source record field on the right to hold the data that will be merged back into the source record for use later on in the flow. New fields will be added to the source record unless you specify an existing field. If you use a field that already exists in the source record, it will be overwritten.
4. Click Save & close.