spencerlepine / printify-sdk-js

Printify SDK for Node.js / TypeScript. A wrapper for the Printify REST API (v1)
https://github.com/spencerlepine/printify-sdk-js/blob/main/docs/API.md
MIT License
2 stars 0 forks source link
javascript nodejs nodejs-sdk printify printify-api printify-sdk typescript

Printify SDK for TypeScript (Node.js)

NPM Version Coverage MIT license

Printify SDK for Node.js. A basic TypeScript wrapper for the Printify REST API (v1). Guidelines and source endpoints can be found here: developers.printify.com.

Getting started

Prerequisites

Installation

# Npm
npm install printify-sdk-js

# Yarn
yarn add printify-sdk-js

# Pnpm
pnpm add printify-sdk-js

Usage

⚠️ For security purposes, this is intended only for server-side use, the API does not support CORS and will not process requests from a frontend application

$ curl -X GET <https://api.printify.com/v1/shops.json> --header "Authorization: Bearer $PRINTIFY_API_TOKEN"`
# ref: https://developers.printify.com/#create-a-personal-access-token
import Printify from 'printify-sdk-js';
// const Printify = require('printify-sdk-js'); // CommonJS

const printify = new Printify({
  shopId: '123456', // global query by shop_id
  accessToken: process.env.PRINTIFY_API_KEY,
});

(async () => {
  const data = {/* ... */};
  try {
    const result = await printify.orders.submit(data);
    console.log(result); // { "id": "5a96f649b2439217d070f507" }
  } catch (error) {
    console.error('Error submitting order:', error);
  }
})();

API

For the full documentation, please see API.md

Contributing

We welcome contributions from the community! 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 Printify. It is provided "as is" without warranty of any kind. For official information and guidelines on using the Printify API, please refer to the Printify Developer Documentation.

License

MIT