Skip to main content

Class: SettingsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:43

Extends​

  • BaseService

Constructors​

Constructor​

new SettingsService(client): SettingsService

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

Parameters​

client​

TanqoryClient

Returns​

SettingsService

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​

addPaymentMethod()​

addPaymentMethod(storeId, data): Promise<{ cardBrand: string; cardExpMonth: number; cardExpYear: number; cardLast4: string; createdAt: string; id: string; isDefault: boolean; paypalEmail: string; stripePaymentMethodId: string; type: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:191

Parameters​

storeId​

string

data​
isDefault?​

boolean

paymentMethodId?​

string

setAsDefault?​

boolean

stripePaymentMethodId?​

string

Returns​

Promise<{ cardBrand: string; cardExpMonth: number; cardExpYear: number; cardLast4: string; createdAt: string; id: string; isDefault: boolean; paypalEmail: string; stripePaymentMethodId: string; type: string; }>

addVATNumber()​

addVATNumber(storeId, taxId, taxIdType?): Promise<{ taxId: string; taxIdType: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:228

Parameters​

storeId​

string

taxId​

string

taxIdType?​

string

Returns​

Promise<{ taxId: string; taxIdType: string; }>

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

calculateShippingRates()​

calculateShippingRates(data): Promise<Record<string, unknown>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:634

Parameters​

data​

Record<string, unknown>

Returns​

Promise<Record<string, unknown>>

cancelSubscription()​

cancelSubscription(storeId, cancelAtPeriodEnd?, reason?): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:290

Parameters​

storeId​

string

cancelAtPeriodEnd?​

boolean = true

reason?​

string

Returns​

Promise<any>

Deprecated​

Use SubscriptionService.cancelSubscription() instead

changeCurrency()​

changeCurrency(storeId, defaultCurrency, reason?): Promise<{ autoArchive: boolean; conversionFeePercent: number; defaultCurrency: string; fulfillmentMode: string; orderIdPrefix: string; orderIdSuffix: string; region: string; storeName: string; timezone: string; unitSystem: string; weightUnit: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:119

Change store default currency with optional reason for analytics

Parameters​

storeId​

string

Store ID

defaultCurrency​

string

ISO 4217 currency code (3 chars, e.g., "USD", "THB")

reason?​

"testing_payment_processors" | "default_currency_not_intended" | "relocating_business" | "experimenting_with_different_markets" | "other_reason"

Optional reason for currency change (for analytics/audit)

Returns​

Promise<{ autoArchive: boolean; conversionFeePercent: number; defaultCurrency: string; fulfillmentMode: string; orderIdPrefix: string; orderIdSuffix: string; region: string; storeName: string; timezone: string; unitSystem: string; weightUnit: string; }>

createFulfillmentService()​

createFulfillmentService(storeId, data): Promise<{ createdAt: string; email: string; enabled: boolean; id: string; name: string; updatedAt: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:599

Parameters​

storeId​

string

data​
email​

string

enabled?​

boolean

name​

string

Returns​

Promise<{ createdAt: string; email: string; enabled: boolean; id: string; name: string; updatedAt: string; }>

createPackage()​

createPackage(storeId, data): Promise<{ carrierId?: string; carrierName?: string; createdAt?: string; dimensionUnit: "cm" | "in" | "IN" | "CM"; height: number; id: string; isCarrierPackage?: boolean; isDefault: boolean; length: number; name: string; type: "box" | "envelope" | "soft_package" | "BOX" | "ENVELOPE" | "SOFT_PACK"; updatedAt?: string; weight: number; weightUnit: "kg" | "g" | "lb" | "oz" | "KG" | "LB" | "OZ" | "G"; width: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:457

Parameters​

storeId​

string

data​

Omit<ShippingPackage, "id">

Returns​

Promise<{ carrierId?: string; carrierName?: string; createdAt?: string; dimensionUnit: "cm" | "in" | "IN" | "CM"; height: number; id: string; isCarrierPackage?: boolean; isDefault: boolean; length: number; name: string; type: "box" | "envelope" | "soft_package" | "BOX" | "ENVELOPE" | "SOFT_PACK"; updatedAt?: string; weight: number; weightUnit: "kg" | "g" | "lb" | "oz" | "KG" | "LB" | "OZ" | "G"; width: number; }>

createShippingRate()​

createShippingRate(storeId, zoneId, data): Promise<{ conditionMax?: number; conditionMin?: number; conditionType?: string; createdAt: string; currency: string; description?: string; id: string; maxDays?: number; minDays?: number; name: string; price: number; sortOrder: number; updatedAt: string; zoneId: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:494

Parameters​

storeId​

string

zoneId​

string

data​

Record<string, unknown>

Returns​

Promise<{ conditionMax?: number; conditionMin?: number; conditionType?: string; createdAt: string; currency: string; description?: string; id: string; maxDays?: number; minDays?: number; name: string; price: number; sortOrder: number; updatedAt: string; zoneId: string; }>

createShippingZone()​

createShippingZone(storeId, data): Promise<{ countries: string[]; createdAt: string; id: string; name: string; rates?: object[]; regions: string[]; shippingProfileId: string; updatedAt: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:544

Parameters​

storeId​

string

data​

Record<string, unknown>

Returns​

Promise<{ countries: string[]; createdAt: string; id: string; name: string; rates?: object[]; regions: string[]; shippingProfileId: string; updatedAt: string; }>

deleteFulfillmentService()​

deleteFulfillmentService(storeId, serviceId): Promise<DeletedResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:626

Parameters​

storeId​

string

serviceId​

string

Returns​

Promise<DeletedResponse>

deletePackage()​

deletePackage(storeId, packageId): Promise<DeletedResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:480

Parameters​

storeId​

string

packageId​

string

Returns​

Promise<DeletedResponse>

deleteShippingRate()​

deleteShippingRate(storeId, zoneId, rateId): Promise<DeletedResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:523

Parameters​

storeId​

string

zoneId​

string

rateId​

string

Returns​

Promise<DeletedResponse>

deleteShippingZone()​

deleteShippingZone(storeId, zoneId): Promise<DeletedResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:571

Parameters​

storeId​

string

zoneId​

string

Returns​

Promise<DeletedResponse>

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

get()​

get(storeId): Promise<unknown>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:44

Parameters​

storeId​

string

Returns​

Promise<unknown>

getAvailablePlans()​

getAvailablePlans(): Promise<object[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:280

Returns​

Promise<object[]>

Deprecated​

Use SubscriptionService.getPlans() instead

getBillDetails()​

getBillDetails(billId): Promise<{ createdAt: string; currency: string; discount: number; dueDate: string; hostedInvoiceUrl: string; id: string; invoiceDate: string; invoiceNumber: string; lineItems: object[]; paidAt: string; pdfUrl: string; periodEnd: string; periodStart: string; status: string; stripeInvoiceId: string; subtotal: number; tax: number; totalAmount: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:266

Parameters​

billId​

string

Returns​

Promise<{ createdAt: string; currency: string; discount: number; dueDate: string; hostedInvoiceUrl: string; id: string; invoiceDate: string; invoiceNumber: string; lineItems: object[]; paidAt: string; pdfUrl: string; periodEnd: string; periodStart: string; status: string; stripeInvoiceId: string; subtotal: number; tax: number; totalAmount: number; }>

getBillingPreferences()​

getBillingPreferences(storeId): Promise<{ city: string; company: string; country: string; district: string; email: string; postalCode: string; province: string; state: string; street: string; subDistrict: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:641

Parameters​

storeId​

string

Returns​

Promise<{ city: string; company: string; country: string; district: string; email: string; postalCode: string; province: string; state: string; street: string; subDistrict: string; }>

getBillingProfile()​

getBillingProfile(storeId): Promise<object[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:183

Parameters​

storeId​

string

Returns​

Promise<object[]>

getCurrencies()​

getCurrencies(): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:109

Returns​

Promise<any>

getCurrencyFormatting()​

getCurrencyFormatting(storeId): Promise<{ emailWithCurrency: string; emailWithoutCurrency: string; htmlWithCurrency: string; htmlWithoutCurrency: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:146

Parameters​

storeId​

string

Returns​

Promise<{ emailWithCurrency: string; emailWithoutCurrency: string; htmlWithCurrency: string; htmlWithoutCurrency: string; }>

getCurrentPlan()​

getCurrentPlan(storeId): Promise<{ billingPeriod: string; currency: string; features: Record<string, unknown>; limits: Record<string, unknown>; nextBillingDate: string; planName: string; price: number; status: string; trialEndsAt: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:272

Parameters​

storeId​

string

Returns​

Promise<{ billingPeriod: string; currency: string; features: Record<string, unknown>; limits: Record<string, unknown>; nextBillingDate: string; planName: string; price: number; status: string; trialEndsAt: string; }>

getEstimatedDatesSettings()​

getEstimatedDatesSettings(storeId): Promise<Record<string, unknown>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:403

Parameters​

storeId​

string

Returns​

Promise<Record<string, unknown>>

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

getFulfillmentServices()​

getFulfillmentServices(storeId, params?): Promise<ListResponse<{ createdAt: string; email: string; enabled: boolean; id: string; name: string; updatedAt: string; }>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:590

Parameters​

storeId​

string

params?​
limit?​

number

page?​

number

Returns​

Promise<ListResponse<{ createdAt: string; email: string; enabled: boolean; id: string; name: string; updatedAt: string; }>>

getLocalDeliverySettings()​

getLocalDeliverySettings(storeId): Promise<object[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:416

Parameters​

storeId​

string

Returns​

Promise<object[]>

getNotifications()​

getNotifications(storeId): Promise<unknown>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:54

Parameters​

storeId​

string

Returns​

Promise<unknown>

getPackages()​

getPackages(storeId, params?): Promise<ListResponse<{ carrierId?: string; carrierName?: string; createdAt?: string; dimensionUnit: "cm" | "in" | "IN" | "CM"; height: number; id: string; isCarrierPackage?: boolean; isDefault: boolean; length: number; name: string; type: "box" | "envelope" | "soft_package" | "BOX" | "ENVELOPE" | "SOFT_PACK"; updatedAt?: string; weight: number; weightUnit: "kg" | "g" | "lb" | "oz" | "KG" | "LB" | "OZ" | "G"; width: number; }>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:448

Parameters​

storeId​

string

params?​
limit?​

number

page?​

number

Returns​

Promise<ListResponse<{ carrierId?: string; carrierName?: string; createdAt?: string; dimensionUnit: "cm" | "in" | "IN" | "CM"; height: number; id: string; isCarrierPackage?: boolean; isDefault: boolean; length: number; name: string; type: "box" | "envelope" | "soft_package" | "BOX" | "ENVELOPE" | "SOFT_PACK"; updatedAt?: string; weight: number; weightUnit: "kg" | "g" | "lb" | "oz" | "KG" | "LB" | "OZ" | "G"; width: number; }>>

getPastBills()​

getPastBills(storeId, params?): Promise<ListResponse<{ createdAt: string; currency: string; discount: number; dueDate: string; hostedInvoiceUrl: string; id: string; invoiceDate: string; invoiceNumber: string; lineItems: object[]; paidAt: string; pdfUrl: string; periodEnd: string; periodStart: string; status: string; stripeInvoiceId: string; subtotal: number; tax: number; totalAmount: number; }>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:168

Parameters​

storeId​

string

params?​
limit?​

number

page?​

number

Returns​

Promise<ListResponse<{ createdAt: string; currency: string; discount: number; dueDate: string; hostedInvoiceUrl: string; id: string; invoiceDate: string; invoiceNumber: string; lineItems: object[]; paidAt: string; pdfUrl: string; periodEnd: string; periodStart: string; status: string; stripeInvoiceId: string; subtotal: number; tax: number; totalAmount: number; }>>

getPayment()​

getPayment(storeId): Promise<unknown>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:64

Parameters​

storeId​

string

Returns​

Promise<unknown>

getPermissionRoles()​

getPermissionRoles(): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:326

Returns​

Promise<any>

getPermissionSettings()​

getPermissionSettings(): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:330

Returns​

Promise<any>

getPickupSettings()​

getPickupSettings(storeId): Promise<object[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:434

Parameters​

storeId​

string

Returns​

Promise<object[]>

getPlanBySlug()​

getPlanBySlug(slug): Promise<{ billingPeriod: string; createdAt: string; currency: string; description: string; displayName: string; displayOrder: number; features: Record<string, unknown>; id: string; isActive: boolean; isPopular: boolean; limits: Record<string, unknown>; monthlyPrice: string; name: string; price: string; slug: string; trialDays: number; updatedAt: string; yearlyPrice: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:321

Parameters​

slug​

string

Returns​

Promise<{ billingPeriod: string; createdAt: string; currency: string; description: string; displayName: string; displayOrder: number; features: Record<string, unknown>; id: string; isActive: boolean; isPopular: boolean; limits: Record<string, unknown>; monthlyPrice: string; name: string; price: string; slug: string; trialDays: number; updatedAt: string; yearlyPrice: string; }>

Deprecated​

Use SubscriptionService.getPlanBySlug() instead

getRegions()​

getRegions(): Promise<unknown>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:142

Returns​

Promise<unknown>

getRoles()​

getRoles(): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:360

Returns​

Promise<any>

getShippingRates()​

getShippingRates(storeId, zoneId): Promise<object[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:487

Parameters​

storeId​

string

zoneId​

string

Returns​

Promise<object[]>

getShippingSettings()​

getShippingSettings(storeId): Promise<{ customProcessingTime?: number; defaultPackageId?: string; estimatedDeliveryCustomUnit?: string; estimatedDeliveryCustomValue?: number; estimatedDeliveryMode?: string; estimatedDeliveryPreset?: string; processingTime?: number; shippingLabelNameType?: string; shippingLabelStoreName?: string; showEstimatedDates?: boolean; splitShippingEnabled?: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:390

Parameters​

storeId​

string

Returns​

Promise<{ customProcessingTime?: number; defaultPackageId?: string; estimatedDeliveryCustomUnit?: string; estimatedDeliveryCustomValue?: number; estimatedDeliveryMode?: string; estimatedDeliveryPreset?: string; processingTime?: number; shippingLabelNameType?: string; shippingLabelStoreName?: string; showEstimatedDates?: boolean; splitShippingEnabled?: boolean; }>

getShippingZones()​

getShippingZones(storeId): Promise<object[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:536

Parameters​

storeId​

string

Returns​

Promise<object[]>

getStoreDefaults()​

getStoreDefaults(storeId): Promise<{ autoArchive: boolean; conversionFeePercent: number; defaultCurrency: string; fulfillmentMode: string; orderIdPrefix: string; orderIdSuffix: string; region: string; storeName: string; timezone: string; unitSystem: string; weightUnit: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:91

Parameters​

storeId​

string

Returns​

Promise<{ autoArchive: boolean; conversionFeePercent: number; defaultCurrency: string; fulfillmentMode: string; orderIdPrefix: string; orderIdSuffix: string; region: string; storeName: string; timezone: string; unitSystem: string; weightUnit: string; }>

getStoreDetails()​

getStoreDetails(storeId): Promise<{ city: string; company: string; country: string; district: string; email: string; name: string; phone: string; postalCode: string; state: string; street: string; subDistrict: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:78

Parameters​

storeId​

string

Returns​

Promise<{ city: string; company: string; country: string; district: string; email: string; name: string; phone: string; postalCode: string; state: string; street: string; subDistrict: string; }>

getStoreInfrastructure()​

getStoreInfrastructure(storeId): Promise<unknown>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:104

Parameters​

storeId​

string

Returns​

Promise<unknown>

getStoreNameCustomization()​

getStoreNameCustomization(): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:579

Returns​

Promise<any>

getSubscriptions()​

getSubscriptions(storeId): Promise<{ billingPeriod: string; cancelAt: string; canceledAt: string; createdAt: string; currency: string; currentPeriodEnd: string; currentPeriodStart: string; description: string; displayName: string; displayOrder: number; features: Record<string, unknown>; id: string; isActive: boolean; isPopular: boolean; limits: Record<string, unknown>; monthlyPrice: string; name: string; object: "store_subscription"; paypalSubscriptionId: string; price: string; slug: string; stripeSubscriptionId: string; subscriptionStatus: string; trialDays: number; updatedAt: string; yearlyPrice: string; } | { features: Record<string, unknown>; limits: Record<string, unknown>; object: "trial"; planName: string; status: string; trialEndsAt: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:285

Parameters​

storeId​

string

Returns​

Promise<{ billingPeriod: string; cancelAt: string; canceledAt: string; createdAt: string; currency: string; currentPeriodEnd: string; currentPeriodStart: string; description: string; displayName: string; displayOrder: number; features: Record<string, unknown>; id: string; isActive: boolean; isPopular: boolean; limits: Record<string, unknown>; monthlyPrice: string; name: string; object: "store_subscription"; paypalSubscriptionId: string; price: string; slug: string; stripeSubscriptionId: string; subscriptionStatus: string; trialDays: number; updatedAt: string; yearlyPrice: string; } | { features: Record<string, unknown>; limits: Record<string, unknown>; object: "trial"; planName: string; status: string; trialEndsAt: string; }>

Deprecated​

Use SubscriptionService.getStoreSubscription() instead

getTaxId()​

getTaxId(storeId): Promise<{ taxId: string; taxIdType: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:239

Parameters​

storeId​

string

Returns​

Promise<{ taxId: string; taxIdType: string; }>

getTeamMembers()​

getTeamMembers(): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:369

Returns​

Promise<any>

getTeamRoles()​

getTeamRoles(): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:364

Returns​

Promise<any>

getTimezones()​

getTimezones(): Promise<unknown>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:138

Returns​

Promise<unknown>

getUpcomingBill()​

getUpcomingBill(storeId): Promise<unknown>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:163

Parameters​

storeId​

string

Returns​

Promise<unknown>

getUsers()​

getUsers(): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:340

Returns​

Promise<any>

inviteTeamMember()​

inviteTeamMember(email, role): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:373

Parameters​

email​

string

role​

string

Returns​

Promise<any>

inviteUser()​

inviteUser(email, role): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:344

Parameters​

email​

string

role​

string

Returns​

Promise<any>

removePaymentMethod()​

removePaymentMethod(storeId, paymentMethodId): Promise<DeletedResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:205

Parameters​

storeId​

string

paymentMethodId​

string

Returns​

Promise<DeletedResponse>

removeTeamMember()​

removeTeamMember(memberId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:379

Parameters​

memberId​

string

Returns​

Promise<any>

removeUser()​

removeUser(userId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:350

Parameters​

userId​

string

Returns​

Promise<any>

removeVATNumber()​

removeVATNumber(storeId): Promise<{ taxId: string; taxIdType: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:244

Parameters​

storeId​

string

Returns​

Promise<{ taxId: string; taxIdType: string; }>

setDefaultPaymentMethod()​

setDefaultPaymentMethod(storeId, paymentMethodId): Promise<{ cardBrand: string; cardExpMonth: number; cardExpYear: number; cardLast4: string; createdAt: string; id: string; isDefault: boolean; paypalEmail: string; stripePaymentMethodId: string; type: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:252

Parameters​

storeId​

string

paymentMethodId​

string

Returns​

Promise<{ cardBrand: string; cardExpMonth: number; cardExpYear: number; cardLast4: string; createdAt: string; id: string; isDefault: boolean; paypalEmail: string; stripePaymentMethodId: string; type: string; }>

subscribeToPlan()​

subscribeToPlan(storeId, planSlug, billingCycle, paymentMethodId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:305

Parameters​

storeId​

string

planSlug​

string

billingCycle​

"MONTHLY" | "YEARLY"

paymentMethodId​

string

Returns​

Promise<any>

Deprecated​

Use SubscriptionService.createSubscription() instead

update()​

update(storeId, data): Promise<unknown>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:48

Parameters​

storeId​

string

data​

Record<string, unknown>

Returns​

Promise<unknown>

updateBillingPreferences()​

updateBillingPreferences(storeId, data): Promise<{ city: string; company: string; country: string; district: string; email: string; postalCode: string; province: string; state: string; street: string; subDistrict: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:649

Parameters​

storeId​

string

data​
city?​

string

company?​

string

country?​

string

district?​

string

email?​

string

postalCode?​

string

province?​

string

state?​

string

street?​

string

subDistrict?​

string

Returns​

Promise<{ city: string; company: string; country: string; district: string; email: string; postalCode: string; province: string; state: string; street: string; subDistrict: string; }>

updateCurrencyFormatting()​

updateCurrencyFormatting(storeId, data): Promise<{ emailWithCurrency: string; emailWithoutCurrency: string; htmlWithCurrency: string; htmlWithoutCurrency: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:150

Parameters​

storeId​

string

data​

Partial<UpdateCurrencyFormattingInput>

Returns​

Promise<{ emailWithCurrency: string; emailWithoutCurrency: string; htmlWithCurrency: string; htmlWithoutCurrency: string; }>

updateEstimatedDatesSettings()​

updateEstimatedDatesSettings(storeId, data): Promise<Record<string, unknown>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:407

Parameters​

storeId​

string

data​

Record<string, unknown>

Returns​

Promise<Record<string, unknown>>

updateFulfillmentService()​

updateFulfillmentService(storeId, serviceId, data): Promise<{ createdAt: string; email: string; enabled: boolean; id: string; name: string; updatedAt: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:612

Parameters​

storeId​

string

serviceId​

string

data​

Partial<{ email: string; enabled: boolean; name: string; }>

Returns​

Promise<{ createdAt: string; email: string; enabled: boolean; id: string; name: string; updatedAt: string; }>

updateLocalDeliverySettings()​

updateLocalDeliverySettings(storeId, locationId, data): Promise<{ currency: string; deliveryEnabled: boolean; includeNeighboring: boolean; location?: { id: string; isActive: boolean; name: string; }; radiusUnit: string; zoneMode: string; zones: object[]; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:420

Parameters​

storeId​

string

locationId​

string

data​
currency​

string

deliveryEnabled​

boolean

includeNeighboring​

boolean

radiusUnit​

string

zoneMode​

string

zones​

object[]

Returns​

Promise<{ currency: string; deliveryEnabled: boolean; includeNeighboring: boolean; location?: { id: string; isActive: boolean; name: string; }; radiusUnit: string; zoneMode: string; zones: object[]; }>

updateNotifications()​

updateNotifications(storeId, data): Promise<unknown>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:58

Parameters​

storeId​

string

data​

Record<string, unknown>

Returns​

Promise<unknown>

updatePackage()​

updatePackage(storeId, packageId, data): Promise<{ carrierId?: string; carrierName?: string; createdAt?: string; dimensionUnit: "cm" | "in" | "IN" | "CM"; height: number; id: string; isCarrierPackage?: boolean; isDefault: boolean; length: number; name: string; type: "box" | "envelope" | "soft_package" | "BOX" | "ENVELOPE" | "SOFT_PACK"; updatedAt?: string; weight: number; weightUnit: "kg" | "g" | "lb" | "oz" | "KG" | "LB" | "OZ" | "G"; width: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:466

Parameters​

storeId​

string

packageId​

string

data​

Partial<ShippingPackage>

Returns​

Promise<{ carrierId?: string; carrierName?: string; createdAt?: string; dimensionUnit: "cm" | "in" | "IN" | "CM"; height: number; id: string; isCarrierPackage?: boolean; isDefault: boolean; length: number; name: string; type: "box" | "envelope" | "soft_package" | "BOX" | "ENVELOPE" | "SOFT_PACK"; updatedAt?: string; weight: number; weightUnit: "kg" | "g" | "lb" | "oz" | "KG" | "LB" | "OZ" | "G"; width: number; }>

updatePayment()​

updatePayment(storeId, data): Promise<unknown>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:68

Parameters​

storeId​

string

data​

Record<string, unknown>

Returns​

Promise<unknown>

updatePermissionSettings()​

updatePermissionSettings(data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:334

Parameters​

data​

any

Returns​

Promise<any>

updatePickupSettings()​

updatePickupSettings(storeId, locationId, data): Promise<{ differentProcessingTime: boolean; expectedPickupTime: string; location?: { id: string; isActive: boolean; name: string; }; pickupEnabled: boolean; pickupNotificationMessage: string; showAllLocations: boolean; transferLocationIds: string[]; transferProcessingTime: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:438

Parameters​

storeId​

string

locationId​

string

data​
differentProcessingTime​

boolean

expectedPickupTime​

string

pickupEnabled​

boolean

pickupNotificationMessage?​

string

showAllLocations​

boolean

transferLocationIds​

string[]

transferProcessingTime?​

string

Returns​

Promise<{ differentProcessingTime: boolean; expectedPickupTime: string; location?: { id: string; isActive: boolean; name: string; }; pickupEnabled: boolean; pickupNotificationMessage: string; showAllLocations: boolean; transferLocationIds: string[]; transferProcessingTime: string; }>

updateShippingRate()​

updateShippingRate(storeId, zoneId, rateId, data): Promise<{ conditionMax?: number; conditionMin?: number; conditionType?: string; createdAt: string; currency: string; description?: string; id: string; maxDays?: number; minDays?: number; name: string; price: number; sortOrder: number; updatedAt: string; zoneId: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:508

Parameters​

storeId​

string

zoneId​

string

rateId​

string

data​

Record<string, unknown>

Returns​

Promise<{ conditionMax?: number; conditionMin?: number; conditionType?: string; createdAt: string; currency: string; description?: string; id: string; maxDays?: number; minDays?: number; name: string; price: number; sortOrder: number; updatedAt: string; zoneId: string; }>

updateShippingSettings()​

updateShippingSettings(storeId, data): Promise<{ customProcessingTime?: number; defaultPackageId?: string; estimatedDeliveryCustomUnit?: string; estimatedDeliveryCustomValue?: number; estimatedDeliveryMode?: string; estimatedDeliveryPreset?: string; processingTime?: number; shippingLabelNameType?: string; shippingLabelStoreName?: string; showEstimatedDates?: boolean; splitShippingEnabled?: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:394

Parameters​

storeId​

string

data​

Partial<ShippingSettings>

Returns​

Promise<{ customProcessingTime?: number; defaultPackageId?: string; estimatedDeliveryCustomUnit?: string; estimatedDeliveryCustomValue?: number; estimatedDeliveryMode?: string; estimatedDeliveryPreset?: string; processingTime?: number; shippingLabelNameType?: string; shippingLabelStoreName?: string; showEstimatedDates?: boolean; splitShippingEnabled?: boolean; }>

updateShippingZone()​

updateShippingZone(storeId, zoneId, data): Promise<{ countries: string[]; createdAt: string; id: string; name: string; rates?: object[]; regions: string[]; shippingProfileId: string; updatedAt: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:557

Parameters​

storeId​

string

zoneId​

string

data​

Record<string, unknown>

Returns​

Promise<{ countries: string[]; createdAt: string; id: string; name: string; rates?: object[]; regions: string[]; shippingProfileId: string; updatedAt: string; }>

updateShopPromise()​

updateShopPromise(enabled): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:662

Parameters​

enabled​

boolean

Returns​

Promise<any>

updateStoreDefaults()​

updateStoreDefaults(storeId, data): Promise<{ autoArchive: boolean; conversionFeePercent: number; defaultCurrency: string; fulfillmentMode: string; orderIdPrefix: string; orderIdSuffix: string; region: string; storeName: string; timezone: string; unitSystem: string; weightUnit: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:95

Parameters​

storeId​

string

data​

UpdateStoreDefaultsInput

Returns​

Promise<{ autoArchive: boolean; conversionFeePercent: number; defaultCurrency: string; fulfillmentMode: string; orderIdPrefix: string; orderIdSuffix: string; region: string; storeName: string; timezone: string; unitSystem: string; weightUnit: string; }>

updateStoreDetails()​

updateStoreDetails(storeId, data): Promise<{ city: string; company: string; country: string; district: string; email: string; name: string; phone: string; postalCode: string; state: string; street: string; subDistrict: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:82

Parameters​

storeId​

string

data​

Partial<UpdateStoreInput>

Returns​

Promise<{ city: string; company: string; country: string; district: string; email: string; name: string; phone: string; postalCode: string; state: string; street: string; subDistrict: string; }>

updateStoreNameCustomization()​

updateStoreNameCustomization(data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:583

Parameters​

data​

any

Returns​

Promise<any>

updateTeamMemberRole()​

updateTeamMemberRole(memberId, role): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:383

Parameters​

memberId​

string

role​

string

Returns​

Promise<any>

updateUserRole()​

updateUserRole(userId, role): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:354

Parameters​

userId​

string

role​

string

Returns​

Promise<any>

validateTaxId()​

validateTaxId(storeId, taxId, countryCode): Promise<{ isValid: boolean; message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/settings.ts:213

Parameters​

storeId​

string

taxId​

string

countryCode​

string

Returns​

Promise<{ isValid: boolean; message: string; }>