Skip to main content
Skip to main content

AdminGetBatchParams

Parameters used to filter and configure pagination of the retrieved batch jobs.

Properties​

canceled_atnull | DateComparisonOperator
Date filters to apply on the batch jobs' canceled_at date.
completed_atnull | DateComparisonOperator
Date filters to apply on the batch jobs' completed_at date.
confirmed_atnull | DateComparisonOperator
Date filters to apply on the batch jobs' confirmed_at date.
created_atDateComparisonOperator
Date filters to apply on the batch jobs' created_at date.
expandstring
Comma-separated relations that should be expanded in the returned data.
failed_atnull | DateComparisonOperator
Date filters to apply on the batch jobs' failed_at date.
fieldsstring
Comma-separated fields that should be included in the returned data.
idstring | string[]
IDs to filter batch jobs by.
limitnumberRequired
Limit the number of items returned in the list.
offsetnumberRequired
The number of items to skip when retrieving a list.
orderstring
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.
pre_processed_atnull | DateComparisonOperator
Date filters to apply on the batch jobs' pre_processed_at date.
typestring[]
Types to filter batch jobs by.
updated_atDateComparisonOperator
Date filters to apply on the batch jobs' updated_at date.
Was this section helpful?
© 2023 Medusa, Inc. All rights reserved.