PrintAPI Integration

Order Desk can submit your print on demand orders to PrintAPI. As orders are fulfilled, the shipment info will automatically be pulled back into Order Desk and sent back to the original shopping cart.

IN THIS GUIDE

Setup
Integration Settings
Product Settings
Sending Orders to PrintAPI

Setup

To connect to PrintAPI, click on Manage Integrations in the left sidebar. Under the Print on Demand tab, find and click to enable the PrintAPI integration.

Alternatively, search for PrintAPI from the available integrations search.

Copy your webhook URL over to your settings at PrintAPI, enter your PrintAPI credentials, then click to connect:

Please note that Order Desk isn’t able to help find or reset your credentials, as they can only be provided by PrintAPI.

Integration Settings

Once connected, you will have a few settings where you can set your preferences for this integration.

After Import, Move To

Select the folder you want orders to be moved into after they are sent to PrintAPI.

If you want to use a custom folder, create your own from Store Settings. See the Working with Folders guide for more information.

After Shipment, Move To

Select the folder you want orders to be moved into when PrintAPI sends shipment details back into Order Desk.

If Canceled, Move To

Select the folder you want orders to be moved into if the order is cancelled at PrintAPI.

Send Customer Email Address to PrintAPI

If required, select this option to send customer email addresses to PrintAPI.

Shipment Webhook URL

The Shipment Webhook URL is how PrintAPI tells Order Desk about your order shipments. This URL must be set up at PrintAPI for Order Desk to automatically pull in tracking details on orders sent to PrintAPI.

Product Settings

For more information on what the product settings within the PrintAPI integration do, please read the Print on Demand Product Settings guide.

Sending Orders to PrintAPI

Getting your orders ready to send to PrintAPI will take some set up time. For a detailed walkthrough of how to use Order Desk with your Print on Demand orders, please read through our Print on Demand Fulfillment guide.

Preparing Your Items

The following fields can be set as variations or item metadata for each order item.

Field Name Field Description
print_url Link to your artwork file so PrintAPI can print it.
print_location First is default cover, second is content.
page_count Default is 24. Must be an even number.
print_option_name Set up to 5 option names on an item as print_option_name_1 through print_option_name_5. Use with print_option_value.  Note: These names are case-sensitive, and should be added exactly as they are listed in PrintAPI. (Example: Canvas border instead of canvas borderHanger Set for Canvas instead of hanger set for canvas, etc.)
print_option_value Set up to 5 option values on an item as print_option_value_1 through print_option_value_5. Use with print_option_name.  Note: These names are case-sensitive, and should be added exactly as they are listed in PrintAPI. (Example: Folded instead of foldedFloating Frame White instead of floating frame white, etc.)

Still need help? Contact Us Contact Us