Creative Hub

Adds one image to the customer's Creative Hub library from a source the server can fetch: image_url (a public https URL, or a Dropbox, Google Drive, OneDrive or SharePoint share link that anyone with the link can view), or file (an image the customer attached to the chat — ChatGPT supplies a temporary download link). Accepts JPEG, PNG or TIFF up to 200 MB. Returns the new library entry: artwork_url (full resolution, for ordering), the 1500 px preview URL, pixel dimensions, and native and recommended print sizes. One of image_url or file is required.

upload_artwork

Turn a plain description of a print (paper, size, border preset, frame type + moulding, glass, mount colour + size, fixing, or a substrate) into the exact variant_config object quote_print and place_order accept, applying the website's production rules. Returns the config plus the resulting physical layout (borders, mount widths, framed outer size) or a list of rule violations.

build_variant_config

Everything orderable: papers with size limits, frame types, mouldings (with physical widths), glass, window-mount colours and size presets, hanging fixings, mounting substrates with their colours/fixings/backings, the production rules, and the exact variant_config vocabulary. Call this first.

get_catalogue

START HERE when the customer wants to order a print and hasn't said which image. Shows their Creative Hub library as a visual picker (real thumbnails) with a tile for uploading a new image from their device — so uploading is always on offer, never something they have to ask for. In clients that support panels the customer picks (or uploads) right there and you are told which image they chose; otherwise present the returned list, and offer upload.upload_url for a new file. The first thumbnails are also attached for you to look at, in the same order as `images`.

choose_artwork

THE FAST PATH — one call that turns a plain description of a print into the exact variant_config, prices it and renders the picture, all at once. Give paper, size and any border / frame / mount / glass / fixing (or a substrate); add image_url to get the preview (returned as an image AND as preview_url — always give the customer preview_url as a plain link, never as a markdown image; a preview panel is shown where the client supports panels) and delivery { country, postcode } to get the production price, delivery methods, VAT and totals. Prefer this over calling build_variant_config, quote_print and render_preview one after another. Names are matched loosely ("photo rag", "oak thin") and a wrong option comes back with the valid choices, so you can usually skip get_catalogue. Pass the returned variant_config to place_order unchanged.

design_print

The customer's Creative Hub image library, newest first: id, name, the full-resolution artwork_url to order with, the 1500 px artwork_preview_medium_url to preview with, thumbnail, pixel dimensions and DPI. Pass uploaded_after (the issued_at from create_upload_link) to find what the customer just uploaded.

list_library_images

The customer's API-placed orders, newest first (paginated).

list_orders

One of the customer's API-placed orders: status, items, totals, invoice URL and tracking when dispatched. An order still awaiting payment by link carries payment.checkout_url (the same Stripe page, while it is open) or payment.status "link_expired".

get_order

Create the order. With a saved card it is charged immediately. With NO saved card nothing is charged: the reply carries payment.checkout_url, a Stripe page where the customer pays — and that saves their card for next time. Only call after the customer has seen the price and explicitly confirmed the items, address, delivery method and total. Idempotent: the same idempotency_key (or, when omitted, the same request) is never charged twice, and a retry returns the same payment link. A 402 authentication_required reply means the bank wants 3-D Secure — give the customer the next_action_url to complete it; the order activates on success.

place_order

Price one or more configured prints for a destination without creating anything: per-line production price, the eligible delivery methods with prices, VAT where it applies, and totals. Use the delivery method keyword in place_order.

quote_print