@builtbystack/sq-shopify-theme-sdk

v0.0.34

Published

22 days ago

Downloads

677

0High
0Medium
0Low

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk

以下のScriptタグで読み込んでください。

@x.x.x で指定されているバージョンは適宜最新のものを利用してください。

SDKは名前空間 SQ 内に存在するため、SDKの初期化は new SQ.SDK() で行ってください。

<script src="https://unpkg.com/@builtbystack/[email protected]/dist/sq-shopify-theme-sdk.umd.js" defer></script>
<script type="text/javascript">
  window.onload = async () => {
    const sdk = new SQ.SDK({{ request.origin | json }});
  }
</script>

Classes

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / SDK

Class: SDK

Constructors

new SDK()

new SDK(apiURL): SDK

Parameters

• apiURL: string

Returns

SDK

Methods

DiscountUsageCreate()

DiscountUsageCreate(orderPriceAdjustmentRuleID): Promise<null | object>

DiscountUsageCreate は指定した注文価格調整の利用履歴を作成します。

Parameters

• orderPriceAdjustmentRuleID: string

利用する注文価格調整ルールのID

Returns

Promise<null | object>

getEstimatedShopifyCartLineItemPoint()

getEstimatedShopifyCartLineItemPoint(currencyCode, taxesIncluded, sku, quantity, unitPrice): Promise<null | EstimatedPoint>

Parameters

• currencyCode: CurrencyCode

• taxesIncluded: boolean

• sku: string

• quantity: number

• unitPrice: string

Returns

Promise<null | EstimatedPoint>

getEstimatedShopifyCartPoint()

getEstimatedShopifyCartPoint(currencyCode, taxesIncluded, lineItems): Promise<null | EstimatedPoint>

Parameters

• currencyCode: CurrencyCode

• taxesIncluded: boolean

• lineItems: CartLineItem[]

Returns

Promise<null | EstimatedPoint>

getHasBackOrderProductVariants()

getHasBackOrderProductVariants(id): Promise<null | boolean>

getHasBackOrderProductVariants はIDで指定した商品が持つ商品バリエーションに1つでも予約販売設定がされている場合trueを返します。指定したIDの商品が存在しない場合はnullを返します。

Parameters

• id: string

Returns

Promise<null | boolean>

getLocationAvailabilities()

getLocationAvailabilities(sku, first?, after?, isReverse?): Promise<LocationAvailabilities>

getLocationAvailabilities は渡されたSKUの各ロケーションにおける残り在庫の一覧を返します。

Parameters

• sku: string

在庫一覧を取得したい商品のSKU。

• first?: number

取得してくる個数。デフォルトは250。

• after?: string

ページングの値。指定しない場合先頭から取得してくる。

• isReverse?: boolean

並び順。デフォルトはfalse。

Returns

Promise<LocationAvailabilities>

getLocationAvailability()

getLocationAvailability(sku, locationID): Promise<LocationAvailability>

getLocationAvailability は渡されたSKUとLocationIDにおける在庫情報を返します。

Parameters

• sku: string

在庫情報を取得したい商品のSKU。

• locationID: string

在庫情報を取得したいLocationのID。

Returns

Promise<LocationAvailability>

getLocations()

getLocations(first?, after?, locationFilter?, isReverse?): Promise<Locations>

getLocations は ShopifyIntegration に紐づく LocationGroup の Location の一覧を取得します。

Parameters

• first?: number

取得してくる個数。デフォルトは250。

• after?: string

ページングの値。指定しない場合先頭から取得してくる。

• locationFilter?: LocationFilter

ロケーションのロケーションのフィルタリング条件。

• isReverse?: boolean

並び順。デフォルトはfalse。

Returns

Promise<Locations>

getMileChangeActivities()

getMileChangeActivities(first?, after?, isReverse?, sortKeys?): Promise<null | MileChangeActivities>

getMileChangeActivities は購入者のマイル変動履歴を返します。

Parameters

• first?: number

取得してくる個数。デフォルトは250。

• after?: string

ページングの値。指定しない場合先頭から取得してくる。

• isReverse?: boolean

並び順。デフォルトはfalse。

• sortKeys?: MileChangeActivitySortKey

ソートキー。CREATED_ATかMILE_CHANGE_CREATED_ATを渡す。デフォルトはCREATED_AT。

Returns

Promise<null | MileChangeActivities>

getMileItems()

