Skip to main content

Create Mapping

POST 
/api/airtable/instances/:instance/mappings

Create a dataset mapping that syncs a SKU.io dataset to a table in an Airtable base.

Body fields:

  • dataset (string, required): the SKU.io dataset to sync. One of products, inventory_levels, sales_orders, sales_order_lines, purchase_orders, purchase_order_lines, suppliers.
  • direction (string, optional, default outbound): outbound sends SKU.io data to Airtable; inbound reads changes back. Inbound is only supported for the products dataset.
  • base_id (string, required): the target Airtable base id.
  • table_id (string, required): the target table id within the base.
  • key_field_id (string, required): the Airtable field that stores the SKU.io id and is used as the merge key for upserts.
  • field_map (array, required, min 1): each entry maps a SKU.io source field to an Airtable target field. Each item has source (string) and target_field_id (string).
  • filters (object, optional): optional filter conditions restricting which records sync.
  • delete_mode (string, optional, default flag): how records removed in SKU.io are handled in Airtable. One of flag, delete, ignore.
  • schedule (string, optional, default hourly): automatic sync cadence. One of fifteen_minutes, hourly, daily, manual.
  • realtime_enabled (boolean, optional, default false): push changes as they happen.
  • apply_mode (string, optional): for inbound mappings, whether changes are queued for review or applied automatically. One of review, auto.
  • auto_create (boolean, optional, default false): when true, create missing Airtable records during sync instead of only updating existing rows.
  • is_enabled (boolean, optional, default true): whether the mapping is active.

Authentication: Requires Bearer token.

Request​

Responses​

Created

Response Headers
    Content-Type