Class: SellingPlansService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:63

Extends

• BaseService

Constructors

Constructor

new SellingPlansService(client): SellingPlansService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:12

Parameters

client

TanqoryClient

Returns

SellingPlansService

Inherited from

BaseService.constructor

Properties

client

protected client: TanqoryClient

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:10

Inherited from

BaseService.client

Methods

associateProducts()

associateProducts(storeId, groupId, productIds): Promise<AssociateProductsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:186

Associate products with a selling plan group

Parameters

storeId

string

groupId

string

productIds

string[]

Returns

Promise<AssociateProductsResponse>

---

associateVariants()

associateVariants(storeId, groupId, variantIds): Promise<AssociateVariantsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:216

Associate variants with a selling plan group

Parameters

storeId

string

groupId

string

variantIds

string[]

Returns

Promise<AssociateVariantsResponse>

---

buildQuery()

protected buildQuery(options?): Record<string, any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:26

Build query parameters

Parameters

options?

ListOptions

Returns

Record<string, any>

Inherited from

BaseService.buildQuery

---

create()

create(storeId, data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:93

Create a new selling plan group

Parameters

storeId

string

data

description?

string

isActive

boolean

merchantCode?

string

name

string

options?

object[]

position

number

sellingPlans?

object[]

slug?

string

Returns

Promise<any>

---

createPlan()

createPlan(storeId, groupId, data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:144

Create a selling plan in a group

Parameters

storeId

string

groupId

string

data

billingPolicy

{ interval: "DAY" | "WEEK" | "MONTH" | "YEAR"; intervalCount: number; maxCycles?: number; minCycles?: number; }

billingPolicy.interval

"DAY" | "WEEK" | "MONTH" | "YEAR"

billingPolicy.intervalCount

number

billingPolicy.maxCycles?

number

billingPolicy.minCycles?

number

category

"SUBSCRIPTION" | "PRE_ORDER" | "TRY_BEFORE_YOU_BUY"

deliveryPolicy

{ anchors?: object[]; cutoff?: number; interval: "DAY" | "WEEK" | "MONTH" | "YEAR"; intervalCount: number; preAnchorBehavior: "ASAP" | "NEXT"; }

deliveryPolicy.anchors?

object[]

deliveryPolicy.cutoff?

number

deliveryPolicy.interval

"DAY" | "WEEK" | "MONTH" | "YEAR"

deliveryPolicy.intervalCount

number

deliveryPolicy.preAnchorBehavior

"ASAP" | "NEXT"

description?

string

inventoryPolicy?

{ reserve: "ON_SALE" | "ON_FULFILLMENT"; }

inventoryPolicy.reserve

"ON_SALE" | "ON_FULFILLMENT"

name

string

options?

object[]

position

number

pricingPolicies

object[]

Returns

Promise<any>

---

delete()

delete(storeId, groupId): Promise<DeleteResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:122

Delete a selling plan group

Parameters

storeId

string

groupId

string

Returns

Promise<DeleteResponse>

---

deletePlan()

deletePlan(storeId, planId): Promise<DeleteResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:174

Delete a selling plan

Parameters

storeId

string

planId

string

Returns

Promise<DeleteResponse>

---

dissociateProducts()

dissociateProducts(storeId, groupId, productIds): Promise<DeleteResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:201

Remove products from a selling plan group

Parameters

storeId

string

groupId

string

productIds

string[]

Returns

Promise<DeleteResponse>

---

dissociateVariants()

dissociateVariants(storeId, groupId, variantIds): Promise<DeleteResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:231

Remove variants from a selling plan group

Parameters

storeId

string

groupId

string

variantIds

string[]

Returns

Promise<DeleteResponse>

---

generateIdempotencyKey()

protected generateIdempotencyKey(prefix): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:19

Generate idempotency key

Parameters

prefix

string

Returns

string

Inherited from

BaseService.generateIdempotencyKey

---

getExportMimeType()

protected getExportMimeType(format): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:45

Get MIME type for export format

Parameters

format

string

Returns

string

Inherited from

BaseService.getExportMimeType

---

getGroupsForProduct()

getGroupsForProduct(storeId, productId): Promise<any[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:248

Get selling plan groups for a product

Parameters

storeId

string

productId

string

Returns

Promise<any[]>

---

getGroupsForVariant()

getGroupsForVariant(storeId, variantId): Promise<any[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:261

Get selling plan groups for a variant

Parameters

storeId

string

variantId

string

Returns

Promise<any[]>

---

getPlan()

getPlan(storeId, planId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:134

Get a single selling plan

Parameters

storeId

string

planId

string

Returns

Promise<any>

---

list()

list(storeId, params?): Promise<PaginatedSellingPlanGroupsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:69

List all selling plan groups for a store

Parameters

storeId

string

params?

isActive?

boolean

limit

number

page

number

search?

string

sortBy

"name" | "createdAt" | "position"

sortOrder

"asc" | "desc"

Returns

Promise<PaginatedSellingPlanGroupsResponse>

---

retrieve()

retrieve(storeId, groupId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:83

Get a single selling plan group by ID

Parameters

storeId

string

groupId

string

Returns

Promise<any>

---

update()

update(storeId, groupId, data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:107

Update a selling plan group

Parameters

storeId

string

groupId

string

data

description?

string

isActive?

boolean

merchantCode?

string

name?

string

options?

object[]

position?

number

sellingPlans?

object[]

slug?

string

Returns

Promise<any>

---

updatePlan()

updatePlan(storeId, planId, data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/selling-plans.ts:159

Update a selling plan

Parameters

storeId

string

planId

string

data

billingPolicy?

{ interval: "DAY" | "WEEK" | "MONTH" | "YEAR"; intervalCount: number; maxCycles?: number; minCycles?: number; }

billingPolicy.interval

"DAY" | "WEEK" | "MONTH" | "YEAR"

billingPolicy.intervalCount

number

billingPolicy.maxCycles?

number

billingPolicy.minCycles?

number

category?

"SUBSCRIPTION" | "PRE_ORDER" | "TRY_BEFORE_YOU_BUY"

deliveryPolicy?

{ anchors?: object[]; cutoff?: number; interval: "DAY" | "WEEK" | "MONTH" | "YEAR"; intervalCount: number; preAnchorBehavior: "ASAP" | "NEXT"; }

deliveryPolicy.anchors?

object[]

deliveryPolicy.cutoff?

number

deliveryPolicy.interval

"DAY" | "WEEK" | "MONTH" | "YEAR"

deliveryPolicy.intervalCount

number

deliveryPolicy.preAnchorBehavior

"ASAP" | "NEXT"

description?

string

inventoryPolicy?

{ reserve: "ON_SALE" | "ON_FULFILLMENT"; }

inventoryPolicy.reserve

"ON_SALE" | "ON_FULFILLMENT"

isActive?

boolean

name?

string

options?

object[]

position?

number

pricingPolicies?

object[]

Returns

Promise<any>