Read what a designer link was handed out with
const url = 'https://api.pixonaut.app/v1/share-links/example/designer';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.pixonaut.app/v1/share-links/example/designer \ --header 'Authorization: Bearer <token>'Operation ID: shareLinks.designer.get
A working designer link’s settings, as POST /v1/templates/{id}/designer-links took them and PATCH /v1/share-links/{id} changes them: what its page shows, where it sends the shopper back to and with what, its language, frame, name, design limit and expiry. Never its token. Any other kind of link, a withdrawn or expired one, or one the caller could not have handed out, is answered as not found.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”The link’s settings
object
The blank it is printed on; with placementId, or a panelLayout.
The brand the link’s page is drawn in; null for the workspace’s default, whichever that is when it opens.
How many designs a designer link may make; null for none.
object
How many designs the link may make in its period.
total counts every design the link made; hour, day and week the last 60 minutes, 24 hours or 7 days, rolling.
When it stops working; null for until withdrawn.
The link’s id.
The variant the side starts on, by ref: one of variants when it names any.
The view shown first; absent, the side’s first with a photo.
How every side’s form lays out its steps: page, every step on one page, or steps, one step at a time. Absent, each side’s form follows its template’s own form.layout, and is a page when the template names none.
Which of the sides’ placements one design drives, such as a sweater’s sleeves: a preset, or groups of the sides’ placements, a group with a repeat of its own where it repeats apart from the link. The sides of one group print one template. Absent, the groups the blank suggests whose sides print one template; the link keeps the groups it was made with.
object
Whether the shopper may take a placement out of its group and design it on its own. Absent, no.
Groups of your own in place of a preset, each a list of placements, or { placements, repeat } for a group that repeats apart from the link. A mirror left out is the blank’s suggestion, else none.
Placements one design drives, two at least.
object
Whether the placement’s print is mirrored left to right.
The id of one of the blank’s placements.
Placements one design drives, with a repeat of their own: a proof or commit of one of them is held to it.
object
Placements one design drives, two at least.
object
Whether the placement’s print is mirrored left to right.
The id of one of the blank’s placements.
How the group’s design is laid as a repeat, in place of the link’s repeat; null places it once beside a link that repeats.
object
The layouts the shopper may pick, one at least, each once.
Whether the shopper may pick another of modes and another size. Otherwise every design prints as start.
Whether the shopper may place the design once instead (repeat: null). Only with shopperMayChange.
What the design starts as: a repeat in one of modes, or null for placed once, which needs shopperMayTurnOff. A request through the link that names no repeat is made with it.
object
How the tiles are laid: grid lines them up, brick moves every other row along by half a tile, halfDrop moves every other column down by half a tile, and scatter strews them at random places, turns and sizes, arranged by seed.
Which arrangement a scatter draws: another seed is another arrangement of the same tile. Read by scatter only.
The tile’s width in percent of the print area’s width, above 0 and at most 100; the tile keeps the template’s shape. A tile that would print under 10 mm on a side is drawn at 10 mm.
each: every placement is designed on its own. suggested: the groups the blank suggests, such as its sleeves. all: one design drives every placement. Absent with no groups, suggested.
The language the link’s page is shown in, which its url names as ?lang=<locale>; null when it names none, and the page is shown in the workspace’s default language.
The store’s own product photos the design is shown on, in place of the blank’s views.
object
How far the photo’s folds move the design, above 0 and at most 1; absent or null, not at all.
What the menu calls the photo.
The label per customer-facing language, by code: only the languages it has one in. A designer shown in a language left out reads label.
object
The size of the photo the rect is measured in, when it is not the size of the image the url serves; absent, the image’s own.
object
Its height, in pixels.
Its width, in pixels.
Where the print sits in the photo, in the photo’s pixels.
object
Its height, in the photo’s pixels.
Its width, in the photo’s pixels.
From the photo’s left edge, in its pixels.
From the photo’s top edge, in its pixels.
How strongly the photo’s light and shade carry onto the design, from 0 (flat) to 1; absent, the default.
The photo’s address, http or https.
The store’s own name for the way the product is photographed: photos sharing one are one view.
How the design wraps round the product in the photo, a mug or a bottle; absent or null, flat.
object
How far round the product the rect reaches, above 0 and at most 1.
How dark the design turns toward the product’s silhouette, 0 to 1.
The one kind of wrap: an upright round product.
The workspace’s name for the link.
The name of a panel layout of the link’s blankId, in place of placementId: the page draws one design across the layout’s canvas, and each placement it lays out gets its print cut from it, so art runs across the seams. Not with sides or printSizes.
Whether a designer link’s page draws the placement frame around the shopper’s picture at rest; false for every other link.
The blank’s placement it is printed in; with blankId.
Whether a designer link’s page draws the print area’s frame; false for every other link.
The sizes the shopper picks from, for a print within its area.
One size in the size menu.
object
The print’s height, in mm.
What the menu calls the size.
The label per customer-facing language, by code: only the languages it has one in. A designer shown in a language left out reads label.
object
The print’s width, in mm.
Whether every side’s design is laid as a repeat of its template, which layouts the shopper may pick, what it starts as, and whether they may change it or turn it off; a linked group with a repeat of its own takes that instead. Absent, each design is placed once and a request through the link naming a repeat is refused. Not with panelLayout.
object
The layouts the shopper may pick, one at least, each once.
Whether the shopper may pick another of modes and another size. Otherwise every design prints as start.
Whether the shopper may place the design once instead (repeat: null). Only with shopperMayChange.
What the design starts as: a repeat in one of modes, or null for placed once, which needs shopperMayTurnOff. A request through the link that names no repeat is made with it.
object
How the tiles are laid: grid lines them up, brick moves every other row along by half a tile, halfDrop moves every other column down by half a tile, and scatter strews them at random places, turns and sizes, arranged by seed.
Which arrangement a scatter draws: another seed is another arrangement of the same tile. Read by scatter only.
The tile’s width in percent of the print area’s width, above 0 and at most 100; the tile keeps the template’s shape. A tile that would print under 10 mm on a side is drawn at 10 mm.
Where its page sends the shopper back to; null for none.
The photo that starts selected, by its place in mockups.
The size that starts selected, by its place in printSizes.
Several sides of one item, a front and a back, each its own template and placement, designed one after the other; then the one-side fields go on each side instead.
object
The blank it is printed on; with placementId, or a panelLayout.
The variant the side starts on, by ref: one of variants when it names any.
The view shown first; absent, the side’s first with a photo.
The side’s own short name, such as front: lowercase letters, digits, - and _, unique within the link.
What the side’s step is called, such as Front.
The label per customer-facing language, by code: only the languages it has one in. A designer shown in a language left out reads label.
object
The store’s own product photos the design is shown on, in place of the blank’s views.
object
How far the photo’s folds move the design, above 0 and at most 1; absent or null, not at all.
What the menu calls the photo.
The label per customer-facing language, by code: only the languages it has one in. A designer shown in a language left out reads label.
object
The size of the photo the rect is measured in, when it is not the size of the image the url serves; absent, the image’s own.
object
Its height, in pixels.
Its width, in pixels.
Where the print sits in the photo, in the photo’s pixels.
object
Its height, in the photo’s pixels.
Its width, in the photo’s pixels.
From the photo’s left edge, in its pixels.
From the photo’s top edge, in its pixels.
How strongly the photo’s light and shade carry onto the design, from 0 (flat) to 1; absent, the default.
The photo’s address, http or https.
The store’s own name for the way the product is photographed: photos sharing one are one view.
How the design wraps round the product in the photo, a mug or a bottle; absent or null, flat.
object
How far round the product the rect reaches, above 0 and at most 1.
How dark the design turns toward the product’s silhouette, 0 to 1.
The one kind of wrap: an upright round product.
The blank’s placement it is printed in; with blankId.
The sizes the shopper picks from, for a print within its area.
One size in the size menu.
object
The print’s height, in mm.
What the menu calls the size.
The label per customer-facing language, by code: only the languages it has one in. A designer shown in a language left out reads label.
object
The print’s width, in mm.
The photo that starts selected, by its place in mockups.
The size that starts selected, by its place in printSizes.
The template’s base id; the link’s own when absent.
The size the side sells, as a value of each option its blank’s print areas change with ({"Size": "XL"}): its proofs and designs are made at that size, and a request naming another is refused. Only on a blank whose print areas change with its size; absent, the shopper’s request names the size.
object
The blank’s variants offered, by ref; empty or absent, all.
The blank’s views the side is shown in; empty or absent, all.
What it carries back to returnUrl; null for none.
The template the link opens, by base id; a side naming none.
The size the side sells, as a value of each option its blank’s print areas change with ({"Size": "XL"}): its proofs and designs are made at that size, and a request naming another is refused. Only on a blank whose print areas change with its size; absent, the shopper’s request names the size.
object
The blank’s variants offered, by ref; empty or absent, all.
The blank’s views the side is shown in; empty or absent, all.
Examples
Example
{ "brandId": null, "designLimit": { "count": 50, "period": "day" }, "expiresAt": null, "id": "shl_9a8b7c6d5e4f3a2b1c0d9e8f", "locale": "sv", "name": "Spring market stand", "placementFrame": false, "printAreaFrame": false, "printSizes": [ { "heightMm": 297, "label": "A3", "widthMm": 420 }, { "heightMm": 420, "label": "A2", "widthMm": 594 } ], "returnUrl": "https://shop.example/cart", "selectedPrintSizeIndex": 0, "state": null, "templateId": "graduation-sign"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: unauthorized
object
Examples
unauthorized
{ "error": "unauthorized"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: origin_forbidden, feature_disabled
object
The feature the tenant does not have. Always sent with feature_disabled.
Examples
feature_disabled
{ "error": "feature_disabled", "feature": "api"}origin_forbidden
{ "error": "origin_forbidden"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: not_found
object
Examples
not_found
{ "error": "not_found"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: db_error. A request that failed unexpectedly answers as text instead.
object
Examples
db_error
{ "error": "db_error"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Questions? Write to [email protected].