npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

printful-ts

v1.0.5

Published

a typescript implemention of printful api

Downloads

42

Readme

printful-ts is a Typescript implmentation client liblary for Printful API,

printful offers a range of print on demand products and services

Requirements

To use this package you will need a Printful Token Key

Install

npm install printful-ts

Or

yarn add printful-ts

Usage

import PrintFulAPI from 'printful-ts';

const token = 'YOUR_API_ACCESS';
const printful = new PrintFulAPI(token);

// get scope
const scope = printful.auth.getScope();
// get categories
const categories: Category[] = printful.catelog.getCategories()
// get products
const products: Product[] = printful.catelog.getProducts(categories[0].id)
// get single product
const productId = products[9].id
const product: ProductInfo = printful.catelog.getProduct(productId)
// get variants
const variantId = product.variants[0].id
const variant: VariantInfo = printful.catelog.getVariant(variantId)
// add printfile
const new_file = new NewFileData('image', 'https://path_to_image.com');
const result: File = printful.file.addNewFile(new_file);
// generate mockup
const print_file_ids = [12345, 67890]
const mockupOptions: MockUpOptions = new MockUpOptions(print_file_ids, 'png');

Methods

Here is an overview of the methods available

auth

  • getScope

catalog

  • getProducts
  • getVariant
  • getProductSizeGuide
  • getCategories
  • getCategory

file

  • addNewFile
  • getFile
  • getThreadColors

mockup

  • newTask
  • getPrintFiles
  • getProductTemplate
  • getTaskResult

orders

  • createNewOrder
  • getOrderData
  • cancekOrder
  • updateOrderData
  • estimateOrderCosts

products

  • createSyncProduct
  • getSyncProducts
  • getSyncProduct
  • modifySyncProduct
  • deleteSyncProduct

shipping

  • calculateShippingRates

store

  • changePackingSlip
  • getStoresInfo
  • getStoreInfo

sync

  • getListOfSyncProducts
  • getSyncProduct
  • deleteSyncProduct
  • getSyncVariant
  • modifySyncVariant
  • deleteSyncVariant

tax

  • getCountries

template

  • getProductTemplate
  • deleteProductTemplate

Disclaimer

This package is no officially maintained by Printful, Use at your own risk, the links on this page pointing to Printful may result in a little kickback

License

This project is licensed under the MIT License