Get the payment link
create_checkoutIdempotent
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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| order_id | Yes | The order_id returned by start_print_order. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| spec | Yes | The print as the customer has described it so far, beside garment. Null where they have not said; still_needed lists what is missing. | |
| notes | Yes | Relay these to the customer. | |
| saved | Yes | Whether the order is saved to a customer account (save_progress). | |
| status | Yes | ||
| artwork | No | ||
| choices | No | Answers the customer can pick from, one set per field ask_next asks about. Offer them as selectable options where your client can, otherwise as a short list. They are suggestions: colors are families and the customer may name any shade, quantity and width may be any number. Send whatever they answer to describe_order. | |
| garment | No | The garment on the order, and what mockup_url shows. Name it when you show the picture; when it is provisional, say so. | |
| options | No | ||
| ask_next | No | Ask the customer this, in your own words, and send the answer to describe_order. | |
| order_id | Yes | ||
| next_call | Yes | What to call next, and why. | |
| expires_at | No | When an unsaved order expires; null once it is saved to an account or paid. | |
| mockup_url | No | The garment on the order, in the customer's color, with their design on it once we have it. An image address: show it as a picture where your client can, never as text or as a link, and never describe it in place of the summary. | |
| alternatives | No | Present from the moment several styles fit until the customer picks, beside whatever ask_next asks: show all of them with their summaries and prices, say the first is what we will use unless they choose, and call choose_style with the id they pick (or send "any" to describe_order to keep the first). | |
| checkout_url | No | Show it to the customer as one link labeled "Pay and enter shipping", not as a bare address: they see the artwork and total, confirm their email with a code we send them, then pay and enter their address there. | |
| mockup_views | No | Every side of the garment, the printed one first: mockup_url with the design, then the other sides plain. Where your client can show pictures, show them all, so the customer sees which sides stay blank. | |
| still_needed | Yes | Fields the customer has not told us yet, and any go-ahead we are waiting on for something the order cannot carry. | |
| chosen_option | No | ||
| artwork_upload_url | No | Present until the design is accepted. Show it to the customer as one link labeled "Upload your design", not as a bare address: they drop their design file on that page and it is checked there. You cannot upload for them. |