Skip to main content

Get All Jobs

GET 

/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[]

    An array of jobs.

  • Array [
  • id string

    A unique identifier generated when a job is created.

    type string

    Possible values: [pim-job]

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

    attributes object
    started_at date-timenullable

    The date and time a job is started.

    completed_at date-timenullable

    The date and time a job is completed.

    created_at date-time

    The date and time a job is created.

    updated_at date-time

    The date and time a job is updated.

    type string

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

    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.
    status string

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

    meta object
    x_request_id string

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

    copied_from string

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

    hierarchy_id string

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

    file_locations string[]nullable

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

    filter string

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

  • ]
  • meta object
    results object

    Contains the results for the entire collection.

    total integer

    Total number of results for the entire collection.

Loading...