Skip to content

Jobs

Managing asynchronous jobs in the e-shop.

Operations

List of jobs

Request

List of jobs in queue. Using the "status" parameter to filter by completed|pending|running|failed|expired|killed. Without this filter it will show all statuses. Also you can filter results depends on time of creation and completion.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
statusstring

supported values: completed, pending, running, failed, expired, killed

Example:status=completed
creationTimeFromstring

date and time of job creation - lower limit

Example:creationTimeFrom=2018-05-28T14:17:00+02:00
creationTimeTostring

date and time of job creation - upper limit

Example:creationTimeTo=2018-05-28T14:17:00+02:00
completionTimeFromstring

date and time of job completion - lower limit

Example:completionTimeFrom=2018-05-28T14:17:00+02:00
completionTimeTostring

date and time of job completion - upper limit

Example:completionTimeTo=2018-05-28T14:17:00+02:00
itemsPerPageinteger

Returned items per page. Default value is 100. Max value is 500.

Example:itemsPerPage=50
pageinteger

Page number to return. Default value is 1.

Example:page=3
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/system/jobs?status=completed&creationTimeFrom=2018-05-28T14%3A17%3A00%2B02%3A00&creationTimeTo=2018-05-28T14%3A17%3A00%2B02%3A00&completionTimeFrom=2018-05-28T14%3A17%3A00%2B02%3A00&completionTimeTo=2018-05-28T14%3A17%3A00%2B02%3A00&itemsPerPage=50&page=3' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "jobs": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}