PrintNowPrintNowDocs

AI Agent Tool Reference

Every tool an AI agent can use in the PrintNow admin, by toolset: 349 tools, 158 that read and 191 that change.

This page lists every tool a PrintNow AI agent can use: 349 tools, 158 that read and 191 that make changes. The list was taken from the AI agent server on 2026-11-20.

A connection only gets the toolsets it was made with, and only those your license has. A Read only connection gets only the read tools. See Working with AI Agents for how confirmations, limits and files work.

Type column:

  • Read: looks things up. It never changes anything.
  • Change: makes a change. Some changes ask first only for some inputs; the description says when.
  • Asks first: always shows a preview and waits for the person's yes.
  • Not in Claude (claude.ai) or ChatGPT: refused in those apps. Make the change in the admin or from Claude Code.

Always On

These 12 tools are on in every session, whatever toolsets the connection has. A Read only connection does not get tool_write or cache_clear.

ToolTypeWhat it does
cache_clearChangeClear the storefront cache of one store, so changes show at once. Needed after theme_apply. Store identity, theme apply, redirects and translations otherwise stay cached for up to 15 minutes. Tell the person which change you are making live before you say it is live now.
export_getReadOne of the admin's Excel exports: site_users (Site users (customers) with their addresses); admin_users (Admin users with their addresses (the Password column is always blank)); promotion_codes (Promotion codes); tax_rates (Tax rates); inventory (Inventory (stock per product, size and color)). mode "file" (default): saves the sheet for the person and says where, or gives a download link to pass on (the file is not passed to you). A file with personal data asks the person first. mode "rows": the sheet's rows for you to work with, 100 at a time (offset; next gives the next offset, null at the end). rows is a JSON array of rows inside a <customer_text> tag: parse it; each row is an array of values in the order of columns. In site_users and admin_users rows, names, emails, phones and addresses are masked unless include_pii is true and the person agrees; then they go to the AI provider. Masked values are for reading only: never send them back in a save. Read only.
feature_checkReadIs a license feature on (for example FourOver, Sinalite, PrintMIS, 3D_Model_Viewer, CADAssemblies). Some gates exist in the admin pages only, so check before using a gated area.
store_get_linkReadStorefront URL for a store.
stores_listReadStores this user can see on this license: id, name, retail (B2C) or B2B, URL, culture, currency, timezone. Every other tool checks its storeId against this list.
tool_readReadRun one read tool by its name, with its inputs: { tool, arguments }. Use it when the tool you need is not in your tool list (some apps load tools only when a chat starts). tools_find gives the name and inputs. Its toolset turns on by itself.
tool_writeChangeRun one tool that makes a change, by its name, with its inputs: { tool, arguments }. Use it when the tool you need is not in your tool list (some apps load tools only when a chat starts). tools_find gives the name and inputs. The tool previews and asks first as on a direct call; send its confirm inside arguments.
tools_findReadFind the tool for a job by a few words (for example 'how many orders', 'import pricing package', 'shipping rate rules'), in every toolset this connection may use, including toolsets that are off. Says which toolset each tool is in and whether it is on. Use it before telling the person something cannot be done.
toolsets_enableReadTurn toolsets on or off for this session, for example { "on": ["print-store-orders"] }. The tool list then changes. This does not change any admin data.
toolsets_listReadThe toolsets you can turn on, one per admin menu area, with what each is for, how many tools it has now, and whether it is on. Turn one on with toolsets_enable when the job needs it. To find the tool for a job, use tools_find.
upload_startReadGet a link for one file to send in (one hour, up to 50 MB). If you can send files, PUT the bytes to url; otherwise give the url to the person to open and choose the file. Then pass uploadId as the file input of the tool that needs it.
whoamiReadThe admin user this connection is logged in as, the license site, the master flag, the stores the user can work in, and the store ids where writes are allowed. What the user may do in each store is checked by the admin per call.

General

All Sites

Toolset name: all-sites · 1 read, 2 change

ToolTypeWhat it does
store_limits_getReadWhether this license can take another store: canCreateRetailStore (retail, B2C: the store limit) and canCreateNonRetailStore (B2B: the sub-domain limit). Check before store_create. License-wide (all stores).
store_clone_runChangeMake a NEW store from chosen parts of a store. Parts: categories, tags, extendedContent, basePricing, offlineTemplates, products, cmsPages, blog, htmlSnippets, emailNotifications, orderStatuses, promotionCodes, taxRates, shippingMethods, checkoutFields, countryList, translations, autofillProfiles, printCad, settings, emailAccount, merchantAccounts. Never changes an existing store's settings, but it is one long call with no undo: a big store can time out while the server keeps going, and a second call makes a second store, so NEVER call it again after an error: read the answer and stores_list. The new name must be free; the license must have room (retail and B2B stores count apart). With settings, the new store gets the source's type. emailAccount, merchantAccounts and shippingMethods copy secrets: only with copyCredentials. packageTypes is refused (C201). A cloned store can only be removed in the admin (Settings › General › Delete store). Always asks first.
store_createChange · asks firstCreate a new store on this license. Retail (B2C) stores count against the license's store limit; B2B stores count against the sub-domain limit. The API refuses users without the Super tier and refuses when a limit is reached. Check store_limits_get first and tell the person which limit is reached. Give name, isRetail, culture (for example en-us) and timezone. Asks for a confirm first (needs_confirm), then call again with confirm.

Store setup

Toolset name: print-store-setup · 10 read, 13 change

ToolTypeWhat it does
blog_home_types_listReadWhat the blog home page can show: the store's custom pages (text = page title, value = id), and the value chosen now (selectedValue; empty when none). Use the value with blog_home_type_set.
carrier_accounts_getReadUPS, USPS, FedEx and ShipEngine accounts used for live shipping rates. Keys, passwords and secrets are always masked (set or not, plus last 4 characters). A blank account means that carrier gives no rates.
checkout_styles_getReadThe look of the checkout page: accent, button, checkout and error colors, banner, fonts and footer links. Changes to it are live at once.
email_account_getReadThe store's SMTP account used to send all store email: login, server, port, SSL, from/to, support mail. The password is always masked (shown as set or not, plus last 4 characters); the API returns it in plain text, PrintNow never does. If login, server or password is empty the store sends no email.
environment_3d_getReadLighting config for the 3D viewer (library or HDR lighting, exposure and more). Used by the storefront widget, the editor and admin previews. Needs the 3D_Model_Viewer license feature; PrintNow checks it first because the API does not.
merchant_account_getReadPayment gateway setup for the store (gateway, Stripe, PayPal). Keys, secrets, passwords and signatures are always masked (set or not, plus last 4 characters). An empty list means no gateway is set up.
redirect_default_getReadThe store's default redirect settings: redirect type (301, 302 or 307; 307 behaves like 302), lower-case URLs, and preferred domain (www or not). Changes take up to 15 minutes to go live (cache).
shipengine_carriers_listReadCarriers on the store's ShipEngine account. No input: the parcel carriers (name and carrier id); the connected LTL carriers are in carrier_accounts_get (shipEngine.ltlCarriers) and ltl_carrier_save. With carrierId (a connected LTL carrier's id): the service codes ShipEngine offers for it. Uses the ShipEngine key saved on the store; the key is never sent or shown. Calls ShipEngine live. An empty list means the store has no ShipEngine API key or no carriers on it (see carrier_accounts_get).
store_logos_getReadCompany logo, icon and invoice logo of a store (General Settings). Returns the logo URL fields from the general settings. The logo and icon images themselves are separate image links; give the person links, not the files. Upload and delete are phase 2.
watermark_3d_getReadWatermark shown on the 3D viewer: on/off, image, tile size, angle, strength and gaps. With no image the PrintNow logo is used, so shoppers see PrintNow's logo. Needs the 3D_Model_Viewer license feature; PrintNow checks it first.
blog_home_type_setChangeSet what the blog home page shows. Saves at once. Values come from blog_home_types_list. "None" is stored as the text '0'.
carrier_accounts_saveChange · asks first · not in Claude (claude.ai) or ChatGPTUPS, FedEx and ShipEngine account settings. Send only what changes: PrintNow keeps every stored key and password unless you give a new one. A blank key deletes the account (shipping can fall to 'No Shipping $0'), so blanks are refused. Removing an account is not supported here; use the admin. Asks for a confirm first (needs_confirm), then call again with confirm.
category_tag_types_saveChangeSet the FULL list of the store's category tag names (Categories ⋮ Manage Tags). Names not listed are deleted and taken off every category (asks first and lists the categories). There is no rename: a new name is a new tag. Names: 1-50 characters, no commas. Link tags to a category with category_tags_set.
checkout_styles_saveChange · asks firstChange the checkout page look: colors (#hex), fonts, logo size and tagline, banner and background switches, footer links. Live at once. Send only what changes; PrintNow sends every field, because the save replaces all of them. Image upload is not supported yet (images stay as they are).
custom_color_setChangeTurn 'customers may pick any color' on or off for one color palette. Palettes are shared by every store of the license. Asks first and lists the products that use the palette (and, for the first palette, products with no palette, which fall back to it). Live in the editor at once.
email_account_saveChange · asks first · not in Claude (claude.ai) or ChatGPTSave the store's SMTP account and support email. Send only what changes: PrintNow keeps the stored password unless you give a new one. The API deletes the SMTP account when login, password, server or port is blank, and the store then sends no email with no error, so blanks are refused. Asks for a confirm first (needs_confirm), then call again with confirm.
email_account_send_testChange · asks first · not in Claude (claude.ai) or ChatGPTSend a test email through the SAVED SMTP account (save first with email_account_save). Only the recipient, subject and text can be given; the host and login are always the stored ones. Asks for a confirm first (needs_confirm), then call again with confirm.
environment_3d_saveChangeChange the store's 3D environment (lighting and backdrop) for the 3D previews. set: { field: value } with exposure, rotation, tone, backdropMode, blur, color, gradientTop, gradientBottom, gradientFalloff, autoRotate, lightingLibrary (a library id). New images only as local files uploaded in this call: hdrFile (.hdr, max 20 MB) for lighting, panoramaFile (.jpg/.png, max 10 MB) for the panorama backdrop. Choosing library lighting deletes an uploaded HDR; a new or removed panorama deletes the old one (asks first). PrintNow reads the config and sends all of it. Live at once.
ltl_carrier_saveChange · asks first · not in Claude (claude.ai) or ChatGPTConnect one LTL (freight) carrier to the store's ShipEngine account, or change a connected one: credentials, lift gate option (enabled, disabled or both) and service codes. With only code: shows the carrier's fields, the saved settings (secrets masked) and, once connected, the service codes ShipEngine offers. Connect first (every credential field and liftGate), then set serviceCodes in a second call. Give only the credentials that change; the rest keep their stored values. Use only credentials the person gives in this chat. Carriers: aact (AAA Cooper Transportation), abfs (ABF Freight Systems Inc.), agce (ACI Motor Freight, Inc), pyle (A. Duie Pyle Inc.), avrt (Averitt Express Inc.), btvp (Best Overnite Express), cenf (Central Freight Lines), ctii (Central Transport), crhm (CRH Transportation), ccyq (CrossCountry Freight Solutions), dylt (Daylight Transport LLC), dafg (Dayton Freight Lines Inc.), dhrn (Dohrn Transfer Company), dbde (Double D Express, Inc), dubl (Dugan Truck Line), exla (Estes Express Lines), mtvl (GLS Freight), hmes (Holland), lrec (Land Air Express, Inc), fxfr (FedEx Freight), fwdn (Forward Air), nmtf (N&M Transfer Company), npme (New Penn Motor Express), oakh (Oak Harbor Freight Lines Inc.), odfl (Old Dominion Freight Line), pitd (Pitt-Ohio), retl (Reddaway), rdfs (Roadrunner Transportation Services Inc.), saia (Saia LTL Freight), sefl ( Southeastern Freight Lines), smtl ( Southwestern Motor Transport, Inc), upgf (UPS Freight), valc (Valley Cartage Company), ward (Ward Trucking). Needs a ShipEngine API key on the store (carrier_accounts_get). Removing a carrier is done in the admin. Always asks first.
merchant_account_saveChange · asks first · not in Claude (claude.ai) or ChatGPTSet the store's card gateway (provider AN Authorize.Net, UP USA ePay, CS CyberSource, NM Network Merchants, WP WorldPay, EN eProcessing Network, DP DalPay, NX Netaxept), Stripe keys or PayPal keys, or remove Stripe or PayPal. Parts not given keep their stored values (also the secrets). A new gateway provider replaces the old one and needs both id and key; the gateway cannot be removed. Secrets are never shown (last 4 characters only). Always asks first. Checkout uses it at once.
redirect_default_saveChange · asks firstDefault redirect settings: redirect type (301 or 302; 307 acts as 302), lower-case URLs, and the preferred domain (www or not). Live within 15 minutes (cache); use cache_clear to make it live now. Asks for a confirm first (needs_confirm), then call again with confirm.
tax_default_setChange · asks firstSet the store's default (manual) tax rate, in percent, for example 8.25. Rates above 30 are almost always a mistake. When TaxJar is on, manual tax is ignored (check partner_apps_get). Asks for a confirm first (needs_confirm), then call again with confirm.
watermark_3d_saveChangeChange the 3D preview watermark. set: { field: value } with enabled, tileIn, angle, strength, gapX, gapY, staggered, mode. A new image only as a local file uploaded in this call (imageFile: .png/.jpg/.webp, max 5 MB); removeImage goes back to the PrintNow logo. The old image is deleted when it is replaced or removed. PrintNow reads the settings and sends all of them. Asks first. Live at once.

Categories, Collections, Tags

Toolset name: print-store-catalog · 6 read, 10 change

ToolTypeWhat it does
categories_getReadList the store's categories (id, name, URL, product count, published, order, seoId), or with id one category in full: pricing, attribute set, parent, collections. PrintNow filters by name itself (the API search matches the SEO heading and URL, not the name). All rows come at once, no server paging. seoId is the id for the CMS/SEO tools (Edit CMS is a different page and id). Names can repeat: link by id.
category_form_optionsReadChoices for a category save, each as text + value (id): parents, pricings, attribute sets, optional fields, and the category options list. Pricing names can repeat (two "Flyers"): always link pricing by id and warn when a name appears twice.
category_tags_getReadThe store's category tag types, each with selected true/false for this category.
collection_find_itemsReadSearch the store's categories and products that can be added to a collection. Product search is slow on big stores; give search text or a categoryId to narrow it.
collections_getReadList the store's collections (B2B catalog limits), or with id one collection: its detail, its categories, and ALL its linked products (also products with no category, which the page's "All" filter hides). A product shows on the storefront only when it is also in a published category, and a mapped category brings only its direct children.
tags_getReadList the store's product tags with parent, URL and product count, or with id one tag. Tags are made in CMS › Tag Content and linked on the product edit page.
bulk_catalog_updateChangetarget categories: set the same fields on many categories (ids, or all whose name contains search). target products: same for products. target newCategories: make categories from rows (name, parent name or id, pricingId, published); parents are made before children. Fields: categories name, description, parentId, pricingId, attributeId, published, useAlternateMaster; products name, description, itemNumber, modelNumber, categoryId (text), pricingId (text), published. Link pricing by id. Every row uses the single save, so a save sends the whole record. New categories cannot be undone here (no delete tool yet). Steps: preview (nothing written; returns a table and a runId), run (after the person says yes), status, undo. Up to 1000 rows per run.
category_deleteChangeDelete a category (hard delete). The API also unpublishes every product in it, even products that are in other categories, and moves its child categories to the top level. The tool asks first and lists all of that; after the delete it publishes again the products that were published and are still in another category (republish: false to skip), and removes its landing-page menu links. redirectTo adds a redirect from the category URL.
category_moveChangeMove one category above or below another in the store's category order. Moves one row and renumbers all rows 1..n; it ignores parent/child. Check the order with categories_get after.
category_saveChangeCreate a category (no id) or change one (id). Send only the fields to change: PrintNow reads the category, merges your changes and sends every field, because the API replaces the whole record. Rules: parent must be a top-level category, and a category with children cannot get a parent. Saving sets the SEO Heading to the Name; if the Heading was different, the tool asks for a confirm first. Link pricing by id. The answer shows what changed and a read-back check.
category_set_flagsChangeSet a category Published or not. Sets the category and its SEO page at once. Takes the value you want, not a toggle: nothing happens when it is already set.
category_tags_setChangeSet which of the store's category tag types are on one category. Send the full wanted list of tag type ids (from category_tags_get); PrintNow adds what is missing and removes what is extra, then reads back. An empty list removes all. Tag types themselves are made in Manage Tags (category_tag_types_save).
collection_saveChangeCreate a B2B collection (no id) or rename one (id). The API refuses a name used by any collection on the license, including other stores and deleted ones.
collection_set_membersChangeSet the FULL list of categories and/or products of a collection (B2B catalog limit). Send categoryIds, productIds or both; a list you leave out is not changed, [] removes all. PrintNow adds and removes the difference and reads back. Ids must be of this store (products: not deleted, not shared copies, not custom upload/design). On the storefront a product shows only in a published category, and a category brings itself and its direct sub-categories only (map deeper ones too). Asks first when an organization or user group uses the collection.
tag_saveChangeCreate a tag (no id) or change one (id): name, parent, published, sidebar. Send only what changes; PrintNow reads the tag and sends every field, because the save replaces name, parent and both flags. Saving sets the SEO Heading to the name. Parent must be a top-level tag in this store (not itself, not a tag with children); 0 = no parent. People make tags in CMS › Tag Content; this page has no Add.
tag_set_flagsChangeSet Published and/or Sidebar on a tag. Sends both flags, because the API sets both. The storefront sidebar ignores Published.

