Get product by SKU

GET/products/{sku}

Retrieve details and pricing for a specific product — its price fields as on GET /v1/products: the list price (our price book's, for a product of our own plant's that the book prices), the same on every plan since there is no platform fee — from the catalog of the facility whose capabilities cover it (a sticker SKU is answered by the flat-goods facility; apparel by the default facility). Pass provider to ask one facility's catalog explicitly. Returns 404 when that catalog has no such SKU — 'does this SKU exist?' is answerable here before ordering. When the facility gives no answer about the SKU (5xx, a refused credential, a timeout, a rate limit, or an open circuit), the row is served out of the last-good snapshot with X-Catalog-Stale: true, as GET /v1/products does — so the list and this read agree during an outage. A SKU the snapshot does not hold is a 502, never a 404: a stale list missing a row says nothing about a product added since. On our own plant's catalog, a SKU our price book lists is served from the book instead, as the list serves it (source: "price_book", X-Catalog-Stale: true), and so is another size of a product it lists, spelled as the list spells it (sticker-die-cut-2x2 beside the listed 3×3), which a test key's quote and order take at $0 while the plant does not answer. A SKU our catalog lists (a sticker's, a wall decal's, a poster's or a magnet's, in any canonical spelling of a row or of its shapes and finishes) is never a 404: where our plant's catalog has no row for it, it is the catalog's row under the SKU's canonical spelling, source: "listed", with not_orderable_code: plant_unmapped; where the plant gives no answer, the same row, stale. A stale answer is sent Cache-Control: private, no-store, as on the list.

Credential: An API key in x-api-key
Scopes: products:read

Parameters

skupath · stringrequired
Product SKU identifier
providerquery · string
Which catalog to ask: printedsimply, our own plant's. It is the default and the only value; anything else is a 400.
Always printedsimply
Default printedsimply

Request

Try it

GET /api/v1/products/{sku}

curl "https://printedsimply.com/api/v1/products/sticker-die-cut-3x3" \
  -H "x-api-key: ps_test_YOUR_KEY"

Response `200`

The catalog row for this SKU. data is the facility's own row, unwrapped — the same shape as one element of GET /v1/products, and open for the same reason. Note that category appears here only if the facility publishes one: the derivation that fills it runs on the list, not on this route. May have been served out of the last-good snapshot — read X-Catalog-Stale, which is sent both ways; a stale row from the local synced catalog carries only sku, name and priceCents, and one from our price book sku, name, base_price, category and source: "price_book" (with alt_skus where the book knows the product by another SKU too). Every row our own plant makes, whatever its source, also carries size_in, finish, family, minimum_quantity, quantity_breaks, price_interpolation, min_unit_cents, material, options, orderable, not_orderable_code and not_orderable_reason, as on the list; a row the catalog built carries sku, name, base_price, category and source: "listed".

data

