gooten_list_products
List catalog products
Browse the Gooten print-on-demand product catalog (public data): product id, name, categories, cheapest price and shipping, stock and deprecation flags. Filter by name text or category; use product_id with gooten_list_product_variants. Prices are in USD for the cheapest variant.
Parameterspagequerycategorypage_sizeinclude_deprecated
gooten_list_product_variants
List product variants (SKUs)
The orderable variants (SKUs) of a catalog product for a destination country, with option values (size, color, ...) and Gooten's price for your account. SKUs differ by region (inch vs cm sizes). GET /productvariants.
Parameterspagepage_sizeproduct_idrequiredcountry_coderequiredcurrency_code
gooten_get_product_templates
Get product templates
Print templates for a SKU: how many images are needed, required pixel sizes/DPI, print spaces and layer coordinates, and preview assets. GET /producttemplates.
Parametersskurequired
gooten_check_stock
Check stock for SKUs
Which of the given SKUs are out of stock for a destination (country, state, postal code). Returns only the out-of-stock SKUs; an empty list means all are available. Unknown SKUs are an error. POST /variantstatus (a read: nothing is changed).
Parametersskusrequiredstatepostal_coderequiredcountry_coderequired
gooten_get_shipping_estimate
Get shipping estimate for a product
Shipping price range and delivery time for a product to a country: whether expedited is possible and estimated shipping days, plus min/max price and producing country when Gooten returns them. GET /shippriceestimate.
Parametersproduct_idrequiredcountry_coderequiredcurrency_code
gooten_get_shipping_options
Get shipping options for a cart
Available shipping methods (Standard, Expedited, Overnight) with price and delivery days for a cart of SKUs to a destination. POST /shippingprices (a quote: nothing is ordered).
Parametersitemsrequiredstatepostal_coderequiredcountry_coderequiredcurrency_code
gooten_get_price_estimate
Get price estimate for an order
Estimate the cost of an order before placing it: per-item partner price, customer price and tax, plus shipping total, for SKUs shipped to an address. POST /price (a quote: nothing is ordered or charged).
Parameterscityrequireditemsrequiredstatepostal_coderequiredcountry_coderequiredaddress_line1requiredaddress_line2currency_code
gooten_validate_address
Validate a shipping address
Check a shipping address: validity, a score and Gooten's suggested corrected address. GET /addressvalidation.
Parameterscityrequiredline1requiredline2statepostal_coderequiredcountry_coderequired
gooten_list_currencies
List supported currencies
Currencies Gooten can quote prices in (name, code, display format). GET /currencies.
Takes no parameters.
gooten_list_shipping_countries
List shipping countries
Countries Gooten ships to (code, name, whether supported, measurement system, default currency). By default only supported countries. GET /countries.
Parametersinclude_unsupported
gooten_list_print_ready_products
List print-ready products
Your print-ready products (PRPs: SKUs with artwork already attached) with their variant counts. Paging starts at 1. GET /prpproducts.
Parameterspage
gooten_list_print_ready_variants
List print-ready variants
Orderable SKUs of your print-ready products, optionally for one PRP product name (from gooten_list_print_ready_products). GET /prpvariants.
Parameterspageproduct_name
gooten_search_orders
Search orders
Search your Gooten orders by free text (name, address, phone...), last name, email, postal code, creation date range or your own user id. Returns order id, items with status and tracking, totals and addresses. Needs the Partner Billing Key. GET /ordersearch.
Parameterspagetextemailend_datelast_namepage_sizestart_datepostal_codeunique_user_id
gooten_get_order
Get order
One order by its Safe Order ID: items with status, tracking numbers and carriers, images, options, totals, shipping and billing addresses, discount and metadata. GET /orders.
Parametersorder_idrequired
gooten_get_order_billing
Get order billing
Billing breakdown of an order: product cost per item, shipping, surcharge, tax, fees, discount and total. Takes the numeric Gooten order id (GootenId from gooten_get_order), not the Safe Order ID. Needs the Partner Billing Key. GET /orderbilling.
Parametersorder_idrequiredcurrency_code
gooten_set_order_status
Set order status
WRITE: change an order's status. Allowed targets: Cancelled (cancels the whole order), Hold (pause before production) and New (re-submit an order that was fixed, e.g. after an image or address issue; it then goes on to production and billing). Only orders in AccountingIssue, AddressIssue, HoldByCIImageIssue, ImageIssue, NeedsManualApproval, New, ReadyForAccounting, ReadyForImageDl or Pending can change; a held order cannot be released through the API (Gooten support must release it); otherwise Gooten refuses. POST /orderstatus.
Parametersstatusrequiredorder_idrequired
gooten_cancel_order_items
Cancel order items
WRITE: cancel specific items of an order (cannot be undone). Only items of orders in a pre-production status can be cancelled. Pass the numeric Gooten order id and the order item ids (OrderItemId from gooten_get_order). PUT /orderCancel.
Parametersorder_idrequiredorder_item_idsrequired