Create a cleanup

How to create a cleanup via API

To create a new cleanup, send a POST request to the /api/cleanups endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/cleanups

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.resource_type	string	Required
attributes.filters	object	Optional
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional

Example

Request

The following request creates a new cleanup:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/cleanups' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "cleanups",
    "attributes": {
      "resource_type": "skus"
    }
  }
}'

Response

On success, the API responds with a 201 Created status code, returning the created resource object:

{
  "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",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}