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

200

Returns all the jobs.

application/json

Schema

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.

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "type": "pim-job",
      "attributes": {
        "started_at": "2020-09-22T09:00:00",
        "completed_at": "2020-09-22T09:00:00",
        "created_at": "2020-09-22T09:00:00",
        "updated_at": "2020-09-22T09:00:00",
        "type": "child-products",
        "status": "pending"
      },
      "meta": {
        "x_request_id": "string",
        "copied_from": "string",
        "hierarchy_id": "string",
        "file_locations": [
          "string"
        ],
        "filter": "string"
      }
    }
  ],
  "meta": {
    "results": {
      "total": 2
    }
  }
}

completed

Get all jobs

{
  "data": [
    {
      "type": "pim-job",
      "id": "1ea62172-57f6-45e5-a708-ab5bd634e3f9",
      "attributes": {
        "completed_at": "2024-01-05T13:46:42.142Z",
        "created_at": "2024-01-05T13:46:41.695Z",
        "started_at": "2024-01-05T13:46:42.07Z",
        "status": "success",
        "type": "product-import",
        "updated_at": "2024-01-05T13:46:42.07Z"
      },
      "meta": {
        "x_request_id": "7e832a26-d615-4305-b26a-e33c9c2fc06a"
      }
    },
    {
      "type": "pim-job",
      "id": "3ab3deca-1f11-47b7-a409-24ea3234d72c",
      "attributes": {
        "created_at": "2024-01-05T13:42:41.695Z",
        "status": "started",
        "type": "product-import",
        "updated_at": "2024-01-05T13:42:42.07Z"
      },
      "meta": {
        "x_request_id": "9ac00140-0037-4c6a-913c-b812196a2de6"
      }
    },
    {
      "type": "pim-job",
      "id": "7e1b9ba1-c844-4556-9b16-4ae3f0988b0f",
      "attributes": {
        "completed_at": "2024-01-05T15:27:23.663Z",
        "created_at": "2024-01-05T15:27:23.161Z",
        "started_at": "2024-01-05T15:27:23.65Z",
        "status": "success",
        "type": "product-export",
        "updated_at": "2024-01-05T15:27:23.65Z"
      },
      "meta": {
        "file_locations": [],
        "filter": "eq(sku,product-1)",
        "x_request_id": "fad8c5c0-9546-4e0c-b68e-8a2d809891e5"
      }
    }
  ],
  "meta": {
    "results": {
      "total": 1
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors undefined[]required
Array [
status stringrequired
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"
        ]
      }
    }
  ]
}

bad-request

{
  "errors": [
    {
      "title": "Bad Request",
      "detail": "Could not parse the supplied filter",
      "status": "400"
    }
  ]
}

404

Bad Request. Not Found.

application/json

Schema

Schema

errors undefined[]required
Array [
status stringrequired
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": [
    {
      "title": "Not Found",
      "status": "404"
    }
  ]
}

422

Bad request. The request failed validation.

application/json

Schema

Schema

errors undefined[]required
Array [
status stringrequired
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"
        ]
      }
    }
  ]
}

failed-validation

{
  "errors": [
    {
      "title": "Failed Validation",
      "status": "422",
      "detail": "<XYZ> can not be empty"
    }
  ]
}

500

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

application/json

Schema

Schema

errors undefined[]required
Array [
status stringrequired
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...