Skip to main content

FAQ: Print API

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

To make full use of our print API, you’ll need to either be a developer yourself or have access to a programmer.

Alternatively, if you’re an account holder, you can order using our manual order form or CSV importer as well as via our suite of ecommerce integrations, with sales channels including Etsy, Wix, WooCommerce and more.

What’s the difference between Sandbox and Live?

Live is our production environment. All orders created through the live API (api.prodigi.com) will be charged and routed to print facilities as expected.

On the other hand, Sandbox (api.sandbox.prodigi.com) does not charge or fulfil any orders. Its primary purpose is for merchants to try out the API in a semi-real way without the 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, you can then log in to either the Live or Sandbox API using the same login details you used to create your account.

You can also view your API keys at any time by navigating to your Prodigi dashboard, clicking on the gear icon in the top right-hand corner of the screen and pressing the ‘Show API key’ button.

Do Sandbox and Live have different API keys?

Yes. Sandbox API keys cannot be used on the Live API and vice versa.

Why am I seeing different prices for Sandbox and Live?

While we make every effort to ensure data parity between these environments, it’s not always exact. If there is a discrepancy, the Live environment always has the most up-to-date and accurate information.

If you do notice a price difference, please get in touch with us, and we’ll amend the data accordingly.

How do I reset my API keys?

To reset your API keys, log in to your dashboard, click on the gear icon and select ‘Show API keys’. You’ll then be given the option to regenerate your API keys. You’ll need to do this for both Live and Sandbox environments.

What image file types does the API accept?

Our print 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 my image doesn’t fit the product print area?

If your image doesn’t fit the product size, by default, we’ll crop your image centrally. We print the image as large as possible, removing the top/bottom or left/right parts of the image that extend 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 your selected product. Your image will cover the entire 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 from 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’re creating a 10x15 photo and upload an image that’s 4500x3000px, we’ll flip it so that it’s 3000x4500px and thus fits the photo perfectly.

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

To add multiple images to an order as a batch, you’ll need to send a JSON array of order items. For example:

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

What is an Asset?

An Asset refers to the image that will be printed on a particular part of the product. Some products, such as prints and posters, have a single asset, while others, like certain t-shirts, can have multiple assets.

What attributes does a product have?

Our print API has an endpoint that returns all product information by product SKU, including valid attributes.

How do I validate an order in the print API?

Order creation in our print API is a one-step process. We validate your order on creation, and if it fails, we return feedback on the failure and the order is not created. If the order is valid, it is created, and a 200 response is 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 the print API?

Unless you choose to add an order edit window via our order pausing feature, any valid order you create will be submitted immediately.

To test your order creation process without actually processing or charging orders, you can use the Sandbox environment.

How can I find out what my order will cost?

Our print API has a Quote endpoint that generates a price for your order without creating it. The Quote endpoint accepts product SKUs, a destination country, and, optionally, a shipping method. It then returns a pricing breakdown for your order.