Most of what you do in Growwer as a buyer or a seller is reachable over HTTP: your
account, projects and saved filters, the media catalogue, orders from estimate to
delivery, the managed service, and on the seller side your medias and the orders they
receive. Wallets, invoices and withdrawals are read-only: money movements such as
top-ups and withdrawal requests stay on the web. 66 operations, authenticated with an API key you create yourself.
The OpenAPI contract is the source of truth, and it is public: reading it needs no key.
Every operation below is rendered from that contract, so this page cannot describe an
API that no longer exists.
go get github.com/viralitymedia/growwer-api-sdk/go
Java
Maven
com.growwer:growwer-api
.NET
NuGet
dotnet add package Growwer.Api
Ruby
RubyGems
gem install growwer
The snippets on this page call the API with a plain HTTP client rather than the SDKs.
Most need only the language's standard library; the Python ones use
requests, the Go writes use github.com/google/uuid and PHP needs
its curl extension. The SDKs are the shortcut once a project is past its first call.
Getting a key
Keys are created from . A key starts with gw_sk_ and can carry an expiry date; you can have several
and revoke any of them.
The full key is shown once, when you create it, and never again. Store it
where you store any other secret. If you lose it, revoke it and create another.
Each key has one capability, chosen at creation and fixed for its life:
read calls every GET operation, and read_write also
calls the writes. A read key that calls a write gets 403insufficient_capability. A key never does more than your account can do on
the web.
Your first request
Send the key as Authorization: Bearer gw_sk_....
GET /api/v1/me returns your account: profile basics, your buyer and seller balances,
whether the catalogue is open to you and whether you have a managed service. It is the quickest
way to confirm a key works.
curl -X GET "https://tool.growwer.com/api/v1/me" \
-H "Authorization: Bearer $GROWWER_API_KEY"
Every error answers the same shape, {code, message, requestId, details?}. Branch on code, which is stable; message is for people and may
change. requestId matches the X-Request-Id header every response
carries: quote it when you report a problem.
{
"code": "validation_failed",
"message": "The request is not valid. See details for each field.",
"requestId": "3f2a9c1e7b4d4e0a",
"details": {
"fields": {
"promotedProducts": ["This collection should contain 5 elements or more."]
}
}
}
An invalid request answers 422validation_failed, with the messages for each invalid field under details.fields, by field name.
401unauthorized: the key is missing, malformed, unknown, revoked or expired,
or its account cannot sign in.
403insufficient_capability: a read key called a write.
404not_found: the resource does not exist, or it is not yours.
409invalid_state: the resource is yours but not in a state that allows the
operation.
500internal_error: an unexpected error.
Each operation in the reference lists the statuses it can answer and the codes behind
them.
Rate limits
600 requests per minute per user, and 300 per key. Every authenticated response
carries
X-RateLimit-Limit, X-RateLimit-Remaining and
X-RateLimit-Reset (seconds until the window resets) for whichever of the two
limits is tighter.
Over the limit answers 429rate_limit_exceeded with a
Retry-After header in seconds; wait that long rather than retrying at once. Ten
failed authentications from one address within 15 minutes answer 429too_many_failed_authentications, also with Retry-After.
If the limiter itself cannot be reached, the call is refused with 503rate_limit_unavailable; retry later. The catalogue and the managed service
requests also have daily caps of their own, described next.
Catalogue access and daily caps
The catalogue operations, searching a project's medias, flash offers and media details,
are open to accounts with recent completed orders, as buyer or as seller. Until then
they answer 403catalogue_requires_recent_order, and GET /api/v1/me reports
catalogue.eligible. A media you have ordered is always readable with
GET /api/v1/medias/{id}. Eligibility is cached for a few minutes, so
the catalogue can stay closed for a short while after your first order completes.
The catalogue also counts the distinct medias it shows you per UTC day. A page that
would take you past that cap answers 429catalogue_daily_cap_reached, with details.remaining (how many new
medias still fit today) and Retry-After (the time to the next UTC midnight).
Medias you have already seen that day stay readable.
The two managed service requests, POST /api/v1/managed-service/campaign-requests and POST /api/v1/managed-service/info-requests, take 5 requests each per
UTC day. Past them they answer 429managed_service_request_limit_reached, with Retry-After the time
to the next UTC midnight. A refused request (4xx) does not count; one that
fails on the server (5xx) does, as it may have been sent.
Writes are idempotent
Every write requires an Idempotency-Key header: 1 to 255
printable ASCII characters without spaces. A UUID is the obvious choice. Use a new key
for each operation, and reuse it only to retry that same operation. Keys belong to your
account, not to one API key.
A successful write is stored for 30 days. A retry with the same key and the same
request replays its response with Idempotent-Replayed: true and does nothing
again, so a lost response never becomes a second order.
A refused write (4xx) has no effect and releases its key: fix the cause
and retry with the same key.
A failed write (5xx) may have taken effect, so it never runs again under
its key: a retry gets 409idempotency_outcome_unknown. Check whether it took effect before retrying
with a new key.
A retry while the first request is still running gets 409idempotency_request_in_progress. A request still running after 5 minutes
is treated as failed.
The same key with a different request (method, path, query or body) gets
409idempotency_key_reused. A write without the header gets
400idempotency_key_required, and a malformed one
400invalid_idempotency_key.
The two estimates, POST /api/v1/orders/estimate and
POST /api/v1/managed-service/campaigns/{id}/proposals/estimate, change
nothing: they take no Idempotency-Key and a read key may call them.
Orders have one more guard. Placing the same order (same project, media, type and price)
again within 5 seconds of one still in progress answers 409duplicate_order, with details.orderId the earlier order, or null
when it has finished or was deleted since. The guard covers only those 5 seconds: a retry
after them with a new Idempotency-Key places and pays a second order. To retry
an order safely, reuse its key.
Paging, money and dates
Listings answer {items, total} and take limit (default 20, from
1 to 100) and offset (default 0). A limit above 100 is
refused with 422validation_failed, never quietly clamped, so the page you asked for is the page you get. total counts everything the
filters match, not the size of the page.
Money is an integer amount in cents plus a currency code:
{"amount": 12500, "currency": "EUR"} is 125.00 EUR. Dates are ISO-8601; in
a query string, send the + of an offset as %2B.
There are no webhooks. To follow your orders, poll GET /api/v1/orders with
sort=updatedAt and updatedSince set to the last
updatedAt you saw. Responses may gain fields over time, so ignore the ones you
do not know.
Uploads and downloads
A write that takes a document, such as the draft you propose with an order or the one a
seller delivers, references a file you upload first. POST /api/v1/files takes
a multipart/form-data upload of an odt, doc, docx or txt file of up to 8 MB and
returns its id. A file can be used by one write and expires 24 hours after
the upload.
Downloads, such as GET /api/v1/invoices/{id}/pdf, answer the file
itself with its own content type, not JSON. Their errors still use the JSON shape above.
Account
GET /api/v1/me
Your account
Profile basics, the buyer and seller balances, whether your seller account is restricted, whether the catalogue is open to you, and whether you have a managed service.
Responses
200
Your account.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/me" \
-H "Authorization: Bearer $GROWWER_API_KEY"
Starts, changes or ends your holiday, as the holiday settings of your profile page do. While you are on holiday your medias take no orders. endDate is the day your holiday ends, at 00:00 of that day in Growwer's server time, and must be later than now; leave it out, or send null, for a holiday you end yourself. Ending the holiday takes no endDate.
A holiday that already is as you ask is answered 200 without a change. A restricted seller account stays on holiday until the restriction is lifted, so any change is refused. Your holiday is also in GET /me.
Parameters
Name
In
Type
Description
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
onHolidayRequired
boolean
endDate
string (date) | null
Responses
200
Your holiday, as it now is.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
409
Your seller account is restricted, so its holiday cannot change (code seller_restricted), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The body is not valid (code validation_failed): an endDate that is not a later day, or one sent with onHoliday false.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
The countries, languages, topics, product types, link types and order states that other operations take and return. Names are in English.
Responses
200
Every code, with its English name where it has one.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/vocabulary" \
-H "Authorization: Bearer $GROWWER_API_KEY"
Your saved filters of one of your projects, newest first, including those saved on the web. A project has at most 100. Apply one with savedFilterId on GET /projects/{id}/medias.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
The project.
Responses
200
The saved filters and how many there are.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/projects/$PROJECT_ID/saved-filters" \
-H "Authorization: Bearer $GROWWER_API_KEY"
Saves a catalogue search of one of your projects, which then also appears on the web. filters takes the filter parameters of GET /projects/{id}/medias, and source, with the same values; lists may be JSON arrays and flags JSON booleans. With notificationFrequency, Growwer emails you new medias that match. A project has at most 100 saved filters and an account 500.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
The project.
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
nameRequired
stringmax length 255
1 to 255 characters.
filtersRequired
object
At least one filter parameter of GET /projects/{id}/medias, or source, by name.
notificationFrequency
daily | weekly | monthly
Email new matching medias this often. Omit it for no emails.
Responses
201
The saved filter.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).
404
The resource does not exist, or it is not yours (code not_found).
409
The project already has 100 saved filters, or the account 500 (code saved_filter_limit_reached), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Deletes one of your saved filters of one of your projects, including one saved on the web. Its notifications stop.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
The project.
filterIdRequired
path
string (uuid)
The saved filter.
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Responses
204
The saved filter was deleted.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).
404
The resource does not exist, or it is not yours (code not_found).
409
The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
GET /api/v1/projects/{id}/saved-filters/{filterId}/media-count
Count the medias of a saved filter
How many medias of the project's catalogue one of your saved filters matches: the total of GET /projects/{id}/medias with its savedFilterId. The number is cached for up to 24 hours, and it can differ from the count the web shows, which is not limited to the project's catalogue. A filter saved on the web that uses a filter the API does not support is refused with 422 saved_filter_unsupported.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
The project.
filterIdRequired
path
string (uuid)
The saved filter.
Responses
200
The number of matching medias.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
422
The saved filter uses a web filter the API does not support (code saved_filter_unsupported); details.field names it.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/projects/$PROJECT_ID/saved-filters/$FILTER_ID/media-count" \
-H "Authorization: Bearer $GROWWER_API_KEY"
Example response
{
"count": 0
}
Catalogue
GET /api/v1/flash-offers
List flash offers
The medias on a flash offer, a time-limited discount, in the catalogue of one of your projects. It is GET /projects/{id}/medias with flashOffer=true, and takes the same parameters except flashOffer and savedFilterId. The catalogue access and the daily distinct-media limit of that operation apply.
Which of the project's medias to search: all (the default), recommended (those Growwer recommends for the project), or those you marked favourite, discarded or requested, or bought for the project. Do not combine it with the parameter of the same state.
The order. Without it, the web's default order: medias on the project's topic and language first, then best sellers and medias with more published orders. Ties are always broken by media id, so pages never overlap. -growwerRank: best match first; postPrice, linkAdditionPrice: cheapest first; matchedAt, -matchedAt: when Growwer matched the media with the project; -traffic, -domainRating, -referringDomains: highest first; linkedToReferringRatio: lowest first.
domain
query
string
Medias whose domain contains this text, 1 to 255 characters.
websiteType
query
string
A comma-separated list of website types: blog, press.
language
query
string
A comma-separated list of language codes, as in GET /vocabulary.
country
query
string
A comma-separated list of country codes, as in GET /vocabulary.
topics
query
string
A comma-separated list of topic ids, as in GET /vocabulary: medias on any of them.
notBannedTopics
query
boolean
Leave out medias that refuse the topic of the project. Only true applies it; omit it otherwise.
minTraffic
query
integer
Minimum monthly organic traffic.
maxTraffic
query
integer
Maximum monthly organic traffic.
trafficTrendUpward
query
boolean
Medias whose traffic is growing. Only true applies it; omit it otherwise.
minDomainRating
query
integer
Minimum domain rating, 0 to 100.
maxDomainRating
query
integer
Maximum domain rating, 0 to 100.
minLinkedToReferringRatio
query
number
Minimum ratio of linked domains to referring domains, such as 0.5.
maxLinkedToReferringRatio
query
number
Maximum ratio of linked domains to referring domains, such as 1.5.
minPostPrice
query
integer
Minimum post price, in cents.
maxPostPrice
query
integer
Maximum post price, in cents.
postLinkType
query
string
A comma-separated list of link types the post offer gives: dofollow, nofollow, citation.
promotedSocialNetwork
query
string
A comma-separated list of social networks the media promotes posts on: twitter, instagram, facebook, pinterest, tumblr, newsletter.
withoutAdvertisingLabel
query
boolean
Medias that never label posts as advertising. Only true applies it; omit it otherwise.
homepageListing
query
boolean
Medias that offer listing the post on their homepage. Only true applies it; omit it otherwise.
hasLinkAddition
query
boolean
Medias that offer adding a link to an existing article. Only true applies it; omit it otherwise.
minLinkAdditionPrice
query
integer
Minimum link addition price, in cents.
maxLinkAdditionPrice
query
integer
Maximum link addition price, in cents.
linkAdditionLinkType
query
string
A comma-separated list of link types the link addition offer gives: dofollow, nofollow, citation.
recommended
query
boolean
true: only the medias Growwer recommends for the project; false: only the others.
favourite
query
boolean
true: only your favourites for the project; false: leave them out.
requested
query
boolean
true: only the medias you requested for the project; false: leave them out.
bought
query
boolean
true: only medias you bought for the project; false: leave them out.
discarded
query
boolean
true: only the medias you discarded for the project; false: leave them out.
new
query
boolean
Medias Growwer matched with the project recently. Only true applies it; omit it otherwise.
ranksGoalKeyword
query
string
A comma-separated list of keyword origins: medias that rank for a keyword of the project from any of them. user: your keywords; publicGenerated: keywords Growwer found for the project.
ranksAiKeyword
query
string
A comma-separated list of AI answer engines: medias cited for a keyword of the project by any of them. googleAiOverview, chatgpt, googleAiMode.
limit
query
integermin 1, max 100, default 20
Medias per page, 1 to 100.
offset
query
integermin 0, max 99900, default 0
Medias to skip, at most 99900.
Responses
200
A page of flash offers and how many there are in all.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The catalogue is open to accounts with recent completed orders, as buyer or as seller, and this account has none (code catalogue_requires_recent_order). GET /me reports catalogue.eligible.
404
The resource does not exist, or it is not yours (code not_found).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/flash-offers?projectId=$PROJECT_ID" \
-H "Authorization: Bearer $GROWWER_API_KEY"
One media of the catalogue: an active, public media. A media you have ordered is always readable, even if it has since left the catalogue, and is open to every account. Otherwise the catalogue is open to accounts with recent completed orders (see catalogue.eligible on GET /me), and the media counts towards the distinct medias the account may see per day (UTC). For the media's state in one of your projects, search the project with GET /projects/{id}/medias.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
The media.
Responses
200
The media.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The catalogue is open to accounts with recent completed orders, as buyer or as seller, and this account has none (code catalogue_requires_recent_order). GET /me reports catalogue.eligible.
404
The resource does not exist, or it is not yours (code not_found).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/medias/$MEDIA_ID" \
-H "Authorization: Bearer $GROWWER_API_KEY"
Discards a media for one of your projects, as the web does. Discarding it again changes nothing. The media must be one the catalogue shows for the project: another media, including one of your own as a seller, is answered as not found.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
The project.
mediaIdRequired
path
string (uuid)
The media.
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Responses
204
The media is discarded for the project.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).
404
The resource does not exist, or it is not yours (code not_found).
409
The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Restores a media you discarded for one of your projects. Restoring one that is not discarded changes nothing. It works for any media, even one the catalogue no longer shows.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
The project.
mediaIdRequired
path
string (uuid)
The media.
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Responses
204
The media is not discarded for the project.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).
404
The resource does not exist, or it is not yours (code not_found).
409
The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Marks a media as a favourite of one of your projects, as the heart on the web does. Adding a favourite again changes nothing. The media must be one the catalogue shows for the project: another media, including one of your own as a seller, is answered as not found.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
The project.
mediaIdRequired
path
string (uuid)
The media.
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Responses
204
The media is a favourite of the project.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).
404
The resource does not exist, or it is not yours (code not_found).
409
The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Removes a media from the favourites of one of your projects. Removing one that is not a favourite changes nothing. It works for any media, even one the catalogue no longer shows.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
The project.
mediaIdRequired
path
string (uuid)
The media.
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Responses
204
The media is not a favourite of the project.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).
404
The resource does not exist, or it is not yours (code not_found).
409
The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Asks Growwer to find the medias of these domains for one of your projects, as the "request specific domains" form on the web does. Each entry may be a domain or a URL; it is read as its full domain, lowercased. Repeated domains are requested once, and a domain already requested changes nothing. Up to 200 distinct domains per call. They then appear in the project's catalogue with project.requested true (requested=true on GET /projects/{id}/medias) once Growwer lists them.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
The project.
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
domainsRequired
string[]
Domains or URLs, 1 to 200 distinct domains.
Responses
201
The domains were requested: each distinct domain, as Growwer read it.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).
404
The resource does not exist, or it is not yours (code not_found).
409
The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
The medias the catalogue offers for one of your projects, as the web lists them, with each media's state in the project. Filter with the parameters below, which all combine, or apply one of your saved filters with savedFilterId alone. The catalogue is open to accounts with recent completed orders (see catalogue.eligible on GET /me), and each account can see a limited number of distinct medias per day (UTC) across the catalogue operations; medias seen again the same day are free.
Which of the project's medias to search: all (the default), recommended (those Growwer recommends for the project), or those you marked favourite, discarded or requested, or bought for the project. Do not combine it with the parameter of the same state.
The order. Without it, the web's default order: medias on the project's topic and language first, then best sellers and medias with more published orders. Ties are always broken by media id, so pages never overlap. -growwerRank: best match first; postPrice, linkAdditionPrice: cheapest first; matchedAt, -matchedAt: when Growwer matched the media with the project; -traffic, -domainRating, -referringDomains: highest first; linkedToReferringRatio: lowest first.
savedFilterId
query
string (uuid)
Apply one of your saved filters of this project, including one saved on the web, instead of the other parameters. Do not combine it with any filter, source or sort. A filter saved on the web that uses a filter the API does not support is refused with 422 saved_filter_unsupported.
domain
query
string
Medias whose domain contains this text, 1 to 255 characters.
websiteType
query
string
A comma-separated list of website types: blog, press.
language
query
string
A comma-separated list of language codes, as in GET /vocabulary.
country
query
string
A comma-separated list of country codes, as in GET /vocabulary.
topics
query
string
A comma-separated list of topic ids, as in GET /vocabulary: medias on any of them.
notBannedTopics
query
boolean
Leave out medias that refuse the topic of the project. Only true applies it; omit it otherwise.
minTraffic
query
integer
Minimum monthly organic traffic.
maxTraffic
query
integer
Maximum monthly organic traffic.
trafficTrendUpward
query
boolean
Medias whose traffic is growing. Only true applies it; omit it otherwise.
minDomainRating
query
integer
Minimum domain rating, 0 to 100.
maxDomainRating
query
integer
Maximum domain rating, 0 to 100.
minLinkedToReferringRatio
query
number
Minimum ratio of linked domains to referring domains, such as 0.5.
maxLinkedToReferringRatio
query
number
Maximum ratio of linked domains to referring domains, such as 1.5.
minPostPrice
query
integer
Minimum post price, in cents.
maxPostPrice
query
integer
Maximum post price, in cents.
postLinkType
query
string
A comma-separated list of link types the post offer gives: dofollow, nofollow, citation.
promotedSocialNetwork
query
string
A comma-separated list of social networks the media promotes posts on: twitter, instagram, facebook, pinterest, tumblr, newsletter.
withoutAdvertisingLabel
query
boolean
Medias that never label posts as advertising. Only true applies it; omit it otherwise.
homepageListing
query
boolean
Medias that offer listing the post on their homepage. Only true applies it; omit it otherwise.
hasLinkAddition
query
boolean
Medias that offer adding a link to an existing article. Only true applies it; omit it otherwise.
minLinkAdditionPrice
query
integer
Minimum link addition price, in cents.
maxLinkAdditionPrice
query
integer
Maximum link addition price, in cents.
linkAdditionLinkType
query
string
A comma-separated list of link types the link addition offer gives: dofollow, nofollow, citation.
recommended
query
boolean
true: only the medias Growwer recommends for the project; false: only the others.
favourite
query
boolean
true: only your favourites for the project; false: leave them out.
requested
query
boolean
true: only the medias you requested for the project; false: leave them out.
flashOffer
query
boolean
true: only medias with a flash offer running; false: leave them out.
bought
query
boolean
true: only medias you bought for the project; false: leave them out.
discarded
query
boolean
true: only the medias you discarded for the project; false: leave them out.
new
query
boolean
Medias Growwer matched with the project recently. Only true applies it; omit it otherwise.
ranksGoalKeyword
query
string
A comma-separated list of keyword origins: medias that rank for a keyword of the project from any of them. user: your keywords; publicGenerated: keywords Growwer found for the project.
ranksAiKeyword
query
string
A comma-separated list of AI answer engines: medias cited for a keyword of the project by any of them. googleAiOverview, chatgpt, googleAiMode.
limit
query
integermin 1, max 100, default 20
Medias per page, 1 to 100.
offset
query
integermin 0, max 99900, default 0
Medias to skip, at most 99900.
Responses
200
A page of matching medias and how many match in all.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The catalogue is open to accounts with recent completed orders, as buyer or as seller, and this account has none (code catalogue_requires_recent_order). GET /me reports catalogue.eligible.
404
The resource does not exist, or it is not yours (code not_found).
422
A parameter is not valid (code validation_failed; details.fields names it), or the saved filter uses a web filter the API does not support (code saved_filter_unsupported; details.field names it).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/projects/$PROJECT_ID/medias" \
-H "Authorization: Bearer $GROWWER_API_KEY"
Uploads a document (odt, doc, docx or txt, up to 8 MB) for a later write to reference by its id. A file belongs to you, can be used by one write, and expires 24 hours after it was uploaded; an expired or used file is answered like an unknown one.
Parameters
Name
In
Type
Description
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body multipart/form-data, Required
Field
Type
Description
fileRequired
string (binary)
Responses
201
The file, stored until expiresAt.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).
409
The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).
422
No file was sent as the file field, or it is too large, not an odt, doc, docx or txt document, or its name is longer than 255 characters (code validation_failed).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
A page of your invoices and how many you have in all.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/invoices" \
-H "Authorization: Bearer $GROWWER_API_KEY"
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Answers the file itself (application/pdf), not JSON.
GET /api/v1/wallets/buyer
Get your buyer wallet
The balance you buy with, and the page where you top it up.
Responses
200
Your buyer wallet.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/wallets/buyer" \
-H "Authorization: Bearer $GROWWER_API_KEY"
Every movement of your buyer wallet, newest first: top-ups, order debits and their refunds, gifts and manual corrections.
Parameters
Name
In
Type
Description
limit
query
integermin 1, max 100, default 20
Movements per page, 1 to 100.
offset
query
integermin 0, default 0
Movements to skip.
Responses
200
A page of your movements and how many there are in all.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/wallets/buyer/transactions" \
-H "Authorization: Bearer $GROWWER_API_KEY"
GET /api/v1/wallets/buyer/transactions/{id}/document
Download the document of a wallet movement
The document Growwer attached to a movement of your buyer wallet. 404 when the movement has none (hasDocument is false) or the file cannot be read.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Responses
200
The document, with its own content type and name.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Answers the file itself (application/octet-stream), not JSON.
Managed services
POST /api/v1/managed-service/campaign-requests
Request a new campaign
Asks your account manager for a new campaign, as the managed service page does: the team emails you to agree on it. For accounts with a managed service (GET /me managedService.active); without one, POST /managed-service/info-requests asks about the service.
You may send 5 such requests per UTC day through the API. Past them it answers 429 managed_service_request_limit_reached, with Retry-After the time to the next UTC midnight. A request that is refused (4xx) does not count; one that fails on the server (5xx) does, as it may have been sent.
Parameters
Name
In
Type
Description
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
409
You have no managed service yet (code managed_service_required), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
The campaigns your managed service runs for you, newest first. Without a managed service the list is empty: GET /me says whether you have one.
Parameters
Name
In
Type
Description
limit
query
integermin 1, max 100, default 20
Campaigns per page, 1 to 100.
offset
query
integermin 0, default 0
Campaigns to skip.
Responses
200
A page of your campaigns and how many you have in all.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/managed-service/campaigns" \
-H "Authorization: Bearer $GROWWER_API_KEY"
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/managed-service/campaigns/$CAMPAIGN_ID" \
-H "Authorization: Bearer $GROWWER_API_KEY"
GET /api/v1/managed-service/campaigns/{id}/proposals
List the proposals of a campaign
The medias the team proposes for the campaign, newest first. Those proposed await your review (POST /managed-service/campaigns/{id}/proposals/review).
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
state
query
string
Only proposals in these states, comma-separated: proposed, accepted, cancelled, purchase_started, purchase_finished.
limit
query
integermin 1, max 100, default 20
Proposals per page, 1 to 100.
offset
query
integermin 0, default 0
Proposals to skip.
Responses
200
A page of the campaign's proposals and how many match in all.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/managed-service/campaigns/$CAMPAIGN_ID/proposals" \
-H "Authorization: Bearer $GROWWER_API_KEY"
GET /api/v1/managed-service/campaigns/{id}/proposals-summary
Download the summary of a campaign's proposals
The PDF the campaign page offers: the proposals awaiting your review, accepted or being published, newest first, in your language. With extended=true it also shows each proposal's price, the price it was proposed at (proposedPrice).
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
extended
query
true | falsedefault "false"
Whether to show the prices.
Responses
200
The summary.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Answers the file itself (application/pdf), not JSON.
POST /api/v1/managed-service/campaigns/{id}/proposals/estimate
Estimate accepting proposals
Totals the campaign's accepted proposals that still await their order and the proposed ones you name in accept, and compares the total with your wallet's available balance. Each proposal counts at its currentPrice, or at its proposedPrice when the media no longer offers the service. Nothing is accepted, charged or reserved, so a read-only key may call it and it takes no Idempotency-Key.
The estimate is advisory: accepting a proposal charges nothing. The team charges your wallet when it places the order for an accepted proposal, and the same balance pays for the orders you place yourself.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Request body application/json, Optional
Field
Type
Description
accept
string (uuid)[]
The proposed proposals you would accept, each once. Leave it out to price only the accepted ones.
Responses
200
The totals and how your wallet covers them.
400
The body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The campaign is not yours, or a proposal named in accept is not one of the campaign's (code not_found, with details.proposalId).
409
A proposal named in accept is not awaiting your review (code invalid_state, with details.proposalIds).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
POST /api/v1/managed-service/campaigns/{id}/proposals/review
Accept or reject proposals
Decides on every proposal of the campaign that awaits your review (stateproposed), as the campaign page does: name each one once, with accept or reject, and a comment for the team to reject one. Their order in the body does not matter. Accepting charges nothing: the team places the orders for the accepted proposals and your wallet pays for them then. POST /managed-service/campaigns/{id}/proposals/estimate says what they would cost.
When every proposal is accepted the campaign moves to proposal_accepted; when one is rejected the team is told and prepares others. A proposal someone else moved on the campaign page while the request ran is answered in the state it reached.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
reviewsRequired
object[]min items 1
One decision on each proposal of the campaign that is proposed, each named once. Their order does not matter.
Responses
200
The campaign and the proposals you reviewed, as they now are.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The campaign is not yours, or a proposal named is not one of the campaign's (code not_found, with details.proposalId).
409
No proposal of the campaign awaits your review (code no_pending_proposals), or a proposal named does not (code invalid_state, with details.proposalIds), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The body is invalid (code validation_failed), or it leaves out proposals awaiting your review (code review_incomplete, with details.missingProposalIds).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Asks the team about the managed service for your website, as the managed service landing page does: the team contacts you. For accounts without a managed service (GET /me managedService.active); with one, POST /managed-service/campaign-requests requests a new campaign.
You may send 5 such requests per UTC day through the API. Past them it answers 429 managed_service_request_limit_reached, with Retry-After the time to the next UTC midnight. A request that is refused (4xx) does not count; one that fails on the server (5xx) does, as it may have been sent.
Parameters
Name
In
Type
Description
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
409
You already have a managed service (code managed_service_exists), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
The orders you bought, newest first by default. To follow your orders, poll with sort=updatedAt and updatedSince set to the updatedAt of the last order you saw: an order moves to the end of that list each time it changes state.
Parameters
Name
In
Type
Description
projectId
query
string (uuid)
Only the orders of this project of yours.
mediaId
query
string (uuid)
Only the orders on this media.
state
query
string
Only the orders in one of these states, comma-separated. An unknown state is refused with 422 and the list of valid ones.
updatedSince
query
string (date-time)
Only the orders whose updatedAt is at or after this instant, an ISO-8601 date-time with its offset (send + as %2B).
sort
query
-createdAt | updatedAtdefault "-createdAt"
-createdAt, newest first, or updatedAt, least recently changed first. Orders of the same instant come in id order.
limit
query
integermin 1, max 100, default 20
Orders per page, 1 to 100.
offset
query
integermin 0, default 0
Orders to skip.
Responses
200
A page of your orders and how many match in all.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/orders" \
-H "Authorization: Bearer $GROWWER_API_KEY"
Places an order on a media for one of your projects and pays its price from your wallet's available balance, as ordering on the web does. Estimate the order first (POST /orders/estimate) and send the price it answers as expectedPrice: the order is placed only at that price.
Placing the same order (same project, media, type and price) again within 5 seconds of one still in progress is refused with duplicate_order. Its details.orderId is the earlier order, or null when that order has finished or was deleted since.
A proposed draft (proposedDraftFileId, from POST /files) is used up when the order is placed. If the order is then refused because another request changed your balance, the media or its price, or placed the same order, the file is used up all the same and the refusal's message says so: upload it again before retrying.
Parameters
Name
In
Type
Description
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
expectedPriceRequired
Money
The price POST /orders/estimate answered. Only EUR is accepted.
Responses
201
The order, placed and paid. Location is its URL.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The project is not yours, or the media does not exist or is not one you can order for this project (code not_found).
409
The order cannot be placed, and nothing was charged:
price_changed: the price is not expectedPrice; details.currentPrice is the price.
insufficient_balance: your available balance does not cover the price; details has required, available and missing (Money).
duplicate_order: the same order was placed seconds ago; details.orderId is that order, or null.
seller_on_holiday: the media is not taking orders right now.
media_topic_not_allowed: the media does not accept the project's topic.
offer_unavailable: the media does not offer this type of order.
idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown: the Idempotency-Key conflicts.
422
The body is not valid (code validation_failed, with the messages of each field in details.fields), or proposedDraftFileId names no file you can use: it does not exist, has expired or was already used (code file_unusable).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Checks and prices the order POST /orders would place with the same body, without expectedPrice, and compares the price with your wallet's available balance. Nothing is placed, charged or used up, so a read-only key may call it and it takes no Idempotency-Key. Send the price it answers as expectedPrice when you place the order.
The estimate is refused for the same reasons as the order itself, except a balance that does not cover the price: that is answered here with sufficientBalance: false and the missing amount.
Request body application/json, Required
Field
Type
Description
typeRequired
post | link_addition
projectIdRequired
string (uuid)
One of your projects.
mediaIdRequired
string (uuid)
A media you can order for the project (GET /projects/{id}/medias).
The day to publish on, at least a few days ahead as the web requires.
draftReviewable
boolean
Whether you review the draft before it is published. Defaults to false.
proposedDraftFileId
string (uuid)
A file uploaded with POST /files to propose your own draft. The estimate checks it without using it up.
Responses
200
The price of the order and how your wallet covers it.
400
The body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The project is not yours, or the media does not exist or is not one you can order for this project (code not_found).
409
The order could not be placed:
seller_on_holiday: the media is not taking orders right now.
media_topic_not_allowed: the media does not accept the project's topic.
offer_unavailable: the media does not offer this type of order.
422
The body is not valid (code validation_failed, with the messages of each field in details.fields), or proposedDraftFileId names no file you can use: it does not exist, has expired or was already used (code file_unusable).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
One order you bought, with its briefing, its draft and its state history.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Responses
200
The order.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/orders/$ORDER_ID" \
-H "Authorization: Bearer $GROWWER_API_KEY"
Approves the delivery of an order whose pendingAction is yours to review the delivery, as the web does. The order finishes and the seller is paid. It takes no body.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Responses
200
The order, approved.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The resource does not exist, or it is not yours (code not_found).
409
The order is not pending your review of its delivery (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Approves the draft of a post order whose pendingAction is yours to review the draft (GET /orders/{id}/draft downloads it), as the web does. The seller then publishes it. It takes no body.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Responses
200
The order, with its draft approved.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The resource does not exist, or it is not yours (code not_found).
409
The order is not a post order with a draft pending your review (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
The file you attached to the briefing of a post order. 404 when the order has none (briefing.hasProposedDraft is false) or the file cannot be read.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Responses
200
The file, with its own content type and name.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Answers the file itself (application/octet-stream), not JSON.
POST /api/v1/orders/{id}/cancel
Cancel an order
Cancels an order the seller has not accepted yet (statepending_acceptance), as the web does. Its price returns to your wallet's available balance, and the seller is told your reason.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
reasonRequired
stringmin length 10, max length 2000
What the seller is told, 10 to 2000 characters once trimmed.
Responses
200
The order, cancelled.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The resource does not exist, or it is not yours (code not_found).
409
The seller has already accepted or refused the order, or it has finished (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
The file of the current draft of a post order. 404 when the order has no draft file (draft.hasFile is false) or the file cannot be read.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Responses
200
The file, with its own content type and name.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Answers the file itself (application/octet-stream), not JSON.
POST /api/v1/orders/{id}/request-draft-update
Request changes to a draft
Asks the seller to change the draft of a post order whose pendingAction is yours to review the draft, as the web does. The seller is told your reason.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
reasonRequired
stringmin length 10, max length 2000
What the seller is told, 10 to 2000 characters once trimmed.
Responses
200
The order, with its draft back with the seller.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The resource does not exist, or it is not yours (code not_found).
409
The order is not a post order with a draft pending your review (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Asks the seller to change the delivery of an order whose pendingAction is yours to review the delivery, as the web does. The seller is told your reason.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
reasonRequired
stringmin length 10, max length 2000
What the seller is told, 10 to 2000 characters once trimmed.
Responses
200
The order, back with the seller.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The resource does not exist, or it is not yours (code not_found).
409
The order is not pending your review of its delivery (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
A page of your projects and how many you have in all.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/projects" \
-H "Authorization: Bearer $GROWWER_API_KEY"
Creates a project for a website, as the web's project creation does. Growwer then analyses it in the background to recommend media: the project is answered with state: analyzing and turns finished when the analysis ends. Analysis can take hours, and it never finishes when no medium matches the project, so poll GET /projects/{id} with backoff and use createdAt to decide when to stop.
Every value is validated as on the web: topics, language and country take the identifiers GET /vocabulary publishes.
Creating a project also categorises its website through an external service, as the web does. When that service fails the answer is 500, although the project may already be saved, and a retry under the same Idempotency-Key answers 409 idempotency_outcome_unknown. After either, list your projects (GET /projects) before retrying with a new key, or you may create a duplicate.
Parameters
Name
In
Type
Description
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
name
string | nullmax length 255
rootUrlRequired
string (uri)
websiteTypeRequired
ecommerce | services | other
topicsRequired
integer[]min items 1, max items 1
Exactly one topic id from GET /vocabulary.
languageRequired
string
A language code from GET /vocabulary.
country
string | null
A country code from GET /vocabulary; omit it or send null for worldwide.
promotedProductsRequired
string[]min items 5, max items 10
5 to 10 products or services the campaign promotes.
userKeywords
string[]max items 100
At most 100 keywords, none with a line break.
Responses
202
The project, created and being analysed. Location is its URL.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability), or you have reached the number of projects an account may have without a wallet deposit in the last year (code project_limit_reached).
409
The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
One of your projects. Poll it to follow state after creating the project.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Responses
200
The project.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/projects/$PROJECT_ID" \
-H "Authorization: Bearer $GROWWER_API_KEY"
Changes only the fields you send. rootUrl cannot be changed; any field not listed here is refused. Changing language, country, promotedProducts or topics makes Growwer categorise the project and work out its target keywords again, in the background.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
name
string | nullmax length 255
Null or an empty string removes the name.
websiteType
ecommerce | services | other
topics
integer[]min items 1, max items 1
Exactly one topic id from GET /vocabulary.
language
string
A language code from GET /vocabulary.
country
string | null
A country code from GET /vocabulary, or null for worldwide.
promotedProducts
string[]min items 5, max items 10
5 to 10 products or services the campaign promotes.
userKeywords
string[]max items 100
At most 100 keywords, none with a line break.
Responses
200
The project as edited.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).
404
The resource does not exist, or it is not yours (code not_found).
409
The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Deletes one of your projects. A project with an order in progress cannot be deleted until its orders finish.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Responses
204
The project was deleted.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).
404
The resource does not exist, or it is not yours (code not_found).
409
The project has an order in progress (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
By creation date, number of published orders or publication rate; a leading - sorts descending. Medias with no publication rate come first ascending, last descending. Ties come in id order.
limit
query
integermin 1, max 100, default 20
Medias per page, 1 to 100.
offset
query
integermin 0, default 0
Medias to skip.
Responses
200
A page of your medias and how many match in all.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/seller/medias" \
-H "Authorization: Bearer $GROWWER_API_KEY"
One of your medias, with your fees, its extras, the competitive fees Growwer suggests and how it performs. Another seller's media is not found.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Responses
200
The media.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/seller/medias/$MEDIA_ID" \
-H "Authorization: Bearer $GROWWER_API_KEY"
Sets the fees of one of your medias, as the media edit page saves them. Send only the sections you change: a section you send replaces that section wholly, a section you leave out stays as it is.
postOffer.pricingOptions lists every link type you offer for sponsored posts, at least one. A link type you leave out is no longer offered. Each option needs at least one fee, and every option must offer the same sides (written by you, written by the buyer or Growwer), as the page requires. Each fee is at least 1 EUR.
linkAdditionOffer.pricingOptions lists the link types you offer for adding a link to an existing article; null or an empty list stops offering link additions.
extraServices is the full list of extra services you offer; an empty list removes them all.
The fees are your base fees, the ones GET /seller/medias/{id} returns: while a flash offer runs, its discount keeps applying on top of them, and currentCost shows the result. currentCost may be sent back as read and is ignored. Characteristics, topics and comments are not edited here.
As on the page, a change of the post offer's price may cancel the managed-service proposals accepted for the media whose price it changes, and raising the price above the best competitor's tells Growwer's support team. A restricted seller account may edit its fees.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
postOffer
object
linkAdditionOffer
object | null
extraServices
object[]
Responses
200
The media, with the fees saved.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The resource does not exist, or it is not yours (code not_found).
409
The Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The body is not valid (code validation_failed): details.fields names each field by its path in the body, such as postOffer.pricingOptions.0.feeWhenSellerWritesPost, with the rule the media edit page applies. Nothing changed.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
POST /api/v1/seller/medias/{id}/apply-competitive-fees
Set the competitive fees Growwer suggests
Sets your post fees for the media to the competitive fees Growwer suggests, the competitiveFees of GET /seller/medias/{id}, as the button on the media edit page does. Each link type you offer gets the suggested fee on each side it already has a fee for; no link type gains a side it did not offer.
Two differences from the page: a side Growwer has no suggestion for keeps your fee (the page clears it), and the fixed fee the page falls back to when it cannot find a competitive one is never applied (the page applies it). When neither side has a suggestion, nothing changes and the answer is 409 no_competitive_fees. When your fees already are the suggested ones, or the suggestion is only for a side none of your link types offers, nothing changes and the answer is 200.
The fees set are your base fees: a running flash offer keeps discounting them. As with a fee edit, a change of the price may cancel the managed-service proposals accepted for the media whose price it changes. Send no body, or an empty object.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Responses
200
The media, with the suggested fees set.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The resource does not exist, or it is not yours (code not_found).
409
Growwer has no competitive fees to suggest for the media now (code no_competitive_fees), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The body is not empty, or the fees set break a rule of the media edit page (code validation_failed). Nothing changed.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
What your sales have earned: the balance you can withdraw now and what is held until orders settle. restricted is true while your seller account is restricted; the reason is not published here, and support can tell you more.
Responses
200
Your seller wallet.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/wallets/seller" \
-H "Authorization: Bearer $GROWWER_API_KEY"
Every movement of your seller wallet, newest first: earnings from orders, withdrawals and manual corrections. An earning names its order (orderId) and a withdrawal its request (withdrawalId).
Parameters
Name
In
Type
Description
limit
query
integermin 1, max 100, default 20
Movements per page, 1 to 100.
offset
query
integermin 0, default 0
Movements to skip.
Responses
200
A page of your movements and how many there are in all.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/wallets/seller/transactions" \
-H "Authorization: Bearer $GROWWER_API_KEY"
GET /api/v1/wallets/seller/transactions/{id}/document
Download the document of a seller wallet movement
The document Growwer attached to a movement of your seller wallet. 404 when the movement has none (hasDocument is false) or the file cannot be read.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Responses
200
The document, with its own content type and name.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Answers the file itself (application/octet-stream), not JSON.
GET /api/v1/withdrawals
List your withdrawals
The withdrawals you requested from your seller wallet, newest first. Requesting a withdrawal is not available through the API; use the seller wallet page.
Parameters
Name
In
Type
Description
state
query
string
Only the withdrawals in one of these states, comma-separated: started, approved, rejected. An unknown state is refused with 422.
limit
query
integermin 1, max 100, default 20
Withdrawals per page, 1 to 100.
offset
query
integermin 0, default 0
Withdrawals to skip.
Responses
200
A page of your withdrawals and how many match in all.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/withdrawals" \
-H "Authorization: Bearer $GROWWER_API_KEY"
The invoice you uploaded for one of your withdrawals, named withdrawal-{id}-invoice.pdf. 404 when the withdrawal has none (hasInvoice is false); 503 storage_unavailable when the file cannot be read right now.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Responses
200
The invoice file.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Answers the file itself (application/octet-stream), not JSON.
Seller orders
GET /api/v1/seller/orders
List the orders you sell
The orders placed on your medias, newest first by default. To follow them, poll with sort=updatedAt and updatedSince set to the updatedAt of the last order you saw: an order moves to the end of that list each time it changes state. The orders you bought are under GET /orders.
Parameters
Name
In
Type
Description
mediaId
query
string (uuid)
Only the orders on this media of yours.
state
query
string
Only the orders in one of these states, comma-separated. An unknown state is refused with 422 and the list of valid ones.
updatedSince
query
string (date-time)
Only the orders whose updatedAt is at or after this instant, an ISO-8601 date-time with its offset (send + as %2B).
sort
query
-createdAt | updatedAtdefault "-createdAt"
-createdAt, newest first, or updatedAt, least recently changed first. Orders of the same instant come in id order.
limit
query
integermin 1, max 100, default 20
Orders per page, 1 to 100.
offset
query
integermin 0, default 0
Orders to skip.
Responses
200
A page of the orders you sell and how many match in all.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/seller/orders" \
-H "Authorization: Bearer $GROWWER_API_KEY"
One order placed on one of your medias, with its briefing, its draft and its state history. An order you only bought is not found here; it is under GET /orders/{id}.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Responses
200
The order.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
curl -X GET "https://tool.growwer.com/api/v1/seller/orders/$ORDER_ID" \
-H "Authorization: Bearer $GROWWER_API_KEY"
Accepts an order placed on one of your medias (statepending_acceptance), as the web does. A post order whose draft is still to be written (by you or by Growwer) moves to pending_draft; any other order moves to pending_order_delivery. The buyer is told. Takes no body.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Responses
200
The order, accepted.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The resource does not exist, or it is not yours (code not_found).
409
The order is not waiting for your acceptance (code invalid_state), your seller account is restricted and accepts no orders (code seller_restricted; support can tell you why), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
The file the buyer attached to the briefing of a post order you sell. 404 when the order has none (briefing.hasProposedDraft is false) or the file cannot be read.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Responses
200
The file, with its own content type and name.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Answers the file itself (application/octet-stream), not JSON.
POST /api/v1/seller/orders/{id}/deliver
Deliver an order
Delivers an order placed on one of your medias (statepending_order_delivery), as the web does. A post order takes the URL of the published post and the confirmation of its publication date; a link addition order takes no body, and any field is refused. The order moves to pending_order_delivery_review and the buyer is asked to review it, or, for a post order whose scheduled publication date is still to come, to scheduled without telling the buyer yet. The URL is checked to be a URL only, as the web does.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Optional
Field
Type
Description
urlRequired
string (uri)
The URL of the published post. It is checked to be a URL only, as the web does; whether the post carries the links is not checked here.
publicationDateConfirmedRequired
boolean
Must be true. Confirms the post is live, or for an order with a scheduled publication date, that it will be published on that date.
Responses
200
The order, delivered or scheduled.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The resource does not exist, or it is not yours (code not_found).
409
The order is not waiting for its delivery (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Delivers the draft of a post order placed on one of your medias whose draft you write (statepending_draft), as the web does, from a file you uploaded with POST /files. The order moves to pending_draft_review when the buyer reviews drafts, otherwise to pending_order_delivery. The file is used up once the draft is delivered; a refused request leaves it usable.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
fileIdRequired
string (uuid)
A file you uploaded with POST /files and have not used yet. It must be an odt, doc, docx or txt file of up to 8 MB. It is used up once the draft is delivered.
Responses
200
The order, with its draft delivered.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The resource does not exist, or it is not yours (code not_found).
409
The order is not waiting for a draft you write (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The body is not valid, or the file is not an odt, doc, docx or txt file of up to 8 MB (code validation_failed, with the messages of each field in details.fields), or fileId names no file you can use: it does not exist, has expired or was already used (code file_unusable).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
POST /api/v1/seller/orders/{id}/deliver-draft-update
Deliver a draft update
Delivers the draft update the buyer asked for on a post order placed on one of your medias whose draft you write (statepending_draft_update), as the web does, from a file you uploaded with POST /files. The order moves back to pending_draft_review. The file is used up once the draft is delivered; a refused request leaves it usable.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
fileIdRequired
string (uuid)
A file you uploaded with POST /files and have not used yet. It must be an odt, doc, docx or txt file of up to 8 MB. It is used up once the draft is delivered.
Responses
200
The order, with its updated draft delivered.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The resource does not exist, or it is not yours (code not_found).
409
The buyer has not asked for an update of a draft you write (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The body is not valid, or the file is not an odt, doc, docx or txt file of up to 8 MB (code validation_failed, with the messages of each field in details.fields), or fileId names no file you can use: it does not exist, has expired or was already used (code file_unusable).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Delivers the update the buyer asked for on an order placed on one of your medias (statepending_order_delivery_update), as the web does. A post order takes the URL of the published post, which may be the same as before, and the confirmation of its publication date; both must be sent. A link addition order takes no body, and any field is refused. The order moves back to pending_order_delivery_review and the buyer is asked to review it.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Optional
Field
Type
Description
urlRequired
string (uri)
The URL of the published post. It is checked to be a URL only, as the web does; whether the post carries the links is not checked here.
publicationDateConfirmedRequired
boolean
Must be true. Confirms the post is live, or for an order with a scheduled publication date, that it will be published on that date.
Responses
200
The order, with the update delivered.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The resource does not exist, or it is not yours (code not_found).
409
The buyer has not asked for an update (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
The file of the current draft of a post order you sell. 404 when the order has no draft file (draft.hasFile is false) or the file cannot be read. Earlier drafts are not available.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Responses
200
The file, with its own content type and name.
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
404
The resource does not exist, or it is not yours (code not_found).
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Answers the file itself (application/octet-stream), not JSON.
POST /api/v1/seller/orders/{id}/refute-draft-update
Refuse a draft update
Refuses the draft update the buyer asked for on a post order placed on one of your medias whose draft you write (statepending_draft_update), as the web does. The order moves back to pending_draft_review and the buyer is told your reason. A draft Growwer or the buyer writes cannot be refused here.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
reasonRequired
stringmin length 10, max length 2000
Why you refuse the buyer's request, which the buyer is told, 10 to 2000 characters once trimmed.
Responses
200
The order, with its draft back in review.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The resource does not exist, or it is not yours (code not_found).
409
The buyer has not asked for an update of a draft you write, including when Growwer or the buyer writes the draft (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Refuses the update the buyer asked for on an order placed on one of your medias (statepending_order_delivery_update), as the web does. The order moves back to pending_order_delivery_review and the buyer is told your reason.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
reasonRequired
stringmin length 10, max length 2000
Why you refuse the buyer's request, which the buyer is told, 10 to 2000 characters once trimmed.
Responses
200
The order, back in review.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The resource does not exist, or it is not yours (code not_found).
409
The buyer has not asked for an update (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.
Rejects an order placed on one of your medias that you have not accepted yet (statepending_acceptance), as the web does. The order moves to rejected_by_seller, its price returns to the buyer, and the buyer is told your reason.
Parameters
Name
In
Type
Description
idRequired
path
string (uuid)
Idempotency-KeyRequired
header
stringmax length 255
A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (! to ~); any other value answers 400 invalid_idempotency_key.
Request body application/json, Required
Field
Type
Description
reasonRequired
object
Responses
200
The order, rejected.
400
The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).
401
The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).
403
The key is read-only (code insufficient_capability).
404
The resource does not exist, or it is not yours (code not_found).
409
The order is not waiting for your acceptance (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).
422
The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.
429
Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.
500
An unexpected error (code internal_error).
503
The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.