Skip to content
getbizprint.com

Check print job status with the BizPrint Print API

This page shows you how to check the status of your print jobs with the BizPrint Print API, by looking up one job or listing your jobs. It is for developers who send print jobs from their own app or website with an application of the Custom platform.

Checking a job’s status is also how you avoid printing twice. Every accepted POST /jobs request creates a new job, so if a request times out or you are not sure it worked, look the job up before you send it again.

All addresses on this page start with the Print API base URL:

https://print.bizswoop.app/api/connect-application/v1

Every request also carries the signing parameters publicKey, time and hash in the query string. The examples show them as placeholders.

When you create a print job, as described in Create a print job with the BizPrint Print API, the response contains the new job, including its id. Save that ID. To check the job later, send a GET request to /jobs/{id}:

GET https://print.bizswoop.app/api/connect-application/v1/jobs/YOUR_JOB_ID?publicKey=YOUR_PUBLIC_KEY&time=YOUR_TIMESTAMP&hash=YOUR_SIGNATURE

The response is a JSON object with the job in data:

{
"data": {
"id": "YOUR_JOB_ID",
"status": "done",
"description": "Order 1001 receipt",
"url": "https://example.com/receipts/1001.pdf",
"printOption": {},
"printerId": "YOUR_PRINTER_ID",
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T10:00:05.000Z"
}
}

In a real response, id and printerId are numbers. The example uses placeholders.

Field What it means
id The print job ID.
status Where the job is in the printing process. See What each status means.
description The description you sent when you created the job.
url The address of the document the station loads and prints.
printOption The print options you sent, or an empty object ({}) if you sent none.
printerId The ID of the printer the job was sent to.
createdAt, updatedAt When the job was created, and when it last changed, for example when its status changed.

You can only look up jobs that your own application created. A job created by another application, such as your WooCommerce store’s application, returns a 403 error with the code ERR_ACCESS_FORBIDDEN. A job ID that does not exist returns a 404 error with the code ERR_NOT_FOUND. See BizPrint Print API error codes and how to fix them.

To see many jobs at once, send a GET request to /jobs:

GET https://print.bizswoop.app/api/connect-application/v1/jobs?perPage=10&page=1&publicKey=YOUR_PUBLIC_KEY&time=YOUR_TIMESTAMP&hash=YOUR_SIGNATURE
Query parameter Required What it does
perPage No How many jobs to return, from 1 to 100. The default is 10.
page No Which page to return, starting at 1. The default is 1.

The response is a JSON object with a data list of jobs, with the same fields as a single job. The list:

  • contains only the jobs created by the application whose keys signed the request, and
  • is sorted from the oldest job to the newest, so your newest jobs are on the last page.

To read the list page by page, see Page through results with the BizPrint Print API.

A job’s print job status is one of these values:

Status What it means
pending Waiting to be sent to the station. A job is also set back to pending when the station did not confirm it in time and the BizPrint dashboard setting Archive offline print jobs is off. Pending jobs are sent again when the station reconnects.
connecting-to-printer BizPrint has sent the job to the station, which has not confirmed it yet.
processing The station reported that it started printing the job.
done The station reported that it printed the job.
failed The station reported that it could not print the job.
archived The station did not confirm the job within about 2 minutes, usually because it was offline, and Archive offline print jobs is on. Archived jobs are not sent again automatically.

done, failed and archived are the usual end states, but a status describes what the station reported, not what is on paper. To learn how the offline setting works, see Choose what happens to BizPrint print jobs when a station is offline.

Follow these steps when you are not sure whether a print job went through, for example after a timeout:

  1. Look up the job with GET /jobs/{id} if you saved its id from the POST /jobs response.
  2. List your recent jobs with GET /jobs if you do not have the ID. Newest jobs are on the last page.
  3. Find the job in that list by its description, url and createdAt.
  4. Check the job’s status. Do not create a new job if it is pending, connecting-to-printer, processing or done.
  5. Ask someone at the printer to look at the paper for that document.
  6. Wait for the station to finish anything it is still printing, whatever status the job shows.
  7. Create a new job only when you are sure the document did not print.

Never ask your customer to place an order or pay again to get a printout. Merchants can also reprint a job by hand, as described in Reprint a print job from the BizPrint dashboard.

Instead of checking a job again and again, you can let BizPrint tell your server with a webhook when the station reports a new status. See Receive print job updates from BizPrint with webhooks. If you do check by hand, wait a few seconds between checks, and stop once the job reaches done, failed or archived.

Need help? Contact BizPrint support at https://getbizprint.com/support/.