Skip to main content
Skip to main content

AdminPriceListResource

admin/price-lists.AdminPriceListResource

Methods​

addPrices​

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

Parameters​

idstringRequired
payloadAdminPostPriceListPricesPricesReqRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminPriceListRes>

ResponsePromiseResponsePromise<AdminPriceListRes>Required

create​

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

Parameters​

payloadAdminPostPriceListsPriceListReqRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminPriceListRes>

ResponsePromiseResponsePromise<AdminPriceListRes>Required

delete​

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

Parameters​

idstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<DeleteResponse>

ResponsePromiseResponsePromise<DeleteResponse>Required

deletePrices​

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

Parameters​

idstringRequired
payloadAdminDeletePriceListPricesPricesReqRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminPriceListDeleteBatchRes>

deleteProductPrices​

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

Parameters​

priceListIdstringRequired
productIdstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminPriceListDeleteBatchRes>

deleteProductsPrices​

deleteProductsPrices(priceListId, payload, customHeaders?): ResponsePromise<AdminPriceListDeleteBatchRes>

Parameters​

priceListIdstringRequired
payloadAdminDeletePriceListsPriceListProductsPricesBatchReqRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminPriceListDeleteBatchRes>

deleteVariantPrices​

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

Parameters​

priceListIdstringRequired
variantIdstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminPriceListDeleteBatchRes>

list​

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

Parameters​

queryAdminGetPriceListPaginationParams
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminPriceListsListRes>

ResponsePromiseResponsePromise<AdminPriceListsListRes>Required

listProducts​

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

Parameters​

idstringRequired
queryAdminGetPriceListsPriceListProductsParams
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<any>

ResponsePromiseResponsePromise<any>Required

retrieve​

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

Parameters​

idstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminPriceListRes>

ResponsePromiseResponsePromise<AdminPriceListRes>Required

update​

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

Parameters​

idstringRequired
payloadAdminPostPriceListsPriceListPriceListReqRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminPriceListRes>

ResponsePromiseResponsePromise<AdminPriceListRes>Required
Was this section helpful?
© 2023 Medusa, Inc. All rights reserved.