Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

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.

Path Parameters

merchant_id
string
required

Lite merchant id, e.g. shopify-<shop id>.

Response

The merchant.

id
string
required
display_name
string
required
base_currency
string
required

Currency of the default market (ISO 4217).

desktop_columns
integer
required

Collection grid columns on desktop.

mobile_columns
integer
required

Collection grid columns on mobile.

shopify_domain
string
required

The shop's *.myshopify.com domain.

shopify_app_installed
boolean
required
has_run_at_least_one_ingestion
boolean | null
required

The first full catalog import has finished.

multi_store_group_id
string | null
required

Multi-store group the merchant belongs to, if any.

multi_store_activation_code
string | null
required
variant_group_by_name
string | null
required

Product option name used to group variants in the collection grid (e.g. Color); null = no grouping.

start_timestamp
number | null

Install time, epoch seconds.

has_completed_onboarding
boolean
auto_activate_all_collections
boolean

New collections are activated for Depict sorting automatically.

shopify_is_multi_market
boolean
uses_cloudflare_ingestion
boolean
default_market_id
string | null