getMileItems(first?, after?, isReverse?, sortKeys?): Promise<null | MileItems>

getMileItems は顧客が利用可能なマイル交換商品の一覧を返します。

Parameters

• first?: number

取得してくる個数。デフォルトは250。

• after?: string

ページングの値。指定しない場合先頭から取得してくる。

• isReverse?: boolean

並び順。デフォルトはfalse。

• sortKeys?: ShopifyMileItemSortKey

ソートキー。デフォルトはCREATED_AT。

Returns

Promise<null | MileItems>

getMileOrders()

getMileOrders(first?, after?, isReverse?, sortKeys?): Promise<null | MileOrders>

getMileOrders は顧客のマイル交換履歴の一覧を返します。

Parameters

• first?: number

取得してくる個数。デフォルトは250。

• after?: string

ページングの値。指定しない場合先頭から取得してくる。

• isReverse?: boolean

並び順。デフォルトはfalse。

• sortKeys?: MileOrderSortKey

ソートキー。デフォルトはCREATED_AT。

Returns

Promise<null | MileOrders>

getMiles()

getMiles(): Promise<null | Miles>

getMiles は、Miles は SDK から取得できるマイルの情報を返します。

Returns

Promise<null | Miles>

getPointCampaignOrderRuleTargetCustomerRank()

getPointCampaignOrderRuleTargetCustomerRank(): Promise<null | PointCampaignOrderRuleTargetCustomerRank>

Returns

Promise<null | PointCampaignOrderRuleTargetCustomerRank>

getPointChangeActivities()

getPointChangeActivities(first?, after?, isReverse?, sortKeys?): Promise<null | PointChangeActivities>

getPointChangeActivities は購入者のポイント変動履歴を返します。

Parameters

• first?: number

取得してくる個数。デフォルトは250。

• after?: string

ページングの値。指定しない場合先頭から取得してくる。

• isReverse?: boolean

並び順。デフォルトはfalse。

• sortKeys?: PointChangeActivitySortKey

ソートキー。CREATED_ATかPOINT_CHANGE_CREATED_ATを渡す。デフォルトはCREATED_AT。

Returns

Promise<null | PointChangeActivities>

getPoints()

getPoints(): Promise<null | Points>

getPoints は、Points は SDK から取得できるポイントの情報を返します。

Returns

Promise<null | Points>

getProduct()

getProduct(id, first?, after?, isReverse?, sortKeys?): Promise<null | Product>

Parameters

• id: string

• first?: number

• after?: string

• isReverse?: boolean

• sortKeys?: ProductVariantSortKeys

Returns

Promise<null | Product>

getPurchasingCustomerCurrentRank()

getPurchasingCustomerCurrentRank(): Promise<null | CustomerRank>

getPurchasingCustomerCurrentRank は購入者の現在のランク情報を返します。

Returns

Promise<null | CustomerRank>

getPurchasingCustomerDiscountCodeCount()

getPurchasingCustomerDiscountCodeCount(): Promise<number>

getPurchasingCustomerDiscountCodeCount は顧客に紐付くDiscountCodeの数を返します。

Returns

Promise<number>

getPurchasingCustomerDiscounts()

getPurchasingCustomerDiscounts(first?, after?, isReverse?): Promise<null | PurchasingCustomerDiscounts>

getPurchasingCustomerDiscounts は購入者の割引情報を返します。

Parameters

• first?: number

取得してくる個数。デフォルトは250。

• after?: string

ページングの値。指定しない場合先頭から取得してくる。

• isReverse?: boolean

並び順。デフォルトはfalse。

Returns

Promise<null | PurchasingCustomerDiscounts>

getPurchasingCustomerMetafield()

getPurchasingCustomerMetafield(namespace, key): Promise<null | PurchasingCustomerMetafield>

getPurchasingCustomerMetafield は渡されたnamespaceとkeyに一致する現在ログインしているCustomerのカスタムメタフィールドを返します。存在しない場合はnullを返します。

Parameters

• namespace: string

取得したいメタフィールドのnamespace。

• key: string

取得したいメタフィールドのkey。

Returns

Promise<null | PurchasingCustomerMetafield>

getPurchasingCustomerSMS()

getPurchasingCustomerSMS(): Promise<null | PurchasingCustomerSMS>

getPurchasingCustomerSMS は顧客のSMS認証情報を返します。

Returns

Promise<null | PurchasingCustomerSMS>

getPurchasingCustomerSharing()

