Skip to main content

Class: AdminRegionsResource

Hierarchy

  • defaultCopy to Clipboard

    AdminRegionsResourceCopy to Clipboard

Methods

addCountry

addCountry(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>

DescriptionCopy to Clipboard

adds a country to the list of countries in a region

Parameters

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardregion id
payloadCopy to ClipboardAdminPostRegionsRegionCountriesReqCopy to Clipboardcountry data
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:103


addFulfillmentProvider

addFulfillmentProvider(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>

DescriptionCopy to Clipboard

adds a fulfillment provider to a region

Parameters

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardregion id
payloadCopy to ClipboardAdminPostRegionsRegionFulfillmentProvidersReqCopy to Clipboardfulfillment provider data
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:135


addPaymentProvider

addPaymentProvider(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>

DescriptionCopy to Clipboard

adds a payment provider to a region

Parameters

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardregion id
payloadCopy to ClipboardAdminPostRegionsRegionPaymentProvidersReqCopy to Clipboardpayment provider data
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:181


create

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

DescriptionCopy to Clipboard

creates a region.

Parameters

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

Returns

ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>

created region.

Defined in

medusa-js/src/resources/admin/regions.ts:24


delete

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

DescriptionCopy to Clipboard

deletes a region

Parameters

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardid of region to delete.
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>

Deleted response

Defined in

medusa-js/src/resources/admin/regions.ts:54


deleteCountry

deleteCountry(idCopy to Clipboard, country_codeCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>

DescriptionCopy to Clipboard

remove a country from a region's list of coutnries

Parameters

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardregion id
country_codeCopy to ClipboardstringCopy to Clipboardthe 2 character ISO code for the Country.
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>

updated region

Defined in

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


deleteFulfillmentProvider

deleteFulfillmentProvider(idCopy to Clipboard, provider_idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>

DescriptionCopy to Clipboard

remove a fulfillment provider from a region

Parameters

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardregion id
provider_idCopy to ClipboardstringCopy to Clipboardthe if of the fulfillment provider
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:151


deletePaymentProvider

deletePaymentProvider(idCopy to Clipboard, provider_idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>

DescriptionCopy to Clipboard

removes a payment provider from a region

Parameters

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardregion id
provider_idCopy to ClipboardstringCopy to Clipboardthe id of the payment provider
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:197


list

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

DescriptionCopy to Clipboard

lists regions matching a query

Parameters

NameTypeDescription
query?Copy to ClipboardAdminGetRegionsParamsCopy to Clipboardquery for searching regions
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminRegionsListResCopy to Clipboard>

a list of regions matching the query.

Defined in

medusa-js/src/resources/admin/regions.ts:82


retrieve

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

DescriptionCopy to Clipboard

get a region

Parameters

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardid of the region to retrieve.
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>

the region with the given id

Defined in

medusa-js/src/resources/admin/regions.ts:68


retrieveFulfillmentOptions

retrieveFulfillmentOptions(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminGetRegionsRegionFulfillmentOptionsResCopy to Clipboard>

DescriptionCopy to Clipboard

retrieves the list of fulfillment options available in a region

Parameters

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardregion id
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminGetRegionsRegionFulfillmentOptionsResCopy to Clipboard>

list of fulfillment options

Defined in

medusa-js/src/resources/admin/regions.ts:166


update

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

DescriptionCopy to Clipboard

updates a region

Parameters

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardid of the region to update.
payloadCopy to ClipboardAdminPostRegionsRegionReqCopy to Clipboardupdate to apply to region.
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>

the updated region.

Defined in

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