Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Print.one Campaigns API
description: 'This documentation belongs to Print.one''s API. # Introduction
This API is documented in **OpenAPI format**. In addition to standard
OpenAPI syntax we use a few vendor extensions
For technical information about our API, please consult our help center or request support. # Cross-Origin Resource Sharing
This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. # Authentication
# Early Access
Some features are marked as ''Early Access''. This means only a small portion of users have access to these features. We do this to conduct thorough testing before a major release. Would you like to gain access to one of our Early Access features? Please raise a >">support ticket here, specifying which feature you would like access to. # Premium Access
Some features are marked as ''Premium''. This means this feature is only included on paid plans. Would you like to gain access to one of our Premium features? Have a look at the Subscriptions page. # API Errors
Below is a list with all known errors returned by our API, identified by a unique `code`. These codes will also show in the error response of specific API responses. Unique code
Error name
Error type
Example message
10001
InvalidInputData
Combined
Invalid input data
10002
OrderPropertyRequired
Default
The property recipient is required
10003
OrderCreationError
Combined
Could not create order
10004
RecipientAddressInvalid
Default
Recipient''s address is invalid
10005
AddressValidation
Validation
Address validation failed
10006
ResourceNotFound
Default
Campaign ''cmp_123456789'' does not exist
10007
BatchWrongMode
Default
Batch is ''live'', but received a ''live'' request
10008
BatchNotAcceptingOrders
Default
Batch ''batch_123456789'' is not in a state to accept orders
10009
BatchIsFull
Default
Batch ''batch_123456789'' is full and does not accept any more orders (max 10000 orders per batch)
10010
ArchivedCampaignNotAcceptingOrders
Default
Campaign ''My Campaign'' is archived and no longer accepts orders
10011
ProductFeatureNotAllowed
Default
The product ''GREETINGCARD_SQ15'' does not support batch
10012
ObjectMissingRequiredFields
Default
The recipient is missing required fields
10013
CannotRetrieveObject
Default
An error occurred while retrieving the design ''tmpl_123456798''
10014
DesignContentUnparsable
Combined
Could not parse the design content
10015
FormatPageRequirement
Default
The format ''POSTCARD_A5'' requires 2 pages, but 1 was provided
10016
DuplicateDesignPage
Default
Found page ''1'' multiple times in the design
10017
CountryNotSupported
Default
The country ''BE'' is not supported
10018
ProductDestinationNotAllowed
Default
The product ''GREETINGCARD_SQ15'' does not support GERMANY
10019
UnknownCreationError
Default
An unknown error occurred while creating the campaign
10020
UnknownPublishError
Default
An unknown error occurred while publishing the order
10021
SendDateInPast
Default
The send date must be in the future
10022
SendDateBeyondYear
Default
The send date must be within one year
10023
InstallNotAllowed
Default
You are not allowed to install this integration
10024
BatchRecipientCountryRestriction
Default
Only addresses shipped to ''NL'' are allowed for this batch
10025
PostalStampCountryUnavailable
Default
Postal stamp ''stmp_123456789'' is not available for the country ''BE''
10026
EarlyAccessRestricted
Default
Sorry, some-early-access-feature is in early access.'
version: v3
contact:
name: Print.one
url: https://support.print.one
email: info@print.one
servers:
- url: https://api.print.one
tags:
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://artifacts.apis.io/print-one/openapi/print-one-campaigns-api-openapi.yml