Skip to main content

Cancel a Job

POST 
/pcm/jobs/:jobID/cancel

The jobs endpoints display the status of a number of endpoints that function as jobs, for example, product import and export, and duplicating hierarchies.

Jobs are processed one at a time. You can continue to send job requests, but those jobs are queued. In other words, Commerce looks for any jobs that have a status of PENDING and starts the job with the earliest created date. If you decide that a specific job needs to be prioritized over another, you can cancel the less critical job using the Cancel a job endpoint. You can only cancel jobs whose status is PENDING.

Request​

Path Parameters

    jobID stringrequired

    A unique identifier for the job.

Body

    object

Responses​

Successfully cancelled job

Schema
    data object
    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.

Loading...