Skip to main content

Class: AdminPriceListResource

Hierarchy

  • default

    AdminPriceListResource

Methods

addPrices

addPrices(id, payload, customHeaders?): ResponsePromise<AdminPriceListRes>

Parameters

NameType
idstring
payloadAdminPostPriceListPricesPricesReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminPriceListRes>

Defined in

medusa-js/src/resources/admin/price-lists.ts:80


create

create(payload, customHeaders?): ResponsePromise<AdminPriceListRes>

Parameters

NameType
payloadAdminPostPriceListsPriceListReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminPriceListRes>

Defined in

medusa-js/src/resources/admin/price-lists.ts:18


delete

delete(id, customHeaders?): ResponsePromise<DeleteResponse>

Parameters

NameType
idstring
customHeadersRecord<string, any>

Returns

ResponsePromise<DeleteResponse>

Defined in

medusa-js/src/resources/admin/price-lists.ts:35


deletePrices

deletePrices(id, payload, customHeaders?): ResponsePromise<AdminPriceListDeleteBatchRes>

Parameters

NameType
idstring
payloadAdminDeletePriceListPricesPricesReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminPriceListDeleteBatchRes>

Defined in

medusa-js/src/resources/admin/price-lists.ts:89


deleteProductPrices

deleteProductPrices(priceListId, productId, customHeaders?): ResponsePromise<AdminPriceListDeleteBatchRes>

Parameters

NameType
priceListIdstring
productIdstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminPriceListDeleteBatchRes>

Defined in

medusa-js/src/resources/admin/price-lists.ts:98


deleteVariantPrices

deleteVariantPrices(priceListId, variantId, customHeaders?): ResponsePromise<AdminPriceListDeleteBatchRes>

Parameters

NameType
priceListIdstring
variantIdstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminPriceListDeleteBatchRes>

Defined in

medusa-js/src/resources/admin/price-lists.ts:107


list

list(query?, customHeaders?): ResponsePromise<AdminPriceListsListRes>

Parameters

NameType
query?AdminGetPriceListPaginationParams
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminPriceListsListRes>

Defined in

medusa-js/src/resources/admin/price-lists.ts:51


listProducts

listProducts(id, query?, customHeaders?): ResponsePromise<any>

Parameters

NameType
idstring
query?AdminGetPriceListsPriceListProductsParams
customHeadersRecord<string, any>

Returns

ResponsePromise<any>

Defined in

medusa-js/src/resources/admin/price-lists.ts:65


retrieve

retrieve(id, customHeaders?): ResponsePromise<AdminPriceListRes>

Parameters

NameType
idstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminPriceListRes>

Defined in

medusa-js/src/resources/admin/price-lists.ts:43


update

update(id, payload, customHeaders?): ResponsePromise<AdminPriceListRes>

Parameters

NameType
idstring
payloadAdminPostPriceListsPriceListPriceListReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminPriceListRes>

Defined in

medusa-js/src/resources/admin/price-lists.ts:26