Skip to content

Add typed JSON output to app bulk status - #8781

Merged
isaacroldan merged 3 commits into
codex/app-bulk-json-commonfrom
codex/app-bulk-status-json
Oct 8, 2026
Merged

isaacroldan merged 3 commits into
codex/app-bulk-json-commonfrom
codex/app-bulk-status-json

Conversation

@isaacroldan

@isaacroldan isaacroldan commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

Related to https://github.com/shop/issues-develop/issues/23664

Give callers a typed, discoverable JSON result for bulk-operation status without parsing terminal output.

WHAT is this pull request doing?

Add JSON output for app bulk status, including empty lists and missing operations. Reuse the preceding common layer's bulk-operation projection, codec, and diagnostic presenter. Keep the existing text output.

Representative text output:

Bulk operation in progress (2 objects read)
ID: gid://shopify/BulkOperation/123

Matching JSON output:

{
  "storeDomain": "shop.myshopify.com",
  "apiVersion": "2026-01",
  "operationGid": "gid://shopify/BulkOperation/123",
  "operation": {
    "gid": "gid://shopify/BulkOperation/123",
    "type": "QUERY",
    "status": "RUNNING",
    "errorCode": null,
    "createdAt": "2026-09-01T00:00:00Z",
    "completedAt": null,
    "objectCount": "2",
    "url": null,
    "partialDataUrl": null
  }
}

How to manually test your changes?

Use a linked app installed on a development store.

  1. Run pnpm shopify app bulk status --store <store.myshopify.com>, then add --json. Confirm the table becomes one object with an operations array.
  2. Add --id <operation-id> to both commands. Check the existing status banner and the JSON operation fields.
  3. Run pnpm shopify app bulk status --json-schema. No app or store authentication is needed for schema discovery.

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes
  • I've considered analytics changes to measure impact
  • The change is user-facing; a minor changeset is included.

@isaacroldan
isaacroldan requested review from a team as code owners October 6, 2026 08:29
@github-actions github-actions Bot added shopify.dev preview Area: @shopify/cli @shopify/cli package issues labels Oct 6, 2026
@isaacroldan
isaacroldan added this pull request to stack #8784 October 6, 2026 08:30
@isaacroldan

Copy link
Copy Markdown
Contributor Author

/snapit

@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm.

Built from 8b7fbc5a2d0c3b89fa79b2996e33efaa3854b240. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20261006083341

Caution

After installing, validate the version by running shopify version in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

@isaacroldan
isaacroldan force-pushed the codex/app-bulk-status-json branch from 8b7fbc5 to c0bcb14 Compare October 6, 2026 10:00
@isaacroldan
isaacroldan removed this pull request from stack #8784 October 6, 2026 10:03
@isaacroldan
isaacroldan changed the base branch from main to codex/app-bulk-json-common October 6, 2026 10:03
@isaacroldan
isaacroldan added this pull request to stack #8789 October 6, 2026 10:03
@isaacroldan
isaacroldan force-pushed the codex/app-bulk-status-json branch from c0bcb14 to 99d2c65 Compare October 6, 2026 16:48

@dmerand dmerand left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tophat + changes both LGTM 🚢

@isaacroldan
isaacroldan force-pushed the codex/app-bulk-status-json branch from 99d2c65 to b502af8 Compare October 7, 2026 15:33
@isaacroldan
isaacroldan force-pushed the codex/app-bulk-status-json branch from b502af8 to 42a1c30 Compare October 8, 2026 08:13
@isaacroldan
isaacroldan added this pull request to the merge queue Oct 8, 2026
Merged via the queue into main with commit f6234ab Oct 8, 2026
30 of 31 checks passed
@isaacroldan
isaacroldan deleted the codex/app-bulk-status-json branch October 8, 2026 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: @shopify/cli @shopify/cli package issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants