Product documentation
Patchworks services
Patchworks services
  • Services documentation
  • Getting started
    • What is a service?
  • Roles & Permissions
    • Roles & permissions summary (services)
  • Working with Services
    • Accessing services
    • The services list
    • The anatomy of a service
      • Service summary
      • Service canvas
      • Service filters
      • Service trigger
      • Service source
      • Service destination
      • Service mapping
      • Service alerts
      • Payload script
      • Run service
      • Service settings
    • Adding a Patchworks service
      • Add a default service
      • Configure service settings
      • Set the service trigger schedule
      • Define service filters
      • Define field mappings
      • Activate the service
    • Cloning an existing service
    • Updating a service
      • Service notes
      • Using a payload-level custom script in services
    • Removing a service
    • Field mappings & transformations (services)
      • Field mappings (services)
        • Mapping metafields for products (services)
      • Field transformations (services)
        • Transform function reference (services)
        • Using a custom script in field transformations (services)
      • Transform mapping/lookup tables (services)
      • Legacy shipment & payment maps (services)
  • Service connectors
    • What is a service connector?
    • Accessing service connectors
    • The anatomy of a service connector
    • Adding a service connector
    • Updating a service connector
    • Removing a service connector
  • Reporting & logging
    • Service sync reports
      • Viewing the service sync report
      • Handling failed service syncs
      • Sync failure email notifications
    • Service sync logs
    • Viewing logs for custom script activity in services
  • Service systems
    • Service systems
    • Supported service systems
      • Active Ants (service connector)
        • Finding service connector credentials for Active Ants
      • BigCommerce (service connector)
        • Finding service connector credentials for BigCommerce
        • Additional setup notes for BigCommerce (services)
      • Bleckmann (service connector)
        • Finding service connector credentials for Bleckmann (API)
      • Bleckmann Returns (service connector)
        • Finding service connector credentials for Bleckmann (Returns)
      • Bleckmann SFTP (service connector)
        • Finding service connector credentials for Bleckmann (SFTP)
      • Brightpearl (service connector)
        • Finding service connector credentials for Brightpearl
        • Additional setup notes for Brightpearl (services)
      • Business Central (service connector)
        • Finding service connector credentials for Business Central
      • Citrus-Lime (service connector)
        • Finding service connector credentials for Citrus-Lime
      • CommerceTools (service connector)
        • Finding service connector credentials for CommerceTools
      • Cybertill (service connector)
        • Finding service connector credentials for Cybertill
      • Descartes Peoplevox (service connector)
        • Finding service connector credentials for Peoplevox
        • Configuring Peoplevox as a data destination (services)
        • Quick setup CSV files for Peoplevox (services)
      • Dynamics NAV (service connector)
        • Finding service connector credentials for Dynamics NAV
      • Emarsys (service connector)
        • Finding service connector credentials for Emarsys (FTP)
      • EposNow (service connector)
        • Finding service connector credentials for EposNow
      • Global-e (service connector)
        • Finding service connector credentials for Global-e
      • Inventory Planner (service connector)
        • Finding service connector credentials for Inventory Planner
      • Khaos Control (service connector)
        • Finding service connector credentials for Khaos Control
      • Lightspeed Retail R-Series (service connector)
        • Authorising Patchworks to access your Lightspeed Retail R-Series account (services)
      • Lightspeed Retail X-Series (service connector)
      • Linnworks (service connector)
        • Finding service connector credentials for Linnworks
      • Magento 2 (service connector)
        • Finding service connector credentials for Magento 2
        • Required settings for Magento 2.4.4+ (services)
      • Mirakl (service connector)
        • Finding service connector credentials for Mirakl
      • Navision (service connector)
      • NetSuite (service connector)
        • Authorising Patchworks to access your NetSuite account (services)
        • Required NetSuite features (services)
        • Working with NetSuite custom fields (services)
        • Setting unique IDs for NetSuite product syncs (services)
        • NetSuite concurrency (services)
        • Troubleshooting NetSuite connections (services)
        • Additional setup notes for NetSuite (services)
        • Legacy service connector setup for NetSuite
          • Installing the Patchworks bundle for NetSuite (services)
          • Finding connector credentials for NetSuite (services)
      • Odoo (service connector)
        • Finding service connector credentials for Odoo
      • Ometria (service connector)
        • Finding service connector credentials for Ometria
      • Patchworks SFTP (service connector)
        • Finding basic auth service connector credentials for SFTP
        • Finding ssh auth service connector credentials for SFTP
        • Specifying a non-root folder as the file location (services)
        • Adding entity schemas (services)
      • Plytix (service connector)
        • Finding service connector credentials for Plytix
      • Prima (service connector)
        • Finding service connector credentials for Prima
      • ReBound (service connector)
        • Finding service connector credentials for ReBound
      • SAP Business One (service connector)
        • Finding service connector credentials for SAP Business One
      • Seko (service connector)
        • Finding service connector credentials for Seko (API)
        • Finding service connector credentials for Seko (FTP)
      • Shopify / Shopify+ (service connector)
        • Finding service connector credentials for Shopify (token auth)
        • Finding service connector credentials for Shopify (legacy auth)
        • Additional setup notes for Shopify (service connector)
      • Sitoo (service connector)
        • Finding service connector credentials for Sitoo
      • SparkLayer (service connector)
        • Finding service connector credentials for SparkLayer
      • The Edge by John Lewis (service connector)
        • Finding service connector credentials for The Edge by John Lewis
      • TikTok Shop (service connector)
        • Finding service connector credentials for TikTok Shop
      • Torque (service connector)
        • Finding service connector credentials for Torque
      • Veeqo
        • Finding service connector credentials for Veeqo
      • Vend (service connector)
        • Finding service connector credentials for Vend
      • Visualsoft (service connector)
        • Finding service connector credentials for Visualsoft
      • Voyado (service connector)
        • Finding service connector credentials for Voyado
      • WooCommerce (service connector)
        • Finding service connector credentials for WooCommerce
      • ZigZag (service connector)
        • Finding service connector credentials for ZigZag
  • Troubleshooting
    • How to manage failed service syncs
    • How to run a service manually
    • How to deactivate/activate a service
    • How to check the operational status of a service connector
    • What to check if you can't save a new service connector
    • How to handle an empty mapping page
    • What to do if your third-party systems go offline
  • Inbound API
    • Inbound API for services
    • Using the Inbound API connector with Patchworks services
      • Adding an inbound API connector with a custom payload
      • Generating token credentials for API access
      • Adding a Patchworks service for an inbound API connector
        • Add a default service
        • Configure service settings
        • Set the service trigger schedule
        • Define field mappings
        • Activate the service
      • Implementing API requests
  • Support
    • Raising a support ticket