getPurchasingCustomerSharing(): Promise<null | PurchasingCustomerSharing>

getPurchasingCustomerSharing は共有化している顧客情報を返します。

Returns

Promise<null | PurchasingCustomerSharing>

getSharingPurchasingCustomerCount()

getSharingPurchasingCustomerCount(): Promise<number>

getSharingPurchasingCustomerCount は顧客が共有化している数を返します。

Returns

Promise<number>

mileItemExchange()

mileItemExchange(mileItemID): Promise<null | MileOrder>

mileItemExchange は指定したマイル商品を交換します。

Parameters

• mileItemID: string

交換したいマイル商品のID。

Returns

Promise<null | MileOrder>

purchasingCustomerActivateCustomerSharing()

purchasingCustomerActivateCustomerSharing(email, activationCode): Promise<null | PurchasingCustomer>

purchasingCustomerActivateCustomerSharing はアクティベーションコードを入力して顧客を有効化する。

Parameters

• email: string

• activationCode: string

Returns

Promise<null | PurchasingCustomer>

purchasingCustomerSendCustomerSharingActivationCode()

purchasingCustomerSendCustomerSharingActivationCode(): Promise<null | CustomerSharingActivationCode>

purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信します。

Returns

Promise<null | CustomerSharingActivationCode>

purchasingCustomerSendSMSVerificationCode()

purchasingCustomerSendSMSVerificationCode(phone): Promise<null | PurchasingCustomerSMS>

purchasingCustomerSendSMSVerificationCode は指定された電話番号に対して、SMS認証用コード(数字6桁)を送信します。

Parameters

• phone: string

SMS認証コードを送信する電話番号

Returns

Promise<null | PurchasingCustomerSMS>

purchasingCustomerVerifySMS()

purchasingCustomerVerifySMS(phone, verificationCode): Promise<null | PurchasingCustomerSMS>

purchasingCustomerVerifySMS はSMS認証用コード(数字6桁)を指定して、SMS認証を行います。

Parameters

• phone: string

SMS認証コードを送信した電話番号

• verificationCode: string

SMS認証用コード

Returns

Promise<null | PurchasingCustomerSMS>

Enumerations

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / CurrencyCode

Enumeration: CurrencyCode

CurrencyCode は通貨コードを表す

Enumeration Members

Eur

Eur: "EUR"

Jpy

Jpy: "JPY"

Usd

Usd: "USD"

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / LocationType

Enumeration: LocationType

LocationType はロケーションの種別を表す

Enumeration Members

Retail

Retail: "RETAIL"

店舗

Warehouse

Warehouse: "WAREHOUSE"

倉庫

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk

Enumerations

Classes

Type Aliases

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / Address

Type Alias: Address

Address: object

Address はLocationの住所を表す。

Type declaration

address1

address1: string

address2

address2: string

city

city: string

country

country: string

countryCode

countryCode: string

id

id: string

postalCode

postalCode: string

province

province: string

provinceCode

provinceCode: string

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / CartLineItem

Type Alias: CartLineItem

CartLineItem: object

CartLineItem はカートの商品明細情報を表す

Type declaration

quantity

quantity: number

商品の数量

sku

sku: string

商品のSKU

unitPrice

unitPrice: string

商品の単価

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / CustomerRank

Type Alias: CustomerRank

CustomerRank: object

CustomerRank は会員ランクを表す。

Type declaration

calculationCondition

calculationCondition: CustomerRankCalculationCondition

この会員ランクを算出した際の条件

earnedPoint

earnedPoint: number

現在時刻時点を含む算出期間における顧客のリアルタイムな獲得ポイント数

earnedPointToRankUp

earnedPointToRankUp: number

ランクアップするために必要な残り獲得ポイント

higherRank?

optional higherRank: CustomerRankRule

この会員ランクの一段階上の会員ランク。上の会員ランクが存在しない場合はnull

id

id: string

lowerRank?

optional lowerRank: CustomerRankRule

この会員ランクの一段階下の会員ランク。下の会員ランクが存在しない場合はnull

name

name: string

会員ランク名

pointMultiplier?

optional pointMultiplier: PointMultiplierCustomerRankRule

この会員ランクの注文時ポイント倍率。ポイント設定がなかったり、ポイント設定があってもポイント倍率設定がなければnullが返る

purchasePrice

purchasePrice: number

現在時刻時点を含む算出期間における顧客のリアルタイムな購入金額

