Connections and parameters
The connection object tells an automation where to get or send data. Available connection types include ftp, sftp, ftps, sdsftp, sds3, http, and email; shipstation_fulfillments supports a specific import workflow. The settings needed depend on the connection and direction. Confirm them with your integration partner.
File transfer
File transfer connections can use address, username, password, path, and port. FTP defaults to port 21 and SFTP to port 22. is_key_file selects key-based SFTP authentication. use_pasv_address controls use of the address returned for passive FTP. check_after_send enables an additional SFTP check after sending. sdsftp uses an account identifier, while sds3 can use bucket and path as applicable.
An import may select a source with name or a delimited regular expression in regex. For an archive, top-level extract supports name or regex to select the archive, files_to_extract or regex_extract to select its contents, and an optional ZIP password. File-level move_remote_file, rename_remote_file, and delete_remote_file control what happens to source files after processing. Confirm that the source should be moved or deleted before enabling those options.
HTTP
For HTTP, address, method, headers, and payload describe a request. login_address and login_credentials support an initial login; auth can obtain a token with address, method, headers, payload, and token_key. OAuth configuration can include authorization and token endpoints, scopes, and client settings. The supported fields depend on the provider. ssl_http defaults to true and verifies the peer certificate. Do not disable certificate verification to work around a provider configuration problem.
Where the provider requires a signed request, hmac supplies the algorithm, data, key and optional binary-output setting. validate controls connection validation during a save. An optional auth.logout request is available only for qualifying custom per-order HTTP template exports; the workflow must not use triggers, line-item output, batching, caching or OAuth.
delete_missing_ok defaults to false. When enabled for a DELETE export, a 404 response can be treated as success if an absent resource is the intended outcome. It does not make other errors successful.
Pagination can use paginate and the pagination object. Options include next_token, next_parameter, page_parameter, page_start, page_iterator, page_per_second, and ignore_errors. Choose these according to the provider's pagination contract. pointer can carry a position across runs; configure its field and start/end parameters according to the provider's API. triggers support a sequence of preliminary requests; settings can include request details, response keys, retry limits, and retry timing.
HTTP caching uses cached, cache_ttl, cache_force, and cache_scope. Scope defaults to account; global can share eligible GET responses across accounts. Use shared caching only for responses safe to share. throttle controls request rate with request_limit, optional time_period, and optional endpoint.
Email exports can specify address, subject, body, sender_address, sender_name, cc, bcc, reply-to, and send_as_attachment. Address can be a list of recipients. Imports can use mailbox, email_search, and mark_as_seen. Avoid putting private information in subject lines or examples.
Parameters
Parameters let a configuration accept values without duplicating the automation. Each parameter can have a name, value, label, description, type, and required setting. allowed_values restricts choices. encrypted protects a stored value; use protected parameters for credentials and avoid placing real credentials in examples. hidden_from_user controls visibility; date_format and date_timezone format dates; base64_encoded controls encoding. linked_parameters and value_map let a selection supply related values.
field_run, stock_sum_fields, vendor_actions, and suredone_actions can each use an exact {{linked_name}} placeholder for an array supplied by a linked parameter. stock_zero_search can similarly use a linked string. These have a bounded selector contract: all such references in a definition must belong to one parent selector, which must be an unencrypted, untransformed string with one to eight distinct nonempty allowed values and a default in that list. Each linked target must contain a complete literal mapping for every allowed value, with arrays for array fields and strings for stock_zero_search. Nested placeholders or nested linked controls inside these values are not supported. Parameter names in this linked graph must be unique, and a linked target cannot also be an editable top-level parameter. A stock-zero target cannot also supply an array field.
The validator checks every branch, including branches not currently selected, and retains the original placeholders. Changes to selector choices or maps must include the complete file_configs and parameters so every branch can be checked. Installations inherit the parent schema and can change the permitted selection. These restrictions apply to the listed linked file-configuration fields, not to every ordinary scalar parameter.
Always validate and test a configuration using representative data and a safe destination before turning on its schedule.