printify-sdk-js

Printify SDK for TypeScript (Node.js)

The Printify Node SDK provides convenient access to the Printify API from applications written in server-side JavaScript.

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

📢 Note: This SDK currently supports V1 API endpoints only. A 2.0.0 release is planned once the majority of V2 endpoints have been migrated.

Documentation

See the printify-sdk-js API docs for Node.js

• Shops - printify.shops.*
• Catalog - printify.catalog.*
• Products - printify.products.*
• Orders - printify.orders.*
• Uploads - printify.uploads.*
• Webhooks - printify.webhooks.*

Installation

npm install printify-sdk-js
# or
yarn add printify-sdk-js
# or
pnpm add printify-sdk-js

Usage

The package needs to be configured with your account's Personal Access Token (create one here).

import Printify from 'printify-sdk-js';

const printify = new Printify({
  shopId: '123456', // (optional) find using printify.shops.list()
  accessToken: process.env.PRINTIFY_API_TOKEN, // generate a token: https://printify.com/app/account/api
  enableLogging: true, //  (optional) enabled by default
});

const orders = await printify.orders.list({ limit: 5, status: 'fulfilled' });
console.log(orders); // { current_page: 1, data: [{ id: "5a9", address_to: {}, line_items: [], total_price: 2200, status: "fulfilled"  } ]

Usage with TypeScript

import Printify from 'printify-sdk-js';
import type { ListWebhooksResponse, Webhook } from 'printify-sdk-js';

const printify = new Printify({ shopId: '123456', accessToken: process.env.PRINTIFY_API_TOKEN });

const result: ListWebhooksResponse = await printify.webhooks.list();
const webhook: Webhook = result[0];
console.log(webhook); // { "topic": "order:created", "url": "https://example.com/webhooks/order/created", "shop_id": "1", "id": "5cb87a8cd490a2ccb256cec4" }

Usage with CommonJS

const Printify = require('printify-sdk-js');

const printify = new Printify({
  shopId: '123456',
  accessToken: process.env.PRINTIFY_API_TOKEN,
  enableLogging: true,
});

printify.orders
  .list({ limit: 5, status: 'fulfilled' })
  .then(orders => console.log(orders))
  .catch(error => console.error(error));

Development

yarn install
yarn test

If you do not have yarn installed, you can get it with npm install --global yarn.

# (optional) test the bundle locally
yarn build
mv dist examples/development
cd examples/development
yarn start

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