Get order details

data

• guaranteeobject | null

  The delivery guarantee in force on this order, or null when the order carries none (guarantees are issued only on lanes whose measured on-time record clears the floor, and only while the feature is enabled). The keys mirror the guarantee block returned by POST /orders/quote, so this is the object you were quoted, read back, plus what has since happened to it.

• guarantee.guarantee_idstringrequired

  Same id the quote issued.

• guarantee.deliver_bystring (date-time)required

  The date this order is guaranteed to arrive by.

• guarantee.quality_standardstringrequired

  The quality standard guaranteed ("standard" in v1).

• guarantee.confidencenumberrequired

  Lower bound on the lane's on-time probability at issue time (Wilson), between 0 and 1.

• guarantee.remedyobjectrequired

  The promise. cap_cents is the ceiling on what a breach can pay — never an amount owed or paid; read remedies for what was actually recorded.

• guarantee.remedy.typestringrequired

  credit is the only remedy issued today, and the one that settles as a real refund. remake and expedite are reserved for the ops-driven remedies; one would settle as not_applicable rather than pay.

  One of credit remake expedite

• guarantee.remedy.cap_centsintegerrequired
• guarantee.statusstringrequired

  issued while the promise is open, honored once the order was delivered on time, remedied once it was not. There is deliberately no breached value: a breach and its capped remedy are recorded in one transaction (so two overlapping sweeps cannot both pay out), so the terminal state of a broken promise is remedied and whether the money moved is the remedy's own status.

  One of issued honored remedied

• guarantee.issued_atstring (date-time)required
• guarantee.resolved_atstring (date-time) | nullrequired

  When the guarantee was honored or remedied; null while still open.

• guarantee.remediesobject[]required

  Remedies recorded against this guarantee. Empty unless it was breached.

• guarantee.remedies[].typestringrequired

  One of credit remake expedite

• guarantee.remedies[].amount_centsintegerrequired

  What was recorded, capped at the order value at issue.

• guarantee.remedies[].statusstringrequired

  applied is the only value that means money moved — a real refund on the order's charge. not_applicable is the ordinary sandbox outcome (a test order has no charge) and also covers a remake/expedite, which is an ops action rather than an automatic payment. failed is an owed remedy that has not been paid, kept distinct from not_applicable so it stays visible.

  One of pending applied failed not_applicable

• guarantee.remedies[].applied_atstring (date-time) | nullrequired
• guarantee.remedies[].created_atstring (date-time)required
• order_idstring

  The fulfilment network's order id: the one every order operation takes, whichever id this request was made with. Present on every order; on a live one the facility's own body supplies it when it carries one.

• portal_order_idstring

  This platform's own id for the order (ord_…), the id in the dashboard's order page. GET /v1/order/{id} and every other order operation accept it in place of order_id. Present on every order; on a live one the facility's own body supplies it when it carries one.

• referencestring | null

  The reference you supplied at creation, echoed back.

• vatstring | null

  The vat you supplied at creation, echoed back.

• statusstring

  The order's lifecycle status. The published vocabulary is the one GET /v1/orders filters on. Always on a sandbox order; on a live one it comes from the facility's own body. pending_approval on an order held for a person's approval (see approval), which is served from our own record, as a sandbox order is, until it is placed.

• approvalobject

  On an order placed with approval: "required" only: whether a person has approved it, the link they decide at while it still decides, and their decision. A hold whose link has expired is closed by this read (expired, the order cancelled).

• approval.statusstringrequired

  pending: waiting for the person. approving: a decision is placing it now. approved: approved and placed. declined: the person declined; the order is cancelled. expired: nobody decided in time; cancelled. cancelled: you cancelled it before anyone decided. failed: an approval did not place it (see failure); nothing was charged and it may be approved again until it expires.

  One of pending approving approved declined expired cancelled failed

• approval.urlstring | nullrequired

  The signed page the person approves or declines on, with no account. Null once it no longer decides (decided, expired, cancelled).

• approval.expires_atstring (date-time) | nullrequired

  When the link stops deciding: 72 hours after the hold.

• approval.decided_atstring (date-time) | nullrequired

  When the person approved or declined it. Null until then.

• approval.decided_bystring | nullrequired

  The name the person typed with their decision, if any. No address or other identifier is recorded.

• approval.failureobject | nullrequired

  Why the last approval placed nothing: the code and message POST /order answered. Null unless an approval failed.