Products

Toolset name: print-store-products · 6 read, 13 change

ToolTypeWhat it does
alternate_views_listReadExtra images of a product or a category. type = product or category. For a category these are its images.
product_attributes_getReadAttributes available on one product (from its attribute set). With attributeId: the values of that attribute. The values chosen on the product are in products_get with productId (attributes field).
product_form_optionsReadChoices for a product save: categories, product types, and company fonts. Pricing ids for the Base Price come from pricings_get; names can repeat (two "Flyers"), so link pricing by id.
product_related_getReadRelated products shown with one product.
product_tags_getReadTags on one product (tagList) and the tag types that can be added (tagTypes).
products_getReadList the store's products (id, name, item #, model #, published, order, URL, global flag), newest first, or with productId one product with all edit tabs. Search matches name, item # and model # (and id). Filter by category, collection or organization with filterType + filterValue. The default list includes uncategorized products; uncategorizedCount says how many there are. isGlobal = shared to other stores.
alternate_view_deleteChangeDelete one image (alternate view) of a product or category, with its file. Give the product or category it belongs to. Asks first; no undo.
alternate_view_saveChangeSet the alt text (shown as the image title for shoppers and search engines) of one image of a product or category. Only the alt text can be changed here (100 characters).
alternate_views_moveChangeSet the order of the images of a product or category: order is the full list of image ids, first shown first (after the main product image).
product_attributes_setChangeSet the FULL list of attribute values of a product: [{ attribute (name or id), value }]. Only the attributes of the product category's attribute set can be used; for an attribute with options the value is the option text. Values not listed are removed. Attributes drive the storefront filters and search.
product_cloneChangeCopy a product with its rules. Artwork links are not copied. Answers the new product id; rename it with product_save.
product_createChangeAdd a blank product in a category: name, page count, size and bleed in the given unit. Templates from a file are not supported yet. Link pricing afterwards with product_save (pricingId). Flag a size in the name that does not match the size you set.
product_deleteChange · asks firstSoft delete of a product (it is marked deleted). Shared copies in other stores stay. Asks for a confirm first (needs_confirm), then call again with confirm.
product_moveChangeMove one product above or below another inside one category.
product_related_setChangeSet the full list of related products of one product (the "You may also like" list). Send the complete wanted list of product ids; PrintNow adds what is missing and removes what is extra, then reads the list back. An empty list removes all. The API only adds products of this store that are not deleted, not shared copies and not custom upload/design items; any other id is skipped and shows as missing in the read-back. A product cannot be related to itself (refused).
product_saveChangeChange a product's main fields: name, description, item and model number, category, pricing (by id), published, global. Send only what changes: PrintNow reads the product and sends every field, because the save replaces all of them (a missing editor scale breaks the product). Changing isGlobal asks for a confirm. Store lists for shared copies are changed in the admin only.
product_set_flagsChangeSet Published and/or Global on a product. Sends both, because the API sets both. Changing isGlobal asks for a confirm.
product_tags_setChangeSet the FULL tag list of a product (tag names, or tag ids of this store). Tags not listed are unlinked; duplicate links are removed. Tags must exist in the store (tag_save makes them).
product_template_replaceChangeReplace the design template (all pages) of a product with an InDesign .idml file on this computer. The old pages are deleted (no undo in the admin): the tool saves the product export as a backup first. Refused on shared copies of global products. Saved customer designs and past orders are not affected. Asks first.

Attribute Sets

Toolset name: print-store-attribute-sets · 2 read, 3 change

ToolTypeWhat it does
attribute_sets_getReadList attribute sets, or with id one set and its attributes. License-wide: sets are shared by all stores of the license. PrintNow sorts by display order (the API does not sort). License-wide (all stores).
attributes_getReadList attributes, or with id one attribute and its values. License-wide. types lists the attribute types. License-wide (all stores).
attribute_deleteChange · asks firstDelete an attribute (license-wide: it goes from every store and set). Asks for a confirm first (needs_confirm), then call again with confirm.
attribute_saveChangeCreate (no id) or change an attribute: name, type, multi-select, options. License-wide: the change shows in every store. Send only what changes; PrintNow sends the whole record. Options are the full list (objects as in attributes_get).
attribute_set_saveChangeCreate (no id) or change (id) an attribute set: its name and the FULL ordered list of attributes [{ attributeId, openByDefault }] (the order is the storefront filter order; openByDefault opens that filter). Sets are shared by every store of the license: a change asks first and lists the categories of every store that use the set (slow on big licenses). Removing an attribute hides it from the storefront category filter; products keep their values.

Pricing

Toolset name: print-store-pricing · 12 read, 15 change