purchasePriceToRankUp

purchasePriceToRankUp: number

ランクアップするために必要な残り購入金額

threshold

threshold: number

この会員ランクへのランクアップに必要な値。会員ランクの算出方法によりthresholdが指す値は異なり、獲得ポイントと購入金額のどちらかになる

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / CustomerRankCalculationCondition

Type Alias: CustomerRankCalculationCondition

CustomerRankCalculationCondition: object

CustomerRankCalculationCondition は会員ランクの算出条件を表す。

Type declaration

customerRankCalculationPeriod?

optional customerRankCalculationPeriod: CustomerRankCalculationPeriod

会員ランク算出期間。期間が無期限の場合はnullを返す

earnedPoint

earnedPoint: number

会員ランクの算出根拠となる獲得ポイント

purchasePrice

purchasePrice: number

会員ランクの算出根拠となる購入金額

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / CustomerRankCalculationPeriod

Type Alias: CustomerRankCalculationPeriod

CustomerRankCalculationPeriod: object

CustomerRankCalculationPeriod は会員ランクの算出期間を表す。

Type declaration

end

end: Date

集計期間終了日

start

start: Date

集計期間開始日

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / CustomerRankRule

Type Alias: CustomerRankRule

CustomerRankRule: object

CustomerRankRule は会員ランクのルールを表す。

Type declaration

id

id: string

name

name: string

会員ランク名

threshold

threshold: number

この会員ランクへのランクアップに必要な値。会員ランクの算出方法によりthresholdが指す値は異なり、獲得ポイントと購入金額のどちらかになる。

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / CustomerSharingActivationCode

Type Alias: CustomerSharingActivationCode

CustomerSharingActivationCode: object

Type declaration

customerSharingActivationCodeID

customerSharingActivationCodeID: string

purchasingCustomer

purchasingCustomer: PurchasingCustomer

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / EstimatedPoint

Type Alias: EstimatedPoint

EstimatedPoint: object

EstimatedPoint は獲得予想ポイントを表す

Type declaration

pointCampaign?

optional pointCampaign: EstimatedPointCampaign

適用されるポイントキャンペーン注文日時に開催期間内で条件を満たすキャンペーンが存在しなかった場合はnilを返すカートの場合、明細ごとのポイント計算ロジック内でポイントが加算されるため、ポイントキャンペーンの種別が「商品」の場合もnilを返す商品に適用されるポイントキャンペーンはgetEstimatedShopifyCartLineItemPointから取得が可能

pointsEarning

pointsEarning: number

ポイントキャンペーン適用前の獲得予想ポイント

totalPointsEarning

totalPointsEarning: number

ポイントキャンペーン適用後の獲得予想ポイント

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / EstimatedPointCampaign

Type Alias: EstimatedPointCampaign

EstimatedPointCampaign: object

Type declaration

pointCampaignOrderRule

pointCampaignOrderRule: PointCampaignOrderRule

pointsEarning

pointsEarning: number

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / InventoryItem

Type Alias: InventoryItem

InventoryItem: object

InventoryItem は在庫情報を表す。

Type declaration

id

id: string

sku

sku: string

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / Location

Type Alias: Location

Location: object

Location は ShopifyIntegration に紐付いている Location を表す。

Type declaration

address?

optional address: Address

id

id: string

mapURL?

optional mapURL: string

name

name: string

phone

phone: string

Type Alias: LocationAvailabilities

LocationAvailabilities: object

LocationAvailabilities は LocationAvailability の一覧を取得するための情報を表す。

Type declaration

nodes

nodes: LocationAvailability[]

pageInfo

pageInfo: PageInfo

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / LocationAvailability

Type Alias: LocationAvailability

LocationAvailability: object

LocationAvailability はLocationの在庫情報を表す。

Type declaration

inventoryQuantity

inventoryQuantity: number

inventoryQuantity は在庫数を表す。

location

location: Location

location は在庫のLocationを表す。

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / LocationFilter

Type Alias: LocationFilter

LocationFilter: object

LocationType はロケーションのフィルタリング条件を表現するオブジェクト

Type declaration

locationType?

optional locationType: LocationType

ロケーションの種別

provinceCodes?

optional provinceCodes: string[]

ロケーションの都道府県コード

tag?

optional tag: string

ロケーションのタグ

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / Locations

Type Alias: Locations

Locations: object

Locations は Location の一覧を取得するための情報を表す。

