Get a Job

GET 
/v2/jobs/:jobID

Retrieves the specified job.

Request

Path Parameters

jobID stringrequired

The unique identifier of the requested job.

Responses

200

application/json

Schema

Schema

data Job

id uuid

A unique ID generated when a job is created

type string

This represents the type of object being returned. Always job.

job_type string

This represents the type of job. For example, order_export.

status string

The status of a job.

• PENDING - Commerce has received the request but is currently busy processing other requests.
• STARTED - Commerce has started processing the job.
• SUCCESS - The job has successfully completed.
• FAILED - The job has failed.

error string

A message describing the error that caused a job to fail.

timestamps object

The date and time a job is created/updated.

created_at string

The date and time a job is created.

updated_at string

The date and time a job is updated.

links object

Links are used to allow you to move between requests

self string

Single entities use a self parameter with a link to that specific resource.

link object

A link to the exported data.

href string

The publicly available URL for this CSV file that contains the exported data.

Example (from schema)

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "job",
    "job_type": "order_export",
    "status": "failed",
    "error": "No results matched the supplied filter",
    "timestamps": {
      "created_at": "2018-10-04T11:08:49.156490335Z",
      "updated_at": "2018-10-04T11:08:49.162867081Z"
    },
    "links": {
      "self": "https://useast.api.elasticpath.com/v2/jobs/974c9db4-38da-4dbf-90c2-33eed5f3e77c"
    },
    "link": {
      "href": "string"
    }
  }
}

default

{
  "data": {
    "id": "974c9db4-38da-4dbf-90c2-33eed5f3e77c",
    "type": "job",
    "job_type": "order_export",
    "status": "failed",
    "error": "No results matched the supplied filter",
    "link": {
      "href": ""
    },
    "links": {
      "self": "https://useast.api.elasticpath.com/v2/jobs/974c9db4-38da-4dbf-90c2-33eed5f3e77c"
    },
    "timestamps": {
      "created_at": "2018-10-04T11:08:49.156490335Z",
      "updated_at": "2018-10-04T11:08:49.162867081Z"
    }
  }
}

404

Forbidden. The operation is forbidden on this entity.

application/json

Schema

Schema

errors Error[]required
Array [
status intrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "title": "Resource Not Found",
  "status": 404,
  "detail": "The resource you are requesting does not exist"
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
status intrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "status": 500,
      "title": "Internal Server Error",
      "detail": "There was an internal server error, you can report with your request id.",
      "request_id": "635da56d-75a1-43cd-b696-7ab119756b3a"
    }
  ]
}

Loading...