Handwrytten

These are the Handwrytten actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• Check Authentication

  Tool to verify API key authentication validity for Handwrytten. Use when you need to test if the API credentials are valid and properly configured.

• Get Basket (New Method)

  Tool to retrieve the user's basket using the new method. Use when you need to fetch the current state of the shopping basket with all items, billing information, and totals.

• Get Current User Info

  Tool to retrieve information about the currently authenticated user. Use when you need to fetch user profile details, account information, or verify authentication status.

• Get List of Addresses

  Tool to retrieve a list of all addresses associated with the user's account. Use when you need to view or select from saved addresses for sending handwritten cards.

• List Cards

  Tool to retrieve a list of available Handwrytten cards with optional filtering and pagination. Use when browsing card catalog or searching for specific card types.

• List Recipients

  Tool to retrieve a list of recipient addresses that the user has previously saved. Use when you need to view or select from saved recipient addresses for sending handwritten cards.

• Place Order in Basket

  Tool to add an order to the basket in Handwrytten. Use when you need to create a new handwritten card order with specified recipients, card design, message, and delivery details. The order can be placed immediately or scheduled for future delivery.

• Add Recipient

  Tool to add a recipient address to the user's addressbook in Handwrytten. Use when you need to store a new recipient for sending handwritten cards.

• Calculate Order Taxes

  Tool to calculate taxes for Handwrytten basket orders. Use without any parameters for basket orders, or optionally provide order details to calculate taxes for a specific order (experimental).

• Clear Basket

  Tool to clear all items from the shopping basket. Use when you need to empty the basket and remove all pending items before starting a new order or canceling the current selection.

• Create Template

  Tool to create a new template for the current user. Use when you need to save a new message template for sending handwritten cards.

• Create User Address

  Tool to create a new user address in Handwrytten. Use when adding a new return address to a user's profile for sending handwritten cards.

• Delete Custom Image

  Tool to delete a custom image/logo from Handwrytten. Use when you need to remove a previously uploaded custom image or logo from your account.

• Delete Recipient Address

  Tool to delete one or more recipient addresses from user's profile. Use when you need to remove saved recipient addresses. Provide either address_id for single deletion or address_ids for bulk deletion.

• Delete Template

  Tool to delete a user's template by its ID. Use when you need to remove a saved template from the user's account.

• Get Basket Count

  Tool to retrieve the count of items currently in the basket. Use when you need to check how many items are in the shopping basket before proceeding with checkout or additional operations.

• Get Basket Item

  Tool to retrieve a basket item by its ID from Handwrytten. Use when you need to get details of a specific basket item.

• Get Card Details

  Tool to get detailed information about a specific card in the Handwrytten catalog. Use when you need comprehensive details about a card including pricing, dimensions, images, and customization options.

• Get Random Cards

  Tool to retrieve random cards from Handwrytten. Use when you need to get a random selection of greeting cards from the Handwrytten catalog.

• Get Template Details

  Tool to get detailed information about a card text template in the Handwrytten catalog. Use when you need to view the template message content and details.

• Get User Address

  Tool to retrieve the authenticated user's address and billing information. Use when you need to access user profile address details.

• List Basket Orders Grouped

  Tool to list all basket orders grouped by basket. Use when you need to retrieve all items currently in the user's basket or review pending orders.

• List Categories

  Tool to retrieve the list of available card categories from Handwrytten. Use when you need to display category options or filter cards by category.

• List Countries

  Tool to retrieve the list of countries available in Handwrytten. Use when you need to get available countries for sending handwritten cards.

• List Credit Cards

  Tool to list all credit cards associated with the Handwrytten account. Use when you need to retrieve stored payment methods and billing information.

• List Custom User Images

  Tool to retrieve a list of custom user images uploaded to Handwrytten. Use when you need to browse or manage custom cover images or logos.

• List Fonts

  Tool to retrieve the list of available handwriting fonts. Use when you need to display font options or select a font for a handwritten message.

• List Fonts for Customizer

  Tool to list fonts available for use with the card customizer. Use when you need to retrieve available font options for customizing handwritten cards.

• List Gift Cards

  Tool to retrieve the list of available gift cards with their denominations and pricing. Use when you need to see what gift card options are available for purchase through the Handwrytten API.

• List Inserts

  Tool to retrieve a list of available inserts from Handwrytten. Use when you need to view all inserts that can be included with handwritten cards.

• List Orders

  Tool to retrieve a list of user's past orders from Handwrytten. Use when you need to view order history or check the status of previously placed orders.

• List Orders Grouped

  Tool to retrieve the user's order history grouped by basket. Use when you need to view or analyze past orders.

• List Past Baskets

  Tool to retrieve a list of user's past baskets. Use when you need to view historical basket information including orders, recipients, and totals.

• List Past Orders

  Tool to retrieve a list of user's past orders from Handwrytten API. Use when you need to view order history or check the status of previously placed orders.

• List Signatures

  Tool to retrieve the list of available signatures for use in card orders. Use when you need to display signature options or select a signature for a handwritten message.

• List States

  Tool to retrieve the list of states/provinces available in Handwrytten. Use when you need to get available states for addressing handwritten cards.

• List Template Categories

  Tool to retrieve the list of available template categories from Handwrytten. Use when you need to display template category options or filter templates by category.

• List Templates

  Tool to retrieve a list of card text templates from Handwrytten. Use when you need to display available templates or filter templates by category.

• Logout User

  Tool to logout user from Handwrytten application. Use when you need to terminate the current user session and invalidate the authentication token.

• Register User

  Tool to register a new Handwrytten user account. Use when creating a new user with email and password. Sends activation email to user; user status is not_active until email is confirmed.

• Request Password Reset

  Tool to request a password reset email for a Handwrytten account. Use when a user needs to reset their password and requires an email with reset instructions. The API will send an email with a password reset link if the provided email exists in the system, but will return success regardless to prevent email enumeration attacks.

• Set Default Address

  Tool to set a default return address for the user in Handwrytten. Use when you need to designate a specific address as the default return address for sending handwritten cards.

• Set Test Mode

  Tool to set test mode for the current Handwrytten user. Use when you need to enable or disable test mode for testing purposes. When enabled, cards will not be sent and money will be returned to the credit card.

• Update Basket Item

  Tool to update an existing basket item in Handwrytten. Use when you need to modify card details, recipient addresses, messages, or other basket item properties.

• Update Billing Information

  Tool to update user billing information (country, zip, address) for tax calculations in Handwrytten. Use when updating billing address details for accurate tax computation.

• Update Recipient

  Tool to update a recipient address in the user's addressbook in Handwrytten. Use when you need to modify an existing recipient's address details.

• Update Template

  Tool to update an existing user template in Handwrytten. Use when you need to modify a template's name or message content.

• Upload Custom Logo

  Tool to upload a custom image (logo or cover) to Handwrytten for use with custom cards. Use when you need to add a custom logo or cover image that can be referenced in future card creation requests.