Skip to main content

Get All Jobs

GET 

https://euwest.api.elasticpath.com/pcm/jobs

The jobs endpoints displays the status of a number of endpoints that function as jobs, for example, product import and export, price book import, building child products, and duplicating hierarchies.

Responses

Returns all the jobs.

Schema
    data object[]required

    An array of jobs.

  • Array [
  • idstringrequired

    A unique identifier generated when a job is created.

    typestringrequired

    This represents the type of resource object being returned. Always pim-job.

    Possible values: [pim-job]

    attributes objectrequired
    started_atdate-timenullablerequired

    The date and time a job is started.

    Example: 2020-09-22T09:00:00
    completed_atdate-timenullablerequired

    The date and time a job is completed.

    Example: 2020-09-22T09:00:00
    created_atdate-timerequired

    The date and time a job is created.

    Example: 2020-09-22T09:00:00
    updated_atdate-timerequired

    The date and time a job is updated.

    Example: 2020-09-22T09:00:00
    typestringrequired

    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.

    Possible values: [child-products, product-import, product-export, hierarchy-duplicate, price-import]

    statusstringrequired

    Possible values: [pending, cancelled, started, success, failed]

    meta objectrequired
    x_request_idstringrequired

    Applies to all job types. A unique request ID is generated when a job is created.

    copied_fromstring

    Applies to hierarchy-duplicate job types. The ID of the original hierarchy that you duplicated.

    hierarchy_idstring

    Applies to hierarchy-duplicate job types. The duplicated hierarchy ID.

    file_locationsstring[]nullable

    If the job type is product_export, a link to the file is created when running a job.

    filterstring

    The entities included in the job. For example, if the job type is product-export, the PXM products included in the export.

  • ]
  • meta objectrequired
    results objectrequired

    Contains the results for the entire collection.

    totalintegerrequired

    Total number of results for the entire collection.

    Example: 2

Authorization: http

name: bearerAuthtype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/pcm/jobs");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://euwest.api.elasticpath.com
Auth
ResponseClear

Click the Send API Request button above and see the response here!

We use cookies to enhance your experience. By continuing to visit this site you agree to our use of cookies.