Review the cart before ordering
prepare_checkoutCheckout's review of the whole cart in the current buying context, as printdash.io's checkout shows it: every line with its artwork state and Printdash's file notices, delivery to a saved address (address_id, else the default) or pickup where the account has it, the order reference (required, up to 50 characters), notes, a PO number for a Team on account, is_whitelabel (Remove Printdash Branding), the totals from Printdash's own delivery pricing, expected_total, and what placing it will do: placed unpaid with a pay link on printdash.io, on the Team's account, or held for a Team owner's approval. When it is ready, the summary and a confirmation_token for place_order. Writes nothing; nothing is ordered until place_order is called after the customer agrees. Printdash prints in Australia and delivers within Australia only; prices are in AUD and include GST. Needs a signed-in Printdash account: called without one, the connection asks the customer to sign in on printdash.io.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | No | Notes for Printdash's team about this order. | |
| po_number | No | A Team on account: the purchase order number (required when the Team says so). | |
| reference | No | The order reference, required as at checkout: a name for this order. Kept to 50 characters. | |
| address_id | No | A saved address id for delivery (list_addresses). Omit for the context's default address. | |
| fulfilment | No | pickup only where the account has it (pickup_available). | |
| is_whitelabel | No | Remove Printdash Branding, as the checkout switch. Default false. | |
| payment_method | No | A request: a Team with approved terms orders on account unless card is asked for; Printdash decides. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | Yes | ||
| lines | Yes | ||
| notes | Yes | ||
| ready | Yes | ||
| action | No | ||
| totals | Yes | ||
| details | No | ||
| payment | Yes | ||
| summary | No | Show this to the customer exactly as written before placing the order. | |
| blocking | No | ||
| currency | Yes | ||
| po_number | Yes | ||
| reference | Yes | ||
| address_id | Yes | ||
| deliver_to | Yes | ||
| expires_at | No | ||
| fulfilment | Yes | ||
| checkout_url | Yes | ||
| service_area | Yes | ||
| is_whitelabel | Yes | ||
| expected_total | Yes | The total the customer is shown; place_order is refused if Printdash's own total differs. | |
| pickup_available | Yes | ||
| confirmation_token | No | ||
| prices_include_gst | Yes | ||
| confirmation_required | No |