Inkthreadable Integration
Order Desk can submit your print on demand orders to Inkthreadable. 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
To connect to Inkthreadable, click on Manage Integrations in the left sidebar. Under the Print on Demand tab, find and click to enable the Inkthreadable integration.
Alternatively, search for Inkthreadable from the available integrations search:
Enter your Inkthreadable credentials (App ID and Secret Key), 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 Inkthreadable.
Integration Settings
Once connected, you will have a few settings where you can set your preferences for this integration.
Default Mail Class
Choose the mail class you want Inkthreadable to use for orders.
If you need to apply specific methods for certain orders, match your method names to their names in the Shipping Class Match section below.
After Import, Move To
Select the folder you want orders to be moved into after they are sent to Inkthreadable.
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 Inkthreadable sends shipment details back into Order Desk.
If Canceled, Move To
Select the folder you want orders to be moved into when they get canceled at Inkthreadable.
Notification URL
Add this URL to your Inkthreadable account and enable it for both the Order Shipped and Order Updated events. This lets Order Desk know when the status of your orders changes in Inkthreadable.
Product Settings
For more information on what the product settings within the Inkthreadable integration do, please read the Print on Demand Product Settings guide.
Shipping Class Match
If the shipping methods you set up in your shopping cart(s) don't match the shipping method names Inkthreadable uses, they won't know what methods you intend for them to use. When this happens, the default mail class applied above will be used instead for all of your orders.
To tell Inkthreadable what methods you want them to use, you will need to match your method names to theirs. This can be done in the shipping class match section. For detailed instructions on setting this up, please read through the shipping class match guide.
Sending Orders to Inkthreadable
Getting your orders ready to send to Inkthreadable 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 Orders
The following details can be submitted for an order as either checkout data or order metadata.
| Field Name | Field Description |
|---|---|
| brand | Use this to pass the brand name for the order. |
| packing_slip | Use this to pass the packing slip URL. |
| note | Use this to pass additional comments about the order. |
If you are unfamiliar with checkout data, see the How to Work with Checkout Data guide.
Preparing Your Items
The following fields can be set as variations or item metadata for each order item.
| Field Name | Field Description |
|---|---|
| print_sku | Required. Inkthreadable’s product code or SKU for the item. |
| print_url_x | Required. Link to your artwork file. Supports up to 5 files using print_url_1 through print_url_5. |
| print_location_x |
Required. Sets where each artwork should be printed on the item. Supports up to 5 values using print_location_1 through print_location_5. Each location must match the related print_url_x. Supported location values include front and back. For other supported values, reach out to Inkthreadable. |
| print_preview_x | Optional. Link to a preview image of the finished product. Supports up to 5 values using print_preview_1 through print_preview_5. |
| label_type | Optional. Sets the label type for the item. Defaults to printed if unset. |
| item_brand | Optional. Brand name for the item. |
Rules Reference
In addition to the general set of rule events and actions in Order Desk, Inkthreadable includes a number of rule events and actions that are specific to the integration. These aren’t found directly on the integration page. Instead, you’ll need to use the Rule Builder to access them.
If you’re new to using rules in Order Desk, we recommend starting with our How to Work With Rules guide.
Rule Events
The following events are specific to Inkthreadable. To find them, type Inkthreadable in the Event dropdown menu in the Rule Builder:
| Event | Description |
|---|---|
| Order Canceled at Inkthreadable | Triggered when an order is canceled at Inkthreadable. |
| Order Scheduled to Inkthreadable |
Triggered when an order is scheduled to be sent from Order Desk to Inkthreadable. This triggers immediately after the order is scheduled to be sent, so it can be used when you want to take immediate action on the order at that point. |
| After Order Submitted to Inkthreadable | Triggers after an order has been successfully submitted to Inkthreadable. |
| Before Order Submitted to Inkthreadable | Triggered just before an order is sent from Order Desk to Inkthreadable. This is useful in cases where you want to make last-minute updates before an order is sent. |
| Order Not Submitted to Inkthreadable Because of Invalid SKU | Triggers when an order submission fails because one or more SKUs aren’t valid in Inkthreadable. |
| Order Not Submitted to Inkthreadable Because of General Error | Triggers when a general error prevents the order from being submitted to Inkthreadable. |
| Order Not Submitted to Inkthreadable Because No Products Available | Triggers when an order submission fails because no valid products were found for submission. |
Rule Actions
Inkthreadable also supports specific rule actions that you can apply to your orders. These can be found in the Actions dropdown by searching for Inkthreadable:
| Action | Description |
|---|---|
| Submit Order to Inkthreadable | Sends an order from Order Desk to Inkthreadable. |
| Cancel Order at Inkthreadable | Attempts to cancel an order that was previously submitted to Inkthreadable. |