printful-sdk-js-v2

Printful SDK for Node.js (TypeScript)

A lightweight SDK for interacting with the Printful RESTful API, written in TypeScript. Designed for server-side use in Node.js environments.

🔗 Official API docs: developers.printful.com

📢 Notice: Printful API v2 is currently in beta. While an official release date and roadmap have not yet been announced, most v2 endpoints are already available. This SDK is actively being developed, and breaking changes may occur until the first stable release. If you encounter any issues, feel free to open an issue!

Announcements

• 2024-11-31: Printful and Printify announced a merge, no API changes planned, both platforms will operate separately "for the foreseeable future"
• 2024-08-05: initial SDK pre-release: v2.0.0-beta
• 2023-09-14: Printful announces API V2 beta release

Documentation

View the site here: spencerlepine.github.io/printful-sdk-js-v2

Installation

# npm
npm install printful-sdk-js-v2

# yarn
yarn add printful-sdk-js-v2

# pnpm
pnpm add printful-sdk-js-v2

Usage

The package needs to be configured with your private token (create one here).

// getCountries.ts

import { PrintfulClient, Country } from 'printful-sdk-js-v2';
// const { PrintfulClient } = require('printful-sdk-js-v2'); // CommonJS

const printful = new PrintfulClient({
  TOKEN: '<PRINTFUL_API_TOKEN>',
});

(async () => {
  const response = await printful.countriesV2.getCountries();
  const countries: Country[] = response.data;
  console.log(countries);
})();

Configuration

import { PrintfulClient } from 'printful-sdk-js-v2';

const printful = new PrintfulClient({
  TOKEN: '<PRINTFUL_API_TOKEN>',
});

Option	Default	Description
TOKEN	null	The private token for authenticating requests. Generate one at Printful Developers.

Example Code

These samples are provided as-is and are not guaranteed to be production-ready. They serve as a starting point for your own implementation.

• JavaScript: examples/javascript
• TypeScript: examples/typescript

Contributing

Pull requests welcome! If you need assistance contributing to this project, please review the CONTRIBUTING.md file to get started.

Disclaimer

This SDK is a third-party library and is not officially endorsed or maintained by Printful. It is provided "as is" without warranty of any kind. For official information and guidelines on using the Printful API, please refer to the Printful Developer Documentation.

License

MIT