Skip to content
BizPrintBizPrintBizPrint Docs
getbizprint.com

Move the BizPrint plugin for WooCommerce from the Legacy API to the REST API

This page shows you how to move your WooCommerce store’s BizPrint connection from the Legacy API to the REST API. It is for store owners, developers and agencies whose BizPrint plugin for WooCommerce still uses the Legacy API, which is usually a store that was connected to BizPrint several years ago.

The Legacy API is no longer recommended. The REST API is the current way for the plugin to talk to BizPrint, and only the REST API lets BizPrint send print job status updates back to your store. New connections use the REST API, so you do not need this page for a new store.

Check which API your store uses

Section titled “Check which API your store uses”
  1. Sign in to WordPress as an administrator.
  2. Go to WooCommerce > Print Manager.
  3. Click the Application tab.
  4. Look at API Version in the Application API Keys section.
  • If it shows REST API, your store already uses the REST API. You do not need to do anything.
  • If it shows Legacy API and a Migrate to REST API button, follow the steps on this page.

You can also see it in the BizPrint dashboard:

  1. Sign in to the BizPrint dashboard.
  2. Click Applications in the menu.
  3. Click your store’s application.
  4. Look at API Version. It shows Legacy API or REST API.

Before you start

Section titled “Before you start”
  • Make sure the Public Key and Secret Key on the Application tab are the keys of your store’s application in the BizPrint dashboard. The switch uses them to contact BizPrint.
  • Make sure your store can connect to the internet and reach BizPrint. The plugin’s normal printing already needs this.
  • Pick a quiet moment, so you can send a test print straight after the switch.

The switch does not print anything, and it does not change your keys, printer locations or templates.

Switch to the REST API

Section titled “Switch to the REST API”
  1. Go to WooCommerce > Print Manager in WordPress.
  2. Click the Application tab.
  3. Click Migrate to REST API, next to Legacy API. The page reloads.
  4. Check API Version again. It now shows REST API.

When the switch works, BizPrint also sets your application’s webhook address to your store’s Webhook Url, the address shown on the Application tab. This is how your store receives print job status updates. In the BizPrint dashboard, your application’s API Version now shows REST API.

If API Version still shows Legacy API after the page reloads, the switch did not happen:

  1. Check that the keys on the Application tab match your application in the BizPrint dashboard.
  2. Click Migrate to REST API again.
  3. Contact BizPrint support if it still shows Legacy API.

Check before you send a test print

Section titled “Check before you send a test print”

A test print is a real print job: it prints your newest WooCommerce order again. Do these checks first, so you do not print an order twice:

  1. Look at the paper at the printer for your newest order’s printout.
  2. Check the status of the latest jobs in the BizPrint dashboard. See View print jobs and their status in the BizPrint dashboard.
  3. Wait for the station to finish anything it is still printing, whatever status the job shows.
  4. Go to WooCommerce > Print Manager in WordPress.
  5. Click the Support tab.
  6. Check Queue Status in the Print Job Queue. If a print request could not reach BizPrint, the plugin may keep it in the Print Job Queue and try again later.
  7. Wait for any pending or processing jobs to finish.

Check that printing still works

Section titled “Check that printing still works”

The Test print button appears only on a saved printer location, and only when your store has at least one order.

  1. Do the checks in Check before you send a test print.
  2. Click the Printers tab.
  3. Click the name of the printer location in the Description column.
  4. Click Test print once, only if no job for that order is pending, connecting-to-printer or processing. For more about test prints, see Send a test print from a BizPrint printer location in WooCommerce.
  5. Check that the printout looks right.

A test print still follows the location’s mapping rules from Product Mapping, Shipping Mapping or Metadata Mapping (add-ons included with some plans). If your newest order does not match a location’s rules, it does not print there.

If the printout shows “Error: No Access - Connection Issue” instead of your order, see BizPrint printout shows “Error: No Access - Connection Issue” instead of the order.

Connecting a store for the first time

Section titled “Connecting a store for the first time”

If the Application tab asks you to choose an API Version for a new connection, choose REST API. Do not choose Legacy API [Not recommended]. When you create an application in the BizPrint dashboard for a WooCommerce store, choose REST API as its API Version too. See Create a BizPrint application for your WooCommerce store.

Section titled “Related pages”

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