start_print_order
Start a print order
Opens a print order. Use it when the customer wants a design printed on a garment. Call it before asking your own questions: our first reply asks for the design and the garment in words written for the customer. Pass what they have said about the order in context — a phrase or a paragraph is fine. Returns the order_id to use with every other tool, what is still needed, and the next question to ask.
輸入參數context
describe_order
Describe the order
Records more about what the customer wants — an answer to ask_next, a correction, or a whole paragraph — and reports what is still needed. Call it each time the customer gives a new detail. In clients that render our order card the customer sees the order so far and the question in ask_next with its choices as buttons; when several styles fit it shows them too. An answer or a pick made there arrives as a message; the question in ask_next is for the customer whether or not the card shows. Also records a decision about the order: a stop, an objection to the price or the date, or a request we do not offer. It belongs to the order's record, and the reply says what the order still needs.
輸入參數context必填order_id必填
Lands one of the choices the last reply offered beside ask_next, by field and option, exactly as shown. Use it when the customer picks one of them; an answer in their own words goes to describe_order instead.
輸入參數field必填option必填order_id必填
choose_style
Choose a garment
Lands the order on one of the alternatives describe_order offered, by id, or on the style already chosen. Use it when the customer picks one of them; a pick in their own words can still go to describe_order. Pass color when they picked a picture from preview_colors or want the style in another shade: the style lands in that shade in one call.
輸入參數colororder_id必填style_id必填
preview_colors
Preview colors
Shows the customer's design on the garment in other colors without changing the order: one picture per offered style per color named, up to four colors. Use it when the customer wants to compare colors or see one before deciding; `describe_order` with a new color changes the order, this compares without changing anything. In clients that render our color preview the customer can pick a picture there and their pick arrives as a message; otherwise, when they pick, call choose_style with the style_id and color.
輸入參數colorsorder_id必填
submit_artwork
Send the design
Sends the design to be printed when you already hold a public https link to the original file; never ask the customer for one, they upload through the artwork_upload_url from any reply. We check whether it will print well at the requested size and answer in inches, with what to fix if anything. A design you only saw in the chat is not one you hold: never transcribe, redraw or regenerate it; give the customer the artwork_upload_url instead. Artwork can be replaced later.
輸入參數filenameorder_id必填image_urlimage_base64
get_options
Get priced options
Returns priced options with lead times once the order is fully described and the artwork has passed the print check. Present them to the customer; each has an id for choose_option. In clients that render our option picker the customer can pick there, and you will see the choice as a message. Call it again whenever the customer asks to see or reconsider the options; it costs nothing. Prices come from us and cannot be passed in.
輸入參數order_id必填
choose_option
Choose an option
Locks in the option the customer picked from get_options, and its price. Pass the option id exactly as returned. There is no way to pass a price.
輸入參數order_id必填option_id必填
create_checkout
Get the payment link
Returns the payment link for a fully specified order with a chosen option. Show checkout_url to the customer as a link labeled "Pay and enter shipping": they see their artwork and total, confirm their email address with a code we send them, then pay and enter their shipping address. Nothing is ordered until they pay. Refuses, and says what is missing, if the order is not ready. When the customer is signed in, asking to pay also saves the order to their account, so it stops expiring.
輸入參數order_id必填
resume_order
Resume an expired order
Picks up an order that another tool refused as expired. Applies only after that refusal, with the same order_id, when the customer wants to continue that order rather than start over: it gives the order a fresh window and fresh links and returns where things stand, so you can carry on with the call next_call names. Without a refusal there is nothing to resume; start_print_order opens a new order.
輸入參數order_id必填
save_progress
Save the order to my account
Saves the customer's order to their account so they can pick it up from any conversation; a saved order never expires. Needs the customer to be signed in: if they are not, your client will ask them to sign in or create an account with us, then call this again. Applies when a response's notes offer saving, or when the customer asks to save, to come back later, or to keep their order.
輸入參數order_id必填
Lists the signed-in customer's orders with us, open and paid, each with its status. Needs the customer to be signed in; if they are not, your client will ask them to. Applies when the customer asks what they have with us, wants to pick up a saved order, or asks where an order is.
輸入參數include