Skip to main content

Class: ProductViewsService

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

Extends​

  • BaseService

Constructors​

Constructor​

new ProductViewsService(client): ProductViewsService

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

Parameters​

client​

TanqoryClient

Returns​

ProductViewsService

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​

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<ProductView>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-views.ts:105

Create a new product view

Parameters​

storeId​

string

data​

CreateProductViewInput

Returns​

Promise<ProductView>

Example​

const view = await tanqory.productViews.create('store_123', {
  name: 'Low Stock Items',
  filters: {
    tabFilter: 'low_stock',
    search: '',
    advancedFilters: {}
  },
  columns: ['title', 'sku', 'inventory', 'status'],
  isPinned: true
})

delete()​

delete(viewId, storeId): Promise<boolean>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-views.ts:149

Delete a product view

Parameters​

viewId​

string

storeId​

string

Returns​

Promise<boolean>

Example​

await tanqory.productViews.delete('view_123', 'store_123')

duplicate()​

duplicate(viewId, storeId): Promise<ProductView>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-views.ts:162

Duplicate an existing product view

Parameters​

viewId​

string

storeId​

string

Returns​

Promise<ProductView>

Example​

const duplicated = await tanqory.productViews.duplicate('view_123', 'store_123')

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

getDefault()​

getDefault(storeId): Promise<ProductView>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-views.ts:234

Get the default view for a store

Parameters​

storeId​

string

Returns​

Promise<ProductView>

Example​

const defaultView = await tanqory.productViews.getDefault('store_123')

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

getPinned()​

getPinned(storeId): Promise<ProductView[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-views.ts:247

Get all pinned views for a store

Parameters​

storeId​

string

Returns​

Promise<ProductView[]>

Example​

const pinnedViews = await tanqory.productViews.getPinned('store_123')

list()​

list(storeId): Promise<ProductView[]>

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

List all product views for a store

Parameters​

storeId​

string

Returns​

Promise<ProductView[]>

Example​

const views = await tanqory.productViews.list('store_123')

reorder()​

reorder(storeId, viewIds): Promise<ProductView[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-views.ts:201

Reorder product views

Parameters​

storeId​

string

viewIds​

string[]

Returns​

Promise<ProductView[]>

Example​

const views = await tanqory.productViews.reorder('store_123', [
  'view_1',
  'view_2',
  'view_3'
])

retrieve()​

retrieve(viewId, storeId): Promise<ProductView>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-views.ts:80

Get a single product view by ID

Parameters​

viewId​

string

storeId​

string

Returns​

Promise<ProductView>

Example​

const view = await tanqory.productViews.retrieve('view_123', 'store_123')

setDefault()​

setDefault(viewId, storeId): Promise<ProductView>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-views.ts:218

Set a view as default

Parameters​

viewId​

string

storeId​

string

Returns​

Promise<ProductView>

Example​

const view = await tanqory.productViews.setDefault('view_123', 'store_123')

togglePin()​

togglePin(viewId, storeId): Promise<ProductView>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-views.ts:181

Toggle pin status of a product view

Parameters​

viewId​

string

storeId​

string

Returns​

Promise<ProductView>

Example​

const view = await tanqory.productViews.togglePin('view_123', 'store_123')

update()​

update(viewId, storeId, data): Promise<ProductView>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-views.ts:128

Update an existing product view

Parameters​

viewId​

string

storeId​

string

data​

UpdateProductViewInput

Returns​

Promise<ProductView>

Example​

const updated = await tanqory.productViews.update('view_123', 'store_123', {
  name: 'Updated View Name',
  isPinned: false
})