Type declaration

nodes

nodes: Location[]

pageInfo

pageInfo: PageInfo

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / MileChange

Type Alias: MileChange

MileChange: object

MileChange はマイルの変動を表す。

Type declaration

createdAt

createdAt: Date

MileChangeのコミットタイムスタンプ

delta

delta: number

マイル変動の数値。正負どちらの値も取りうる。

id

id: string

mileChangeCreatedAt

mileChangeCreatedAt: Date

マイルの発生日時

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / MileChangeActivities

Type Alias: MileChangeActivities

MileChangeActivities: object

MileChangeActivities はマイルの変動の履歴一覧を表す。

Type declaration

nodes

nodes: MileChangeActivity[]

pageInfo

pageInfo: PageInfo

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / MileChangeActivity

Type Alias: MileChangeActivity

MileChangeActivity: object

MileChangeActivity はマイルの変動の履歴を表す。

Type declaration

id

id: string

mileChange

mileChange: MileChange

title

title: string

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / MileItem

Type Alias: MileItem

MileItem: object

MileItem はマイル商品の情報を表す。

Type declaration

customerExchangeable

customerExchangeable: boolean

交換可能かどうか

description

description: string

マイル商品の説明

endsAt?

optional endsAt: Date

交換可能期間の終了日時

id

id: string

オブジェクトのID

isActive

isActive: boolean

現在交換可能かどうか

isScheduled

isScheduled: boolean

交換開始前かどうか

miles

miles: number

マイル商品の画像URL

sku

sku: string

マイル商品のSKU

startsAt

startsAt: Date

交換可能期間の開始日時

title

title: string

マイル商品のタイトル

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / MileItems

Type Alias: MileItems

MileItems: object

MileItems はマイル商品の一覧を取得するための情報を表す。

Type declaration

nodes

nodes: MileItem[]

pageInfo

pageInfo: PageInfo

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / MileOrder

Type Alias: MileOrder

MileOrder: object

Type declaration

exchangedAt

exchangedAt: Date

交換日時

id

id: string

オブジェクトのID

isCancelled

isCancelled: boolean

Shopifyマイル交換履歴をキャンセルしたかどうか

mileItem

mileItem: MileItem

交換したマイル商品

miles

miles: number

使用したマイル数

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / MileOrders

Type Alias: MileOrders

MileOrders: object

MileOrders はマイル商品の交換履歴の一覧を取得するための情報を表す。

Type declaration

nodes

nodes: MileOrder[]

pageInfo

pageInfo: PageInfo

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / Miles

Type Alias: Miles

Miles: object

Miles は SDK から取得できるマイルの情報を表す。

Type declaration

miles

miles: number

Miles は保有マイルを表す。

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / PageInfo

Type Alias: PageInfo

PageInfo: object

PageInfo はページングを伴って一覧を取得したときに、その一覧のページングの情報を表す。

Type declaration

endCursor

endCursor: string

endCursor は一覧の末尾のカーソルを表す。このカーソルを使って次のページを取得することができる。

hasNextPage

hasNextPage: boolean

hasNextPage は次のページがあるかどうかを表す。

hasPreviousPage

hasPreviousPage: boolean

hasPreviousPage は前のページがあるかどうかを表す。

startCursor

startCursor: string

startCursor は一覧の先頭のカーソルを表す。

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / PointCampaignOrderRule

Type Alias: PointCampaignOrderRule

PointCampaignOrderRule: object

PointCampaignOrderRule はポイントキャンペーンの設定を表す。

Type declaration

id

id: string

pointMethod

pointMethod: string

キャンペーンポイントの計算方法

targetType

targetType: string

キャンペーンポイント付与対象の種別

title

title: string

キャンペーンのタイトル

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / PointCampaignOrderRuleTargetCustomerRank

Type Alias: PointCampaignOrderRuleTargetCustomerRank

PointCampaignOrderRuleTargetCustomerRank: object

PointCampaignOrderRuleTargetCustomerRank は会員ランク種別のポイントキャンペーンの設定を表す。以下の場合はnullを返す

開催期間中であるキャンペーンが存在しない場合
存在するが種別が会員ランクではない場合
未ログインの場合

Type declaration

fixedPoint?

optional fixedPoint: string

顧客に適用されるキャンペーン固定ポイント以下の場合はnullを返す

該当キャンペーンが存在しない場合
未ログイン状態の場合
計算方法が固定ポイントでない場合

