Theme Jobs

Get a Theme Job

GET /themes/jobs/{job_id}

Request

Returns a theme Job. When the job is complete, the results array provides a generated link to access the theme. The link is active for 60 seconds.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • job_id in path - string
    required
    The job identifier.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/themes/jobs/[job_id]' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json
Response for /GET Jobs by Id.
  • data
    object

    The job for theme upload or download
  • meta
    object

    Response metadata.

response

{
"data": {
"id": "ceea1917b1518f5ae491da6ad8a56336",
"time": "2018-09-18T13:59:01Z",
"status": "COMPLETED",
"percent_complete": 100,
"result": {
"theme_id": "ed1982d0-9d78-0136-33ba-0d84a0c6431b"
},
"warnings": [],
"errors": []
},
"meta": {}
}
Did you find what you were looking for?