fulfillment_cost_basisstring
Approved per-size US standard shipping benchmark; actual postage, manufacturing cost and profit remain unknown.
Always approved_size_shipping_benchmark
goods_cost_centsany
Actual manufacturing cost is unknown, never represented by zero.
manufacturing_cost_centsany
actual_contribution_centsany
maximum_quantityinteger
One product, one SKU, quantity 1 in its own order.
Always 1
shipping_constraintsobject
shipping_constraints.destination_countrystringrequired
Always US
shipping_constraints.methodstringrequired
Always standard
shipping_constraints.separate_orderbooleanrequired
Always true
shipping_benchmark_centsinteger
The approved quantity-1 US standard benchmark, packing included.
at least 0
packagingstring
Always included_in_shipping_benchmark
artwork_layoutstring
Always prepared_combined_all
artwork_instructionsstring
Prepare one combined ALL PNG: flag front and back, or Santa hat front and band, according to the exact guide; remove guide lines.
artwork_guide_urlstring
Local path to the layout guide SVG. This reference is not customer artwork and must not be sent as print_file.
skustring | number
The identifier every other operation takes: an order item's sku, the {sku} path parameter, a recommendation's sku. Numeric on some facility catalogs — compare it as a string.
namestring
descriptionstring
categorystring
The facility's own category, where it publishes one — an open vocabulary, not this API's. GET /v1/products always fills this field (see ProductListItem); by SKU it is present only if the facility sent it.
sourcestring
Present only on a row this API built itself; absent on every row a facility sent. price_book: built from our own price book because our plant's catalog had nothing of its own to serve (the answer is then X-Catalog-Stale: true, with X-Catalog-Degraded naming why). Its price is the book's, which is what an order of the SKU is charged; the row carries sku, name, base_price and category. listed: a row of our catalog (a sticker, a wall decal, a poster or a magnet) that our plant's catalog, as this read found it, does not hold, listed after the rows read, with the same fields and its price from the catalog; not_orderable_code says whether our plant carries it.
One of price_book listed
size_innumber[] | null
Our plant's rows only: [width, height] in inches, read from the size the SKU names (the size the price book and an order price). Null when the SKU names no size, as an unsized sticker roll does.
2 to 2 entries
finishstring | null
Our plant's rows only: the finish the plant's row names, else the one the SKU names (glossy, matte, holographic, clear, satin); null when neither names one. No finish changes the price. A SKU of our sticker catalog is read by its own grammar: the finish it names after the size, else the bare stem's (glossy); there clear and holographic name a material, not a finish. A wall decal of our catalog: its sheet's one finish, matte; a poster of our catalog: its one finish, matte (matte paper). A magnet, bumper sticker or single-sheet sticker of our catalog: null, as it names none.
materialstring | null
Our catalog's rows only: the material the SKU is made in, as our catalog names it — an economy die-cut or kiss-cut sticker's white, clear, glitter or holographic adhesive vinyl; a bumper sticker's white surface or a single-sheet sticker's white, clear (Transparent) or holographic surface (no finish inferred); a wall decal's film (Removable Wall Film, the bare wall-decal- stem) or fabric (Polyester Fabric, the Textured Wall Decal), both indoor rated; a poster's paper (matte paper, the bare poster- stem and its only material); UV DTF transparent-film, roll labels bopp, and catalog-only flags and hats polyester. Sheet packs preserve white, clear or holographic surfaces. Null on every other row, a magnet of our catalog's included: our catalog names no material for one.
One of white clear glitter holographic film fabric paper transparent-film bopp polyester
optionsobject | null
Economy die-cut and kiss-cut stickers and listed magnets: the shapes and finishes an order line may name. Magnet cuts share their size's price and have no finish choice. Null for bumper stickers, single sticker sheets, UV DTF packs, label rolls, sheet packs, wall decals, posters, catalog-only flags and hats, and other rows with no choices. Pack count and surface are distinct SKUs.
options.shapesstring[]required
The shapes a SKU may name after its size, the bare SKU's first. Empty for a kiss cut, whose shape is the cut.
options.finishesstring[]required
The finishes a SKU may name after its size, the bare SKU's first.
options.default_shapestringrequired
What the bare SKU is cut to: contour (the artwork's outline), or kiss for a kiss cut. A magnet's bare SKU is custom contour.
One of contour circle square rectangle oval kiss
options.default_finishstring | nullrequired
What the bare SKU is finished in; null when no finish is offered, including magnets.
One of gloss matte
options.variant_skusstring[]required
Every SKU an order line may name for this product, canonically spelled, the bare SKU first (sticker-die-cut-3x3, sticker-die-cut-3x3-matte, sticker-die-cut-3x3-circle, …): the spellings our plant is asked to carry, and so the ones to send. A shape or finish never changes the price, and an order's lines of one product count as one quantity. A test key orders any of them now. A live key orders each once our plant's catalog carries that SKU itself: the row's orderable speaks for the row's own SKU only, and a live quote or order of a variant the plant does not carry yet is refused 422 sku_not_orderable_yet before anything is charged. Any other spelling (-gloss, -glossy, the words in another order) is asked of our plant under that spelling and is not one it was asked to carry.
familystring
Our plant's rows only: the product family. Modeled rows read pricing and cost under their family. The approved flag and Santa hat policy has bounded fulfillment while actual manufacturing cost remains unknown.
One of stickers decals magnets posters flags headwear
catalog_readinessstring
Present on provider-product additions. Modeled sticker goods have estimated cost/weight. owner_exception identifies only the four approved flag sizes and one Santa hat: separate quantity-1 US standard orders with prepared combined ALL artwork and explicit benchmark/unknown-cost disclosures. Both test and live requests require reviewed exact production mappings and confirmed product evidence. catalog_only references cannot be quoted or ordered automatically.
One of modeled owner_exception catalog_only
selling_unitstring
One order quantity buys this complete selling unit. A roll or pack is never priced or ordered as one individual label or sheet.
One of piece roll pack
physical_piecesinteger
Physical pieces inside one selling unit: labels per roll, sheets per sheet pack, pieces per UV DTF pack, or one single product. Two ordered packs contain twice this number; order quantity remains two packs.
at least 1
minimum_quantityinteger
Our plant's rows only: the fewest units of this SKU one order line takes, which is 1. A run of one is an order, priced at the first quantity_breaks entry; POST /v1/order refuses a quantity below it with 400 validation_error.
Always 1
quantity_breaksobject[]
Our plant's rows only: what an order of this SKU charges, from one unit up — computed by the function POST /v1/orders/quote and POST /v1/order charge with (no platform fee is added on any plan). The first entry (min_qty 1) is the row's own price. price_interpolation says how to read between entries. With none, one entry per quantity where the unit price changes, each unit holding until the next entry; a single entry when the SKU climbs no ladder (a SKU our price book does not price, and a wall decal or a poster of our catalog: its listed price, one price each, at any quantity). With linear_total (our sticker catalog's rows), one entry at each of the catalog's pack quantities (1, 5, 10, 25, 50, 100, 250, 500, 1,000 and 2,500): an order of exactly min_qty is charged total_cents, and any other quantity follows the rule price_interpolation states, to the cent. With formula (our magnet catalog's rows), one entry at each of 1, 5, 10, 25, 50, 100, 250, 500, 1,000, 2,500, 5,000 and 10,000 units: an order of exactly min_qty is charged total_cents, and any other quantity is the price list's own total for it, which POST /v1/orders/quote gives. Counted on an order's whole quantity of the SKU, across its lines (on our sticker catalog's rows, across every shape and finish of one product). A negotiated price for your account takes no break and replaces these. Empty when the row carries no usable price (not_orderable_code: no_price) or is a catalog-only reference (not_orderable_code: catalog_only), whose displayed reference price cannot be charged.
quantity_breaks[].min_qtyintegerrequired
From this many units of the SKU on one order (counted across its lines).
at least 1
quantity_breaks[].unit_centsintegerrequired
What an order of min_qty charges per unit, in cents. On a row whose price_interpolation is none it holds until the next entry's min_qty; on a linear_total or formula row it is total_cents over min_qty, rounded, and the units between entries follow the row's rule instead.
quantity_breaks[].total_centsinteger
What an order of exactly min_qty units of the SKU is charged for the goods, in cents: the quote's line_total_cents for that many. On every entry.
quantity_breaks[].list_total_centsinteger
Our sticker catalog's rows only (price_interpolation: linear_total): the catalog's own pack total for min_qty, before min_unit_cents raises it; equal to total_cents wherever it is not raised. The rule between entries reads these. Absent on every other row, a magnet's (formula) included.
price_interpolationstring
Our plant's rows only: how an order's goods total moves between two quantity_breaks entries. none: each entry's unit_cents holds from its min_qty until the next entry's, so the total is that unit times the quantity (a wall decal or a poster of our catalog: its one entry, at any quantity). linear_total (our sticker catalog's rows, priced as a pack total): between two entries the total is the straight line between their list_total_cents, rounded half up to the cent — for a quantity q between entries a and b, round_half_up(list_a + (list_b − list_a) × (q − a) ÷ (b − a)); from the last entry on, its unit rate holds: round_half_up(q × list_last ÷ min_qty_last); and never less than min_unit_cents × q where the row states one. That is the quote's goods total at every quantity, exactly; unit_cents is the total over the quantity, rounded, and is not a bound on the units between entries. formula (our magnet catalog's rows): the total at every quantity is the magnet price list's own, computed from the size and the quantity, which no entry restates between two of them: quote the quantity. It never falls as the quantity grows. Rounding can make a unit rise slightly between neighboring quantities, but the 85% bulk share continues at 250 and beyond; the discount no longer expires there. Its entries carry no list_total_cents.
One of none linear_total formula
min_unit_centsinteger | null
Our plant's rows only: the least a unit of this SKU is charged, where that raises the goods total of some quantity a line can carry (a large sticker at volume is charged this, not less); its quantity_breaks entries from there on already show it as their unit_cents. Null where it raises no quantity, and on every row whose price_interpolation is none.
orderableboolean
Our plant's rows only: true when nothing POST /v1/orders/quote checks before pricing would refuse this SKU right now. False says why in not_orderable_reason (a sentence) and not_orderable_code (a code). A hint for a cart, read when the catalog was: the quote and the order decide.
not_orderable_reasonstring | null
Why not, in the order path's own words — the same field, meaning the same thing, as on every other row of this endpoint that says orderable. Null when orderable. On our plant's rows not_orderable_code is the same answer as a code.
not_orderable_codestring | null
Our plant's rows only: null when orderable; otherwise why not, as a code, in the order the quote meets them. catalog_only — a flag or hat whose artwork, production cost and shipping weight remain unconfirmed: automatic test and live quotes/orders are refused, even if the plant feed carries the SKU. facility_not_configured — the plant has no credentials in this environment (a live quote or order answers 503 provider_unavailable; a test key's degrades to $0 marked pricing_degraded, except a row of our catalog, a sticker's, a wall decal's, a poster's or a magnet's, which a test key orders at its listed price). plant_unreachable — the plant's catalog did not answer this read (the row is a snapshot or the price book's); a quote, estimate or order asks the plant about the SKU, and answers 503 provider_unavailable with Retry-After (details.reason: plant_unreachable) until it does. plant_unmapped — a row of our catalog (a sticker's, a wall decal's, a poster's or a magnet's) that our plant's catalog, as this read found it, does not carry yet: a live quote or order of it is refused 422 sku_not_orderable_yet before anything is asked or charged, and a test key orders it now, at the listed price. plant_price_held — the plant's prices are held after one of its launch goods read far above its book price, and this SKU has no book price to show it is not wrong the same way; the quote refuses it until the hold lifts. no_price — the row carries no usable list price and our price book does not price the SKU, so the quote refuses it.
One of catalog_only facility_not_configured plant_unreachable plant_unmapped plant_price_held no_price

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.

Example response

{
  "status": "success",
  "data": {
    "sku": "sticker-die-cut-3x3",
    "name": "Die-Cut Sticker, 3×3 in",
    "price": "0.70",
    "regular_price": "0.70",
    "category": "stickers",
    "purchasable": true,
    "stock_status": "instock",
    "size_in": [
      3,
      3
    ],
    "finish": "glossy",
    "family": "stickers",
    "minimum_quantity": 1,
    "quantity_breaks": [
      {
        "min_qty": 1,
        "unit_cents": 70,
        "total_cents": 70,
        "list_total_cents": 70
      },
      {
        "min_qty": 5,
        "unit_cents": 70,
        "total_cents": 350,
        "list_total_cents": 350
      },
      {
        "min_qty": 10,
        "unit_cents": 70,
        "total_cents": 700,
        "list_total_cents": 700
      },
      {
        "min_qty": 25,
        "unit_cents": 70,
        "total_cents": 1750,
        "list_total_cents": 1750
      },
      {
        "min_qty": 50,
        "unit_cents": 70,
        "total_cents": 3500,
        "list_total_cents": 3500
      },
      {
        "min_qty": 100,
        "unit_cents": 70,
        "total_cents": 7000,
        "list_total_cents": 7000
      },
      {
        "min_qty": 250,
        "unit_cents": 48,
        "total_cents": 12083,
        "list_total_cents": 12083
      },
      {
        "min_qty": 500,
        "unit_cents": 37,
        "total_cents": 18667,
        "list_total_cents": 18667
      },
      {
        "min_qty": 1000,
        "unit_cents": 30,
        "total_cents": 30083,
        "list_total_cents": 30083
      },
      {
        "min_qty": 2500,
        "unit_cents": 24,
        "total_cents": 59167,
        "list_total_cents": 59167
      }
    ],
    "price_interpolation": "linear_total",
    "min_unit_cents": null,
    "material": "white",
    "options": {
      "shapes": [
        "contour",
        "circle",
        "square"
      ],
      "finishes": [
        "gloss",
        "matte"
      ],
      "default_shape": "contour",
      "default_finish": "gloss",
      "variant_skus": [
        "sticker-die-cut-3x3",
        "sticker-die-cut-3x3-matte",
        "sticker-die-cut-3x3-circle",
        "sticker-die-cut-3x3-circle-matte",
        "sticker-die-cut-3x3-square",
        "sticker-die-cut-3x3-square-matte"
      ]
    },
    "orderable": true,
    "not_orderable_code": null,
    "not_orderable_reason": null
  },
  "request_id": "4e3753e1-48dd-4313-bfd8-48e4af4e116a"
}

Errors

400validation_error
Invalid request body or parameters. When the request failed the operation's schema, details carries formErrors (problems with the request as a whole), fieldErrors (messages keyed by top-level field) and errors: one { pointer, code, message } per refused value, pointer an RFC 6901 JSON pointer into the body (or into the object of query parameters, for a query parameter) — /items/0/sku, with ~ written ~0 and / written ~1, and "" for the request as a whole. POST /v1/orders/bulk answers errors as one { index, details } per refused order, each details with its own pointers from the request body (/orders/3/items/0/sku); POST /v1/orders/multi-ship keeps errors as the { formErrors, fieldErrors } it always published; POST /v1/mockups/generate and POST /v1/products/recommend keep their fields at the top of details, with errors beside them. A refusal of a rule the schema cannot state (an asset that does not exist, an expiry too soon) names it in message and carries no errors.
401invalid_api_key missing_api_key key_expired
Missing, invalid or expired API key: missing_api_key (none sent), invalid_api_key (unknown or revoked), key_expired (past the expiry set when it was created; create a new key).
404
Resource not found
429rate_limit_exceeded daily_quota_exceeded
Rate limit exceeded. Two windows can produce this status and error.code says which: rate_limit_exceeded for the per-minute sliding window, daily_quota_exceeded for the plan's daily quota. Both carry Retry-After; the daily one also carries X-Daily-Limit and X-Daily-Remaining. The per-minute limits are plan-based — see Rate Limits above, or call GET /v1/me for this credential's own figures.
502
The facility catalog gave no answer and no snapshot holds the SKU (nor, on our own plant's catalog, our price book) — or, with not_configured, the facility has no credentials in this environment, which is an operator fact rather than an outage. X-Catalog-Degraded carries the reason on every 502, so a failure is diagnosable rather than indistinguishable from an empty catalog. This is not a verdict on the SKU: retry, or read GET /v1/products.

Every Products operation

Response 200

data

fulfillment_cost_basisstring
Approved per-size US standard shipping benchmark; actual postage, manufacturing cost and profit remain unknown.
Always approved_size_shipping_benchmark
goods_cost_centsany
Actual manufacturing cost is unknown, never represented by zero.
manufacturing_cost_centsany
actual_contribution_centsany
maximum_quantityinteger
One product, one SKU, quantity 1 in its own order.
Always 1
shipping_constraintsobject
shipping_constraints.destination_countrystringrequired
Always US
shipping_constraints.methodstringrequired
Always standard
shipping_constraints.separate_orderbooleanrequired
Always true
shipping_benchmark_centsinteger
The approved quantity-1 US standard benchmark, packing included.
at least 0
packagingstring
Always included_in_shipping_benchmark
artwork_layoutstring
Always prepared_combined_all
artwork_instructionsstring
Prepare one combined ALL PNG: flag front and back, or Santa hat front and band, according to the exact guide; remove guide lines.
artwork_guide_urlstring
Local path to the layout guide SVG. This reference is not customer artwork and must not be sent as print_file.
skustring | number
The identifier every other operation takes: an order item's sku, the {sku} path parameter, a recommendation's sku. Numeric on some facility catalogs — compare it as a string.
namestring
descriptionstring
categorystring
The facility's own category, where it publishes one — an open vocabulary, not this API's. GET /v1/products always fills this field (see ProductListItem); by SKU it is present only if the facility sent it.
sourcestring
Present only on a row this API built itself; absent on every row a facility sent. price_book: built from our own price book because our plant's catalog had nothing of its own to serve (the answer is then X-Catalog-Stale: true, with X-Catalog-Degraded naming why). Its price is the book's, which is what an order of the SKU is charged; the row carries sku, name, base_price and category. listed: a row of our catalog (a sticker, a wall decal, a poster or a magnet) that our plant's catalog, as this read found it, does not hold, listed after the rows read, with the same fields and its price from the catalog; not_orderable_code says whether our plant carries it.
One of price_book listed
size_innumber[] | null
Our plant's rows only: [width, height] in inches, read from the size the SKU names (the size the price book and an order price). Null when the SKU names no size, as an unsized sticker roll does.
2 to 2 entries
finishstring | null
Our plant's rows only: the finish the plant's row names, else the one the SKU names (glossy, matte, holographic, clear, satin); null when neither names one. No finish changes the price. A SKU of our sticker catalog is read by its own grammar: the finish it names after the size, else the bare stem's (glossy); there clear and holographic name a material, not a finish. A wall decal of our catalog: its sheet's one finish, matte; a poster of our catalog: its one finish, matte (matte paper). A magnet, bumper sticker or single-sheet sticker of our catalog: null, as it names none.
materialstring | null
Our catalog's rows only: the material the SKU is made in, as our catalog names it — an economy die-cut or kiss-cut sticker's white, clear, glitter or holographic adhesive vinyl; a bumper sticker's white surface or a single-sheet sticker's white, clear (Transparent) or holographic surface (no finish inferred); a wall decal's film (Removable Wall Film, the bare wall-decal- stem) or fabric (Polyester Fabric, the Textured Wall Decal), both indoor rated; a poster's paper (matte paper, the bare poster- stem and its only material); UV DTF transparent-film, roll labels bopp, and catalog-only flags and hats polyester. Sheet packs preserve white, clear or holographic surfaces. Null on every other row, a magnet of our catalog's included: our catalog names no material for one.
One of white clear glitter holographic film fabric paper transparent-film bopp polyester
optionsobject | null
Economy die-cut and kiss-cut stickers and listed magnets: the shapes and finishes an order line may name. Magnet cuts share their size's price and have no finish choice. Null for bumper stickers, single sticker sheets, UV DTF packs, label rolls, sheet packs, wall decals, posters, catalog-only flags and hats, and other rows with no choices. Pack count and surface are distinct SKUs.
options.shapesstring[]required
The shapes a SKU may name after its size, the bare SKU's first. Empty for a kiss cut, whose shape is the cut.
options.finishesstring[]required
The finishes a SKU may name after its size, the bare SKU's first.
options.default_shapestringrequired
What the bare SKU is cut to: contour (the artwork's outline), or kiss for a kiss cut. A magnet's bare SKU is custom contour.
One of contour circle square rectangle oval kiss
options.default_finishstring | nullrequired
What the bare SKU is finished in; null when no finish is offered, including magnets.
One of gloss matte
options.variant_skusstring[]required
Every SKU an order line may name for this product, canonically spelled, the bare SKU first (sticker-die-cut-3x3, sticker-die-cut-3x3-matte, sticker-die-cut-3x3-circle, …): the spellings our plant is asked to carry, and so the ones to send. A shape or finish never changes the price, and an order's lines of one product count as one quantity. A test key orders any of them now. A live key orders each once our plant's catalog carries that SKU itself: the row's orderable speaks for the row's own SKU only, and a live quote or order of a variant the plant does not carry yet is refused 422 sku_not_orderable_yet before anything is charged. Any other spelling (-gloss, -glossy, the words in another order) is asked of our plant under that spelling and is not one it was asked to carry.
familystring
Our plant's rows only: the product family. Modeled rows read pricing and cost under their family. The approved flag and Santa hat policy has bounded fulfillment while actual manufacturing cost remains unknown.
One of stickers decals magnets posters flags headwear
catalog_readinessstring
Present on provider-product additions. Modeled sticker goods have estimated cost/weight. owner_exception identifies only the four approved flag sizes and one Santa hat: separate quantity-1 US standard orders with prepared combined ALL artwork and explicit benchmark/unknown-cost disclosures. Both test and live requests require reviewed exact production mappings and confirmed product evidence. catalog_only references cannot be quoted or ordered automatically.
One of modeled owner_exception catalog_only
selling_unitstring
One order quantity buys this complete selling unit. A roll or pack is never priced or ordered as one individual label or sheet.
One of piece roll pack
physical_piecesinteger
Physical pieces inside one selling unit: labels per roll, sheets per sheet pack, pieces per UV DTF pack, or one single product. Two ordered packs contain twice this number; order quantity remains two packs.
at least 1
minimum_quantityinteger
Our plant's rows only: the fewest units of this SKU one order line takes, which is 1. A run of one is an order, priced at the first quantity_breaks entry; POST /v1/order refuses a quantity below it with 400 validation_error.
Always 1
quantity_breaksobject[]
Our plant's rows only: what an order of this SKU charges, from one unit up — computed by the function POST /v1/orders/quote and POST /v1/order charge with (no platform fee is added on any plan). The first entry (min_qty 1) is the row's own price. price_interpolation says how to read between entries. With none, one entry per quantity where the unit price changes, each unit holding until the next entry; a single entry when the SKU climbs no ladder (a SKU our price book does not price, and a wall decal or a poster of our catalog: its listed price, one price each, at any quantity). With linear_total (our sticker catalog's rows), one entry at each of the catalog's pack quantities (1, 5, 10, 25, 50, 100, 250, 500, 1,000 and 2,500): an order of exactly min_qty is charged total_cents, and any other quantity follows the rule price_interpolation states, to the cent. With formula (our magnet catalog's rows), one entry at each of 1, 5, 10, 25, 50, 100, 250, 500, 1,000, 2,500, 5,000 and 10,000 units: an order of exactly min_qty is charged total_cents, and any other quantity is the price list's own total for it, which POST /v1/orders/quote gives. Counted on an order's whole quantity of the SKU, across its lines (on our sticker catalog's rows, across every shape and finish of one product). A negotiated price for your account takes no break and replaces these. Empty when the row carries no usable price (not_orderable_code: no_price) or is a catalog-only reference (not_orderable_code: catalog_only), whose displayed reference price cannot be charged.
quantity_breaks[].min_qtyintegerrequired
From this many units of the SKU on one order (counted across its lines).
at least 1
quantity_breaks[].unit_centsintegerrequired
What an order of min_qty charges per unit, in cents. On a row whose price_interpolation is none it holds until the next entry's min_qty; on a linear_total or formula row it is total_cents over min_qty, rounded, and the units between entries follow the row's rule instead.
quantity_breaks[].total_centsinteger
What an order of exactly min_qty units of the SKU is charged for the goods, in cents: the quote's line_total_cents for that many. On every entry.
quantity_breaks[].list_total_centsinteger
Our sticker catalog's rows only (price_interpolation: linear_total): the catalog's own pack total for min_qty, before min_unit_cents raises it; equal to total_cents wherever it is not raised. The rule between entries reads these. Absent on every other row, a magnet's (formula) included.
price_interpolationstring
Our plant's rows only: how an order's goods total moves between two quantity_breaks entries. none: each entry's unit_cents holds from its min_qty until the next entry's, so the total is that unit times the quantity (a wall decal or a poster of our catalog: its one entry, at any quantity). linear_total (our sticker catalog's rows, priced as a pack total): between two entries the total is the straight line between their list_total_cents, rounded half up to the cent — for a quantity q between entries a and b, round_half_up(list_a + (list_b − list_a) × (q − a) ÷ (b − a)); from the last entry on, its unit rate holds: round_half_up(q × list_last ÷ min_qty_last); and never less than min_unit_cents × q where the row states one. That is the quote's goods total at every quantity, exactly; unit_cents is the total over the quantity, rounded, and is not a bound on the units between entries. formula (our magnet catalog's rows): the total at every quantity is the magnet price list's own, computed from the size and the quantity, which no entry restates between two of them: quote the quantity. It never falls as the quantity grows. Rounding can make a unit rise slightly between neighboring quantities, but the 85% bulk share continues at 250 and beyond; the discount no longer expires there. Its entries carry no list_total_cents.
One of none linear_total formula
min_unit_centsinteger | null
Our plant's rows only: the least a unit of this SKU is charged, where that raises the goods total of some quantity a line can carry (a large sticker at volume is charged this, not less); its quantity_breaks entries from there on already show it as their unit_cents. Null where it raises no quantity, and on every row whose price_interpolation is none.
orderableboolean
Our plant's rows only: true when nothing POST /v1/orders/quote checks before pricing would refuse this SKU right now. False says why in not_orderable_reason (a sentence) and not_orderable_code (a code). A hint for a cart, read when the catalog was: the quote and the order decide.
not_orderable_reasonstring | null
Why not, in the order path's own words — the same field, meaning the same thing, as on every other row of this endpoint that says orderable. Null when orderable. On our plant's rows not_orderable_code is the same answer as a code.
not_orderable_codestring | null
Our plant's rows only: null when orderable; otherwise why not, as a code, in the order the quote meets them. catalog_only — a flag or hat whose artwork, production cost and shipping weight remain unconfirmed: automatic test and live quotes/orders are refused, even if the plant feed carries the SKU. facility_not_configured — the plant has no credentials in this environment (a live quote or order answers 503 provider_unavailable; a test key's degrades to $0 marked pricing_degraded, except a row of our catalog, a sticker's, a wall decal's, a poster's or a magnet's, which a test key orders at its listed price). plant_unreachable — the plant's catalog did not answer this read (the row is a snapshot or the price book's); a quote, estimate or order asks the plant about the SKU, and answers 503 provider_unavailable with Retry-After (details.reason: plant_unreachable) until it does. plant_unmapped — a row of our catalog (a sticker's, a wall decal's, a poster's or a magnet's) that our plant's catalog, as this read found it, does not carry yet: a live quote or order of it is refused 422 sku_not_orderable_yet before anything is asked or charged, and a test key orders it now, at the listed price. plant_price_held — the plant's prices are held after one of its launch goods read far above its book price, and this SKU has no book price to show it is not wrong the same way; the quote refuses it until the hold lifts. no_price — the row carries no usable list price and our price book does not price the SKU, so the quote refuses it.
One of catalog_only facility_not_configured plant_unreachable plant_unmapped plant_price_held no_price

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.

Example response

{
  "status": "success",
  "data": {
    "sku": "sticker-die-cut-3x3",
    "name": "Die-Cut Sticker, 3×3 in",
    "price": "0.70",
    "regular_price": "0.70",
    "category": "stickers",
    "purchasable": true,
    "stock_status": "instock",
    "size_in": [
      3,
      3
    ],
    "finish": "glossy",
    "family": "stickers",
    "minimum_quantity": 1,
    "quantity_breaks": [
      {
        "min_qty": 1,
        "unit_cents": 70,
        "total_cents": 70,
        "list_total_cents": 70
      },
      {
        "min_qty": 5,
        "unit_cents": 70,
        "total_cents": 350,
        "list_total_cents": 350
      },
      {
        "min_qty": 10,
        "unit_cents": 70,
        "total_cents": 700,
        "list_total_cents": 700
      },
      {
        "min_qty": 25,
        "unit_cents": 70,
        "total_cents": 1750,
        "list_total_cents": 1750
      },
      {
        "min_qty": 50,
        "unit_cents": 70,
        "total_cents": 3500,
        "list_total_cents": 3500
      },
      {
        "min_qty": 100,
        "unit_cents": 70,
        "total_cents": 7000,
        "list_total_cents": 7000
      },
      {
        "min_qty": 250,
        "unit_cents": 48,
        "total_cents": 12083,
        "list_total_cents": 12083
      },
      {
        "min_qty": 500,
        "unit_cents": 37,
        "total_cents": 18667,
        "list_total_cents": 18667
      },
      {
        "min_qty": 1000,
        "unit_cents": 30,
        "total_cents": 30083,
        "list_total_cents": 30083
      },
      {
        "min_qty": 2500,
        "unit_cents": 24,
        "total_cents": 59167,
        "list_total_cents": 59167
      }
    ],
    "price_interpolation": "linear_total",
    "min_unit_cents": null,
    "material": "white",
    "options": {
      "shapes": [
        "contour",
        "circle",
        "square"
      ],
      "finishes": [
        "gloss",
        "matte"
      ],
      "default_shape": "contour",
      "default_finish": "gloss",
      "variant_skus": [
        "sticker-die-cut-3x3",
        "sticker-die-cut-3x3-matte",
        "sticker-die-cut-3x3-circle",
        "sticker-die-cut-3x3-circle-matte",
        "sticker-die-cut-3x3-square",
        "sticker-die-cut-3x3-square-matte"
      ]
    },
    "orderable": true,
    "not_orderable_code": null,
    "not_orderable_reason": null
  },
  "request_id": "4e3753e1-48dd-4313-bfd8-48e4af4e116a"
}

Errors

400validation_error

Invalid request body or parameters. When the request failed the operation's schema, details carries formErrors (problems with the request as a whole), fieldErrors (messages keyed by top-level field) and errors: one { pointer, code, message } per refused value, pointer an RFC 6901 JSON pointer into the body (or into the object of query parameters, for a query parameter) — /items/0/sku, with ~ written ~0 and / written ~1, and "" for the request as a whole. POST /v1/orders/bulk answers errors as one { index, details } per refused order, each details with its own pointers from the request body (/orders/3/items/0/sku); POST /v1/orders/multi-ship keeps errors as the { formErrors, fieldErrors } it always published; POST /v1/mockups/generate and POST /v1/products/recommend keep their fields at the top of details, with errors beside them. A refusal of a rule the schema cannot state (an asset that does not exist, an expiry too soon) names it in message and carries no errors.

401invalid_api_key missing_api_key key_expired

Missing, invalid or expired API key: missing_api_key (none sent), invalid_api_key (unknown or revoked), key_expired (past the expiry set when it was created; create a new key).

404

Resource not found

429rate_limit_exceeded daily_quota_exceeded

Rate limit exceeded. Two windows can produce this status and error.code says which: rate_limit_exceeded for the per-minute sliding window, daily_quota_exceeded for the plan's daily quota. Both carry Retry-After; the daily one also carries X-Daily-Limit and X-Daily-Remaining. The per-minute limits are plan-based — see Rate Limits above, or call GET /v1/me for this credential's own figures.

502

The facility catalog gave no answer and no snapshot holds the SKU (nor, on our own plant's catalog, our price book) — or, with not_configured, the facility has no credentials in this environment, which is an operator fact rather than an outage. X-Catalog-Degraded carries the reason on every 502, so a failure is diagnosable rather than indistinguishable from an empty catalog. This is not a verdict on the SKU: retry, or read GET /v1/products.

Get product by SKU

Parameters

Request

Response 200

Errors

Get product by SKU

Parameters

Request

Response 200

Errors

Response `200`

Response `200`