multiplier?

optional multiplier: string

顧客に適用されるキャンペーン倍率以下の場合はnullを返す

該当キャンペーンが存在しない場合
未ログイン状態の場合
計算方法が倍率でない場合

pointCampaignOrderRule

pointCampaignOrderRule: PointCampaignOrderRule

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / PointChange

Type Alias: PointChange

PointChange: object

PointChange はポイントの変動を表す。

Type declaration

availableAt?

optional availableAt: Date

ポイントが利用可能になる日時。nilの場合はまだ利用可能になる日時が決まっていない。主に未配送注文に関するポイントはnilになる。

availableUntil?

optional availableUntil: Date

ポイントが利用できる期限。失効する直前を表すため、expiresDateから1ナノ秒を引いた値となる。例えば、expiresDateが 2024-06-12 00:00:00 なら、availableUntilは 2024-06-11 23:59:59.999999999 となる。

createdAt

createdAt: Date

PointChangeのコミットタイムスタンプ

delta

delta: number

ポイント変動の数値。正負どちらの値も取りうる。

expiresDate?

optional expiresDate: Date

ポイントの失効日。nilの場合はまだ失効日が決まっていない。ポイント消費や、未配送注文に関するポイントはnilになる。

id

id: string

pointChangeCreatedAt

pointChangeCreatedAt: Date

ポイントの発生日時

tenant

tenant: Tenant

ポイントに紐づくテナント情報

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / PointChangeActivities

Type Alias: PointChangeActivities

PointChangeActivities: object

PointChangeActivities はポイントの変動の履歴一覧を表す。

Type declaration

nodes

nodes: PointChangeActivity[]

pageInfo

pageInfo: PageInfo

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / PointChangeActivity

Type Alias: PointChangeActivity

PointChangeActivity: object

PointChangeActivity はポイントの変動の履歴を表す。

Type declaration

id

id: string

pointChange

pointChange: PointChange

retailLocation?

optional retailLocation: Location

tenant

tenant: Tenant

title

title: string

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / PointMultiplierCustomerRankRule

Type Alias: PointMultiplierCustomerRankRule

PointMultiplierCustomerRankRule: object

PointMultiplierCustomerRankRule はこの会員ランクの注文時ポイント倍率を表す。

Type declaration

customerRankRule

customerRankRule: CustomerRankRule

id

id: string

multiplier

multiplier: string

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / Points

Type Alias: Points

Points: object

Points は SDK から取得できるポイントの情報を表す。

Type declaration

pointsApproved

pointsApproved: number

PointsApproved は保有ポイントを表す。

pointsExpiringSoon?

optional pointsExpiringSoon: object

PointsExpiringSoon は最も直近の失効予定ポイントを表す。

pointsExpiringSoon.availableUntil

availableUntil: Date

availableUntil は最も直近の失効予定ポイントが利用できる期限を表す。失効する直前を表すため、expiresDate から1ナノ秒を引いた値となる。例えば、expiresDate が 2024-06-12 00:00:00 なら、availableUntil は 2024-06-11 23:59:59.999999999 となる。

pointsExpiringSoon.expiresDate

expiresDate: Date

expiresDate は最も直近の失効日を表す。

pointsExpiringSoon.points

points: number

points は最も直近の失効予定ポイントを表す。

pointsPending

pointsPending: number

PointsPending は獲得予定ポイントを表す。

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / Product

Type Alias: Product

Product: object

Product は商品情報を表す。

Type declaration

hasBackOrderProductVariants

hasBackOrderProductVariants: boolean

商品が持つバリエーションに1つでも予約販売設定がされている場合trueが返る

id

id: string

isLocalPickupAvailable

isLocalPickupAvailable: boolean

商品の店舗受取が可能な場合にtrueが返る

title

title: string

商品のタイトル

variants

variants: ProductVariants

商品のバリエーション一覧

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / ProductVariant

Type Alias: ProductVariant

ProductVariant: object

ProductVariant は商品のバリエーションを表す。

Type declaration

id

id: string

inventoryItem

inventoryItem: InventoryItem

在庫情報

isBackOrderEnable

isBackOrderEnable: boolean

予約販売が設定されている場合にtrueが返る

isLocalPickupAvailable

isLocalPickupAvailable: boolean

商品の店舗受取が可能な場合にtrueが返る

title

title: string

