Skip to content
All guides

Manage products with the API

Connect your product catalog or packaging system to CodePersist. Your team can keep product information up to date, decide when changes go live and get QR codes ready for printing.

Browse the API reference

Connect your system

The API is included with Lite and Premium. An organisation owner can create a key in CodePersist for the system you want to connect.

Create an API key

Give the key a name that identifies the system using it. Copy the secret when you create the key and keep it in secure storage. CodePersist shows it only once.

Open API keys

Choose what the key can do

A read-only key can view products and their history, preview QR codes and download existing artwork. Choose read/write access if your system also needs to make changes or generate print artwork.

Plan for key expiration

Replace the key before it expires to keep your system connected. Expiration leaves already published QR codes working as before.

Replace or revoke a key

Create a replacement key and check that your system works with it before revoking the old one. If you think a key was exposed, revoke it right away.

Walk through the life of a product

1. Create a product

Start with one product from your catalog. Use the name your team recognises, the barcode number (GTIN) from its packaging, and the web page you want people to reach when they scan. CodePersist saves the product so you can review it before it goes live.

See how to create a product in the API reference, including what your team needs to send.

2. Publish the product

Check the product’s links before you publish the saved version. Publishing makes that version available to people who scan the QR code. Check the publication history if you need to confirm what went live.

The API reference explains how to publish a product and view publishing history.

3. Prepare the QR code for print

Once the latest product version is published, download the SVG for printing using a read-only or read/write key. You can include a batch, serial number, expiration date or net weight for each code. Scan a proof to check that it opens the right page before you print the packaging.

See how to download a QR print file in the API reference.

4. Make changes after launch

If the product page moves or its links change, start with the latest saved version. Save your changes and review the new version. Publish it when you’re ready for people scanning the code to see the changes.

The API reference shows how to view the current product and save changes to a product.

5. Take the product offline

When a product should no longer be available through its QR code, disable it. CodePersist keeps the product and its history. Wait for the product to show as disabled before moving on.

See how to disable a product or retry a failed deactivation in the API reference.

6. Bring it back or delete it

If the product is coming back, enable it and publish it again to restore access through the QR code. If you no longer need its record, you can permanently delete it once it is fully disabled.

The API reference explains how to enable a disabled product or permanently delete a disabled product.

Manage your products

Find products and review earlier versions

If an edit needs to be undone, restore an earlier version. CodePersist saves that content as a new version you can review before publishing.

See how to find products in your catalog, view saved versions or restore a previous version in the API reference.

Use your own domain

Connect and verify the domain in CodePersist first. You can then permanently attach it to an eligible product created with a CodePersist address.

Publish the updated product and generate new artwork to print codes with your domain. Existing printed codes keep the CodePersist address.

The API reference shows how to attach a custom domain after you’ve set it up in CodePersist.

Put your own domain in your product QR codes

Manage several products at once

Apply the same action to up to five products at a time. Check the result for each product, since some may succeed while others need attention.

The API reference explains how to publish several products, disable several products, enable several products or delete several disabled products in one request.

When something goes wrong

If you’re unsure whether a change went through, check the product in CodePersist before trying again. If someone else updated it, review the latest version first.

API reference

Share the reference with the team building your integration. It shows how to connect and what information to send and expect for each action.

Browse the API reference