Read a design's first-order delivery
const url = 'https://api.pixonaut.app/v1/designs/example/delivery';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/designs/example/delivery \ --header 'Authorization: Bearer <token>'Operation ID: designs.delivery.get
A secret key, a studio member holding orders:read, or the design’s address capture link. The delivery given for the design’s first order, while the design is open; once it is ordered, the delivery its newest open order holds now — or, through an address capture link bound to one order, that order’s, with orderClosed once it is closed — while that order’s address can still change (changeable), else none; once it is erased or rejected, none.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”The design’s delivery
object
Whether a delivery given now still reaches the design’s order: always while it is open; once it is ordered, while its open order’s printshop takes address changes, or the order ships to a saved address, and the order is not past one. Never otherwise.
Who the design’s first order is for and where it ships, while the design is open and one has been given; once it is ordered and changeable, who its open order is for and where it ships now.
object
object
The recipient’s email address, for the carrier’s notices.
The recipient’s name as a parcel label carries it, a person’s or a company’s. Up to 200 characters.
The recipient’s phone number as the customer gave it, with the country code when it has one.
object
The city or town.
The company of a business address, which the parcel goes to; the recipient is who receives it.
The country as a two-letter ISO 3166-1 code in capitals, such as SE or US.
The first line of the street address: street and number.
The second line of the address: an apartment, floor or c/o.
The postal code as the country writes it, such as 111 22 or SW1A 1AA. Left out where the country has none; a printshop that needs one refuses the order postal_code_required.
The state, province or county, where the country uses one.
Read through an address capture link bound to one order, once that order has shipped, will not be made (failed, cancelled) or its personal data was erased: which. Absent otherwise.
open while the design takes a delivery; ordered once its first order has been placed, which took the delivery or went by its own request; erased once the design’s personal data was erased; rejected once the design is rejected.
Examples
Example
{ "changeable": true, "delivery": { "capturedAt": 1791766800000, "recipient": { "name": "Alexandra Lind", "phone": "+44 20 7946 0958" }, "shippingAddress": { "city": "London", "country": "GB", "line1": "44 Baker Street", "line2": "Floor 3", "postalCode": "NW1 6XE", "region": "Greater London" } }, "state": "open"}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, forbidden, feature_disabled, workspace_suspended
object
The feature the tenant does not have. Always sent with feature_disabled.
Examples
feature_disabled
{ "error": "feature_disabled", "feature": "api"}forbidden
{ "error": "forbidden"}origin_forbidden
{ "error": "origin_forbidden"}workspace_suspended
{ "error": "workspace_suspended"}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: rate_limited
object
Examples
rate_limited
{ "error": "rate_limited"}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].