商品バリエーションのタイトル

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / ProductVariants

Type Alias: ProductVariants

ProductVariants: object

ProductVariants は商品のバリエーションの一覧を取得するための情報を表す。

Type declaration

nodes

nodes: ProductVariant[]

pageInfo

pageInfo: PageInfo

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / PurchasingCustomer

Type Alias: PurchasingCustomer

PurchasingCustomer: object

Type declaration

id

id: string

sharingPurchasingCustomerCount

sharingPurchasingCustomerCount: number

tenant

tenant: Tenant

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / PurchasingCustomerDiscount

Type Alias: PurchasingCustomerDiscount

PurchasingCustomerDiscount: object

PurchasingCustomerDiscount は購入者の割引情報を表す。

Type declaration

applicableLocationCount

applicableLocationCount: number

code

code: string

createdAt

createdAt: Date

customerApplicable

customerApplicable: boolean

Discountがこの顧客で有効かどうかを表す。

description

description: string

endsAt

endsAt: Date

hasApplicableLocations

hasApplicableLocations: boolean

id

id: string

shopifyStoreApplicable

shopifyStoreApplicable: boolean

startsAt

startsAt: Date

status

status: string

Discountのステータス。"ACTIVE", "SCHEDULED", "EXPIRED" のいずれかが入る。

title

title: string

updatedAt

updatedAt: Date

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / PurchasingCustomerDiscounts

Type Alias: PurchasingCustomerDiscounts

PurchasingCustomerDiscounts: object

PurchasingCustomerDiscounts は PurchasingCustomerDiscount の一覧を取得するための情報を表す。

Type declaration

id

id: string

nodes

nodes: PurchasingCustomerDiscount[]

pageInfo

pageInfo: PageInfo

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / PurchasingCustomerMetafield

Type Alias: PurchasingCustomerMetafield

PurchasingCustomerMetafield: object

PurchasingCustomerMetafield は購入者のカスタムメタフィールドを表す。

Type declaration

id

id: string

key

key: string

namespace

namespace: string

value

value: string

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / PurchasingCustomerSMS

Type Alias: PurchasingCustomerSMS

PurchasingCustomerSMS: object

PurchasingCustomerSMS は、顧客のSMS認証情報を表す。

Type declaration

id

id: string

smsVerified

smsVerified: boolean

この会員がSMS認証を行ったかどうかを表すフラグ

smsVerifiedPhone

smsVerifiedPhone: string

この会員がSMS認証を行った電話番号

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / PurchasingCustomerSharing

Type Alias: PurchasingCustomerSharing

PurchasingCustomerSharing: object

Type declaration

id

id: string

purchasingCustomers

purchasingCustomers: PurchasingCustomer[]

@builtbystack/sq-shopify-theme-sdk • Docs

@builtbystack/sq-shopify-theme-sdk / Tenant

Type Alias: Tenant

Tenant: object

Tenant はテナント情報を表す。

Type declaration

id

id: string

name

name: string

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@builtbystack/sq-shopify-theme-sdk

Classes

Class: SDK

Constructors

new SDK()

Parameters

Returns

Methods

DiscountUsageCreate()

Parameters

Returns

getEstimatedShopifyCartLineItemPoint()

Parameters

Returns

getEstimatedShopifyCartPoint()

Parameters

Returns

getHasBackOrderProductVariants()

Parameters

Returns

getLocationAvailabilities()

Parameters

Returns

getLocationAvailability()

Parameters

Returns

getLocations()

Parameters

Returns

getMileChangeActivities()

Parameters

Returns

getMileItems()

Parameters

Returns

getMileOrders()

Parameters

Returns

getMiles()

Returns

getPointCampaignOrderRuleTargetCustomerRank()

Returns

getPointChangeActivities()

Parameters

Returns

getPoints()

Returns

getProduct()

Parameters

Returns

getPurchasingCustomerCurrentRank()

Returns

getPurchasingCustomerDiscountCodeCount()

Returns

getPurchasingCustomerDiscounts()

Parameters

Returns

getPurchasingCustomerMetafield()

Parameters

Returns

getPurchasingCustomerSMS()

Returns

getPurchasingCustomerSharing()

Returns

getSharingPurchasingCustomerCount()

Returns

mileItemExchange()

Parameters

Returns

purchasingCustomerActivateCustomerSharing()

Parameters

Returns

purchasingCustomerSendCustomerSharingActivationCode()

Returns