Printful SDK for Node.js (TypeScript)

📢 Notice: Printful API v2 is in beta, and this package is still in development. Expect changes until the stable release.

Guidelines and source endpoints can be found here: developers.printful.com.

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.

Contributing

Pull requests welcome! If you're interested in contributing to this project, please read 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