• approval.failure.codestringrequired
• approval.failure.messagestringrequired
• approval.failure.atstring (date-time)required
• issue_reasonstring | null

  Why the order is issue_flagged, when the facility's status said: the same code order.issue carries. Null when the order is not flagged, or is flagged without a reason that fits one of these. Always on a sandbox order (a simulation names it); on a live one it is filled from our record wherever the facility's own body carries no key of that name.

  One of artwork_unprintable address_undeliverable shipment_exception on_hold cancellation_pending

• providerstring

  The fulfilment network that holds the order. Always on a sandbox order; on a live one it comes from the facility's own body.

• made_byobject | null

  The independent network shop that produced an order, or null when an in-house lane did. GET /v1/orders and GET /v1/order/{id} build it from the same helper and both $ref this, so they cannot describe one fact two ways — which they did, one of them calling it a string. Every order placed on this portal is made at our own plant, so it is null on them; a shop is named only on an order placed before that.

• made_by.namestringrequired

  The shop's display name.

• made_by.slugstringrequired

  The shop's directory slug.

• made_by.profile_urlstring (uri)required

  Its public profile page on this platform.

• total_centsinteger

  What the order was charged, in cents. Sandbox orders only — a live response reports money the way the facility does.

• shipping_centsinteger

  The shipping charge, in cents. Sandbox orders only, like total_cents.

• tax_centsinteger

  The sales tax charged on top of the order's total, in cents, from our own record. Present only on a live order that was taxed: while sales tax collection is on, Stripe Tax calculates it on the goods and shipping for the ship-to address. Absent on a sandbox order, which is never taxed, and on every order placed while tax collection is off.

• total_with_tax_centsinteger

  What the card was charged for the order, tax included, in cents. Present only with tax_cents.

• tracking_tokenstring | null

  The opaque token for this order's hosted tracking page, as GET /v1/orders reports it; null on an order with none.

• tracking_numberstring | null

  The carrier's tracking number; null until the order ships. The same value as tracking.number, the list's tracking_number and the order.shipped webhook's.

• tracking_carrierstring | null

  The carrier that holds the shipment; null until the order ships.

• tracking_urlstring | null

  The carrier's tracking link; null until the order ships. (The create response's tracking_url is the hosted tracking page, which this read publishes as tracking.page_url.)

• trackingobject

  Where the parcel is. The same block on GET /v1/order/{id} and on every GET /v1/orders row. number, carrier and url are null until the order ships, and equal the flat tracking_number, tracking_carrier and tracking_url beside it. On a live order whose facility reports its own tracking object, that object's keys are kept and these are added where it has none.

• tracking.numberstring | nullrequired

  The carrier's tracking number; null until the order ships.

• tracking.carrierstring | nullrequired

  The carrier that holds the shipment; null until the order ships.

• tracking.urlstring | nullrequired

  The carrier's tracking link; null until the order ships.

• tracking.page_urlstring (uri) | nullrequired

  The order's hosted tracking page, the link to give your customer. It exists from the moment the order is placed and shows each step, including before the carrier has a number; the create response's tracking_url opens the same page. Null only on an order with no tracking token.

• estimated_deliveryobject | null

  When the order should arrive, as an estimate counted from placement; null where no honest date exists (see OrderEstimatedDelivery). Ours on a live order too: a key of that name in the facility's body is replaced.

• estimated_delivery.earlieststring (date)required

  YYYY-MM-DD, UTC: the soonest the order should arrive.

• estimated_delivery.lateststring (date)required

  YYYY-MM-DD, UTC: the latest it should, before anything goes wrong.

• estimated_delivery.ships_bystring (date)required

  YYYY-MM-DD, UTC: the day it should leave the facility, when its production estimate ends, counted the same way.

• estimated_delivery.is_estimatebooleanrequired

  Always true: say it as an estimate wherever it is shown.

  Always true

• reordered_fromstring | null

  On an order POST /order/{id}/reorder placed: the source order's portal_order_id (this operation takes it), as the order's row records it and the reorder's own answer stated it. Null on any other order. Ours on a live order too: a key of that name in the facility's body is replaced.

• created_atstring (date-time)

  When the order was placed. On a live order the facility's own body supplies it when it carries one.

• updated_atstring (date-time)

  When the order last changed. On a live order the facility's own body supplies it when it carries one.

• test_modeboolean

  Present, and true, only on a sandbox order. Its absence is how a live order is told apart.

• artwork_accessobject[]

  Every print-file grant ever issued on this order, oldest first. Empty when no independent shop has been given this order's artwork — which is every order produced in-house, and every sandbox order.

