REST API and Webhooks

GS1 Digital Link Ready

Integrate connected packaging intelligence into your existing systems.

The ProtectCode and BrandReporter APIs let you generate GS1 Digital Link ready serialised QR codes, activate products at point of manufacture, capture first-party consumer data, and access full supply chain traceability - all from your existing ERP, WMS, packaging line, or custom application.

Access the Dashboard →Book a Free Demo

API Endpoints

What the API
lets you do.

A production-grade REST API with API key authentication, batch processing,
webhooks, and full GS1 Digital Link support. Built for integration with enterprise
manufacturing and logistics systems.

Post

Create ProtectCode Batch

Generate a batch of unique serialised QR codes linked to a specific product SKU and campaign. Configure code format, size, GS1 Digital Link settings, and metadata at batch level.

POST /v1/company/{companyId}/protectcode/batch

get

Poll Batch Status

Check generation progress. Batch moves through initiated, generating, and ready states. Generation runs at approximately 1 million codes per 5 minutes. Webhooks available as an alternative to polling.

GET /v1/company/{companyId}/protectcode/batch/{id}

get

Fetch Codes for Printing

Retrieve codes by page/limit or fetch inactive codes only - enabling a fetch-print-activate-repeat workflow without manually tracking your position in the batch. Limit of 1,000 per call.

GET /v1/company/{companyId}/protectcode/batch/{id}/inactive-codes

POST

Activate ProtectCodes

Activate up to 100 codes per API call at the point of manufacture. Supports metadata at activation - batch ID, production date, expiry, line ID, and any custom fields your process requires.

POST /v1/protectcode/activate

COMING SOON

BrandReporter Traceability API

Access the full supply chain event history for any container or product via API. BrandReporter API endpoints are in active development and will be published before launch. Contact us to register your interest in early access.

GET /v1/company/{companyId}/brandreporter/container/{id}

POST

Webhook Events

Subscribe to batch status changes, scan events, and other system updates. Webhooks fire in real time - no polling required. Configurable per event type and per company.

Configured per company via Dashboard

Integration Pattern

From packaging line
to authenticated product.

The typical manufacturing integration follows four steps. Your line creates a batch, polls until ready, fetches codes for printing, and activates as each product is labelled. Metadata at activation links the code to your internal production records.

Create batch

POST a batch for your product and campaign. Specify code format and size.

Poll or listen

Poll the batch endpoint or subscribe via webhook until status is "ready".

Fetch and print

GET inactive codes in batches of up to 1,000. Send to label printer or packaging line.

Activate on line

POST activation as each product is labelled. Add production metadata at this point.

// Create Batch - Example Request

POST /v1/company/{companyId}/protectcode/batch

{
  "activationType": "manual",
  "campaignId": "{campaign ID}",
  "config": {
    "gslLinks": false,
    "protectCode": {
      "format": "numeric",
      "length": 4,
      "singleCode": false
    }
  },
  "domain": "{company domain}",
  "name": "Reserve Shiraz - Batch 2024-01",
  "productId": "{product ID}",
  "size": 10000,
  "isTest": false,
  "metadata": {}
}

// Activate Codes - Example Request

POST /v1/protectcode/activate

{
  "companyId": "your-company-id",
  "activate": [
    {
      "url": "{protectcode url}",
      "metadata": {
        "batchId": "2024-Q1-LINE-A",
        "productionDate": "2024-03-15",
        "expiryDate": "2026-03-15"
      }
    }
  ]
}

// Up to 100 codes per request
// API Key sent in x-api-key header

What We Connect To

Integrate with the systems
you already use.

The ProtectCode API is designed to fit into your existing technology stack. No
rip-and-replace. Connect to what you already have.

ERP Systems

Connect ProtectCode batch creation and activation to your ERP production orders. Automatically generate codes when a production run is created and activate as items complete the line. Metadata links your internal production records to each code.

SAP compatible

MS Dynamics compatible

Any REST-capable ERP

Warehouse Management Systems

Feed BrandReporter supply chain events directly from your WMS. Scan in, scan out, transfer between sites, and customer order dispatch can all trigger BrandReporter events automatically via the API.

Any REST-capable WMS

3PL systems

Custom WMS

Packaging and Label Printing Lines

Direct integration with label print and apply systems. Fetch inactive codes from a batch, send to your printer controller, and POST activation as each label is applied. Works with standard industrial printers - no special hardware required.

Standard label printers

Print and apply systems

Any CSV-capable printer

Supply Chain and Compliance

The BrandReporter API (in development) will expose the full supply chain event history, enabling integration with compliance workflows and importer documentation requirements. Register your interest in early access via the form below.

Supply chain events

Audit trail access

GS1 Digital Link

Coming soon

API Access

Generate your
API keys.

API access is available to all ProtectCode and BrandReporter customers. Fill in the form and our team will be in touch with your API key, documentation link, and a technical onboarding session if needed.

REST API with x-api-key header authentication

Sandbox environment available for testing

Webhook support for batch status and scan events

Technical onboarding session with our engineering team

GS1 Digital Link configuration support included

Access the Dashboard →

Integrate connected packaging intelligence into your existing systems.

API Endpoints

What the API
lets you do.

Integration Pattern

From packaging line
to authenticated product.

What We Connect To

Integrate with the systems
you already use.

Generate your
API keys.

Ready to integrate?

Platform

Company

Get Started

ASX: CDE

Integrate connected packaging intelligence into your existing systems.

API Endpoints

What the APIlets you do.

Integration Pattern

From packaging lineto authenticated product.

What We Connect To

Integrate with the systemsyou already use.

Generate yourAPI keys.

Ready to integrate?

Platform

Company

Get Started

ASX: CDE

What the API
lets you do.

From packaging line
to authenticated product.

Integrate with the systems
you already use.

Generate your
API keys.