Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/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
javascript nodejs nodejs-sdk printify printify-api printify-sdk typescript
Last synced: 3 months ago
JSON representation
Printify SDK for Node.js / TypeScript. A wrapper for the Printify REST API (v1)
- Host: GitHub
- URL: https://github.com/spencerlepine/printify-sdk-js
- Owner: spencerlepine
- License: mit
- Created: 2024-07-11T17:35:24.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T18:46:01.000Z (4 months ago)
- Last Synced: 2024-10-25T19:45:07.338Z (4 months ago)
- Topics: javascript, nodejs, nodejs-sdk, printify, printify-api, printify-sdk, typescript
- Language: TypeScript
- Homepage: https://github.com/spencerlepine/printify-sdk-js/blob/main/docs/API.md
- Size: 4.87 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Printify SDK for TypeScript (Node.js)
[](https://www.npmjs.com/package/printify-sdk-js)
 
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](https://developers.printify.com).
## Getting started
### Prerequisites
- Printify Personal Access Token (create one [here](https://printify.com/app/account/api))
### Installation
```sh
# 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
```sh
# generate a token: https://printify.com/app/account/api
export PRINTIFY_API_TOKEN="asdfASDFasdfASDFasdfASDF"
# fetch your shopId
curl -X GET https://api.printify.com/v1/shops.json --header "Authorization: Bearer $PRINTIFY_API_TOKEN"
# Expected response: [{"id":1234567,"title":"My Store Name","sales_channel":"custom_integration"}]
# store for process.env.PRINTIFY_API_TOKEN
echo "PRINTIFY_API_TOKEN=\"$PRINTIFY_API_TOKEN\"" >> .env
```
```js
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_TOKEN,
enableLogging: true, // on by default
});
const orderData = {
label: order_123456,
line_items: [
{
print_provider_id: '12345',
blueprint_id: '67890',
variant_id: '112233',
print_areas: {
front: 'https://example.com/path/to/sticker.png', // **must be public
},
quantity: 1,
},
// ...
],
shipping_method: 1,
is_printify_express: false,
is_economy_shipping: false,
send_shipping_notification: true, // send email
address_to: {
first_name: 'John',
last_name: 'Doe',
email: '[email protected]',
phone: '0574 69 21 90',
country: 'US',
region: 'NY',
address1: '123 Main Street',
address2: '',
city: 'New York',
zip: '10001',
},
};
try {
const result = await printify.orders.submit(orderData);
console.log(result); // { "id": "5a96f649b2439217d070f507" }
} catch (error) {
console.error('Error submitting order:', error);
}
```
## API
For the full documentation, please see [`API.md`](./docs/API.md)
- [Shops](./docs/API.md#shops) - `printify.shops.*`
- [Catalog](./docs/API.md#catalog) - `printify.catalog.*`
- [Products](./docs/API.md#products) - `printify.products.*`
- [Orders](./docs/API.md#orders) - `printify.orders.*`
- [Uploads](./docs/API.md#uploads) - `printify.uploads.*`
- [Webhooks](./docs/API.md#webhooks) - `printify.webhooks.*`
## Contributing
We welcome contributions from the community! If you're interested in contributing to this project, please read the [CONTRIBUTING.md](./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](https://developers.printify.com/).
## License
[MIT](./LICENSE)