Read an order's step delivery log
const url = 'https://api.pixonaut.app/v1/orders/example/deliveries';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/orders/example/deliveries \ --header 'Authorization: Bearer <token>'Operation ID: orders.deliveries.list
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”The order’s steps in the order they are sent, with their status
object
The order’s address change steps, oldest first: one for each change its printshop was sent after one of its steps was, as PATCH /v1/orders/{id}/delivery sends them. Status only, never what was sent.
object
When the printshop took it; null until it is accepted.
When it is next tried; null while nothing is scheduled.
object
What its last failed send came back with, in words: the shop’s answer, or why it could not be sent.
When it is next tried; null while nothing is scheduled.
Why a failed step was never sent, when that is why: its order was cancelled, an earlier step gave up, its personal data was erased, or the order was closed before it went.
Examples
Example
{ "addressChanges": [ { "attempts": 1, "createdAt": 1791890047000, "deliveredAt": 1791890048000, "kind": "http", "lastAttemptAt": 1791890047000, "lastError": null, "nextAttemptAt": 1791890047000, "status": "accepted" } ], "deliveries": [ { "attempts": 1, "deliveredAt": 1791886449000, "kind": "email", "lastAttemptAt": 1791886449000, "lastError": null, "nextAttemptAt": 1791886449000, "notSent": null, "status": "delivered", "stepIndex": 0 }, { "attempts": 2, "deliveredAt": null, "kind": "sftp", "lastAttemptAt": 1791886747000, "lastError": "Connection timed out", "nextAttemptAt": 1791887347000, "notSent": null, "status": "pending", "stepIndex": 1 } ], "deliverySteps": true}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: order_not_found, not_found
object
Examples
not_found
{ "error": "not_found"}order_not_found
{ "error": "order_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].