Skip to main content
Skip to main content

AdminBatchJobsResource

admin/batch-jobs.AdminBatchJobsResource

Methods​

cancel​

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

Parameters​

batchJobIdstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminBatchJobRes>

ResponsePromiseResponsePromise<AdminBatchJobRes>Required

confirm​

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

Parameters​

batchJobIdstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminBatchJobRes>

ResponsePromiseResponsePromise<AdminBatchJobRes>Required

create​

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

Parameters​

payloadAdminPostBatchesReqRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminBatchJobRes>

ResponsePromiseResponsePromise<AdminBatchJobRes>Required

list​

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

Parameters​

queryAdminGetBatchParams
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminBatchJobListRes>

ResponsePromiseResponsePromise<AdminBatchJobListRes>Required

retrieve​

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

Parameters​

batchJobIdstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminBatchJobRes>

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