AdminPostBatchesReq

admin/batch-jobs.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 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

Properties

contextRecord<string, unknown>Required

dry_runbooleanRequired

typestringRequired