API reference: objects
The fields of products, variants, quotes, orders, shipments, invoices and events.
Fields not listed here are reserved for future use and are currently null or empty. New fields may be added at any time, so ignore fields you do not know.
# Product
Field
idodp_…
objectproduct
od_codeOur product code, for example OD-000127
typeblank (catalog product), custom, or design (your own design)
title, descriptionName and description
statuslive
production_daysProduction time in business days
min_qtyMinimum quantity per order (1 means none)
shipping_profiletype (flat, live_rate, included, freight_quote), amount (flat rate per order, or null), description
decorationmethod: how it is decorated
optionsFor example [{"name": "Size", "values": ["S", "M", "L"]}, {"name": "Colour", "values": ["Black", "Navy"]}]
images[{"url", "alt", "view", "is_primary"}]. For your designs, the mockup of your design in its main colour
net_price_rangeList calls only: min, max, currency
variant_countList calls only
variantsSingle-product calls only: a list of variants
created_at, updated_atTimes
# VariantOne colour and size of a product: the thing you order.
Field
od_skuOur SKU, for example OD-000125-D1001-BLK-L
partner_skuYour own SKU for your designs, or null
product_idodp_…
titleProduct, colour, size
color, sizeColour name and size
net_priceWhat you pay per piece
net_price_effective_atWhen this NET price was last set
suggested_retail_priceYour price for your designs, or our suggestion, or null
min_qtyThe product's minimum quantity
availabletrue while the variant is offered
orderabletrue when you can order it now (live, active and priced)
unavailable_reasonWhy it cannot be ordered, or null
# Quote
Field
idodq_… (test_odq_… in test mode)
objectquote
livemodetrue for live keys
statusopen or expired
recipientThe address as we read it
itemsOrder lines
shippingprofile (flat, live_rate or included) and amount
tax_detailsstate, rate (for example "0.0825"), reason (taxable or state_not_collected), basis (retail_price in California, net in other taxed states)
totalssubtotal, shipping, tax, card_fee ("0.00"), total, currency
notes, priced_at, expires_at, created_at
# Order
Field
idodo_… (test_odo_… in test mode)
objectorder
livemodetrue for live orders
order_numberOur order number (live orders)
external_idYour order number
statusaccepted, on_hold, in_production, partially_shipped, shipped, delivered, cancelled or refunded
tracking_statuspending or available
channelWhere the order came from, for example api or portal
metadataYour metadata
recipientThe delivery address
itemsOrder lines
shippingamount
tax_detailsAs on a quote
totalssubtotal, shipping, tax, card_fee, total, currency
invoicenumber, status, issued_at (live orders)
requested_in_hands_date, notesWhat you sent
holdWhile on_hold: reason
cancellabletrue while you can still cancel
cancellable_untilWhen the cancel window closes
shipmentsShipments so far
created_at, updated_atTimes
# Order line
Field
line_number1, 2, 3…
external_line_idYour line id, if you sent one
od_sku, partner_skuThe SKU ordered
title, product_idWhat it is
quantityHow many
unit_priceYour NET price per piece
amountunit_price × quantity
retail_priceThe retail price you sent, or null
production_daysProduction time in business days
# Shipment
Field
idshp_…
objectshipment
carrierFor example ups, usps, fedex
serviceThe carrier service
tracking_number, tracking_urlTracking
statusin_transit or delivered (or the carrier's status)
shipped_at, delivered_atTimes
# Invoice
Field
idinv_…
objectinvoice
numberInvoice number
statusFor example issued, paid
issued_at, due_dateWhen it was issued and when it is due
total, amount_paid, credited, balance, currencyMoney
order_id, order_numberThe order
# Event
Field
idevt_… (the webhook-id header)
objectevent
typeorder.created, order.shipped, order.cancelled or ping
livemodeTest or live
created_atWhen it happened
dataorder; for order.shipped also tracking_number and carrier
← Previous Endpoints Next → Errors, limits & idempotency
