medusa-store/docs/content/references/js-client/classes/AdminPriceListResource.md

Class: AdminPriceListResource

Hierarchy

• default

  ↳ AdminPriceListResource

Methods

addPrices

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

Parameters

Name	Type
id	string
payload	AdminPostPriceListPricesPricesReq
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminPriceListRes>

Defined in

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

---

create

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

Parameters

Name	Type
payload	AdminPostPriceListsPriceListReq
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminPriceListRes>

Defined in

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

---

delete

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

Parameters

Name	Type
id	string
customHeaders	Record<string, any>

Returns

ResponsePromise<DeleteResponse>

Defined in

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

---

deletePrices

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

Parameters

Name	Type
id	string
payload	AdminDeletePriceListPricesPricesReq
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminPriceListDeleteBatchRes>

Defined in

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

---

deleteProductPrices

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

Parameters

Name	Type
priceListId	string
productId	string
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminPriceListDeleteBatchRes>

Defined in

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

---

deleteVariantPrices

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

Parameters

Name	Type
priceListId	string
variantId	string
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminPriceListDeleteBatchRes>

Defined in

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

---

list

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

Parameters

Name	Type
query?	AdminGetPriceListPaginationParams
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminPriceListsListRes>

Defined in

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

---

listProducts

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

Parameters

Name	Type
id	string
query?	AdminGetPriceListsPriceListProductsParams
customHeaders	Record<string, any>

Returns

ResponsePromise<any>

Defined in

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

---

retrieve

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

Parameters

Name	Type
id	string
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminPriceListRes>

Defined in

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

---

update

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

Parameters

Name	Type
id	string
payload	AdminPostPriceListsPriceListPriceListReq
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminPriceListRes>

Defined in

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