Interface ShopifyConnection

Hierarchy

ShopifyConnection

Index

Properties

Methods

Properties

configuration

configuration: ShopifyConnectionConfiguration

Configuration of the shopify connection

Optional current

current?: Shopify

Shopify client for the current in context shop or record

Optional currentShopId

currentShopId?: bigint

ID of the shop set up as the current in-context tenant for this context

Methods

forShop

forShop(remoteIdentifier: string): Shopify

deprecated
Use forShopId or forShopDomain instead

Parameters
- remoteIdentifier: string
  
  The Shopify domain
Returns Shopify
Shopify Client

forShopDomain

forShopDomain(shopDomain: string): Promise<Shopify>

Parameters
- shopDomain: string
  
  The Shopify domain
Returns Promise<Shopify>
Promise which resolves to a Shopify Client

forShopId

forShopId(shopId: string | bigint): Promise<Shopify>

Parameters
- shopId: string | bigint
  
  Shop ID from the Shop model
Returns Promise<Shopify>
Promise which resolves to a Shopify Client

setCurrentShop

setCurrentShop(shopId: bigint): Promise<void>

Parameters
- shopId: bigint
  
  to set for the current context
Returns Promise<void>
Resolves when the shop context has been updated

Generated using TypeDoc