Skip to main content

FAQ: Print API

Can I use your print API if I’m not a developer?

Our print API has primarily been designed for developers. You will need to either be a developer yourself or have access to a programmer in order to make full use of it.

We wanted to make our global print network accessible to a whole range of creators. Hence, we created the Shopify print on demand app.

The Shopify print app allows you to have the same automatic integration as the API, without the need for a developer or programmer. Simply download the Prodigi app to your Shopify store, upload your artwork, pick your products and start selling.

Alternatively, if you are an account holder, you can order using our manual order form, or via our integrations with sales channels such as Etsy, Wix, WooCommerce, Squarespace and Adobe Commerce.

For consumers wishing to order online, visit Canvas Republic for photo canvas deals or Magnolia Box for discount fine art prints.

What’s the difference between Sandbox and Live?

Live is our production environment. All orders that get created through the live API (i.e will be charged and routed through to labs as you’d expect.

Sandbox (i.e does not charge and does not fulfil any orders. Its primary purpose is for merchants to come and try out the API in a semi-real way without risk of being charged or accidentally ordering something.

We keep the sandbox environment as up-to-date as our live environment, so you’ll always see the newest features on both.

How do I find my API keys?

Once you’ve registered we’ll send you an email containing your live and sandbox API keys.

You can also view these at any time by going to the dashboard, clicking on the gear icon in the top right hand corner of the screen and then pressing the show API key button; you can go between live and sandbox by pressing the buttons at the top.

Do Sandbox and Live have different API keys?

Yes. You cannot use your Sandbox API Keys on Live and vice versa.

Why am I seeing different prices for Sandbox and Live?

Whilst we make every effort to ensure data parity between these environments, it’s not always spot on. If there is a discrepancy, Live is always the most up to date and accurate.

If you do see a price difference, please get in touch and we will amend the data.

How do I reset my API keys?

Go to your settings (the gear icon) on the dashboard and press the “Show API keys” button. There is then an option to regenerate your API Keys. You need to do this for both live and sandbox.

What image file types does the API accept?

Our API currently only accepts jpg, png or pdf files. However, the image required is often product specific. Most products require either jpg or png.

What happens if the image does not fit the product print area?

If your image does not fit the product size, by default we will crop your image centrally. We print the image as large as possible, removing the top/bottom or left/right parts of the image that go beyond the print area.

However, you can also specify a sizing parameter to change this behaviour.

Crop (default): your image will be centred and cropped so that it exactly fits the aspect ratio (height divided by width) of the printing area of the product you chose. Your image will cover all of the product print area.

ShrinktoFit: your image will be resized so that it completely fills the print area of the product, If the aspect ratio of your image is different to that of the printing area, your image will be stretched or squashed to fit.

Rotation Our print API will automatically rotate your images so that they need the least possible resizing to fit the product size. For example, if you are creating a 10x15 photo, and upload an image that is 4500x3000px, then we will flip it so it is 3000x4500px and thus fits the photo perfectly.

How do I add multiple images to an order as a batch?

You just need to send a JSON array of order items, e.g.

[ ` { ` ` “type”:”4x6”, “url”:”https://…” }, { ` ` “type”:”5x7”, “url”:”https://…” } ]`

How many companies are already integrated with the API?

Thousands of ecommerce companies are using our Print API.

What is an Asset?

An Asset is the image that will be printed on a particular part of the product in v4 of the API. Some products have a single asset, like a poster, and some can have multiple assets, like some t-shirts.

What attributes does a product have?

v4 has a new endpoint to which returns all product information by SKU, including valid attributes.

How do I validate an order in v4?

Unlike previous versions of the API, order creation is a one-step process in v4.

We validate your order on creation, and if it fails we return feedback the failure and the order is not created. (If the order is valid, it is created and a 200 response returned.)

If you wish to test your order creation process, you can do so against the Sandbox environment, where orders are not processed or charged.

How do I submit an order in v4?

There is no submission step in v4. If you attempt to create an order and it is valid, the order will be created and submitted immediately.

If you wish to test your order creation process, you can do so against the Sandbox environment where the orders are not processed or charged.

Have the products changed in v4?

v4 uses the same products as v3. Going forward, we will be adding more products to v4 that require multi-asset support which will not be available in v3.

Does v4 have different pricing to v3?

Existing customers using v3 will see no difference in pricing. Our Quote endpoints may return different pricing, because it now returns your discounted prices, not the base rates for the product.

How can I find out what my order will cost?

v4 has a Quote endpoint which generates a price for your order without creating it. The Quote endpoint accepts SKUs, a destination country and optionally a shipping method and returns a pricing breakdown.