A valid request URL is required to generate request examples{
"id": "<string>",
"display_name": "<string>",
"base_currency": "<string>",
"desktop_columns": 123,
"mobile_columns": 123,
"shopify_domain": "<string>",
"shopify_app_installed": true,
"has_run_at_least_one_ingestion": true,
"multi_store_group_id": "<string>",
"multi_store_activation_code": "<string>",
"variant_group_by_name": "<string>",
"start_timestamp": 123,
"has_completed_onboarding": true,
"auto_activate_all_collections": true,
"shopify_is_multi_market": true,
"uses_cloudflare_ingestion": true,
"default_market_id": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Install or reinstall the app for the calling Shopify store
Creates the merchant for the Shopify store in the caller’s session token, or marks an existing one reinstalled, then exchanges and stores a fresh offline Admin API token. Call it from the app’s install flow only: it writes config.merchant, the default market, default boost/bury rules and the Shopify config, and emits install analytics. Needs a Shopify session token (a staff identity cannot install). Returns the merchant record.
A valid request URL is required to generate request examples{
"id": "<string>",
"display_name": "<string>",
"base_currency": "<string>",
"desktop_columns": 123,
"mobile_columns": 123,
"shopify_domain": "<string>",
"shopify_app_installed": true,
"has_run_at_least_one_ingestion": true,
"multi_store_group_id": "<string>",
"multi_store_activation_code": "<string>",
"variant_group_by_name": "<string>",
"start_timestamp": 123,
"has_completed_onboarding": true,
"auto_activate_all_collections": true,
"shopify_is_multi_market": true,
"uses_cloudflare_ingestion": true,
"default_market_id": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Shopify App Bridge session token of the embedded Depict: Search & Merchandising app. The shop in the token determines the merchant; merchant_id parameters must belong to that shop.
Response
The created or reinstalled merchant.
Currency of the default market (ISO 4217).
Collection grid columns on desktop.
Collection grid columns on mobile.
The shop's *.myshopify.com domain.
The first full catalog import has finished.
Multi-store group the merchant belongs to, if any.
Product option name used to group variants in the collection grid (e.g. Color); null = no grouping.
Install time, epoch seconds.
New collections are activated for Depict sorting automatically.
Was this page helpful?