Products | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Products

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Products(options: ProductsOptions, http: Client): Products

Overrides ThBaseHandler.constructor
- Defined in src/v1/products.ts:223
Parameters
- options: ProductsOptions
- http: Client
Returns Products

Properties

endpoint

endpoint: string

http

http: Client

options

options: ProductsOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v1/products'

Methods

bookStock

bookStock(requestOptions: BookStockQuery): Promise<ProductResponse>

- Defined in src/v1/products.ts:601
Parameters
- requestOptions: BookStockQuery
Returns Promise<ProductResponse>

bulkCreate

bulkCreate(products: Product[], query?: HandlerProductsQuery): Promise<ProductsBulkResponse>

- Defined in src/v1/products.ts:480
Parameters
- products: Product[]
- Optional query: HandlerProductsQuery
Returns Promise<ProductsBulkResponse>

bulkDelete

bulkDelete(body: ProductsBulkDeleteBody): Promise<ProductsResponse>

- Defined in src/v1/products.ts:525
Parameters
- body: ProductsBulkDeleteBody
Returns Promise<ProductsResponse>

bulkEdit

bulkEdit(products: Product[]): Promise<ProductsResponse>

- Defined in src/v1/products.ts:507
Parameters
- products: Product[]
Returns Promise<ProductsResponse>

checkBarcode

checkBarcode(code: string): Promise<ProductResponse>

- Defined in src/v1/products.ts:616
Parameters
- code: string
Returns Promise<ProductResponse>

count

count(): Promise<ProductsResponse>

- Defined in src/v1/products.ts:545
Returns Promise<ProductsResponse>

create

create(product: Product, query?: HandlerProductsQuery): Promise<ProductResponse>

- Defined in src/v1/products.ts:238
Parameters
- product: Product
- Optional query: HandlerProductsQuery
Returns Promise<ProductResponse>

delete

delete(productId: string, deleteOptions?: ProductDeleteOptions): Promise<ProductsResponse>

- Defined in src/v1/products.ts:563
Parameters
- productId: string
- Optional deleteOptions: ProductDeleteOptions
Returns Promise<ProductsResponse>

duplicate

duplicate(body: ProductsDuplicateBody): Promise<ProductsDuplicateResponse>

- Defined in src/v1/products.ts:258
Parameters
- body: ProductsDuplicateBody
Returns Promise<ProductsDuplicateResponse>

export

export(query?: ProductsQuery): Promise<ProductsExportResponse>

- Defined in src/v1/products.ts:369
Parameters
- Optional query: ProductsQuery
Returns Promise<ProductsExportResponse>

get

get(productId: string): Promise<ProductResponse>

- Defined in src/v1/products.ts:351
Parameters
- productId: string
Returns Promise<ProductResponse>

getAll

getAll(options?: ProductsOptions): Promise<ProductsResponse>

- Defined in src/v1/products.ts:276
Parameters
- Optional options: ProductsOptions
Returns Promise<ProductsResponse>

getChildrenDetails

getChildrenDetails(productId: string, hideStock?: boolean, options?: ProductsDetailsOptions): Promise<ProductResponse>

- Defined in src/v1/products.ts:411
Parameters
- productId: string
- Optional hideStock: boolean
- Optional options: ProductsDetailsOptions
Returns Promise<ProductResponse>

getDetails

getDetails(productId: string, options?: ProductsOptions): Promise<ProductResponse>

- Defined in src/v1/products.ts:388
Parameters
- productId: string
- Optional options: ProductsOptions
Returns Promise<ProductResponse>

import

import(options?: ProductsOptions): Promise<ProductsResponse>

- Defined in src/v1/products.ts:325
Parameters
- Optional options: ProductsOptions
Returns Promise<ProductsResponse>

meta

meta(q?: ProductsQuery): Promise<ProductsResponse>

- Defined in src/v1/products.ts:439
Parameters
- Optional q: ProductsQuery
Returns Promise<ProductsResponse>

pricebookEntries

pricebookEntries(): PricebookEntries

- Defined in src/v1/products.ts:649
Returns PricebookEntries

pricebooks

pricebooks(): Pricebooks

- Defined in src/v1/products.ts:645
Returns Pricebooks

put

put(productId: string, product: Product): Promise<ProductResponse>

- Defined in src/v1/products.ts:462
Parameters
- productId: string
- product: Product
Returns Promise<ProductResponse>

search

search(query: string | SearchQuery): Promise<ProductsResponse>

- Defined in src/v1/products.ts:581
Parameters
- query: string | SearchQuery
Returns Promise<ProductsResponse>

select

select(options: SelectProductsQuery): Promise<ProductsResponse>

- Defined in src/v1/products.ts:302
Parameters
- options: SelectProductsQuery
Returns Promise<ProductsResponse>

Generated using TypeDoc