Skip to content

Job detail

Request

Returns information about job. If job is completed, it will contain additional information about job result.

Returns 404 if job does not exist.

Returns 403 response if job detail of unprocessed job is requested more than 10 times.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
jobIdstringrequired
Example:3ax1844
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/system/jobs/3ax1844 \
  -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": {
    "job": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}