List all cleanups

How to fetch a collection of cleanups via API

To fetch a collection of cleanups, send a GET request to the /api/cleanups endpoint.

Request

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

Example

Request

The following request fetches a collection of cleanups:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/cleanups/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Response

On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:

{
  "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"
      }
    },
    {
      "other": "... 9 cleanups (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14
  },
  "links": {
    "first": "https://yourdomain.commercelayer.io/api/cleanups?page[number]=1&page[size]=10",
    "next": "https://yourdomain.commercelayer.io/api/cleanups?page[number]=2&page[size]=10",
    "last": "https://yourdomain.commercelayer.io/api/cleanups?page[number]=14&page[size]=10"
  }
}

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of cleanups can be sorted by the following fields:

• resource_type

• status

• started_at

• completed_at

• interrupted_at

• records_count

• errors_count

• processed_count

• id

• created_at

• updated_at

• reference

• reference_origin

Filterable fields

The list of cleanups can be filtered by the following fields:

Attributes

• resource_type

• status

• started_at

• completed_at

• interrupted_at

• records_count

• errors_count

• processed_count

• id

• created_at

• updated_at

• reference

• reference_origin

• metadata

Relationships

• events