Skip to main content

Class: AdminBatchJobsResource

Hierarchy

  • default

    AdminBatchJobsResource

Methods

cancel

cancel(batchJobId, customHeaders?): ResponsePromise<AdminBatchJobRes>

Parameters

NameType
batchJobIdstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminBatchJobRes>

Defined in

medusa-js/src/resources/admin/batch-jobs.ts:35


confirm

confirm(batchJobId, customHeaders?): ResponsePromise<AdminBatchJobRes>

Parameters

NameType
batchJobIdstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminBatchJobRes>

Defined in

medusa-js/src/resources/admin/batch-jobs.ts:43


create

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

Parameters

NameType
payloadAdminPostBatchesReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminBatchJobRes>

Defined in

medusa-js/src/resources/admin/batch-jobs.ts:13


list

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

Parameters

NameType
query?AdminGetBatchParams
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminBatchJobListRes>

Defined in

medusa-js/src/resources/admin/batch-jobs.ts:21


retrieve

retrieve(batchJobId, customHeaders?): ResponsePromise<AdminBatchJobRes>

Parameters

NameType
batchJobIdstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminBatchJobRes>

Defined in

medusa-js/src/resources/admin/batch-jobs.ts:51

Was this page helpful?