• Documentation >
• Apps >
• Internet of Things >
• Printful

Printful

The Printful modules allow you to watch, create, update, retrieve, and delete the orders in your Printful account.

Getting Started with Printful

Prerequisites

• A Printful account

In order to use Printful with Ibexa Connect, it is necessary to have a Printful account. If you do not have one, you can create a Printful account at printful.com/auth/register.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting Printful to Ibexa Connect

To connect your Printful account to Ibexa Connect you need to obtain the Store API Key from your Printful account and insert it in the Create a connection dialog in the Ibexa Connect module.

1. Login to your Printful account.

2. Click Settings > API > Enable API Access > Accept the Conditions.

   

3. Copy the API Key to your clipboard.

   

4. Go to Ibexa Connect and open the Printful module's Create a connection dialog.

   

5. In the Connection name field, enter a name for the connection.

6. In the Your Store's API Key field, enter the API key copied in step 3, and click Continue.

The connection has been established.

Orders

Watch Orders

Watches for new orders.

Limit	Set the maximum number of new orders Ibexa Connect should return during one scenario execution cycle.

Watch Fulfilled Orders

Watches for orders which have been fulfilled (all items shipped successfully).

Limit	Set the maximum number of fulfilled orders Ibexa Connect should return during one scenario execution cycle.

Watch Canceled Orders

Watches for new canceled orders.

Limit	Set the maximum number of canceled orders Ibexa Connect should return during one scenario execution cycle.

Get an Order

Returns information about an order.

Order ID	Select the Order ID whose details you want to retrieve.

Create an Order

Creates an order.

Product ID	Select the Product ID for which you are creating the order.
Quantity	Enter the number of product items being ordered.
URL	Enter the URL address of the Printfile being ordered.
Name	Enter the recipient's name.
Address Line 1	Enter the recipient's street address.
City	Enter the recipient's city name.
Country Code	Enter the recipient's two-letter country code. For example, the US for the United States.
ZIP (Postal Code)	Enter the recipient's area postal code.
State Code	Enter the recipient's two-digit state code. For example, AK for Alaska.
Company Name	Enter the recipient's company name.
Address Line 2	Enter the recipient company's street address.
State Name	Enter the recipient company's state name.
Country Name	Enter the recipient company's country name.
Phone	Enter the recipient's phone number.
Email	Enter the recipient's email address.

Update an Order

Updates an unsubmitted order and optionally submits it for fulfillment.

Order ID	Select the Order ID whose details you want to update.
Product ID	Select the Product ID for which you are creating the order.
Quantity	Enter the number of product items being ordered.
URL	Enter the URL address of the Printfile.
Name	Enter the recipient's name.
Address Line 1	Enter the recipient's street address.
City	Enter the recipient's city name.
Country Code	Enter the recipient's two-letter country code. For example, the US for United States.
ZIP (Postal Code)	Enter the recipient's area postal code.
State Code	Enter the recipient's two-digit state code. For example, AK for Alaska.
Company Name	Enter the recipient's company name.
Address Line 2	Enter the recipient company's street address.
State Name	Enter the recipient company's state name.
Country Name	Enter the recipient company's country name.
Phone	Enter the recipient's phone number.
Email	Enter the recipient's email address.

Cancel an Order

Cancels a pending or draft order.

Order ID	Select the Order ID you want to cancel.

Others

Make an API Call.

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.printful.com/. For example: /orders/estimate-costs

For the list of available endpoints, refer to the Printful API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - List Orders

The following API call returns all the orders from your Printfile account:

URL:

/orders

Method:

GET

Matches of the search can be found in the module's Output under Bundle > Body > result.

In our example, 4 orders were returned:

. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - List Orders

The following API call returns all the orders from your Printfile account:

URL:

/orders

Method:

GET

Matches of the search can be found in the module's Output under Bundle > Body > result.

In our example, 4 orders were returned: