daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
1.5 KiB
1.5 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AdminPostBatchesReq
internal.AdminPostBatchesReq
Schema
AdminPostBatchesReq type: object required:
- type
- context
properties:
type:
type: string
description: The type of batch job to start, which is defined by the
batchTypeproperty of the associated batch job strategy. example: product-export context: type: object description: Additional infomration regarding the batch to be used for processing. example: shape: prices: - region: null currency_code: "eur" dynamicImageColumnCount: 4 dynamicOptionColumnCount: 2 list_config: skip: 0 take: 50 order: created_at: "DESC" relations: - variants - variant.prices - images dry_run: type: boolean description: Set a batch job in dry_run mode, which would delay executing the batch job until it's confirmed. default: false
Properties
context
• context: Record<string, unknown>
Defined in
packages/medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:108
dry_run
• dry_run: boolean
Defined in
packages/medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:109
type
• type: string
Defined in
packages/medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:107