The cleanup object

A comprehensive list of the cleanup resource's attributes and relationships

A cleanup object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/cleanups endpoint.

Fields

Field	Type	Description
type	string	cleanups
id	string	The cleanup unique identifier
links.self	string	The cleanup endpoint URL
attributes.resource_type	string	The type of resource being cleaned. One of 'promotions', 'skus', 'bundles', 'sku_lists', 'stock_items', 'gift_cards', 'sku_options', or 'prices'.
attributes.status	string	The cleanup job status. One of 'pending' (default), 'in_progress', 'interrupted', or 'completed'.
attributes.started_at	string	Time at which the cleanup was started.
attributes.completed_at	string	Time at which the cleanup was completed.
attributes.interrupted_at	string	Time at which the cleanup was interrupted.
attributes.filters	object	The filters used to select the records to be cleaned.
attributes.records_count	integer	Indicates the number of records to be cleaned.
attributes.errors_count	integer	Indicates the number of cleanup errors, if any.
attributes.processed_count	integer	Indicates the number of records that have been cleaned.
attributes.errors_log	object	Contains the cleanup errors, if any.
attributes.dry_run	boolean	When true, evaluates filters and populates records_count without performing any deletion.
attributes._interrupt	boolean	Send this attribute if you want to mark status as 'interrupted'.
attributes.created_at	string	Time at which the resource was created.
attributes.updated_at	string	Time at which the resource was last updated.
attributes.reference	string	A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin	string	Any identifier of the third party system that defines the reference code.
attributes.metadata	object	Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.events	array	The associated events.
relationships.event_stores	array	The associated event stores.
meta.mode	string	The resource environment (can be one of test or live)