Files
medusa-store/docs/api/admin/components/schemas/AdminPostBatchesReq.yaml
github-actions[bot] 658339767b chore(docs): Generated API Reference (#4706)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2023-08-07 16:54:48 +03:00

37 lines
897 B
YAML

type: object
required:
- type
- context
properties:
type:
type: string
description: >-
The type of batch job to start, which is defined by the `batchType`
property 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