• artwork_access[].asset_idstringrequired

  Stable handle for the file this grant covers — a digest of the artwork URL, so two order lines printing the same design share one grant and one count. The artwork URL itself is deliberately not returned: it is held only so the shop never receives it.

• artwork_access[].locationstring | nullrequired

  Print area ("front", "back", …) or "mockup"; null when the order line named none.

• artwork_access[].shopobject | anyrequired

  The shop the file was released to. Null only if that shop's record has since been deleted — a suspended or de-listed shop is still named here, because an audit entry that disappeared with the shop's directory listing would hide exactly the disclosure worth reading.

• artwork_access[].shop.namestring
• artwork_access[].shop.slugstring
• artwork_access[].statusstringrequired

  live while the signed window is open, expired once it closed without being re-issued (the ordinary end state — we simply stop re-issuing), revoked if we withdrew it first. live is necessary but not sufficient for a fetch to succeed: access also requires the shop to still be live on the network and the order not to be cancelled, both of which this response already reports via made_by and status.

  One of live expired revoked

• artwork_access[].granted_atstring (date-time)required

  When the file was first released to this shop.

• artwork_access[].expires_atstring (date-time)required

  End of the current signed window. In the past on an expired grant.

• artwork_access[].access_countintegerrequired

  Fetches recorded against this grant. 0 means the file was granted and never downloaded.

• artwork_access[].last_accessed_atstring (date-time) | nullrequired

  Most recent fetch, or null if there has never been one.

• artwork_access[].revoked_atstring (date-time) | nullrequired
• artwork_access[].revoked_reasonstring | nullrequired

  Why the grant was withdrawn; null unless status is revoked. A closed set: provider_declined (the shop refused the order), submission_failed (submission failed after the URLs had gone out), order_cancelled, order_rerouted (the order moved to another maker), reroute_submit_failed (the replacement refused it too).

  One of provider_declined submission_failed order_cancelled order_rerouted reroute_submit_failed account_purged

• landed_costobject | null

  What the border cost on this order, as recorded for the parcel that ships. Null on a domestic shipment — there is no border, so there is nothing to state, and a row of zeros would read like a customs assessment that came to nothing. When a cross-border order has no stored figures, recorded is false and only destination_country and not_recorded_reason are present: the duty, tax and FX rates that applied on the day are not recoverable, and backfilling them with today's rates would be a fabricated record rather than a missing one. That is what an order placed before these figures were stored looks like, and also a free replacement order, which carries no charged goods value to assess. The figures are a snapshot, never recomputed on read, so a stale figure cannot be mistaken for a current one — but they ARE re-recorded when the parcel itself changes, because the border is costed against the destination, the goods and the shipping charge. Change the address, add or cancel a line, change a quantity or change the shipping method and the order is costed again at that moment; recorded_at moves with it, and it is the order's creation time until something does. An order re-routed to a domestic address goes back to null. estimated stays true throughout: on DAP the courier bills the recipient directly, so we never learn what customs actually assessed.

• landed_cost.recordedbooleanrequired

  False when no landed cost was stored for this order.

• landed_cost.destination_countrystring

  ISO 3166-1 alpha-2.

• landed_cost.not_recorded_reasonstring

  Present only when recorded is false.

• landed_cost.recorded_atstring (date-time)

  When the figures were computed — never the moment of the read. The order's creation time, or the moment of the last change to its destination, lines or shipping charge.

• landed_cost.duty_basisstring

  DAP today: goods and shipping are collected at checkout, and the courier bills the recipient for duties and import tax on delivery.

  One of DDP DAP

• landed_cost.duty_ratenumber
• landed_cost.tax_ratenumber
• landed_cost.breakdownobject
• landed_cost.breakdown.goods_centsinteger
• landed_cost.breakdown.shipping_centsinteger
• landed_cost.breakdown.duties_centsinteger
• landed_cost.breakdown.tax_centsinteger
• landed_cost.total_landed_centsinteger

  What the buyer ends up paying in total.

• landed_cost.pre_collected_centsinteger

  Collected at checkout. Equals goods + shipping — never more than was charged.

• landed_cost.due_on_delivery_centsinteger

  Billed by the courier on delivery. Sums with pre_collected_cents to the total.

• landed_cost.presentmentobject
• landed_cost.presentment.currencystring
• landed_cost.presentment.amount_centsinteger
• landed_cost.presentment.minor_unitsinteger
• landed_cost.presentment.fx_ratenumber
• landed_cost.estimatedboolean
• landed_cost.notestring
• line_itemsobject[]

  The order's lines, each with the id our own item and return operations resolve. Present on live and sandbox orders alike.

