Get Started on Cloud
BasicsAI AgentsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAMLBuddy GitFAQ

YAML for Shopify

View as Markdown

Shopify (SHOPIFY)

YAML parameters for Shopify

PARAMETERS
integrationrequiredstring
Shopify integration (SHOPIFY)
typerequiredstring

Value: SHOPIFY

actionrequiredstring
Unique identifier for the action within the pipeline.
themestring
The name of the Shopify theme
local_pathstring
Path in the repository to deploy. Use '/' for entire repository.
input_typestring enum
The source of files to deploy.
Allowed enum:
SCM_REPOSITORY,
BUILD_ARTIFACTS
always_from_scratchboolean
If set to true, the action always deploys the full set of files ignoring the changeset. For PUBLISH_ARTIFACT_VERSION the artifact version contents are also cleared before upload. The action runs from scratch when this flag OR the run-level always_from_scratch flag is true.
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
loopstring[]
The list of variables for dynamic action execution. The action runs once for each value.
run_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
disabledboolean
When set to true the action is disabled. By default it is set to false.
timeoutinteger
The timeout in seconds.
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.
retry_intervalinteger
Delay time between auto retries in seconds.
retry_countinteger
Number of retries if the action fails.

Constraints: ≤ 10

run_nextstring enum
Defines whether the action should run in parallel with the next one.
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
trigger_conditionsTriggerConditionYaml[]
The list of trigger conditions to meet so that the action can be triggered.
variablesVariableYaml[]
The list of variables you can use in the action.

Last modified on Aug 10, 2026

Previous pageSet variablesNext pageShopify CLI

YAML examples for Shopify

Deploy to Shopify

yaml
  - action: "Deploy to Shopify"
    type: "SHOPIFY"
    trigger_time: "ON_EVERY_EXECUTION"
    integration: "my_shopify_integration"
    theme: "my-custom-theme"
    input_type: "BUILD_ARTIFACTS"
    local_path: "/theme"
    always_from_scratch: true