Documentation

Everything you need to know about implementing Digital Product Passports in your business.

Getting Started

Follow these steps to start implementing Digital Product Passports in your business.

Installation

Install our SDK using your preferred package manager:

npm install @digital-passports/sdk

Quick Start

Initialize the SDK with your API key:

import { DigitalPassport } from '@digital-passports/sdk';
const dpp = new DigitalPassport({
  apiKey: 'your_api_key',
  environment: 'production'
});

Core Concepts

Product Passports

Digital records containing comprehensive product information, from materials to sustainability metrics.

API Access

RESTful API endpoints for creating, managing, and accessing product passports programmatically.

Integrations

Pre-built connectors for popular e-commerce platforms and ERP systems.

Compliance

Built-in validation and templates ensuring compliance with EU DPP regulations.

API Reference

Complete reference for all API endpoints and methods.

GET/v1/passports

List all passports

Returns a paginated list of all Digital Product Passports.

Request Example

curl -X GET "https://api.digitalpassporthub.com/v1/passports" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "data": [
    {
      "id": "pp_123",
      "sku": "TSHIRT-M",
      "status": "active"
    }
  ],
  "meta": {
    "total": 42,
    "page": 1
  }
}

POST/v1/passports

Create a passport

Creates a new Digital Product Passport.

Request Example

curl -X POST "https://api.digitalpassporthub.com/v1/passports" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sku": "TSHIRT-M",
    "name": "Organic Cotton T-Shirt"
  }'

Response

{
  "id": "pp_123",
  "sku": "TSHIRT-M",
  "name": "Organic Cotton T-Shirt",
  "status": "active"
}

SDK Documentation

Learn how to use our SDK to integrate Digital Product Passports into your applications.

createPassport(data)

Creates a new Digital Product Passport.

const passport = await dpp.createPassport({
  sku: "TSHIRT-M",
  name: "Organic Cotton T-Shirt",
  materials: [
    { name: "Organic Cotton", percentage: 100 }
  ]
});

Parameters

data (object) - Passport data including SKU and product details

Returns

Promise resolving to the created passport object

generateQRCode(passportId, options)

Generates a QR code for a specific passport.

const qrCode = await dpp.generateQRCode("pp_123", {
  size: 256,
  format: "svg"
});

Parameters

passportId (string) - ID of the passport
options (object) - QR code generation options

Returns

Promise resolving to the QR code data

Platform Integrations

Ready-to-use integrations for popular e-commerce and ERP platforms.

Shopify

Connect your Shopify store to automatically sync products and generate DPPs.

View Integration Guide →

WooCommerce

Integrate with your WooCommerce-powered site for seamless product data management.

View Integration Guide →

SAP

Sync your product data from SAP S/4HANA for enterprise-grade DPP management.

View Integration Guide →

Salesforce

Connect with Salesforce Commerce Cloud to manage your product passports.

View Integration Guide →