Class: AdminPriceListResource
Hierarchy
defaultCopy to Clipboard↳
AdminPriceListResourceCopy to Clipboard
Methods
addPrices
▸ addPrices(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPriceListResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostPriceListPricesPricesReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPriceListResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/price-lists.ts:80
create
▸ create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPriceListResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
payloadCopy to Clipboard | AdminPostPriceListsPriceListReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPriceListResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/price-lists.ts:18
delete
▸ delete(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/price-lists.ts:35
deletePrices
▸ deletePrices(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPriceListDeleteBatchResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminDeletePriceListPricesPricesReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPriceListDeleteBatchResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/price-lists.ts:89
deleteProductPrices
▸ deleteProductPrices(priceListIdCopy to Clipboard, productIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPriceListDeleteBatchResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
priceListIdCopy to Clipboard | stringCopy to Clipboard |
productIdCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPriceListDeleteBatchResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/price-lists.ts:98
deleteVariantPrices
▸ deleteVariantPrices(priceListIdCopy to Clipboard, variantIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPriceListDeleteBatchResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
priceListIdCopy to Clipboard | stringCopy to Clipboard |
variantIdCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPriceListDeleteBatchResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/price-lists.ts:107
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPriceListsListResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
query?Copy to Clipboard | AdminGetPriceListPaginationParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPriceListsListResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/price-lists.ts:51
listProducts
▸ listProducts(idCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<anyCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
query?Copy to Clipboard | AdminGetPriceListsPriceListProductsParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<anyCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/price-lists.ts:65
retrieve
▸ retrieve(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPriceListResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPriceListResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/price-lists.ts:43
update
▸ update(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPriceListResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostPriceListsPriceListPriceListReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPriceListResCopy to Clipboard>