• line_items[].idstringrequired

  This line's id. Use it as {itemId} on PUT /v1/{id}/item/{itemId} and DELETE /v1/{id}/item/{itemId}/cancel.

• line_items[].skustringrequired
• line_items[].quantityintegerrequired

  at least 1

• line_items[].unit_price_centsintegerrequired

  The unit price the line was placed at, in USD cents. Where a price is a pack total that does not divide into whole cents a unit, this is the line's rate rounded to the cent, for display: it stays as placed when the line's quantity changes and is shared by the lines of one SKU, so it is not necessarily line_total_cents over quantity. Read the line's money from line_total_cents, never as this times quantity.

• line_items[].line_total_centsintegerrequired

  This line's goods, exact, in USD cents, at its current quantity: what the order charged for them, and what cancelling the line refunds. A quantity change moves it at the rate the line's SKU was placed at on this order, which the order's lines of one SKU share, rounded once to the cent. Equal to unit_price_cents × quantity on every line priced in whole cents a unit.

• line_items[].artworkobject

  The line's artwork declaration, as the order accepted it: how the artwork was made, and who approved it and when. Absent on a line that declared none.

• line_items[].artwork.provenancestring

  How the artwork was made: human (made by a person), ai_assisted (a person made it with a model's help) or ai_generated (a model made it).

  One of human ai_assisted ai_generated

• line_items[].artwork.approved_bystring

  Who approved the artwork for print: a name or an email address, at most 200 characters. Control and invisible formatting characters are removed and whitespace collapsed before it is stored. Send it with approved_at.

  non-empty · at most 200 characters

• line_items[].artwork.approved_atstring (date-time)

  When the artwork was approved: an ISO 8601 date-time with a time zone, not in the future. Stored and echoed in UTC. Send it with approved_by.

• actionsobject

  Which changes this order still takes, read from the same checks the operations refuse on, so a client can show or offer an action without trying it first. true means the order's own state does not refuse it; the request is still checked as usual (the key's scope; the line an item action names, which must exist and, on a live order at our own plant, carry its artwork; and on a live order the facility, which can refuse a change with 502 fulfillment_error). false names the refusal the operation would give. Live PrintedSimply orders have add_item, update_item and upgrade_shipping false; only supported no-cost or downward shipping requests remain requestable. On other orders a shopper paid for (a drop, a checkout link or an agent checkout), update_item and update_shipping stay true because a decrease or a downgrade is allowed, while an increase or an upgrade is refused 409 shopper_paid_order, as add_item is.

• actions.cancelbooleanrequired

  DELETE /order/{id}/cancel. True only before production (pending_payment, paid or accepted); false once the order is cancelled (400 already_cancelled) or past that (409 not_cancellable).

• actions.update_addressbooleanrequired

  PUT /order/{id}/address. False on an order an independent shop made (501 not_supported_by_provider) and once the order is past the point of change (409 order_not_modifiable).

• actions.update_shippingbooleanrequired

  PUT /order/{id}/shipping. False for the reasons update_address is.

• actions.upgrade_shippingbooleanrequired

  Positive-cost PUT /order/{id}/shipping upgrades. False for live PrintedSimply orders (501 not_supported_by_provider), shopper-paid orders (409 shopper_paid_order), and when update_shipping is false. A downgrade or unchanged method can still be allowed when this is false.

• actions.add_itembooleanrequired

  POST /{id}/item. False for the reasons update_address is, on live PrintedSimply orders (501 not_supported_by_provider), and on an order a shopper paid for (409 shopper_paid_order).

• actions.update_itembooleanrequired

  PUT /{id}/item/{itemId}. False for the reasons update_address is and on live PrintedSimply orders (501 not_supported_by_provider). An unchanged quantity is still an allowed no-op.

• actions.cancel_itembooleanrequired

  DELETE /{id}/item/{itemId}/cancel. False for the reasons update_address is.

meta

• pageinteger
• totalinteger
• limitinteger

  The page size actually applied, which is not necessarily the one asked for — the operation's own ceiling wins.

• pagesinteger

  total over limit, rounded up.

• next_cursorstring | null

  On a cursor-paged operation: send this back as cursor for the next page. Null on the last page. Absent on operations that do not page by cursor.

• has_moreboolean

  On a list operation whose meta is ListMeta: whether another page follows this one.