Qodex.ai

Create a cleanup

POST https://{{subdomain}}.commercelayer.io/api/cleanups

Request Body

{"data"=>{"type"=>"cleanups", "attributes"=>{"resource_type"=>"{{cleanup_resource_type}}"}}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Authorizationstring

RESPONSES

status: Created

{"data":{"id":"xYZkjABcde","type":"cleanups","links":{"self":"https://yourdomain.commercelayer.io/api/cleanups/xYZkjABcde"},"attributes":{"resource_type":"skus","status":"in_progress","started_at":"2018-01-01T12:00:00.000Z","completed_at":"2018-01-01T12:00:00.000Z","interrupted_at":"2018-01-01T12:00:00.000Z","filters":{"code_eq":"AAA"},"records_count":300,"errors_count":30,"processed_count":270,"errors_log":{"ABC":{"name":["has already been taken"]}},"created_at":"2018-01-01T12:00:00.000Z","updated_at":"2018-01-01T12:00:00.000Z","reference":"ANY-EXTERNAL-REFEFERNCE","reference_origin":"ANY-EXTERNAL-REFEFERNCE-ORIGIN","metadata":{"foo":"bar"}},"relationships":{"events":{"links":{"self":"https://yourdomain.commercelayer.io/api/cleanups/xYZkjABcde/relationships/events","related":"https://yourdomain.commercelayer.io/api/cleanups/xYZkjABcde/events"}},"versions":{"links":{"self":"https://yourdomain.commercelayer.io/api/cleanups/xYZkjABcde/relationships/versions","related":"https://yourdomain.commercelayer.io/api/cleanups/xYZkjABcde/versions"}}},"meta":{"mode":"test"}}}