Skip to content

Add env var to allow using Partners API #6671

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gonzaloriestra merged 1 commit into from
Dec 1, 2025
Merged

Add env var to allow using Partners API #6671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/cli-kit/src/private/node/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export const environmentVariables = {
themeKitAccessDomain: 'SHOPIFY_CLI_THEME_KIT_ACCESS_DOMAIN',
json: 'SHOPIFY_FLAG_JSON',
neverUsePartnersApi: 'SHOPIFY_CLI_NEVER_USE_PARTNERS_API',
usePartnersApi: 'SHOPIFY_CLI_USE_PARTNERS_API',
skipNetworkLevelRetry: 'SHOPIFY_CLI_SKIP_NETWORK_LEVEL_RETRY',
maxRequestTimeForNetworkCalls: 'SHOPIFY_CLI_MAX_REQUEST_TIME_FOR_NETWORK_CALLS',
}
Expand Down
18 changes: 13 additions & 5 deletions packages/cli-kit/src/public/node/environment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,21 @@ export function jsonOutputEnabled(environment = getEnvironmentVariables()): bool
/**
* If true, the CLI should not use the Partners API.
*
* @returns True when SHOPIFY_CLI_NEVER_USE_PARTNERS_API is set or SHOPIFY_CLI_1P_DEV is not set.
* @returns True when the CLI should not use the Partners API.
*/
export function blockPartnersAccess(): boolean {
return (
isTruthy(getEnvironmentVariables()[environmentVariables.neverUsePartnersApi]) ||
!isTruthy(getEnvironmentVariables()[environmentVariables.firstPartyDev])
)
// Block if explicitly set to never use Partners API
if (isTruthy(getEnvironmentVariables()[environmentVariables.neverUsePartnersApi])) {
return true
}

// If explicitly forcing to use Partners API, do not block
if (isTruthy(getEnvironmentVariables()[environmentVariables.usePartnersApi])) {
return false
}

// Block for 3P devs
return !isTruthy(getEnvironmentVariables()[environmentVariables.firstPartyDev])
}

/**
Expand Down