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. Orders created through the Live API are charged and, once submitted for fulfilment, routed to our print facilities.
Sandbox is a separate test environment where orders aren’t charged or fulfilled. It allows you to build and test your integration without the risk of accidentally creating a live order.
With v5, Sandbox API keys use the sandbox_ prefix, while production API keys use the live_ prefix.** **Both are sent to the same base URL. The prefix tells v5 which environment to use.
We aim to maintain parity between Sandbox and Live, but there may occasionally be differences. Where there is a discrepancy, Live has the most up-to-date and accurate information.
How do I find my API keys?
Once you’ve registered, you can view and manage your API keys through your Prodigi dashboard.
v5 uses separate API keys for Sandbox and Live. Sandbox keys use the sandbox_ prefix, while production keys use the live_ prefix.
Do Sandbox and Live have different API keys?
Yes. Sandbox and Live use separate API keys, so a Sandbox key can’t be used with the Live API and vice versa.
With v5, Sandbox keys use the sandbox_ prefix, while production keys use the live_ prefix. This makes it easier to identify which environment a key belongs to and reduces the risk of using a production key while testing.
Why am I seeing different prices for Sandbox and Live?
We make every effort to maintain data parity between Sandbox and Live, but it may not always be exact. If there is a discrepancy, the Live environment has the most up-to-date and accurate pricing information.
If you notice a price difference, please email us at support@prodigi.com and we’ll investigate.
How do I reset my API keys?
You can manage and regenerate your API keys through your Prodigi dashboard.
Sandbox and Live use separate API keys, so make sure you regenerate the key for the correct environment.
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?
You can add multiple images to an order by including multiple items in your order request, with each item containing the details for the individual product and artwork required.
This works in the same way as v4 – simply add an item for each image you want to include in the order.
With v5, you can also add new items to an existing draft order using the add order item endpoint. This means you can build up an order progressively before submitting it for fulfilment.
What is an Asset?
An asset is the artwork that will be printed on a particular part of a product. Some products, such as prints and posters, require a single asset, while others can have multiple assets.
With v5, artwork can also be uploaded directly to Prodigi or imported from a URL, then reused across orders. You can check an asset against a selected catalogue variant (SKU) and print area before ordering, with v5 flagging potential resolution and aspect ratio issues.
What attributes does a product have?
You can use the v5 catalogue endpoints to retrieve product information, including the attributes and options available for a product.
How do I validate an order in the print API?
The validation process depends on which version of our print API you’re using.
With v5, you can create an order as a draft, make changes and resolve any reported validation issues before submitting it for fulfilment.
If a request fails validation, the API returns details of the problem, including which fields are causing issues where applicable.
You can also use a sandbox_ API key to test your order creation process without placing live fulfilment orders.
How do I submit an order in the print API?
With v5 of our print API, orders can be created as drafts, allowing you to build and amend an order before submitting it for fulfilment.
Once the order is ready, you can submit it through the API. If you prefer the create-and-submit flow used in v4, you can add submit: true when creating an order to create and submit it in a single request.
If you use Prodigi’s order pause feature, a submitted order will enter your configured pause window before being released to production. With v5, you can access paused orders through the API and resume an individual order when you’re ready for it to enter production.
To test your order creation and submission process without fulfilling or charging orders, use the Sandbox environment.
For technical details, explore the v5 documentation.
How can I find out what my order will cost?
With v5, you can request a quote before placing an order, including product pricing, shipping costs and tax.
You can retrieve these costs individually or request a combined order quote, giving you a clearer picture of the total cost before submitting your order.
How do I submit a photo book order via the API?
When placing a photo book order via the print API, you must include the total page count of the book in your order submission to ensure accurate pricing and smooth order processing.
What happens if I don’t provide the page count?
If you don’t provide a page count, we assume no extra charges apply for additional pages. However, if our system detects a mismatch between the actual page count and the submitted value, the order will be placed on hold.
How can I resolve an order placed on hold due to a page count mismatch?
If your order is placed on hold due to a page count mismatch, we’ll notify you. You’ll receive a request to resubmit the order with the correct page count.
To resolve the issue, please ensure that your order includes a value for the pageCount property on the order item asset entity. Specific details for the required payload can be found in our API documentation: Prodigi API Reference – Order Object Asset.
What are the page count rules?
The base price includes the first 24 pages.
For books with more than 24 pages:
- If the submitted page count matches the actual count, the order is processed as normal
- If the page counts don’t match, the order is placed on hold, and you’ll need to correct and resubmit it
What’s the difference between Prodigi API v4 and v5?
v5 gives you much more control over the full order lifecycle through our print API.
You can create and amend draft orders, access and resume paused orders, cancel orders before production, add or remove items, change quantities and delivery details, raise issues and access order history and shipment information.
v5 also introduces dedicated quoting functionality, managed artwork, interactive documentation and separate Sandbox and Live environments.
Already using v4? There’s no immediate need to migrate. Learn more about what’s changed in our API v5 launch post, or explore the v5 documentation for technical details.
Do I need to migrate from v4 to v5?
No. If you already have a working v4 integration, there’s no immediate action required.
We’ll continue supporting v4 for a long transition period, so you can decide when moving to v5 makes sense for your business. There’s no forced migration deadline at launch.
We’ve also kept several parts of v4 familiar to make moving across easier. Existing Prodigi SKUs continue to work, copies is accepted as a deprecated alias for quantity and submit: true can be used to recreate v4’s create-and-submit flow.
Read our v4 to v5 migration guide for a technical breakdown of what’s changed and how to migrate your integration.
Can I access paused orders through the print API?
Yes. With v5, you can access orders through the API while they’re within your configured pause window.
This means your integration can interact with a paused order before it enters production. When you’re confident everything is correct, you can resume an individual order through the API and release it into production early.
Learn more about our order pause feature.
Can I edit an order through the print API?
Yes. v5 gives you more control over orders before they enter production.
You can create an order as a draft, then add or remove items, change quantities and sizes and update delivery details before submitting it for fulfilment.
Once an order has been submitted, only the delivery details can be changed, and only before it enters production. We therefore recommend making any other amendments before submitting your order.
Can I cancel an order through the print API?
Yes. v5 allows you to cancel eligible orders through the API before they enter production.
Once an order has entered production, cancellation may no longer be possible.
Can I view an order’s history and shipments through the print API?
Yes. v5 gives you access to an order’s current status and chronological history, as well as its shipments, including carrier and tracking information where available.
This gives your integration greater visibility into what has happened to an order without needing to check it separately in the Prodigi dashboard.
Can I raise an issue with an order through the print API?
Yes. With v5, you can raise an issue against an order directly through the API.
This includes problems relating to damaged, incorrect or missing items, print quality or shipping, allowing more of your post-order workflow to be managed through your integration.
Can I upload artwork through the print API?
Yes. v5 allows you to upload artwork directly to Prodigi or import it from a URL, rather than relying solely on externally hosted artwork URLs.
Direct uploads support files up to 100 MB, and uploaded artwork can be reused across orders. You can also check an asset against a selected catalogue variant (SKU) and print area before ordering, with v5 flagging potential resolution and aspect ratio issues.
What happens if I need to retry an order creation request?
v5 supports an Idempotency-Key header when creating an order.
If your integration needs to retry an order creation request, using the same idempotency key protects against accidentally creating the same order more than once.
Idempotency applies to order creation, so refer to the v5 documentation for details on how and when to use an Idempotency-Key.
Is there a rate limit for Prodigi API v5?
Yes. v5 API keys are currently limited to 1,000 requests per hour, per key.
Standard rate-limit headers are included in API responses to help your integration understand and manage its usage.
Does Prodigi API v5 support webhooks?
Webhook subscriptions aren’t currently available in v5.
Per-order callbacks are supported and are delivered in the existing v4 callback format, helping existing integrations continue to receive order updates while moving to v5.