enh: added support for get job item status

Author: sunil-lakshman

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [v1.27.6](https://github.com/contentstack/contentstack-management-javascript/tree/v1.27.6) (2026-03-02)
+ - Enhancement
+   - Added support for get job item status.
+
 ## [v1.27.5](https://github.com/contentstack/contentstack-management-javascript/tree/v1.27.5) (2026-02-16)
  - Enhancement
    - OAuth PKCE: store code_verifier in sessionStorage (browser only) so token exchange works after redirect in React and other SPAs; verifier is restored on callback, cleared after successful exchange or on error; 10-minute expiry; Node remains memory-only

lib/stack/bulkOperation/index.js

@@ -126,6 +126,49 @@ export function BulkOperation (http, data = {}) {
     }
   }
 
+  /**
+   * The getJobItems request allows you to get the items of a bulk job.
+   * Response structure varies based on query params: items (always), skip/limit/total_count (when include_count=true), and other fields per params.
+   * @memberof BulkOperation
+   * @func getJobItems
+   * @returns {Promise<Object>} Response Object. Structure varies with params - always includes items array; may include skip, limit, total_count when include_count=true.
+   * @param {String} job_id - The ID of the job.
+   * @param {Object} [params={}] - Query parameters. Supports: include_count, skip, limit, include_reference, status, type, ct (content type UID or array), api_version, and any other dynamic query params.
+   * @example
+   * client.stack({ api_key: 'api_key'}).bulkOperation().getJobItems('job_id')
+   * .then((response) => { console.log(response) })
+   * @example
+   * client.stack({ api_key: 'api_key'}).bulkOperation().getJobItems('job_id', { skip: 0, limit: 50, include_count: true })
+   * .then((response) => { console.log(response) })
+   */
+  // eslint-disable-next-line camelcase
+  this.getJobItems = async (job_id, params = {}) => {
+    // eslint-disable-next-line camelcase
+    const { api_version = '3.2', ...queryParams } = cloneDeep(params)
+    // eslint-disable-next-line camelcase
+    this.urlPath = `/bulk/jobs/${job_id}/items`
+    const headers = {
+      headers: {
+        ...cloneDeep(this.stackHeaders)
+      }
+    }
+    // eslint-disable-next-line camelcase
+    if (api_version) headers.headers.api_version = api_version
+    if (Object.keys(queryParams).length > 0) headers.params = queryParams
+    try {
+      const response = await http.get(this.urlPath, headers)
+      if (response.data) {
+        // eslint-disable-next-line camelcase
+        if (api_version) delete headers.headers.api_version
+        return response.data
+      }
+    } catch (error) {
+      // eslint-disable-next-line camelcase
+      if (api_version) delete headers.headers.api_version
+      console.error(error)
+    }
+  }
+
   /**
    * The Publish entries and assets in bulk request allows you to publish multiple entries and assets at the same time.
    * @memberof BulkOperation

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/management",
-  "version": "1.27.5",
+  "version": "1.27.6",
   "description": "The Content Management API is used to manage the content of your Contentstack account",
   "main": "./dist/node/contentstack-management.js",
   "browser": "./dist/web/contentstack-management.js",

package.json

@@ -536,6 +536,26 @@ describe('BulkOperation api test', () => {
     expect(response.body).to.not.equal(undefined)
   })
 
+  it('should get job items for a completed job', async () => {
+    await waitForJobReady(jobId1)
+
+    const response = await doBulkOperationWithManagementToken(tokenUidDev)
+      .getJobItems(jobId1)
+
+    expect(response).to.not.equal(undefined)
+    expect(response.items).to.be.an('array')
+  })
+
+  it('should get job items with explicit api_version', async () => {
+    await waitForJobReady(jobId2)
+
+    const response = await doBulkOperationWithManagementToken(tokenUidDev)
+      .getJobItems(jobId2, { api_version: '3.2' })
+
+    expect(response).to.not.equal(undefined)
+    expect(response.items).to.be.an('array')
+  })
+
   it('should delete a Management Token', done => {
     makeManagementToken(tokenUid)
       .delete()

test/sanity-check/api/bulkOperation-test.js

@@ -11,6 +11,7 @@ describe('Contentstack BulkOperation test', () => {
     expect(bulkOperation.urlPath).to.be.equal('/bulk')
     expect(bulkOperation.stackHeaders).to.be.equal(undefined)
     expect(bulkOperation.addItems).to.not.equal(undefined)
+    expect(bulkOperation.getJobItems).to.not.equal(undefined)
     expect(bulkOperation.publish).to.not.equal(undefined)
     expect(bulkOperation.unpublish).to.not.equal(undefined)
     expect(bulkOperation.delete).to.not.equal(undefined)
@@ -23,6 +24,7 @@ describe('Contentstack BulkOperation test', () => {
     expect(bulkOperation.stackHeaders).to.not.equal(undefined)
     expect(bulkOperation.stackHeaders.api_key).to.be.equal(stackHeadersMock.api_key)
     expect(bulkOperation.addItems).to.not.equal(undefined)
+    expect(bulkOperation.getJobItems).to.not.equal(undefined)
     expect(bulkOperation.publish).to.not.equal(undefined)
     expect(bulkOperation.unpublish).to.not.equal(undefined)
     expect(bulkOperation.delete).to.not.equal(undefined)
@@ -218,6 +220,142 @@ describe('Contentstack BulkOperation test', () => {
     expect(response.notice).to.equal('Your job status request is successful.')
     expect(response.status).to.equal('completed')
   })
+
+  it('should fetch job items with default api_version', async () => {
+    const jobId = 'job_id'
+
+    const mock = new MockAdapter(Axios)
+    mock.onGet(`/bulk/jobs/${jobId}/items`).reply((config) => {
+      expect(config.headers.api_version).to.equal('3.2')
+      return [200, {
+        items: [
+          { uid: 'entry_uid', content_type_uid: 'content_type_uid', status: 'completed' }
+        ]
+      }]
+    })
+
+    const response = await makeBulkOperation().getJobItems(jobId)
+    expect(response.items).to.not.equal(undefined)
+    expect(response.items).to.be.an('array')
+    expect(response.items[0].uid).to.equal('entry_uid')
+    expect(response.items[0].content_type_uid).to.equal('content_type_uid')
+  })
+
+  it('should fetch job items with custom api_version', async () => {
+    const jobId = 'job_id'
+    const params = { api_version: '3.0' }
+
+    const mock = new MockAdapter(Axios)
+    mock.onGet(`/bulk/jobs/${jobId}/items`).reply((config) => {
+      expect(config.headers.api_version).to.equal('3.0')
+      return [200, { items: [] }]
+    })
+
+    const response = await makeBulkOperation().getJobItems(jobId, params)
+    expect(response.items).to.not.equal(undefined)
+    expect(response.items).to.be.an('array')
+  })
+
+  it('should fetch job items with query params: include_count, skip, limit', async () => {
+    const jobId = 'job_id'
+    const params = {
+      include_count: true,
+      skip: 10,
+      limit: 50
+    }
+
+    const mock = new MockAdapter(Axios)
+    mock.onGet(`/bulk/jobs/${jobId}/items`).reply((config) => {
+      expect(config.params.include_count).to.equal(true)
+      expect(config.params.skip).to.equal(10)
+      expect(config.params.limit).to.equal(50)
+      return [200, { items: [], count: 0 }]
+    })
+
+    const response = await makeBulkOperation().getJobItems(jobId, params)
+    expect(response.items).to.be.an('array')
+    expect(response.count).to.equal(0)
+  })
+
+  it('should fetch job items with query params: include_reference, status, type', async () => {
+    const jobId = 'job_id'
+    const params = {
+      include_reference: false,
+      status: 'failed',
+      type: 'entry'
+    }
+
+    const mock = new MockAdapter(Axios)
+    mock.onGet(`/bulk/jobs/${jobId}/items`).reply((config) => {
+      expect(config.params.include_reference).to.equal(false)
+      expect(config.params.status).to.equal('failed')
+      expect(config.params.type).to.equal('entry')
+      return [200, { items: [] }]
+    })
+
+    const response = await makeBulkOperation().getJobItems(jobId, params)
+    expect(response.items).to.be.an('array')
+  })
+
+  it('should fetch job items with ct (content type) filter as array', async () => {
+    const jobId = 'job_id'
+    const params = { ct: ['content_type_uid_1', 'content_type_uid_2'] }
+
+    const mock = new MockAdapter(Axios)
+    mock.onGet(`/bulk/jobs/${jobId}/items`).reply((config) => {
+      expect(config.params.ct).to.be.an('array')
+      expect(config.params.ct).to.deep.equal(['content_type_uid_1', 'content_type_uid_2'])
+      return [200, { items: [] }]
+    })
+
+    const response = await makeBulkOperation().getJobItems(jobId, params)
+    expect(response.items).to.be.an('array')
+  })
+
+  it('should fetch job items with dynamic query params', async () => {
+    const jobId = 'job_id'
+    const params = {
+      include_count: true,
+      skip: 0,
+      limit: 100,
+      include_reference: true,
+      status: 'success',
+      type: 'asset',
+      ct: ['blog_post', 'author'],
+      custom_param: 'custom_value'
+    }
+
+    const mock = new MockAdapter(Axios)
+    mock.onGet(`/bulk/jobs/${jobId}/items`).reply((config) => {
+      expect(config.params.include_count).to.equal(true)
+      expect(config.params.skip).to.equal(0)
+      expect(config.params.limit).to.equal(100)
+      expect(config.params.include_reference).to.equal(true)
+      expect(config.params.status).to.equal('success')
+      expect(config.params.type).to.equal('asset')
+      expect(config.params.ct).to.deep.equal(['blog_post', 'author'])
+      expect(config.params.custom_param).to.equal('custom_value')
+      return [200, { items: [], count: 0 }]
+    })
+
+    const response = await makeBulkOperation().getJobItems(jobId, params)
+    expect(response.items).to.be.an('array')
+    expect(response.count).to.equal(0)
+  })
+
+  it('should fetch job items with empty params object', async () => {
+    const jobId = 'job_id'
+
+    const mock = new MockAdapter(Axios)
+    mock.onGet(`/bulk/jobs/${jobId}/items`).reply((config) => {
+      expect(config.headers.api_version).to.equal('3.2')
+      expect(config.params).to.equal(undefined)
+      return [200, { items: [] }]
+    })
+
+    const response = await makeBulkOperation().getJobItems(jobId, {})
+    expect(response.items).to.be.an('array')
+  })
 })
 
 function makeBulkOperation (data) {

test/unit/bulkOperation-test.js

@@ -9,6 +9,7 @@ export interface BulkOperation extends SystemFields {
     addItems(config: BulkAddItemsConfig): Promise<Response>
     updateItems(config: BulkAddItemsConfig): Promise<Response>
     jobStatus(config: BulkJobStatus): Promise<Response>
+    getJobItems(job_id: string, params?: BulkJobItemsParams): Promise<BulkJobItemsResponse>
 }
 export interface BulkOperationConfig {
     details: PublishItems
@@ -61,4 +62,52 @@ export interface BulkJobStatus {
     job_id: AnyProperty;
     bulk_version?: string;
     api_version?: string;
+}
+
+export interface BulkJobItemsParams {
+    api_version?: string;
+    include_count?: boolean;
+    skip?: number;
+    limit?: number;
+    include_reference?: boolean;
+    status?: string;
+    type?: string;
+    ct?: string | string[];
+    [key: string]: unknown;
+}
+
+export interface BulkJobItem {
+    uid: string;
+    locale: string;
+    version: number;
+    title: string;
+    type: "asset" | "entry";
+    publish_details: {
+        status: string;
+        failure_reason?: string;
+    };
+    publish_locale: string;
+    environment: string;
+    action: string;
+    published_at: string | null;
+    scheduled_at: string;
+    user: string;
+    depth: number;
+    content_type?: { uid: string };
+}
+
+/**
+ * Response structure varies based on query params passed to getJobItems:
+ * - items: Always present - array of job items
+ * - skip, limit, total_count: Present when include_count=true
+ * - Additional fields may be included based on other params (e.g. include_reference)
+ */
+export interface BulkJobItemsResponse {
+    items?: Array<BulkJobItem | AnyProperty>;
+    skip?: number;
+    limit?: number;
+    total_count?: number;
+    count?: number;
+    notice?: string;
+    [key: string]: unknown;
 }