Class: CustomerStoreCreditService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-store-credit.ts:20

Extends

• BaseService

Constructors

Constructor

new CustomerStoreCreditService(client): CustomerStoreCreditService

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

Parameters

client

TanqoryClient

Returns

CustomerStoreCreditService

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

adjustStoreCredit()

adjustStoreCredit(storeId, data): Promise<{ data: { amount: number; balanceAfter: number; balanceBefore: number; createdAt: string; createdBy?: string; createdByName?: string; currency: string; customerId: string; expiresAt?: string; id: string; note?: string; orderId?: string; orderNumber?: string; reason?: string; refundId?: string; returnId?: string; source?: "MANUAL" | "RETURN" | "TRANSFER" | "REFUND" | "PROMOTION" | "REWARD"; storeCreditId: string; type: "ADJUSTMENT" | "CREDIT" | "DEBIT" | "EXPIRY"; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-store-credit.ts:88

Adjust store credit balance

Parameters

storeId

string

Store ID

data

Adjustment data

amount

number

customerId

string

note?

string

reason

string

Returns

Promise<{ data: { amount: number; balanceAfter: number; balanceBefore: number; createdAt: string; createdBy?: string; createdByName?: string; currency: string; customerId: string; expiresAt?: string; id: string; note?: string; orderId?: string; orderNumber?: string; reason?: string; refundId?: string; returnId?: string; source?: "MANUAL" | "RETURN" | "TRANSFER" | "REFUND" | "PROMOTION" | "REWARD"; storeCreditId: string; type: "ADJUSTMENT" | "CREDIT" | "DEBIT" | "EXPIRY"; }; }>

Created transaction

---

applyStoreCredit()

applyStoreCredit(storeId, data): Promise<{ data: { amount: number; balanceAfter: number; balanceBefore: number; createdAt: string; createdBy?: string; createdByName?: string; currency: string; customerId: string; expiresAt?: string; id: string; note?: string; orderId?: string; orderNumber?: string; reason?: string; refundId?: string; returnId?: string; source?: "MANUAL" | "RETURN" | "TRANSFER" | "REFUND" | "PROMOTION" | "REWARD"; storeCreditId: string; type: "ADJUSTMENT" | "CREDIT" | "DEBIT" | "EXPIRY"; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-store-credit.ts:67

Apply store credit to an order

Parameters

storeId

string

Store ID

data

Apply credit data

amount

number

currency

string

customerId

string

orderId

string

Returns

Promise<{ data: { amount: number; balanceAfter: number; balanceBefore: number; createdAt: string; createdBy?: string; createdByName?: string; currency: string; customerId: string; expiresAt?: string; id: string; note?: string; orderId?: string; orderNumber?: string; reason?: string; refundId?: string; returnId?: string; source?: "MANUAL" | "RETURN" | "TRANSFER" | "REFUND" | "PROMOTION" | "REWARD"; storeCreditId: string; type: "ADJUSTMENT" | "CREDIT" | "DEBIT" | "EXPIRY"; }; }>

Created transaction

---

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

---

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

---

getStoreCredit()

getStoreCredit(storeId, customerId): Promise<{ data: { balance: number; currency: string; pendingExpiry: number; recentTransactions: object[]; totalIssued: number; totalUsed: number; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-store-credit.ts:32

Get store credit balance for a customer

Parameters

storeId

string

Store ID

customerId

string

Customer ID

Returns

Promise<{ data: { balance: number; currency: string; pendingExpiry: number; recentTransactions: object[]; totalIssued: number; totalUsed: number; }; }>

Store credit balance and summary

---

issueStoreCredit()

issueStoreCredit(storeId, data): Promise<{ data: { amount: number; balanceAfter: number; balanceBefore: number; createdAt: string; createdBy?: string; createdByName?: string; currency: string; customerId: string; expiresAt?: string; id: string; note?: string; orderId?: string; orderNumber?: string; reason?: string; refundId?: string; returnId?: string; source?: "MANUAL" | "RETURN" | "TRANSFER" | "REFUND" | "PROMOTION" | "REWARD"; storeCreditId: string; type: "ADJUSTMENT" | "CREDIT" | "DEBIT" | "EXPIRY"; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-store-credit.ts:46

Issue store credit to a customer

Parameters

storeId

string

Store ID

data

Issue credit data

amount

number

currency

string

customerId

string

expiresAt?

string

note?

string

orderId?

string

reason?

string

refundId?

string

returnId?

string

source

"MANUAL" | "RETURN" | "TRANSFER" | "REFUND" | "PROMOTION" | "REWARD"

Returns

Promise<{ data: { amount: number; balanceAfter: number; balanceBefore: number; createdAt: string; createdBy?: string; createdByName?: string; currency: string; customerId: string; expiresAt?: string; id: string; note?: string; orderId?: string; orderNumber?: string; reason?: string; refundId?: string; returnId?: string; source?: "MANUAL" | "RETURN" | "TRANSFER" | "REFUND" | "PROMOTION" | "REWARD"; storeCreditId: string; type: "ADJUSTMENT" | "CREDIT" | "DEBIT" | "EXPIRY"; }; }>

Created transaction

---

listStoreCreditTransactions()

listStoreCreditTransactions(storeId, params?): Promise<{ data: object[]; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-store-credit.ts:151

List store credit transactions

Parameters

storeId

string

Store ID

params?

Query parameters

customerId?

string

endDate?

string

limit

number

orderId?

string

page

number

source?

"MANUAL" | "RETURN" | "TRANSFER" | "REFUND" | "PROMOTION" | "REWARD"

startDate?

string

type?

"ADJUSTMENT" | "CREDIT" | "DEBIT" | "EXPIRY"

Returns

Promise<{ data: object[]; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

Paginated list of transactions

---

refundToStoreCredit()

refundToStoreCredit(storeId, data): Promise<{ data: { amount: number; balanceAfter: number; balanceBefore: number; createdAt: string; createdBy?: string; createdByName?: string; currency: string; customerId: string; expiresAt?: string; id: string; note?: string; orderId?: string; orderNumber?: string; reason?: string; refundId?: string; returnId?: string; source?: "MANUAL" | "RETURN" | "TRANSFER" | "REFUND" | "PROMOTION" | "REWARD"; storeCreditId: string; type: "ADJUSTMENT" | "CREDIT" | "DEBIT" | "EXPIRY"; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-store-credit.ts:130

Refund to store credit instead of payment method

Parameters

storeId

string

Store ID

data

Refund data

amount

number

notifyCustomer

boolean

orderId

string

reason?

string

refundId?

string

Returns

Promise<{ data: { amount: number; balanceAfter: number; balanceBefore: number; createdAt: string; createdBy?: string; createdByName?: string; currency: string; customerId: string; expiresAt?: string; id: string; note?: string; orderId?: string; orderNumber?: string; reason?: string; refundId?: string; returnId?: string; source?: "MANUAL" | "RETURN" | "TRANSFER" | "REFUND" | "PROMOTION" | "REWARD"; storeCreditId: string; type: "ADJUSTMENT" | "CREDIT" | "DEBIT" | "EXPIRY"; }; }>

Created transaction

---

transferStoreCredit()

transferStoreCredit(storeId, data): Promise<{ data: { fromTransaction: { amount: number; balanceAfter: number; balanceBefore: number; createdAt: string; createdBy?: string; createdByName?: string; currency: string; customerId: string; expiresAt?: string; id: string; note?: string; orderId?: string; orderNumber?: string; reason?: string; refundId?: string; returnId?: string; source?: "MANUAL" | "RETURN" | "TRANSFER" | "REFUND" | "PROMOTION" | "REWARD"; storeCreditId: string; type: "ADJUSTMENT" | "CREDIT" | "DEBIT" | "EXPIRY"; }; toTransaction: { amount: number; balanceAfter: number; balanceBefore: number; createdAt: string; createdBy?: string; createdByName?: string; currency: string; customerId: string; expiresAt?: string; id: string; note?: string; orderId?: string; orderNumber?: string; reason?: string; refundId?: string; returnId?: string; source?: "MANUAL" | "RETURN" | "TRANSFER" | "REFUND" | "PROMOTION" | "REWARD"; storeCreditId: string; type: "ADJUSTMENT" | "CREDIT" | "DEBIT" | "EXPIRY"; }; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-store-credit.ts:106

Transfer store credit between customers

Parameters

storeId

string

Store ID

data

Transfer data

amount

number

fromCustomerId

string

reason?

string

toCustomerId

string

Returns

Promise<{ data: { fromTransaction: { amount: number; balanceAfter: number; balanceBefore: number; createdAt: string; createdBy?: string; createdByName?: string; currency: string; customerId: string; expiresAt?: string; id: string; note?: string; orderId?: string; orderNumber?: string; reason?: string; refundId?: string; returnId?: string; source?: "MANUAL" | "RETURN" | "TRANSFER" | "REFUND" | "PROMOTION" | "REWARD"; storeCreditId: string; type: "ADJUSTMENT" | "CREDIT" | "DEBIT" | "EXPIRY"; }; toTransaction: { amount: number; balanceAfter: number; balanceBefore: number; createdAt: string; createdBy?: string; createdByName?: string; currency: string; customerId: string; expiresAt?: string; id: string; note?: string; orderId?: string; orderNumber?: string; reason?: string; refundId?: string; returnId?: string; source?: "MANUAL" | "RETURN" | "TRANSFER" | "REFUND" | "PROMOTION" | "REWARD"; storeCreditId: string; type: "ADJUSTMENT" | "CREDIT" | "DEBIT" | "EXPIRY"; }; }; }>

Created transactions for both customers