Skip to main content

Class: AdminDiscountsResource

Hierarchy​

  • defaultCopy to Clipboard

    ↳ AdminDiscountsResourceCopy to Clipboard

Methods​

addConditionResourceBatch​

▸ addConditionResourceBatch(discountIdCopy to Clipboard, conditionIdCopy to Clipboard, payloadCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

DescriptionCopy to Clipboard

Add a batch of items to a discount condition

Parameters​

NameType
discountIdCopy to ClipboardstringCopy to Clipboard
conditionIdCopy to ClipboardstringCopy to Clipboard
payloadCopy to ClipboardAdminPostDiscountsDiscountConditionsConditionBatchReqCopy to Clipboard
query?Copy to ClipboardAdminPostDiscountsDiscountConditionsConditionBatchParamsCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:218

addRegion​

▸ addRegion(idCopy to Clipboard, regionIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

DescriptionCopy to Clipboard

Adds region to discount

Parameters​

NameType
idCopy to ClipboardstringCopy to Clipboard
regionIdCopy to ClipboardstringCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:27

create​

▸ create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

DescriptionCopy to Clipboard

Creates discounts

Parameters​

NameType
payloadCopy to ClipboardAdminPostDiscountsReqCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:39

createCondition​

▸ createCondition(discountIdCopy to Clipboard, payloadCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

DescriptionCopy to Clipboard

creates a discount condition

Parameters​

NameType
discountIdCopy to ClipboardstringCopy to Clipboard
payloadCopy to ClipboardAdminPostDiscountsDiscountConditionsCopy to Clipboard
queryCopy to ClipboardAdminPostDiscountsDiscountConditionsParamsCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:148

createDynamicCode​

▸ createDynamicCode(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

DescriptionCopy to Clipboard

Creates a dynamic discount code

Parameters​

NameType
idCopy to ClipboardstringCopy to Clipboard
payloadCopy to ClipboardAdminPostDiscountsDiscountDynamicCodesReqCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:62

delete​

▸ delete(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>

DescriptionCopy to Clipboard

Deletes a discount

Parameters​

NameType
idCopy to ClipboardstringCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:74

deleteCondition​

▸ deleteCondition(discountIdCopy to Clipboard, conditionIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>

DescriptionCopy to Clipboard

Removes a condition from a discount

Parameters​

NameType
discountIdCopy to ClipboardstringCopy to Clipboard
conditionIdCopy to ClipboardstringCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:187

deleteConditionResourceBatch​

▸ deleteConditionResourceBatch(discountIdCopy to Clipboard, conditionIdCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

DescriptionCopy to Clipboard

Delete a batch of items from a discount condition

Parameters​

NameType
discountIdCopy to ClipboardstringCopy to Clipboard
conditionIdCopy to ClipboardstringCopy to Clipboard
payloadCopy to ClipboardAdminDeleteDiscountsDiscountConditionsConditionBatchReqCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:238

deleteDynamicCode​

▸ deleteDynamicCode(idCopy to Clipboard, codeCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

DescriptionCopy to Clipboard

Deletes a dynamic discount

Parameters​

NameType
idCopy to ClipboardstringCopy to Clipboard
codeCopy to ClipboardstringCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:85

getCondition​

▸ getCondition(discountIdCopy to Clipboard, conditionIdCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDiscountConditionsResCopy to Clipboard>

DescriptionCopy to Clipboard

Gets a condition from a discount

Parameters​

NameType
discountIdCopy to ClipboardstringCopy to Clipboard
conditionIdCopy to ClipboardstringCopy to Clipboard
query?Copy to ClipboardAdminGetDiscountsDiscountConditionsConditionParamsCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<AdminDiscountConditionsResCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:199

list​

▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDiscountsListResCopy to Clipboard>

DescriptionCopy to Clipboard

Lists discounts

Parameters​

NameType
query?Copy to ClipboardAdminGetDiscountsParamsCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<AdminDiscountsListResCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:119

removeRegion​

▸ removeRegion(idCopy to Clipboard, regionIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

DescriptionCopy to Clipboard

Removes a region from a discount

Parameters​

NameType
idCopy to ClipboardstringCopy to Clipboard
regionIdCopy to ClipboardstringCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:136

retrieve​

▸ retrieve(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

DescriptionCopy to Clipboard

Retrieves a discount

Parameters​

NameType
idCopy to ClipboardstringCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:97

retrieveByCode​

▸ retrieveByCode(codeCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

DescriptionCopy to Clipboard

Retrieves a discount by code

Parameters​

NameType
codeCopy to ClipboardstringCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:108

update​

▸ update(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

DescriptionCopy to Clipboard

Updates discount

Parameters​

NameType
idCopy to ClipboardstringCopy to Clipboard
payloadCopy to ClipboardAdminPostDiscountsDiscountReqCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:50

updateCondition​

▸ updateCondition(discountIdCopy to Clipboard, conditionIdCopy to Clipboard, payloadCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

DescriptionCopy to Clipboard

Updates a discount condition

Parameters​

NameType
discountIdCopy to ClipboardstringCopy to Clipboard
conditionIdCopy to ClipboardstringCopy to Clipboard
payloadCopy to ClipboardAdminPostDiscountsDiscountConditionsConditionCopy to Clipboard
queryCopy to ClipboardAdminPostDiscountsDiscountConditionsConditionParamsCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns​

ResponsePromiseCopy to Clipboard<AdminDiscountsResCopy to Clipboard>

Defined in​

medusa-js/src/resources/admin/discounts.ts:167

Was this page helpful?
© 2023 Medusa, Inc. All rights reserved.