Class: InventoryService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/inventory.ts:51

Extends

• BaseService

Constructors

Constructor

new InventoryService(client): InventoryService

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

Parameters

client

TanqoryClient

Returns

InventoryService

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

adjust()

adjust(storeId, data): Promise<ApiResponseDto<InventoryItem>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/inventory.ts:74

Adjust inventory quantity

Parameters

storeId

string

data

AdjustInventoryInput

Returns

Promise<ApiResponseDto<InventoryItem>>

---

adjustInventory()

adjustInventory(storeId, data): Promise<InventoryItem>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/inventory.ts:151

Parameters

storeId

string

data

AdjustInventoryInput

Returns

Promise<InventoryItem>

---

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

---

bulkAdjust()

bulkAdjust(storeId, adjustments): Promise<ApiResponseDto<BulkAdjustResult>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/inventory.ts:88

Bulk adjust inventory quantities - optimized with database transaction

Parameters

storeId

string

adjustments

AdjustInventoryInput[]

Returns

Promise<ApiResponseDto<BulkAdjustResult>>

---

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

---

getCommittedOrders()

getCommittedOrders(storeId, variantId, locationId): Promise<object[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/inventory.ts:175

Get orders with committed inventory for a variant at a location Used to show which orders are holding committed stock (Tanqory pattern)

Parameters

storeId

string

variantId

string

locationId

string

Returns

Promise<object[]>

---

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

---

getHistory()

getHistory(storeId, variantId, options?): Promise<ApiResponseDto<{ items: object[]; total: number; }>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/inventory.ts:102

Get inventory adjustment history for a variant

Parameters

storeId

string

variantId

string

options?

fromDate?

string | Date

limit?

number

locationId?

string

page?

number

toDate?

string | Date

Returns

Promise<ApiResponseDto<{ items: object[]; total: number; }>>

---

getInventoryHistory()

getInventoryHistory(storeId, variantId, options?): Promise<object[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/inventory.ts:156

Parameters

storeId

string

variantId

string

options?

fromDate?

string | Date

limit?

number

locationId?

string

page?

number

toDate?

string | Date

Returns

Promise<object[]>

---

getInventoryItem()

getInventoryItem(storeId, variantId): Promise<InventoryItem>

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

Parameters

storeId

string

variantId

string

Returns

Promise<InventoryItem>

---

list()

list(storeId, options?): Promise<{ data: object[]; filters: { available?: { max?: number; min?: number; }; binName?: string; committed?: { max?: number; min?: number; }; locationId?: string; onHand?: { max?: number; min?: number; }; productType?: string; salesChannel?: string[]; search?: string; sku?: string; tags?: string[]; unavailable?: { max?: number; min?: number; }; variantIds?: string[]; vendor?: string; }; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/inventory.ts:55

List inventory levels

Parameters

storeId

string

options?

ListInventoryOptions

Returns

Promise<{ data: object[]; filters: { available?: { max?: number; min?: number; }; binName?: string; committed?: { max?: number; min?: number; }; locationId?: string; onHand?: { max?: number; min?: number; }; productType?: string; salesChannel?: string[]; search?: string; sku?: string; tags?: string[]; unavailable?: { max?: number; min?: number; }; variantIds?: string[]; vendor?: string; }; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

---

listInventory()

listInventory(storeId, options?): Promise<{ data: object[]; filters: { available?: { max?: number; min?: number; }; binName?: string; committed?: { max?: number; min?: number; }; locationId?: string; onHand?: { max?: number; min?: number; }; productType?: string; salesChannel?: string[]; search?: string; sku?: string; tags?: string[]; unavailable?: { max?: number; min?: number; }; variantIds?: string[]; vendor?: string; }; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/inventory.ts:139

Parameters

storeId

string

options?

ListInventoryOptions

Returns

Promise<{ data: object[]; filters: { available?: { max?: number; min?: number; }; binName?: string; committed?: { max?: number; min?: number; }; locationId?: string; onHand?: { max?: number; min?: number; }; productType?: string; salesChannel?: string[]; search?: string; sku?: string; tags?: string[]; unavailable?: { max?: number; min?: number; }; variantIds?: string[]; vendor?: string; }; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

---

retrieve()

retrieve(storeId, variantId): Promise<ApiResponseDto<InventoryItem>>

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

Get inventory item by variant ID

Parameters

storeId

string

variantId

string

Returns

Promise<ApiResponseDto<InventoryItem>>

---

setLevel()

setLevel(storeId, data): Promise<ApiResponseDto<{ success: boolean; }>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/inventory.ts:124

Set inventory level for a variant at a location Note: Sets 'available' quantity directly. onHand is calculated as: available + committed + unavailable

Parameters

storeId

string

data

available

number

locationId

string

variantId

string

Returns

Promise<ApiResponseDto<{ success: boolean; }>>