Powered by GitBook
On this page
  • Introduction
  • About field mappings for API connector custom entities
  • Prerequisites
  • The steps
  1. Inbound API
  2. Using the Inbound API connector with Patchworks services
  3. Adding a Patchworks service for an inbound API connector

Define field mappings

PreviousSet the service trigger scheduleNextActivate the service

Last updated 12 months ago

Introduction

This page is part 4 of the instruction set for :

Part #
Link to instructions

1

2

3

4

Define field mappings

5

About field mappings for API connector custom entities

Mappings are at the heart of Patchworks.

When we pull data from one system and push it into another, it’s unlikely that the two will have a like-for-like data structure. By creating mappings between source and destination data fields, the Patchworks engine knows how to transform incoming data as needed to update the destination system.

The illustration below helps to visualise this:

With its standard connectors, Patchworks knows what mappings are likely to be between two given systems - default mappings are provided and can be tweaked if needed.

However, the Inbound API connector is unique for every client - Patchworks has no prior knowledge about how fields in a custom payload correlate to fields in other systems. As such, you must define the required mappings.

Prerequisites

If you have exited the 'new service' flow and need to get back to this point, you can access all service configuration options via the canvas tab:

The steps

Follow the steps below to define field mappings between the custom entity defined for your Inbound API connector, and the chosen destination connector.

Step 1 Click the add new row button:​​

... a new row is created, with fields to complete for source and destination entities - for example:​​

Step 2 Use the source field dropdown list to select a field from your Inbound API connector custom payload - for example:​​

…if required, set a preferred display name - for example:

Step 3 Use the destination field dropdown list to choose a field from your chosen destination connector to be mapped to the selected source field - if required, set a preferred display name.

Step 4 Click the done button associated with this row, to confirm changes:​

Step 5 Repeat steps 1- 4 for all required field mappings.

Alternatively, you can use the advanced editor to add a mapping file in JSON format - for example:

​

The steps detailed on this page assume that you are following the flow and have just saved service trigger schedule settings so the field mappings page is displayed:

​​

Step 6 Click the next button to access final service settings and activate the service - please see the page for guidance.​

'new service'
activate the service
Add a default service
Configure service settings
Set the service trigger schedule
Activate the service
adding a Patchworks service for an Inbound API connector