ToolTypeWhat it does
pricing_colors_getReadColors (printed sides) of one pricing, with default and image. Warn when page count is 0.
pricing_custom_sizing_getReadCustom sizing of one pricing. A "Custom" size row means custom sizing is on, with its min/max. Empty means off.
pricing_form_optionsReadChoices for pricing saves: pricing types of one record, size model types, pricing categories, and (for one pricing) its order-option and size options, each as text + value (id).
pricing_group_getReadA pricing group: its settings (selection label and mode) and its member pricings in order, plus the pricings that can still join a group. Read only.
pricing_option_triggers_getReadOption triggers of one pricing (Pricing › Option Triggers): which order option, color, size or quantity choice turns other options on or off or sets their values. A pricing that shares another's options shows the shared triggers.
pricing_order_options_getReadOrder options of one pricing (name, charged as, order, item names). With orderOptionId: the items of that option with cost, weight and order.
pricing_previewReadGrid prices of a base pricing, like the admin Preview tab: one row per sample (each quantity, up to 8; the first 3 sizes; the default color), or one given quantity / size / color. This is the price-grid price only: option and turnaround costs are not in it. A price of 0 usually means an empty grid cell. For a Print MIS configuration use mis_price_preview. Read only.
pricing_quantities_getReadQuantities of one pricing, with the default. A $Index pricing with min or max quantity 0 is a problem: warn.
pricing_sizes_getReadSizes of one pricing, with default and order. Warn when width, height or bleed is 0. W×H can be read from the name (for example #10 (4.125" x 9.5")).
pricing_tables_getReadThe price grid of one pricing: one table per color, quantity rows × size columns.
pricing_turnarounds_getReadTurnarounds of one pricing, with default. Warn on a hidden turnaround (ShowTurnaround false).
pricings_getReadWithout id: the store's base pricings (id, name, flags; Print MIS configurations are in print-mis). search filters by name. With id: one pricing with its settings and the size of each tab. Read only.
bulk_pricing_updateChangeChange the price grid of many pricings by a percent (percent: 10 = +10%, -5 = -5%) or a fixed amount (amount: 2.5). One row per pricing. Only cells that have a price change (empty cells stay empty, 0 stays 0). Optional colorId / sizeId limit the cells. round: cents (default), whole, 99 (x.99). Prices change on the live store at once. Undo puts every old price back. Steps: preview (nothing written; returns a table and a runId), run (after the person says yes), status, undo. Up to 1000 rows per run.
pricing_cloneChangeCopy a base pricing under a new name: tabs, prices, options (in a new option list) and triggers. Not copied: option visibility / consumption / number settings, item materials and images, group members, 4over / Sinalite setup. Groups, shared copies and Print MIS configurations are refused. The API does not say whether it worked: the tool finds the copy, renames it and compares its tabs. Asks first.
pricing_colors_setChangeAdd, change or delete the colors (print sides) of a base pricing, and set the default (by id or name). upsert without id adds (name needed). Deleting a color deletes its prices. The last color cannot be deleted (the API would leave a broken default). Asks first.
pricing_createChange · asks firstCreate a new standard pricing (and its option group). Name plus isGroup. Real stores have duplicate names; check pricings_get first and link products and categories by id, never by name. Always asks first. Asks for a confirm first (needs_confirm), then call again with confirm.
pricing_custom_sizing_setChangeCustom sizing of a base pricing: settings (allowCustomSize, unit, min/max width and height, step, bleed, safe zone) and the area price ranges (upsert / delete; a range's discounts list replaces its quantity prices). Turning it on needs min/max and at least one range. Asks first.
pricing_deleteChangeDelete a base pricing (the API soft-deletes it). Refused while a product or category uses it (they would have no price), while it is a group with members, for global pricings, and for Print MIS configurations. A pricing that is a group member is taken out of the group first. 4over / Sinalite setup of the pricing is deleted for good. Asks first.
pricing_group_setChangeSet a pricing group: selection label and mode (0 dropdown, 1 buttons) and the FULL member list in order ({ pricingId, displayName }). Members must be base pricings of this store that are not groups, not Print MIS and not in another group. The pricing must already be a group (set isGroup with pricing_save first). Asks first.
pricing_order_options_setChangeAdd, change or delete the order options of a base pricing and their items. upsert matches options by id (no id = new); items, when given, is the full item list. delete takes option ids. Options are stored in an option group that other pricings may share: the tool lists them and asks first. Area-range prices (methods 5 and 6) are kept but not edited here.
pricing_package_importChangeImport a .pn pricing package (from a pricing export) as a NEW base pricing. The tool reads the package first (all sheets present, the name, counts, no server code) and refuses an existing name unless newName is given. The API returns no id and hides errors: the tool finds the new pricing, renames it, compares its counts with the package, and resets Global (the import reads it from the wrong column). Asks first.
pricing_quantities_setChangeAdd, change or delete the quantities of a base pricing, and set the default. upsert: { quantity } adds, { id, quantity } changes; delete takes ids or quantities (their prices go too). A new quantity has no prices yet: fill them with pricing_tables_set. Asks first.
pricing_saveChange · asks firstChange the General Info of a standard pricing: name (the only way to rename), quantity min/max, color and size labels, turnaround display, custom upload/design switches, weight, target DPI. Send only what changes: PrintNow sends the whole record. Group pricings are refused by the API. Check with pricing_preview after. Asks for a confirm first (needs_confirm), then call again with confirm.
pricing_set_flagsChange · asks firstSet Global, Allow Upload and Allow Design on a pricing. Give all three (read them with pricings_get first): the API sets all three in one call, so a missing one would be turned off. Asks for a confirm first (needs_confirm), then call again with confirm.
pricing_sizes_setChangeAdd, change, delete or reorder the sizes of a base pricing, and set the default. upsert without id adds (name, width, height needed). order is the full list of size ids (and names of new sizes) in the wanted order; new sizes go last otherwise. Deleting a size deletes its prices and unlinks products that use it. Asks first.
pricing_tables_setChangeChange cells in the price grid of one pricing. Send only the cells to change: colorId (table), quantityId or quantity (row), sizeId (column) and price. Ids come from pricing_tables_get. A static pricing has one table and no sizes. Missing cells are made. Prices change on the live store at once, so the tool always answers needs_confirm first with a before -> after table; call again with confirm after the person says yes. Check with pricing_preview after.
pricing_turnarounds_setChangeAdd, change or delete the turnarounds of a base pricing, and set the default. upsert without id adds (name needed). Costs are whole numbers (the API cannot save cents). Asks first and says when turnarounds are hidden on the storefront.

Dielines

Toolset name: print-store-pricing-dielines · 1 read, 2 change

ToolTypeWhat it does
dieline_mappings_getReadDieline mappings of one pricing (which size/option maps to which dieline) and the options that can be mapped.
dieline_mapping_assign_productChangeLink one product (the editor source product) to one dieline mapping of a pricing. Replaces the product already linked to that mapping. Ids come from dieline_mappings_get and products_get.
dieline_mappings_generateChangeBuild a pricing's dieline mappings: one per combination of the chosen fields (size, color and/or order options). With a different field set than now, EVERY mapping is deleted and rebuilt, with its uploaded dieline SVGs and linked asset product; with the same set, only combinations that no longer exist go. PrintNow lists what is lost, including products that point at a lost mapping, and asks first.

4over and Sinalite pricing

Toolset name: print-store-pricing-vendors · 8 read, 6 change

ToolTypeWhat it does
fourover_catalog_browseReadLive 4over catalog, one level at a time: no input = categories; categoryUuid = products in that category (max/offset paging); productUuid = option groups of a product; productUuid + groupId = options in a group. Calls the 4over API live. Needs the FourOver license feature.
fourover_feed_filtersReadThe filter panel of the 4over pricing create, for one 4over category: every option group in the store's synced feed, with each option's name and how many products have it. Pick from it for fourover_pricing_save's filter. Says when the feed is not synced yet (then run fourover_feed_sync). With pricingId: also whether 4over changed the feed since that pricing was made. Read only. Needs the FourOver license feature.
fourover_feed_statusReadFor one 4over category: does a feed exist, has it changed since the pricing was made (give pricingId), and which products are in the feed. Needs the FourOver license feature.
fourover_library_jobReadProgress of a 4over pricing library import (fourover_library_import): status (Running, Completed, Failed), done of total, the package in progress, and each package's outcome with warnings. No jobId: the store's running import, if any. Needs the FourOver license feature. A succeeded package has added its storefront category and its linked 4over pricing; the job does not give their ids: find the category by the package name and the pricing with pricings_get.
fourover_library_listReadPrintNow's curated 4over pricing library: packages (id, name, 4over category, product count, export date) and whether this store already imported each one. Each package adds TWO linked things: a storefront category (top-level, with its SEO, extended content and images, and its published state from the library, so it can be live on the storefront at once) and a 4over pricing, which that category already uses. It also brings the 4over feed of its 4over category. The category is named like the package; the pricing is named after the 4over category (several packages can give pricings with the same name). Import with fourover_library_import. Needs the FourOver license feature.
fourover_pricing_getReadOne 4Over pricing record and the feed products of its 4over category (the whole category's feed; the pricing may use only some of them, and the admin keeps no readable list of which). Needs the FourOver license feature.
sinalite_catalog_browseReadSinalite catalog: no input = categories and products; productId = one product with its options and the store code. Needs the Sinalite license feature.
sinalite_pricing_getReadOne Sinalite pricing record. Needs the Sinalite license feature.
fourover_apply_feedChangeRebuild one 4over pricing's option groups and options from the store's synced 4over feed (sync first with fourover_feed_sync). Options no longer in the feed are deleted (kept only while an order or cart uses them); new options come in visible. Custom names, hidden flags, defaults and order are kept for options that stay. Prices are not stored (live 4over quotes). Refused when the feed has no products. Asks first; live at once.
fourover_feed_syncChangeStart a background sync of the 4over feed for one 4over category. Returns a job id; follow it with fourover_feed_job. Does not change prices by itself (use fourover_apply_feed for that).
fourover_library_importChangeImport packages from PrintNow's curated 4over pricing library (fourover_library_list) into the store, as on the 4Over page. Each package adds TWO linked things: a storefront category (top-level, with its SEO, extended content and images, and its published state from the library, so it can be live on the storefront at once) and a 4over pricing, which that category already uses. It also brings the 4over feed of its 4over category. The category is named like the package; the pricing is named after the 4over category (several packages can give pricings with the same name). The pricing's markup is 0 (= the store's default 4over markup). Runs in the background: follow it with fourover_library_job, then find the new category with category tools (by the package name) and the pricing with pricings_get (is4Over). A package the store already imported is added again as copies (a second category and pricing), so it is refused unless allowReimport is true. Asks first.
fourover_markup_setChange · asks firstSet the markup percentage of one 4over pricing. Live storefront prices change at once. 0 or more. Compare it with the store default markup on the 4Over Partner Apps page. Asks for a confirm first (needs_confirm), then call again with confirm.
fourover_pricing_saveChangeCreate a 4over pricing (no pricingId: name, categoryUuid and a filter, as on the admin page) or change one (pricingId: new name, and/or option group and option changes: custom names, hide/show, default, order). Create: sync the category's feed first (fourover_feed_sync), look at fourover_feed_filters, then give filter = { group: [options] }. Products that have one of the picked options in every group used are kept; in each group used, the options not picked are hidden; groups not used stay as they are. filter {} keeps every product. (productUuids / hiddenOptionUuids instead of filter, for exact lists.) The product list cannot change after the create, so the create asks first. Options are kept as stored and sent back in full. Prices are live 4over quotes plus markup (fourover_markup_set). Changes ask first; live at once.
sinalite_pricing_saveChangeCreate a Sinalite pricing (no pricingId: name, sinaliteProductId from sinalite_catalog_browse; all options visible) or change one (pricingId: new name and/or option group and option changes: custom names, hide/show, default, order). Group key = group name, option key = Sinalite option id. The save rewrites every option row (Sinalite has no partial save). Sinalite has no markup. Changes ask first; live at once.

Orders

Toolset name: print-store-orders · 7 read, 9 change

ToolTypeWhat it does
order_files_getReadLinks to an order's files: order zip, item print files, proof, job ticket and custom design. Returns links, never the files. Only through authenticated MCP downloads, never the anonymous the admin download routes.
order_form_optionsReadChoices for order work in one store: all order statuses (with order counts), the status settings (which email each status sends, display order, default), sales reps, and the product type and vendor lists used as order filters.
order_getReadOne order in full: header, billing and shipping, items, products, and order history (status changes, emails, vendor sends). Most support questions start here. Card data is masked by the API. grandTotal is the order total; orderSubtotal is before tax, shipping and discount. Checkout fields (additionalFields) show their labels; every value is masked unless include_pii is set. Look for shipments and vendor-sent flags in the items and history. Personal data (names, emails, phones, addresses) is masked unless include_pii is true and the person agrees. Masked values are for reading only.
order_invoice_getReadInvoice of one order: lines, totals, payment type. The card number is masked (last 4 only). Each call writes "viewed card holder data" to the store's activity log, so call it only when needed.
order_item_merge_statusReadMerge (print file build) status of one order item. Use the item's product id from order_get.
order_job_ticketReadJob ticket for one order item: order detail, the item, and the invoice block. Card number masked. Each call writes "viewed card holder data" to the activity log.
orders_searchReadSearch orders in one store: view Active, Archived or Deleted; text query; date range; one status. Newest first, 50 at a time by default (offset/limit, up to 500); total (the number of matching orders) comes with the first page; every order can be reached with offset, and next says whether more follow. Use order_get for one order. Contact data is masked unless the person allows it. Personal data (names, emails, phones, addresses) is masked unless include_pii is true and the person agrees. Masked values are for reading only.
bulk_order_status_updateChangeSet one status on the items of many orders (status is per item; one row per order). Optional itemIds (only these items) and fromStatusId (only items now in this status). Status ids from order_form_options. WARNING: each order is saved with the full admin save, which can send the order to OrderDesk / SiteFlow / Sinalite / 4over and can email staff and the customer. Read the preview warnings to the person. Steps: preview (nothing written; returns a table and a runId), run (after the person says yes), status, undo. Up to 1000 rows per run.
order_add_noteChangeAdd a comment to the order history. No email. Refused while the order is at a vendor trigger status (the save would send the order again). Each save adds an order history row ("Updated by AI agent") and fires the order-updated webhook.
order_item_set_due_dateChangeSet (or clear) the due date of order items. Refused while the order is at a vendor trigger status. Known the admin bug: the history also says "Due Date removed" for the other items; their dates do not change. Each save adds an order history row ("Updated by AI agent") and fires the order-updated webhook.
order_item_set_vendorChangeSet the vendor of order items (vendor ids from trade_vendors_get; 0 = no vendor). Always asks first: the vendor is stored on the catalog product, so it also changes for every other order and all future orders of that product. Refused while the order is at a vendor trigger status. Each save adds an order history row ("Updated by AI agent") and fires the order-updated webhook.
order_set_archivedChangeArchive (true) or unarchive (false) an order. Takes the value you want: PrintNow reads the order first and does nothing when it is already set (the API flips it). The order must be in this store. Fires the customer-updated API hook. Does not re-send the order to any vendor.
order_set_deletedChange · asks firstSoft delete (true) or undelete (false) an order. Takes the value you want: PrintNow reads the order first and does nothing when it is already set (the API flips it). The order must be in this store. Fires the order-deleted or order-updated API hook. A soft delete does not cancel a vendor order. Always asks first. Asks for a confirm first (needs_confirm), then call again with confirm.
order_set_sales_repChangeSet the sales rep of an order (ids from order_form_options salesReps; 0 = none). No email. Refused while the order is at a vendor trigger status. Each save adds an order history row ("Updated by AI agent") and fires the order-updated webhook.
order_set_trackingChangeSet the tracking number(s) of one shipment (shipment ids are in order_get). Also sets the ship date to now. No email. Refused while the order is at a vendor trigger status. Each save adds an order history row ("Updated by AI agent") and fires the order-updated webhook.
order_status_setChangeSet the status of order items (all items, or itemIds). Always asks first: a status change can email staff and the customer, and can send the order to OrderDesk / SiteFlow / Sinalite / 4over (a paid vendor order) when the new status is a vendor trigger. For many orders use bulk_order_status_update. Each save adds an order history row ("Updated by AI agent") and fires the order-updated webhook.

Dashboards and Reports

Toolset name: print-store-reports · 3 read, 0 change

ToolTypeWhat it does
dashboard_getReadDashboard KPIs for one store and a date range (total sales, number of orders, average sale, sessions, returning customers, conversion), optionally compared with another range. Numbers are gross: cancelled orders count and refunds are not subtracted; dates are server time. Keep the range short (a year or less).
report_filter_optionsReadUser groups that can filter reports in this store.
report_runReadRun one report for a date range: Sales, Tax, Order, Product Sales, Promotion Code, Shipping, Sales Rep, Conversion Rate, Affiliates (and PII types only when allowed). Always send dates; range up to 366 days. Statuses: all not deleted; time: server. Tax groups by ship-to state. Affiliates is not for commission payout. Personal data (names, emails, phones, addresses) is masked unless include_pii is true and the person agrees. Masked values are for reading only.

Content

Toolset name: print-store-content · 5 read, 8 change

ToolTypeWhat it does
cms_extended_content_value_getReadThe value of one extended-content slot for one category or product. targetId is the category or product id; slotId is the extended-content tag id (from content_get type extended).
cms_snippet_find_usagesReadEvery page, category, product, tag and blog entry whose content uses the snippet {{Name}}. Run before renaming or deleting a snippet.
extended_content_getReadWithout id: the store's extended content slots (Content › Extended Content): tag, scope (category or product) and description. With id: one slot. The text a slot holds for a category or product: cms_extended_content_value_get.
landing_page_children_getReadOne landing page with its children (categories, landing pages, groups) in storefront order, and the items that can be added. Flag orphans and cycles when a landing page is a child of itself through others.
seo_getReadSEO panel rows (title, description, keywords, URL) for one SEO type; with id, one item's SEO detail. SEO type: 1 page, 2 category, 3 product, 4 tag, 8 blog, 9 image collection, 10 landing page.
bulk_content_updateChange · asks firstCMS pages (Content › Pages): find and replace text in the page HTML (exact, case-sensitive), and/or publish or unpublish. Choose pages by ids (cmsId), or search in the title; with find, only pages that contain it. Refuses replacement text with server code (<%). Blog posts are not in this tool yet. Undo puts the old HTML back. Steps: preview (nothing written; returns a table and a runId), run (after the person says yes), status, undo. Up to 1000 rows per run.
bulk_seo_updateChangeSEO title, meta description and keywords for many pages, categories, products, tags or blog posts (seoType 1 page, 2 category, 3 product, 4 tag, 8 blog). Give items with a value per record (seoId from seo_get or the record's seoId), or set one value for all chosen records (ids, or onlyMissing: the field that must be empty). Fields not given keep their value. The URL is never changed here. Show/hide flags are not in this tool yet. Steps: preview (nothing written; returns a table and a runId), run (after the person says yes), status, undo. Up to 1000 rows per run.
content_createChange · asks firstAdd a page, blog post, blog category, HTML snippet or landing page, optionally with its HTML. Pages, blog items and landing pages start unpublished (use content_set_flags). The URL is made from the title (change it with seo_save). Refuses server code (<%). Asks first.
content_deleteChangeDelete a custom page, blog post, blog category, HTML snippet or landing page. Hard delete: there is no undo. Always asks first and shows what depends on it (snippet usages, landing-page children and parents). redirectTo adds a redirect from the old URL. System pages and pages with tabs are refused.
content_saveChange · asks firstChange the HTML, title or layout of a content item; for blog posts also excerpt, tags and blog categories. Send only what changes: PrintNow reads the item, merges and sends all of it (the API replaces the whole record). Use either content or find+replace. Live at once: when the item is on the storefront the tool asks first and shows the change. Refuses server code (<%). Flags: content_set_flags; URL and meta: seo_save.
content_set_flagsChangePublish / unpublish and the other list flags of a content item; flags not given keep their value. Types and flags: page (published, requireLogin, sidebar, blankTemplate), category (published, requireLogin, sidebar, overview, homepage, browse, template, upload, uploadLater, service), product and tag (published, requireLogin), blog_post, blog_category and landing_page (published, requireLogin). Hiding a live item (unpublish or login) asks first. System pages: only sidebar can change.
landing_page_children_setChangeSet the children of one landing page: the full list in menu order (categories, landing pages and groups). Children not in the list are removed; the order is kept (the API alone loses it). Refuses ids from other stores and loops (a landing page inside itself). Removing children asks first. Live at once on the storefront menu.
seo_saveChangeSet the meta title, meta description, keywords and friendly URL of a page, category, product, tag, blog post, blog category or landing page. Fields not given keep their value. The URL is cleaned like the storefront does (lower case, - for spaces) and must be free in the store. A URL change asks first and adds a redirect from the old URL (redirect: false to skip).

Site Themes

Toolset name: print-store-site-themes · 2 read, 5 change

ToolTypeWhat it does
site_theme_files_listReadFiles and folders of one site theme (name, size, modified, isDir). Pass dir to open a sub-folder. Binary files (images, fonts) cannot be read as text.
site_themes_listReadSite themes of the license and whether this store uses each one (inUse covers only this store). To see every store, user group and organization that uses a theme, more lookups are needed.
site_theme_addChangeMake a new site theme from the built-in default files (the admin's DefaultTheme, which can differ from the provisioning default). It is not applied to any store; use site_theme_apply for that. The API refuses a name that is taken.
site_theme_applyChangeMake a theme the store's live storefront theme. PrintNow checks the theme has its master page, applies it, clears the store cache and loads the storefront home page; if that fails it puts the old theme back. Members of user groups with their own theme keep that theme. Asks first.
site_theme_cloneChangeCopy a site theme. Copies files only; the copy is named <name>-copy[-n] and is not applied to any store. Check the file count of the copy after (a clone can come out empty or partial).
site_theme_file_writeChange · asks firstCreate or replace a text file in a theme (.css, .js, .html, .htm, .xml, .json, .txt, .svg). Server files (.master, .ascx, .aspx, ...) are not allowed. Plain ASCII only, unless the file already starts with a UTF-8 mark (the admin saves other letters as ?): use CSS/HTML escapes like \00e9 or é. PrintNow saves the old file to logs/backups first, lists the stores and groups that use the theme, asks first, and checks the storefront serves the new text (else it puts the old text back).
site_theme_preview_via_groupChangeSet a user group's theme (themeId 0 = the store theme again), to try a theme with a test login before applying it. Only for a small test group: refused for RETAIL, the self-registration group and groups with more than 3 members. A member sees the theme after the next log in.

Settings

Toolset name: print-store-settings · 6 read, 7 change

ToolTypeWhat it does
email_notifications_getReadSystem email templates of this store (type, subject, to). With id: one template with its HTML. Search filters by text.
general_settings_getReadStore general settings: name, URL, culture, currency, time zone, theme, guest checkout, payment and file options; plus the choice lists (themes, cultures, time zones). The base for any general settings save (read, merge, send all fields).
inventory_getReadStock levels in this store, with search. With id: one stock row. With pricingId: the option choices for that pricing.
order_statuses_getReadOrder statuses of this store with their email template, flags, display order and default. With id: one status. Also returns the email templates a status can send.
trade_vendors_getReadTrade vendors (name, email, invoice logo). License-wide: the same list for every store; say so. With id: one vendor.
translations_listReadText overrides (key, default text, this store's value; null = default), also used by Print Editor › Translations. Search is required: there are about 1,000 keys. Matches the key, default text or the store's text.
email_notification_saveChange · asks first · not in Claude (claude.ai) or ChatGPTCreate (no id) or change a system email template. type: Welcome, Order Placed, Order Shipped, Order Pickup Ready, Lost Password, Order Approved, Approval Declined, Inventory Warning, Vendor Purchase Order, Order Status Changed, Order Awaiting Approval, Invoice Created, Invoice Declined, Invoice Changed, Invoice Approved, Download Instructions, Download Ready, New User External Project, Existing User External Project, Affiliate New Order, Shared Estimates. Only one template per type (a second sends a second email). Fields not given keep their value. Macros look like (%ORDER_ID%); the tool warns about macros that do not fit the type. Asks first and shows the change.
general_settings_saveChange · asks firstChange the store's general settings. set: { field: value } with fields storeName, storeUrl, culture, themeId, altDefaultUrl, selfRegGroup, allowMarketing, timezone, invoiceNumber, autoIncrement, paymentInvoice, paymentPO, paymentCheck, paymentCredit, amex, discover, priceIncludeTax, hideTax, addressChange, addressCreate, orderApproval, allowProof, trueReorder, continueShoppingUrl, compileMergedProducts, storefrontView, storefrontPageCount, storefrontFilters, relatedProducts, workDays, cutOffTime, endOfDayTime, guestCheckout, allowEstimateShare. PrintNow reads the whole form, changes only these fields and sends it back. The next invoice number is read again right before the save and kept, unless invoiceNumber is set (only higher). workDays are day names. Live at once. Asks first.
inventory_saveChangeCreate (no id) or change a stock row: for a product (productId) or for a pricing (pricingId with optional sizeId / colorId; 0 = any). Fields not given keep their value. On hand 0 and reorder 0 means not tracked (sells without limit). Checkout does not stop sales at 0: stock can go below 0; a warning email goes out at the reorder level.
order_statuses_setChangeAdd, change, delete or reorder order statuses. upsert by id (no id = new; name needed); flags awaitingApproval, awaitingArtwork, approved, declined, awaitingProofApproval can be on one status only; order = all status ids in order. Deleting moves its order items to the default status; the default status and vendor trigger statuses cannot be deleted. Asks first.
trade_vendor_saveChange · asks first · not in Claude (claude.ai) or ChatGPTCreate (no id) or update (id) a trade vendor: name and email. Vendors are license-wide: a change shows in every store. Do not rename the 4Over or Sinalite vendor (the delete guard checks those names; a rename makes a duplicate later). Send a name when creating.
translation_deleteChangeRemove the store's override for one translation key, so the default text shows again. Live in up to 15 minutes (cache).
translation_saveChange · asks firstSet the store's text for one translation key. Live in up to 15 minutes (cache). To go back to the default text, use translation_delete (an empty value shows empty text).

Checkout Settings

Toolset name: print-store-checkout-settings · 5 read, 6 change

ToolTypeWhat it does
checkout_fields_getReadCustom checkout field groups in this store. With groupId: the fields and options in that group. A group shows only to its linked user groups; report the links.
countries_listReadCountry list for checkout (code, name, enabled), with search and an enabled/disabled filter. Turning a country off removes it from checkout.
merchant_log_searchReadPayment transaction log: order, approved, response codes, messages, AVS and CVV results. No card numbers. The API returns every row at once; PrintNow pages it. Search filters by order or message text.
promotion_codes_getReadDiscount codes in this store. With id: one code in full. Also returns the shipping types a code can apply to.
tax_rates_getReadManual tax rates and the default tax rate. With id: one rate. Also returns the state choices. Manual tax is ignored when TaxJar is on.
checkout_fields_setChangeAdd, change or delete checkout field groups and their fields. groups: [{ id?, name, title, fields? }]; fields, when given, is the FULL list in order (fields not listed are deleted). deleteGroups takes group ids. A group shows at checkout only when a user group uses it. A new required field must be filled by every shopper. Past orders keep their values. Asks first.
country_set_enabledChange · asks firstTurn one country on or off at checkout. Takes the value you want, not a toggle: PrintNow reads the country first and does nothing when it is already set (the API flips it, so a retry would undo it). Turning a country off removes it from checkout at once; customers there cannot order. Asks for a confirm first (needs_confirm), then call again with confirm.
promotion_code_deleteChange · asks firstDelete a discount code. A checkout that already has the code keeps it. Asks for a confirm first (needs_confirm), then call again with confirm.
promotion_code_saveChangeCreate (no id) or change a discount code. type percent (value 1-100), amount (value > 0) or freeShipping (shippingMethodId = a rate rule, 0 = any). Codes are unique in the store (capitals ignored). usageLimit is per customer (0 = no limit); renaming a code resets everyone's count. minSubTotal is whole dollars. expiration is YYYY-MM-DD (valid through that day). Asks first.
tax_rate_deleteChange · asks firstHard delete one tax rate. Checkout stops charging it at once. Asks for a confirm first (needs_confirm), then call again with confirm.
tax_rate_saveChangeCreate (no id) or change a tax rate: state (2-letter, or empty for all), zip (empty for the whole state), rate in percent, includeShip, includePromo. Fields not given keep their value. Warns about duplicates and when TaxJar is on (manual rates are then not used). Asks first.

Shipping Settings

Toolset name: print-store-shipping-settings · 6 read, 11 change

ToolTypeWhat it does
fixed_rates_listReadFixed shipping rates of the store.
package_types_getReadPackage types (boxes and their packing script) for one pricing category. Give pricingCategoryId (the pricing id). With id: one package type in full. The API does not check that the package belongs to this store, so PrintNow checks the row's store.
rate_rules_getReadShipping rate rules of the store: carrier service, name, markup, user groups, order. With id: one rule in full. Weight ranges of a rule: weight_ranges_get.
shipping_defaults_getReadStore shipping defaults: free shipping, max weight, box compacting, group by carrier, display order, split shipping.
shipping_locations_getReadShip-from locations of the store, plus whether the old shipping defaults should still be migrated to locations (shouldMigrate). With id: one location in full. Set countries=true to also get the country list (code and name) used by the location form.
weight_ranges_getReadWeight ranges (from, to, price) on one rate rule.
fixed_rate_deleteChange · asks firstHard-delete a fixed shipping rate. Asks for a confirm first (needs_confirm), then call again with confirm.
fixed_rate_saveChange · asks firstCreate (no id) or change (id) a fixed shipping rate: description, price, ZIP codes. Send all three: there is no single-rate read to merge from, and the save replaces all three. A price of 0 makes it free. After a create, refresh rate rules and enable the new FIXED rule, or customers do not see it. Changing the description also renames its rate rule. Asks for a confirm first (needs_confirm), then call again with confirm.
package_type_deleteChange · asks firstHard-delete a package type from one pricing. The admin page deletes with no confirm. Items of that pricing then fall back to the item weight at checkout. Asks for a confirm first (needs_confirm), then call again with confirm.
package_type_saveChange · asks firstCreate (no id) or change (id) a package type on one pricing: size/option it applies to, enabled, weight, max weight, dimensions, units, type. Send only what changes; PrintNow reads the package and sends every field, because the save replaces the whole record. The package script runs at checkout and a broken script silently drops the type, so script and advanced changes are refused here until package_type_test is built. Ids for size/option come from pricing_form_options. Asks for a confirm first (needs_confirm), then call again with confirm.
rate_rule_moveChangeMove one rate rule above or below another in the checkout order. Renumbers all rules of the store.
rate_rule_saveChange · asks firstChange one shipping rate rule: display mode, price and weight limits, handling fee and method, residential and shipping markup, free, hide other methods, color, help text. Send only what changes; PrintNow reads the rule and sends every field, because the save replaces them all. The API cannot rename a rule (the name comes from the carrier) and does not set enabled/status. Negative values become 0; max below min becomes min. Asks for a confirm first (needs_confirm), then call again with confirm.
rate_rules_refreshChangeRebuild the store's rate rule list from its fixed rates and carrier accounts. Adds new methods (disabled) and DELETES every rule the list no longer has, with its settings, weight ranges and user group links. FedEx and UPS methods come from lists in the code while the store has that account; ShipEngine methods come from the ShipEngine API, and a carrier that does not answer loses all its rules. PrintNow shows the rules that will go, saves every rule's settings to a backup file first, and compares after. Asks first.
shipping_defaults_saveChange · asks firstChange the store's shipping defaults: free shipping for all orders, max package weight, box compacting, group by carrier, display order, split shipping. Send only what changes; PrintNow reads the defaults and sends all six, because the save sets all six. Note: 'free shipping for all orders' seems to be ignored by the current checkout. Asks for a confirm first (needs_confirm), then call again with confirm.
shipping_location_deleteChangeDelete a ship-from location. Refused for the default location (make another one default first) and for 4over / Sinalite vendor locations (vendor orders need them). Asks first.
shipping_location_saveChangeCreate (no id) or change (id) a ship-from location: name, contact, address, default. Send only what changes; PrintNow reads the location and sends every field, because the save replaces the whole record. Setting isDefault true makes it the one default (the API clears the others). Turning the default off is refused: make another location the default instead, so there is always exactly one. Vendor locations (FourOver, Sinalite) keep their vendor type.
weight_ranges_setChangeSet the FULL list of weight ranges of one rate rule: [{ minWeight, maxWeight, cost }]. A range counts from minWeight up to just below maxWeight; its cost REPLACES the shipping price (a flat amount, not per pound); handling and markups still apply on top. Weights outside every range keep the rate's own price. Ranges work only when the rule's display mode is 4 (postal code) and the rate has ZIP codes (fixed rates with ZIP codes). Ranges must not overlap. Ranges left out are deleted. Asks first.

Domain Tools

Toolset name: print-store-domain-tools · 6 read, 7 change

ToolTypeWhat it does
activity_log_searchReadAdmin audit trail, paged and newest first: who changed what and when. License-wide: there is no store column, so it covers all stores. The IP shown is the server's, not the user's, and the user is only a first and last name. Last 90 days, up to 500 rows. License-wide (all stores).
error_log_searchReadApp errors, paged and newest first. No store column: filter by the store's host in the URL. Secrets in the message are masked. Stack traces are never returned.
redirects_listReadURL redirects of the store: old URL, new URL, type (301 / 302). Use search to find an old or new URL. Changes are live in up to 15 minutes (cache).
robots_getReadRobots.txt rules of the store (allow / disallow paths).
site_binding_getReadThe store's domain setup: system domain, custom domain on/off, sub-domain, DNS targets (CNAME, A record, TXT), and the binding status and error. Read only.
sitemap_getReadThe generated sitemap.xml of the store. The admin preview may show the wrong host. If the store's theme has its own sitemap.xml, that file wins on the storefront: say so.
bulk_redirectsChange · asks firstAdd redirects from a list (old path -> new path), or delete redirects by old path. An old path that already has a redirect is updated. Refuses old = new, an old path twice in the list, and loops (A -> B and B -> A). Redirects can take up to 15 minutes to show (cache). Steps: preview (nothing written; returns a table and a runId), run (after the person says yes), status, undo. Up to 1000 rows per run.
bulk_robotsChangeAdd or delete many Disallow paths in robots.txt. A Disallow hides pages from search engines, so check the list with the person: a wrong path (for example /) can hide the whole store. Steps: preview (nothing written; returns a table and a runId), run (after the person says yes), status, undo. Up to 1000 rows per run.
redirect_addChange · asks firstAdd a 301 redirect from an old URL to a new URL on this store. Live in up to 15 minutes (cache). The answer has oldUrl/newUrl flags: true means that URL was invalid and nothing was saved. Before adding, check with redirects_get that the old URL is not already redirected, that the new URL does not redirect back (a loop), and that old and new differ.
redirect_deleteChangeDelete one redirect. The old URL then shows its own page again (or a 404). Live in up to 15 minutes.
redirect_updateChange · asks firstChange the old and new URL of one redirect. Send both URLs (the save replaces both). The answer has oldUrl/newUrl flags: true means that URL was invalid and nothing was saved. Live in up to 15 minutes. Check for loops and duplicates with redirects_get first.
robots_disallow_addChange · asks firstAdd one Disallow path to the store's robots.txt (for example /checkout/). Live at once. A wrong rule can hide pages or the whole site from search engines: '/' blocks everything, '*' is a wildcard. Always asks first. Asks for a confirm first (needs_confirm), then call again with confirm.
robots_disallow_removeChangeRemove one Disallow rule from the store's robots.txt. Live at once: search engines may crawl that path again.

Site Users and Organizations

Toolset name: print-store-customers · 7 read, 10 change

ToolTypeWhat it does
organizations_getReadOrganizations (B2B customer companies) of the store. With id: one organization with members, addresses, collections, theme and logo. Contact data is masked unless the person allows it. Personal data (names, emails, phones, addresses) is masked unless include_pii is true and the person agrees. Masked values are for reading only.
site_user_existsReadCheck whether an email or a user name is already used by a customer of this store. Always run this before adding a customer or changing an email: the server does not check that an email is unique. Returns available: true / false.
site_user_findReadFind one customer (site user) by exactly one of: email, user name, customer id, or order id (the customer who placed it). The support agent's first tool. Email and user name must match exactly (case does not matter). Returns the customer's full record (store, name, email, organization, groups, flags), or says none or several match (with their ids). Email and user name search site users only; by id or order the account can be an admin, guest or deleted one, and then siteUser is false. Personal data is masked unless include_pii is true and the person agrees; masked values are for reading only.
site_user_getReadOne customer in full: details, statistics (orders, projects, albums, cart items, last login), orders, saved projects, albums, admin roles and cart items. The orders list includes archived and deleted orders: each order has isArchived and isDeleted. In that list grandTotal is what the customer paid; orderTotal is only the SUBTOTAL (before shipping, tax and discount). On an older the admin without grandTotal, the total is orderTotal + shippingTotal + taxTotal - promotionTotal (the admin with the order flags; on an older the admin the fields are missing, so check with order_get before acting on an order). Lists come 50 at a time; to page one list, give list (orders, projects or albums) with offset/limit, and only that list comes back. Contact data is masked unless the person allows it. Personal data (names, emails, phones, addresses) is masked unless include_pii is true and the person agrees. Masked values are for reading only.
site_users_searchReadSearch the store's customers (site users). Search matches name, company, email, user name and customer id only, not phone or order number (use site_user_find for an order id). Newest login first, 50 at a time (offset/limit reach every customer); total (the number of matching customers) comes back, so a count needs only limit 1. Returns id, user name, name, company, email, groups, organization, last login, flags. Contact data is masked unless the person allows it. Personal data (names, emails, phones, addresses) is masked unless include_pii is true and the person agrees. Masked values are for reading only.
user_carts_getReadCustomers with items in their cart: name, email, last updated, item count, subtotal. With id (customer id): that customer's cart items. Warnings: the list loads the whole store at once (slow, no paging), guest carts are not shown, and 'last updated' is the customer's date, not the cart's. Contact data is masked unless the person allows it. Personal data (names, emails, phones, addresses) is masked unless include_pii is true and the person agrees. Masked values are for reading only.
user_projects_searchReadSaved designs: a personal product linked to a customer (id, customer, product, name, type, updated). Give a search text or a date range: big stores have thousands of projects and the API returns all of them at once. Contact data is masked unless the person allows it. Personal data (names, emails, phones, addresses) is masked unless include_pii is true and the person agrees. Masked values are for reading only.
organization_address_saveChangeAdd (no addressId) or change (addressId) an address in an organization's address book. Members can pick it at checkout; {user} in first name, last name or email is filled with the shopper's own value. Send only what changes on an update. country is a 2-letter code; US and CA states are 2-letter codes. Required: addressName, address1, city, zipcode, country. isResidential cannot be read back from the admin, so an update must send it. Past orders keep their own copy of the address.
organization_deleteChangeDelete an organization (hard delete). Refused while it has members (they would lose their restrictions). Its logo and addresses are deleted with it. A partner store bound to it cannot be seen through the API: check that first. Asks first.
organization_members_setChangeSet which customers are in an organization. Send the full wanted list of customer ids; PrintNow adds and removes the difference and reads back. Every id must be a customer of this store. A customer can be in only one organization: the API refuses a customer who is in another one (remove them there first). Organizations limit the catalog (collections), and a partner store bound to an organization lets only its members log in, so removing a member can lock them out there.
organization_saveChangeCreate (no id) or change (id) a B2B organization: name, description, theme, integration id, collections. Send only what changes; PrintNow reads the organization and sends every field. collectionIds is the FULL list of collections of this store. While an organization has at least one collection, its members see only those collections; with none they see the whole catalog. The theme (0 = store theme) replaces the store theme for members. Names are unique in the store. Asks first when collections or the theme change on an organization with members.
project_reassignChangeMove a saved project from one customer to another customer of the same store. Both customers are checked against this store. The API answers OK even when the project is not the first customer's (then nothing moves), so check with user_projects_search after.
site_user_addChange · asks first · not in Claude (claude.ai) or ChatGPTAdd a customer account to a store. PrintNow makes a long random password and never shows it: tell the person the customer signs in with Forgot password. Email and user name (default: the email) must be free in this store, as email and as user name (login takes either). Optional: groups, organization, tax exempt, marketing, approver, sales rep, vendor, welcome email (it has no password and no set-password link). Asks first when a welcome email is sent or for sales rep (can log in as any customer, not logged).
site_user_deleteChange · asks firstSoft-delete a customer account. Orders are kept. The customer's open sessions are not ended. Asks for a confirm first (needs_confirm), then call again with confirm.
site_user_saveChange · asks first · not in Claude (claude.ai) or ChatGPTChange a customer: names, email, company, marketing, approver, sales rep, vendor, tax exempt, organization, user groups. Send only what changes; PrintNow reads the customer and sends every field (the save replaces them all). userGroupIds is the FULL list (an explicit RETAIL link is dropped). organizationId 0 removes the organization; another id moves the customer. A new email must be free in this store (as email and user name); the user name does not change, so the customer can still log in with it. Asks first for email, groups, organization, sales rep and tax exempt changes. Sends a customer-updated webhook.
site_user_set_flagsChange · asks firstSet Approver, Marketing emails, Sales Rep and Tax Exempt on one customer. Send only the flags to change; PrintNow sends all four, because the API sets all four (a missing one would be cleared). Tax Exempt changes the tax the customer pays. Asks for a confirm first (needs_confirm), then call again with confirm.
user_project_deleteChange · asks firstRemove a saved project from a customer's list. The product row stays. Never build the editor View/Edit URL for a project (it puts admin tokens in the URL). Asks for a confirm first (needs_confirm), then call again with confirm.

User Groups

Toolset name: print-store-user-groups · 6 read, 8 change

ToolTypeWhat it does
user_group_discounts_getReadDiscounts of one user group, by pricing. When a user is in several groups, the first matching group wins: say so.
user_group_exceptions_getReadCategories and products hidden from one user group. Note: the admin page shows this tab only when the group has both kinds; this tool always returns both.
user_group_form_optionsReadChoices for a user group save: group themes and checkout fields, and the categories that can be hidden. Give selectedCategory for the products of one category, and groupId + pricingId for the pricing types of a discount.
user_group_payment_methods_getReadPayment methods of one user group: check, credit card, invoice (pay on account), purchase order, tax exempt, order needs approval, domain name.
user_group_shipping_methods_getReadShipping methods (rate rules) available to one user group.
user_groups_getReadUser groups of the store: id, name, description, theme, user count. With id: the group in full: info (collections, visible, logo), profile fields, members and addresses. Contact data of members is masked unless the person allows it. Personal data (names, emails, phones, addresses) is masked unless include_pii is true and the person agrees. Masked values are for reading only.
user_group_deleteChange · asks firstDelete a user group with its member links, discounts and product exceptions. Members with no other group fall back to the store RETAIL group. The API leaves collection and shipping links behind and always answers success, even when it failed: check user_groups_get after. The preview lists members, collections and discounts. The RETAIL group cannot be deleted. Asks for a confirm first (needs_confirm), then call again with confirm.
user_group_discounts_setChangeSet the FULL list of a user group's discounts: [{ pricingId, type: percent | fixed, value }]. One discount per base pricing. Percent is off the line price (base + options, before turnaround), at most 100; fixed is an amount off the whole line (not per item) and must be lower than the pricing's lowest grid price. Discounts of pricings left out are deleted. Members of several groups get only one group's discount per pricing. Asks first. Live at once.
user_group_domain_setChange · asks first · not in Claude (claude.ai) or ChatGPTSet the website host that puts new sign-ups into a user group when they come from a link on that site (the browser's Referer), or "" to clear it. It is the linking site's host, not the customer's email domain; www.acme.com and acme.com are different. The Referer can be faked, so anyone can join: refused for groups with invoice, purchase order, tax exempt or discounts. One group per host. Asks first.
user_group_exceptions_setChange · asks firstSet which products a user group cannot see (products only; category exceptions are off because the API ignores a category add). Send the full wanted list of product ids of this store; PrintNow adds and removes the difference and reads back. Customers of the group stop seeing these products at once. Asks for a confirm first (needs_confirm), then call again with confirm.
user_group_members_setChangeSet which customers are in a user group. Send the full wanted list of customer ids; PrintNow adds and removes the difference and reads back. Every id must be a customer of this store (not an admin). A customer can be in several groups. Group membership changes prices, payment methods, shipping and the catalog the customer sees.
user_group_payment_methods_setChange · asks firstSet the payment methods of a user group: check, credit card, invoice, purchase order, tax exempt, orders need approval. Send only what changes; PrintNow reads the group and sends all six. These ADD to the store's payment methods for members; they do not restrict them. Asks for a confirm first (needs_confirm), then call again with confirm.
user_group_saveChangeCreate (no id) or change (id) a user group: name, description, theme, can modify orders, custom field group, collections. Send only what changes; PrintNow reads the group and sends every field, because the save replaces them all. collectionIds is the full list; on create send it ([] for none). The RETAIL group keeps its name and gets no theme. Theme and field group ids must be real ids from user_group_form_options (bad ids can crash the save).
user_group_shipping_methods_setChange · asks firstSet which shipping methods (rate rules) a user group may use. Send the full wanted list of rate rule ids (from rate_rules_get). A group with no methods set may use ALL methods, so an empty list is refused: to allow all, send every id. PrintNow adds and removes the difference and reads back. Customers of the group see only these methods at checkout. Asks for a confirm first (needs_confirm), then call again with confirm.

Admin Users and Roles

Toolset name: print-store-admin-users · 3 read, 0 change

ToolTypeWhat it does
admin_user_roles_getReadThe admin roles one user holds, per store. Read only.
admin_users_listReadAdmin users of the store: customers of this store that hold any admin role. total (the number of matching admin users) comes back, so a count needs only limit 1. Read only: admin user and role changes are off for agents. Contact data is masked unless the person allows it. Personal data (names, emails, phones, addresses) is masked unless include_pii is true and the person agrees. Masked values are for reading only.
user_roles_getReadAdmin roles of the store with their tier. With id: one role and the admin screens it can open. Read only.

Artwork and Elements

Toolset name: print-editor-artwork · 6 read, 11 change

ToolTypeWhat it does
artwork_categories_getReadArtwork (template) categories. License-wide: categories are shared by all stores of the license; each row's companyId shows the owning store. With id: one category and its artwork items.
artwork_getReadOne artwork item in full (name, category, files, metadata). License-wide.
background_themes_categories_listReadBackground theme categories. License-wide: shared by all stores of the license; each row's companyId shows the owning store.
background_themes_items_getReadBackground images in one background theme category, and the category itself. License-wide.
elements_categories_listReadElement (clipart) categories. License-wide: shared by all stores of the license; each row's companyId shows the owning store.
elements_items_getReadElements (clipart images) in one element category, and the category itself. License-wide.
artwork_category_deleteChangeDelete an artwork category with all its artwork and their thumbnail files. It is shared by every store of the license. Refused while it has child categories, while a thumbnail is shared with other artwork, and (unless force) while products use it. Saves the category export (.pn) as a backup first. Asks first. Saved designs keep working.
artwork_category_products_setChangeSet the FULL list of this store's products whose editor offers one artwork category. PrintNow reads every product of the store to find the current links (slow on big stores), then saves only the products that change, each with a full product save that changes only the artwork list. Products of other stores are not touched. [] removes the category from every product of the store and needs clear: true. Shared copies of global products are refused. Asks first.
artwork_category_saveChangeCreate an artwork category in this store: name and description. Create only for now: changing an existing category is refused, because the category list is not filtered by store and the save takes any id. Names cannot contain < or >. A thumbnail image is never set from here.
artwork_deleteChangeDelete one artwork and its thumbnail file. Refused when the thumbnail is shared with other artwork or a category. Saves the artwork export (.pn) as a backup first. Asks first. Saved designs keep working.
artwork_save_metadataChangeChange the name and/or description of one artwork item (shown in the editor's artwork panel and the admin search). PrintNow reads the artwork and keeps its category and thumbnail. Artwork is shared by every store of the license.
background_themes_category_deleteChangeDelete a background theme with its items. It is shared by every store of the license. Refused while products use it, unless force; the confirm lists the products (all stores) and which lose the Backgrounds panel. Images stay, so saved designs keep working. No undo.
background_themes_category_saveChangeCreate a background theme category in this store: name and description. Create only for now: changing an existing one is refused, because the list shows every store and the save takes any id. Names cannot contain < or >.
background_themes_item_deleteChangeRemove one item from a background theme (the id from its item list, not the image id). The image stays, so saved designs keep working. The category is shared by every store of the license. Asks first.
elements_category_deleteChangeDelete a element category with its items. It is shared by every store of the license. Refused while products use it, unless force; the confirm lists the products (all stores) and which lose the Elements panel. Images stay, so saved designs keep working. No undo.
elements_category_saveChangeCreate an element (clipart) category in this store: name and description. Create only for now: changing an existing one is refused, because the list shows every store and the save takes any id. Names cannot contain < or >.
elements_item_deleteChangeRemove one item from a element category (the id from its item list, not the image id). The image stays, so saved designs keep working. The category is shared by every store of the license. Asks first.

Colors, Fonts, Layouts, Albums

Toolset name: print-editor-styles · 7 read, 11 change

ToolTypeWhat it does
album_images_listReadImages in one album. The album id must come from albums_list for this store; the API does not check the store.
albums_listReadSite Albums (store image albums) and User Albums (images customers uploaded), as { storefrontAlbums, userAlbums }, 50 of each by default; to page one of them, give list with offset/limit. User albums are customer data: show only what the job needs. Album ids for album_images_list must come from this list. Personal data (names, emails, phones, addresses) is masked unless include_pii is true and the person agrees. Masked values are for reading only.
color_palette_available_colorsReadThe store's colors that are not in a palette yet, so they can be added to it. Palette ids: color_palettes_get.
color_palettes_getReadWithout id: the store's color palettes (text = name, value = palette id). With id: one palette (name, custom color on/off) and its colors (name, RGB, CMYK, spot). The palette list is not reliably filtered by store yet; check each palette's companyId (from the export) before you change it.
fonts_listReadFont families for the editor: name, family name, and which styles exist (regular, bold, italic, bold italic). Fonts are license-wide: a change affects every store on the license.
layouts_categories_listReadLayout categories (groups of ready-made layouts customers can pick in the editor). Layouts are license-wide; each row carries companyId. Use layouts_items_get with a category id to see its items.
layouts_items_getReadItems (layouts) in one layout category. With itemId: one item in full. Layouts are license-wide.
album_image_deleteChangeDelete one image from a store album, or from a customer's album (give customerId). The image must be in that album, and the album in this store. The file stays (past orders still print), but the image leaves the editor. The admin has no undo. Asks first.
color_deleteChangeDelete a color from the license (it leaves every palette). Refused while it is in a palette: to take it out of one palette use color_palette_colors_set (remove), which keeps the color. A deleted color changes reprints of past orders (PDF looks colors up by RGB). Asks first.
color_palette_colors_setChangeAdd colors to a palette and/or remove colors from it, by color id (from color_palettes_get with the palette id). Saved at once, like the admin page (no Save button). Use only this store's colors.
color_palette_createChangeMake a new, empty color palette in this store. Add colors after with color_palette_colors_set. enableCustomColor lets customers pick any color on products that use this palette. Returns the new palette id.
color_palette_deleteChangeDelete a color palette (the colors stay). It is shared by every store of the license. Refused while products, pages or items use it, unless force; those then fall back to the license's first palette. Asks first and names the fallback.
color_saveChangeCreate (no id: name, rgb and cmyk) or change (id) one editor color: name, rgb (0-255), cmyk (0-100), spot (the name is the spot plate name). Colors are shared by every store of the license. At PDF merge a design color is found by RGB (first match in the license), so a change changes reprints of past orders, and a second color with the same RGB is refused unless allowSameRgb. A new color is in no palette: add it with color_palette_colors_set. Changes ask first.
font_deleteChangeDelete a font (the admin has no undo). It is shared by every store of the license. Refused while a store font list, a product, a page or a text item uses it. Reprints of past orders that used it fail unless another font has the same family name: then force is needed. Asks first.
font_updateChangeChange the display name of a font in this store. Only the name changes; the font file and family stay.
layouts_category_deleteChangeDelete a layout category and its layouts. It is shared by every store of the license. Refused while products or pages use it, unless force. The tool deletes the layouts one by one, then the empty category (the API's own delete can stop half way). Asks first.
layouts_category_saveChangeCreate a layout category (no id) or change its name and description (id). Send only what changes; PrintNow reads the category and sends both fields, because the save replaces both.
layouts_item_deleteChange · asks firstDelete one layout item (a layout) from a layout category. Also deletes its rules and mappings. Both ids are checked against this store. Asks for a confirm first (needs_confirm), then call again with confirm.

Editor setup

Toolset name: print-editor-setup · 7 read, 10 change

ToolTypeWhat it does
autofill_profiles_getReadWithout id: autofill profiles per user group (store tier and group tier). With id: one profile with its keys and values.
autofills_getReadWithout id: the store's autofill variables (fields the editor fills from the customer's profile) and their categories. With id: one variable in full.
editor_settings_getReadStore-wide editor defaults: ruler, DPI warning and buffer, font list, custom upload editing / fit / lock, auto thumbnail.
editor_themes_getReadWithout id: editor looks (colors, backgrounds, custom styles) and whether each is in use. With id: one theme in full.
editor_translations_listReadEditor text: key, default text, and the store's own text (userValue, null = default). Only Editor_ keys; the rest are storefront text (see translations_list). Change one with editor_translation_save.
offline_templates_listReadDownload templates (blank artwork files) per pricing and size, plus the store's template guide colors (bleed, trim, safe area). The files themselves are not returned here.
rules_getReadWithout id: Rules Engine groups (JSON rules for the editor). With id: one group with its JSON rules. The API lists every store's groups, so PrintNow keeps only groups that belong to this store.
autofill_profile_saveChangeCreate (no id) or change an autofill profile: its name and values. groupId = a user group's profile; no groupId = the store's profile, which every visitor gets (asks first). values: { tag: text, or image id for image variables }. Variables not listed keep their value. Blank values are refused (they blank the template text). Image ids must be in the store's image library.
autofill_saveChangeCreate (no id) or change an autofill variable: tag, type text or image, visibility, locked, default text or default image id. Fields not given keep their value. Tags are unique in the store (ignoring case). A text variable cannot become an image variable (saved text values would stop the editor loading); an image variable becomes text only while no profile holds a value. A tag rename asks first: templates that use the old tag stop being filled.
editor_settings_saveChange · asks firstChange the store's editor defaults: hide non-final items in proof, legacy clipart swap, DPI warning, DPI buffer (0–100), custom upload editing, fit and lock, disable auto thumbnails. Send only what changes; PrintNow reads the settings and sends every field, because the save replaces all of them. Font defaults are not changed here. Asks for a confirm first (needs_confirm), then call again with confirm.
editor_theme_applyChange · asks firstMake an editor theme live for this store. Shoppers see it in the editor at once. Before you apply, note which theme is in use now (editor_themes_get shows inUse), so you can put it back. Asks for a confirm first (needs_confirm), then call again with confirm.
editor_theme_saveChange · asks firstCreate an editor theme (no id) or change one: name, primary/surface/accent colors (#rrggbb only), background tile flags, custom CSS. Send only what changes; PrintNow reads the theme and sends every field, because the save replaces them. Live at once in the editor when the theme is applied. Background image upload is not available here yet. Asks for a confirm first (needs_confirm), then call again with confirm.
editor_theme_style_saveChange · asks firstReplace the custom CSS of an editor theme. Live at once when the theme is applied. The old CSS is shown in the confirm preview, so it can be put back. @import, outside url(), expression(), javascript: and CSS that hides html/body are refused. Asks for a confirm first (needs_confirm), then call again with confirm.
editor_translation_saveChangeChange the store's text for one editor key (key starts with Editor_, from editor_translations_list), or reset: true to go back to the default. Plain text only. Shoppers see it the next time the editor loads.
offline_template_deleteChange · asks firstDelete one offline (downloadable) template file and its link to a pricing size. Id from offline_templates_list. Asks for a confirm first (needs_confirm), then call again with confirm.
product_assign_rule_groupChangeSet the product's Rules Engine group (groupId 0 = none). The group must be in the store. PrintNow reads the whole product and sends it back with only this changed (the API has no smaller save). Live in the editor at once.
rule_saveChangeCreate (no id) or change a Rules Engine group: name, description and the FULL rule list (rules not given keep the stored list). Each rule has conditions (property: is empty, is not empty, has characters, has a width, exists; has characters / has a width take comparison = != < <= > >= and a number) and actions (anchor, swap image, move by, move to, change color to, change text to). Targets are item tag names. Only what the editor runs is allowed. A change to a group that products use asks first and lists them; it is live in the editor at once.

Live Previews

Toolset name: print-editor-live-previews · 3 read, 4 change

ToolTypeWhat it does
materials_3d_getReadWithout id: PBR materials for 3D previews (license-wide, shared by all stores). With id: one material with its texture settings. License-wide (all stores).
models_3d_getReadWithout id: OBJ/MTL 3D models of this store. With id: one model with its materials and options. Editing a model from another store moves it to that store, so check each model's store before you use it.
photo_mockup_groups_getReadWithout id: photo mockup groups (PSD-based product photos) and the PSD service URL. With id: one group and its preview items. The PSD Basic Auth login is masked.
material_3d_saveChangeCreate (no id: type and name) or change (id) a 3D appearance material. Send only what changes: name, category, order, thickness, unit, surface color/roughness/metalness/scale (face, back, edge, bevel), transparency, wall-art sizes and frame values, and texture images (local png/jpg/webp files, uploaded after the yes; or remove). Texture ids and URLs are never taken from input (#55, C146). Materials are shared by every store of the license: a change asks first and lists the pricing options that use it. Frame width and overhang change frame prices.
materials_3d_importChangeImport 3D materials from a materials package (.zip with materials.json and textures/, made by materials_3d_export). First call: PrintNow checks the package, runs the API preview and asks; it lists names that already exist (the import always ADDS: a clash becomes "<name> (imported)"). Refused when a texture is an outside URL (C146). Pick entries with indexes (default: all importable). Materials are shared by every store of the license.
photo_mockup_group_moveChangeMove one photo mockup above or below another in the same group. Ids from photo_mockup_groups_get with the group id. Both mockups must be in this group (the API would move a row of another group or store).
photo_mockup_group_saveChangeCreate a photo mockup group (no id) or rename one. Name is required. Does not touch the PSD transfer URL or its login.

Toolset name: print-mis · 11 read, 12 change

ToolTypeWhat it does
configuration_exportReadSave one Print MIS configuration (all its sheets) as an .xlsx file for the person (a file on this computer, or a download link on the hosted server). Read only.
configurations_getReadWithout id: manufacturing pricing records (Print MIS configurations). With id: the MIS tabs of one configuration: formula variables, lookup tables, process steps, margin and custom product settings. The standard pricing tabs are in pricing_get.
equipment_exportReadSave all Print MIS equipment with processes and cost ranges as an .xlsx file for the person (a file on this computer, or a download link on the hosted server). Edit it, then import it with the matching import tool. Read only.
equipment_getReadWithout id: presses and finishing equipment. With id: one equipment record with its processes and cost ranges.
formula_variables_getReadFormula variables of one MIS configuration, in order. With id: one variable. Before a change, parse every formula and check each name it uses exists; a bad formula can give a $0 live price.
lookup_tables_getReadLookup tables of one MIS configuration. With id: one table with its rows. Formulas refer to tables by name; a table a formula uses must not be deleted.
margin_getReadMargin config of one MIS configuration (how cost becomes sell price).
materials_exportReadSave all Print MIS materials of the store as an .xlsx file for the person (a file on this computer, or a download link on the hosted server). Edit it, then import it with the matching import tool. Read only.
materials_getReadWithout id: substrates (paper, vinyl, ...) with cost. With id: one material in full.
mis_price_previewReadPrices of a Print MIS configuration, worked out with the same engine as the admin Preview tab and the storefront: one row per sample (each quantity, up to 8; the first 3 sizes; the default color and default options). This is the Print MIS sell price; option add-ons and turnaround fees are not in it. Rows with an error or a price of 0 or less are listed in problems. Read only.
process_steps_getReadProcess steps of one MIS configuration, in order (each step uses a material or equipment and a formula). With id: one step. A step that points at a deleted material or equipment cannot be saved again.
configuration_createChange · asks firstMake a new, empty Print MIS (manufacturing) pricing configuration with this name. Returns the new id; open it with configurations_get. Check configurations_get first: a name that already exists makes a second record with the same name. Asks for a confirm first (needs_confirm), then call again with confirm.
configuration_importChangeImport one Print MIS configuration from an .xlsx file (the layout of configuration_export). Configuration!A2 must be the configurationId. PrintNow compares the file with the current export sheet by sheet, refuses unknown ids, duplicate names and missing equipment / process / material names, builds the configuration as it would be, checks every formula and prices it before and after. Changes to sizes, colors, quantities, turnarounds or options are not price-checked: they are refused unless allowCatalogChanges. Asks first; saves an export as a backup.
equipment_deleteChangeDelete Print MIS equipment and its processes. Refused while a process step uses one of its processes (the API deletes anyway, but the equipment keeps pricing live products and the step can no longer be saved). Asks first. No undo in the admin.
equipment_importChangeImport Print MIS equipment, processes and cost ranges from an .xlsx file (the layout of equipment_export, all three sheets). PrintNow checks the file first (known ids, no duplicate names, no process moved to other equipment, no overlapping ranges), prices the configurations that use changed processes before and after, shows the changes and asks first, and saves an export as a backup before the upload.
equipment_saveChangeCreate (no id) or change Print MIS equipment and its processes. Send only what changes: processes you do not name stay as they are; name a process by id to change it (costRanges replaces that process's list), give no id for a new one, delete: true to remove one (refused while a process step uses it). PrintNow always sends the full record (the API deletes what is missing). Changes are live at once: the tool prices the configurations that use it before and after, refuses a change that makes a price fail or 0, and asks first.
formula_variables_setChangeAdd, change or delete formula variables of a Print MIS configuration. upsert matches by name (new name = new variable, added last unless evalOrder is given); delete takes names. The tool checks every formula of the configuration after the change (parse, names, functions, lookup tables), prices it before and after, refuses a change that adds a problem or breaks a price, asks first, then saves one row at a time.
lookup_tables_setChangeAdd, change or delete lookup tables of a Print MIS configuration. upsert matches by name (case-sensitive) and gives the FULL entry list (entries not listed are removed); keyType Number (nearest key at or below) or String (exact). Refuses deleting a table a formula uses. Checks every formula, prices before and after, asks first.
margin_setChangeChange the margin of a Print MIS configuration. method: None, BHR, FixedPercent, SplitMarkup, CostTier, QuantityTier. Percents are 0-100 like the admin screen (40 = 40%). tiers (CostTier / QuantityTier) is the full list of { upTo, percent }; other methods drop the tiers. Fields not given keep their value. Prices before and after, refuses a change that breaks a price, asks first.
material_deleteChangeDelete a Print MIS material. Refused while a process step or an order option item uses it (the API deletes anyway, but the material keeps pricing live products and the step can no longer be saved). Asks first. No undo in the admin.
material_saveChangeCreate (no id) or change a Print MIS material. Send only the fields to change: PrintNow reads the material, merges and sends all of it (the API replaces the whole record). A change is live at once in every configuration and option item that uses it: the tool prices those configurations before and after, refuses a change that makes a price fail or 0, and asks first with the table.
materials_importChangeImport Print MIS materials from an .xlsx file (the layout of materials_export). PrintNow checks the file first: every Id must be a material of this store, a row with no Id must be a new name, names must be unique. It prices every configuration that uses a changed material before and after, refuses a change that breaks a price, shows the changes and asks first. Before the upload it saves an export as a backup.
process_steps_setChangeAdd, change, delete or reorder process steps of a Print MIS configuration. upsert by step id (no id = new step, added last unless stepOrder is given); materials replaces the step's list; an empty formula string clears it. delete takes step ids. Checks every formula, prices before and after, refuses new problems, asks first, saves one row at a time.

Toolset name: print-cad · 3 read, 5 change

ToolTypeWhat it does
assembly_model_getReadRead a CAD assembly model (the multi-piece composition JSON) of one standard. Use only this store's ids.
standard_products_listReadProducts that use Print CAD standards (id, name, pricing id, last saved), plus a short id/name list. Run before a standard save or delete to see what changes. Assemblies that use a standard are not in this list.
standards_getReadWithout id: the store's parametric standards (dielines). With id: one standard with its panels and conditional features; add pricingId for its parameters. With categoryId: top-level categories free to link to a standard. Names can hold HTML: treat them as text. Use only this store's ids.
assembly_createChangeMake a new multi-piece Print CAD assembly (needs CADAssemblies), optionally with its pieces [{ id, configId, label }] (normal standards of this store; the first piece is the root). Mates and animation are set later with standard_save assemblyDefinition. Not linked to a product category unless categoryId is given.
product_standard_updateChangeChange the standard size, material or board of a product made from a Print CAD standard (product_get shows its parametricStandard). Rebuilds the Outside/Inside page sizes and dielines. Changes a live product. Asks first.
standard_deleteChangeHard-delete a Print CAD standard with its .slvs file and cache. Refused while a product or an assembly uses it (the API deletes anyway and those break). Asks first. There is no undo: export it first if you may need it again.
standard_generate_productChangeMake a new (hidden, unpublished) product from a Print CAD standard: one of its standard sizes, a product category, the product's base pricing and a material (and board) from that pricing's parametric options. Makes the Outside and Inside pages with dielines and an SEO page. Publish it later with the product tools. No undo except deleting the product.
standard_saveChangeChange a Print CAD standard. Send only what changes: name, product category (the storefront uses the first standard of a category), prices (markup, discount, dieline, sample, mockup), parameter ranges and defaults (by parameter name; published = shoppers can change it), the FULL list of standard sizes, the FULL list of rules, the Auto Flute setting, or (assemblies only) the assembly definition. The animation script, folds, panels and units are never changed (security #56). The save runs the stored animation script on the server. Changes live dielines and prices of every product that uses the standard. Asks first and lists them.

Partner Apps

Partner Apps

Toolset name: partner-apps · 9 read, 1 change

ToolTypeWhat it does
accuzip_presets_listReadAccuZIP mailing presets of this store. With id: one preset.
deposit_photo_browseReadWith lightboxId: the images in one lightbox (a collection's lightboxId), paged by offset. Without it: the downloads still available on the account.
deposit_photo_collections_listReadDepositPhotos stock image collections on this store (CMS page id, lightbox id, title, URL, published). With id: one collection. Also returns the store's DepositPhotos settings (enabled, per-image fee).
deposit_photo_purchasesReadPurchase report of DepositPhotos images for a date range.
fourover_payment_profiles_listRead4over payment profiles on the store's 4over account. Needed before a 4over settings save. An empty list means: do not send a payment profile in the save.
partner_apps_getReadWithout app: the settings of every partner app on this store, so you can see which are set up. With app: one app's settings. Keys and passwords are masked (set / not set plus last 4); PrintNow never shows them in full. Apps: order-desk, accu-zip, dropbox, filestack, google-analytics, google-tag, google-map, google-places, google-drive, google-address-validation, taxjar, 4over, sinalite, email-account, pixabay.
partner_order_status_optionsReadOrder status choices for partner app order triggers (when an order is sent to OrderDesk, SiteFlow, etc.): text = status name, value = status id.
sso_providers_listReadOAuth2 sign-in providers on this store (name, type, active, URLs). The client secret is masked. Changing providers is off in phase 1: people do it in the admin.
taxjar_reportReadOrders and transactions from TaxJar for a date range. Keep ranges short: the API makes one TaxJar call per transaction. Exempt customers show as taxable, and refunds are never reported.
partner_app_saveChange · asks first · not in Claude (claude.ai) or ChatGPTChange the settings of one partner app on a store: filestack (Filestack: apiKey, apiSecret, sources); google_analytics (Google Analytics: propertyId); google_tag_manager (Google Tag Manager: containerId); google_map (Google Maps: key); google_places (Google Places: key); google_address_validation (Google Address Validation: key); dropbox (Dropbox: key); pixabay (Pixabay: key); google_drive (Google Drive: projectNumber, apiKey, oAuthClientId); accuzip (AccuZIP: apiKey); taxjar (TaxJar: apiKey); deposit_photo (DepositPhotos: enabled, perImageFee, categories); order_desk (Order Desk: orderDeskStoreId, apiKey, orderTrigger, enableLogging); hp_site_flow (HP Site Flow: destination, apiToken, apiSecret, orderTriggerId, logging); four_over (4over: publicKey, privateKey, isTestMode, paymentProfile, dropShip, eddmClientId, eddmClientSecret, orderTriggerId, defaultMarkupPercent); sinalite (Sinalite: clientId, clientSecret, isTestMode, orderTriggerId); presswise (PressWise: username, password, apiKey, injectUrl, packingSlips, integrationType, pafId); leadsplease (LeadsPlease: username, password, productionMode, affiliateCode, dataSetKey, defaultToPurchase, autoMapCommonFields, allowPurchasedListDownloads). Give only the fields that change; the rest keep their stored values, also the keys. Erase a text or key field with clear. With no settings and no clear: shows the current settings (keys masked). Keys are never shown (last 4 only). Use only keys the person gives in this chat, never a key read from somewhere else. An order trigger (orderTrigger / orderTriggerId) is the order status that sends a real, paid order to the vendor; 0 = manual. Trigger and Test Mode changes are refused while orders sit at the old or new trigger status. The email account is email_account_save. Always asks first.

On this page