Configuration reference
This reference introduces configuration fields used by the Automation Engine. Settings apply only to compatible types, actions, and connections. Validate the complete configuration before saving it, and test representative data before enabling a schedule. See the API reference for endpoint requests and responses.
Automation settings
| Field |
Purpose |
name, vendor, slug |
Identify the automation. A slug can be generated when omitted. |
type, action |
Choose the record type (products, orders, or fitment) and whether to import or export. Not every combination is supported. |
active, draft, schedule |
Control availability, draft status, and schedule. The schedule uses a cron expression. |
shared, max_concurrency, disable_all |
Shared automation and run controls where applicable. |
logo, description, readme, disclaimer, beta |
Presentation and descriptive settings. |
connection, extract |
Describe the destination or source, and optional archive extraction. See Connections and parameters. |
create_custom_fields |
Describes custom fields to create when needed. Review field names and types carefully. |
file_configs |
Array of file or payload configurations. |
parameters |
Values used to configure an automation; see Connections and parameters. |
File selection and format
| Field |
Purpose |
name, regex |
Select a file by exact name or a delimited regular expression, subject to connection and workflow requirements. |
date_format, time_format |
Format {{DATE}} and {{TIME}}/{{NOW}} substitutions in UTC. |
bulk_file |
Treat a compatible input as a SureDone bulk file instead of using the ordinary mapping pipeline. |
delimiter, enclosure, headers |
Control delimited-file parsing or output. Delimiter defaults to a comma. Import headers may be a list; export headers are a boolean. |
xpath, jsonpath |
Enable structured XML or JSON mapping expressions. |
compress |
Compress export output as ZIP; defaults to false. Email handles compression within the email connection. |
move_remote_file, rename_remote_file, delete_remote_file |
Control source-file handling after import. Deletion and moving can affect future runs. |
limit_files |
Limit the number of files selected by a pattern. |
Mapping and matching
| Field |
Purpose |
field_map, field_map_default, field_run |
Map fields, define a secondary structured-data mapping, or make fields available to processing without ordinary output. |
value_map, value_map_default |
Translate values or provide defaults. Defaults behave differently for import and export, so test both directions. |
response_field_map, response_field_run |
Map response fields for writeback or processing after a supported export. |
placeholders_items, placeholders_shipments, placeholders_refunds |
Identify mapped fields as order item, shipment, or refund fields when needed. |
identifier, identifiers |
Select the matching field or an ordered list of matching fields. Defaults are guid for products and oid for orders. |
identifier_prefix_vendor, identifier_suffix_vendor |
Add text to the incoming identifier. |
identifier_prefix_suredone, identifier_suffix_suredone |
Adjust the SureDone identifier for matching without changing its saved value. |
identifier_case_sensitive |
Controls case-sensitive matching; defaults to true. |
order_item_identifier |
Field used to match existing order items; defaults to sku. |
See Mapping and formatting fields and Actions for examples.
Import behavior and stock
| Field |
Purpose |
create, update, remove |
Select import operations. The values and supported combinations differ for products and orders. |
diff_update, diff_fields, diff_tolerance |
Control change comparisons. Product-export snapshots have different rules from imports; see Imports and exports. |
search |
Select records using SureDone search syntax. A file-level search replaces generated file-level filters. |
skip_channels, skip_all |
Skip updates to selected channels or all channels. |
force, import_media |
Allow protected-field updates or import media URLs, when appropriate. |
stock_field, stock_sum_fields, stock_sum_multiline_field, stock_negative, stock_run_fields |
Configure stock output, sums and handling. Set stock_field explicitly when the stock feature requires it. |
stock_zero_search |
Optional product-import final stock mask for a stored-field condition. It has strict matching, update, stock-field and diff restrictions; test with representative matched products before enabling it. |
missing_vendor_items |
Apply zeroStock, end, or delete to eligible items missing from a source. Verify source completeness and scope before use. |
validate_headers |
Controls validation of headers in the resulting bulk file; defaults to true. |
Processing and output
| Field |
Purpose |
field_format, field_calculate |
Format values or calculate supported product-export values. |
vendor_actions, suredone_actions |
Apply conditional functions. See Actions. |
template, pdf |
Produce custom template output or PDF for a compatible export and connection. |
payload_multi |
Controls whether records are processed together or individually. It defaults to true for imports and false for exports. Individual template exports require a suitable connection. |
limit_import, limit_export, limit_template_size |
Limit records or approximate template payload size in supported workflows. |
limit_batch_size, limit_batch_concurrency, batch_stall_time, batch_max_retries, batch_throttle |
Configure supported batching, concurrency, stalled-run and rate controls. |
object_failure_update |
Specify supported order updates when a configured error condition matches. Product-side updates are not supported. |
failure_notification |
For a qualifying custom per-order HTTP template export, send failure notifications to one to 20 addresses. Other connection and processing restrictions apply. |
export_empty_file |
Send an empty export where the workflow supports it; defaults to false. |
summary |
Create a supported aggregate report rather than ordinary per-record output. Metrics, filters and connection restrictions depend on record type. |
Orders, tracking, and fitment
| Field |
Purpose |
order_tracking_groups, split_quantity_across_tracking, split_tracking_by_comma |
Configure supported tracking imports. Package mappings and estimated quantity splitting cannot be combined. |
order_payload_line_item, order_payload_line_filter, order_payload_line_delimiter, order_payload_include_items |
Control item-level order exports and template context. Sibling-item context requires explicit filtering when a template should include only a subset. |
order_update_export, order_update_search |
Set values after a successful export or restrict supported order updates. |
orders_start_date, orders_end_date |
Set date bounds for supported order exports. Summary reports have their own date-format restrictions. |
orders_sync_inventory, orders_address_validation |
Control supported order-import inventory sync and address validation. |
edi_spec, edi_export_path, edi_sender_id, edi_receiver_id |
Configure supported EDI processing and acknowledgements. Agree the transaction format and identifiers with your partner. |
trigger_escape_characters, trigger_escape_keys |
Control escaping when trigger values are substituted into supported configurations. |
fitment_export_type, fitment_export_empty_fill, fitment_export_duplicates, fitment_export_catepid |
Configure supported fitment-export format and output. |
fitment_export_diff, fitment_export_max_items, fitment_export_max_rows |
Opt into bounded incremental fitment export. The mode requires one compatible file and has additional restrictions. |
For an incremental fitment export, each emitted SKU contains its complete current fitment. A successful send is not proof of import by the recipient. Deletions, changes to a SKU's identity, and removal of its last fitment need a separately agreed receiver process. Test limits and receiver behavior before scheduling.