Get an order
Returns a completed purchase. Accessible via JWT (authenticated users) or order token header (guests).
Resolves three kinds of id: the order’s own (or_…), the id of the cart it was placed from, and the
id of an order group (ogrp_…). The cart’s id is the handle a storefront keeps through checkout, so
a confirmation page can ask what its cart became without having learned a new one.
A checkout that reached several sellers divided into one order per seller, and the cart moved up to
the group holding them — so that handle, and the group’s own id, answer with the order group,
with the per-seller orders nested inside it. Every other lookup answers with an order. The two
are told apart by the id prefix (ogrp_ vs or_), or by the presence of orders.
Authorizations
Publishable API key for store access
JWT token for authenticated customers
Headers
Bearer token for authenticated customers
Order token for guest access
Path Parameters
Prefixed ID of the order, of the cart it was placed from, or of its order group
Query Parameters
Comma-separated associations to expand (items, fulfillments, payments, discounts, billing_address, shipping_address, gift_card). Use "none" to skip associations.
Comma-separated list of fields to include (e.g., total,amount_due,item_count). id is always included.
Response
order found (guest via order token)
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MTL, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SKK, SLE, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMM, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYI, UYU, UYW, UZS, VED, VEF, VES, VND, VUV, WST, XAF, XCD, XCG, XOF, XPF, YER, ZAR, ZMK, ZMW, ZWD, ZWG, ZWL, ZWN, ZWR aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, de-AT, de-CH, dv, dz, ee, el, en, en-AU, en-CA, en-GB, en-IN, en-NZ, en-US, eo, es, es-419, es-CL, es-EC, es-MX, et, eu, fa, ff, fi, fj, fo, fr, fr-CA, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, pt-BR, pt-PT, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sl-SI, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh-CN, zh-HK, zh-TW, zu backorder, canceled, partial, unfulfilled, fulfilled, delivered, pending, ready, shipped none, authorized, partially_paid, paid, partially_refunded, refunded, overcharged, voided The line items: each price times its quantity, before discounts, fees and delivery.
item_total formatted with its currency symbol in the request's language.
What promotions take off, as a negative amount. Manual discounts are not included.
discount_total formatted with its currency symbol in the request's language.
All tax, both included in prices and added on top.
tax_total formatted with its currency symbol in the request's language.
Tax already included in the prices, as in a store whose prices are tax-inclusive.
included_tax_total formatted with its currency symbol in the request's language.
Tax added on top of the prices.
additional_tax_total formatted with its currency symbol in the request's language.
What delivery costs, before delivery discounts.
delivery_total formatted with its currency symbol in the request's language.
Every fee charged, such as handling or a customs duty.
fee_total formatted with its currency symbol in the request's language.
What a gift card pays.
gift_card_total formatted with its currency symbol in the request's language.
What store credit pays, apart from gift cards.
store_credit_total formatted with its currency symbol in the request's language.
What the customer pays in all: items, delivery, fees and added tax, less discounts.
total formatted with its currency symbol in the request's language.
What is left to pay after payments and store credit.
amount_due formatted with its currency symbol in the request's language.
Every discount, fee and added tax together, as one amount.
adjustment_total formatted with its currency symbol in the request's language.