Preview a card
preview_cardShow a prepared card’s finished surfaces before payment when preview_available is true. Optional, never required to buy. Returns images and their order revision, plus preview_url for clients that need a browser. Preview again after changes. This does not change, charge or mail the order.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"order_id": "<order_id>",
"order_access_token": "<order_access_token>"
},
"name": "preview_card"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| faces | No | Surfaces to render; omission means both. Outside/inside are front/back for postcards and flat cards, or cover/inside for folded cards. | both |
| card_id | No | ID from this order.cards[].id. Required when the order has more than one card; omit to preview its only card. | |
| order_id | Yes | Parent order.id returned by prepare_order, revise_order or read_order. Use the matching private token. | |
| expected_revision | No | Parent order.revision returned by prepare_order, revise_order or read_order. If supplied, a mismatch fails with CONFLICT; omission previews the current revision. Preview again after changes. | |
| order_access_token | Yes | Exact private order_access_token returned by prepare_order or revise_order for this order. Keep it private and never invent one. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| data | Yes |