Skip to main content
Finerworks logo
  • Category: ecommerce
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 33
  • Triggers: 0
  • Slug: FINERWORKS
  • Version: 20261101_00

Tools

Slug: FINERWORKS_ADD_IMAGESAdd up to five images with metadata and URIs to a FinerWorks library. This operation is not available to external accounts.

Input Parameters

array
required
List of up to 5 image details.
object
required
Target library information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_DELETE_IMAGESSoft-delete image files from a FinerWorks library by GUID; for inventory-library images, this also removes assigned virtual inventory products. A successful response can occur even when a GUID was not found.

Input Parameters

array
required
Array of unique identifiers (GUIDs) for images to delete.
object
required
Library location parameters indicating where the images are stored.
string
Only accepted for authorized accounts; otherwise ignored. Leave as null if not authorized.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_DELETE_PENDING_ORDERSTool to remove orders from temporary storage that were saved as pending. Use when you need to delete pending orders by their identifiers.

Input Parameters

array
required
Collection of identifiers linked to pending orders to be deleted
string
Account identifier for order assignment; only honored for authorized accounts, otherwise disregarded

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_DELETE_VIRTUAL_INVENTORYTool to delete virtual inventory products by SKU. Use when removing products from virtual inventory. Note that deleted items will lose any sync connection with 3rd party platforms.

Input Parameters

array
required
List of SKU identifiers to delete from virtual inventory. These products will be removed and any sync with 3rd party platforms will be disconnected.
string
Updates virtual inventory by account key. Only accepted for authorized accounts with appropriate permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_DISCONNECT_VIRTUAL_INVENTORYTool to disconnect ALL virtual inventory items from a 3rd party platform. Use when you need to remove platform data (e.g., Shopify, WooCommerce, Etsy) from all virtual inventory items.

Input Parameters

string
required
Name of platform to be disconnected (e.g., woocommerce, shopify, etsy)
string
Optional parameter for accounts with permission; will only be accepted for accounts with permission to utilize this parameter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_FETCH_ORDER_STATUSRetrieve FinerWorks order status and shipment tracking details by order IDs or purchase order references. When both are supplied, order IDs take precedence; PO lookup returns at most five recent matches.

Input Parameters

array
List of unique order submission reference IDs. At least one of order_ids or order_pos must be provided.
array
List of unique order submission order_pos values. At least one of order_pos or order_ids must be provided.
string
Only accepted for authorized accounts; leave null otherwise

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_GET_COMPANY_INFOTool to get essential information about FinerWorks including site identifier, company address, and operating hours. Use when you need to retrieve FinerWorks’ contact information or business location details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_GET_FRAME_DETAILSTool to retrieve detailed specifications for a specific frame by ID. Returns dimensions, pricing, material info, size constraints, and URLs for visual references. Use when you need complete frame specifications for order processing or product catalog display.

Input Parameters

integer
required
Id number of the frame to retrieve details for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_GET_PRICESRetrieve pricing breakdowns for FinerWorks product SKUs and quantities. Returned total prices are per unit and do not multiply in the requested quantity.

Input Parameters

array
required
List of products to get pricing for (1-50 items)
string
Optional parameter for accounts with permission, otherwise ignored

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_GET_SHIPPING_OPTIONS_IDSTool to list all available shipping option IDs from FinerWorks. Use this to retrieve IDs for various shipping methods that can be used for cross-reference purposes when configuring orders. Sites should periodically check and update this data in case new shipping methods are added or deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_GET_USERRetrieves the authenticated user’s FinerWorks account profile including billing/business addresses, account credits, shipping preferences, connected platforms, and gallery settings. Use this to get user details like account_key, email, credits balance, or to verify authentication.

Input Parameters

string
Account unique identifier (UUID). Only required if fetching a different user’s profile and your app key has permission. Leave empty to get the currently authenticated user’s profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_LIST_FILE_SELECTIONTool to retrieve the list of currently selected files by their master guid. Use when you need to see which file GUIDs are grouped under a specific selection key.

Input Parameters

string
required
The master key (UUID) assigned to all files that are selected. This groups multiple file GUIDs together.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_LIST_FRAME_COLLECTIONSRetrieve available frame collections and categories from FinerWorks. Use this to discover frame options for print orders. Pass a collection ID to get detailed frame specifications within that collection, or filter by product code to see only compatible frames. Returns all collections if no filters specified.

Input Parameters

integer
Filter by collection ID. Required to get a list of available frames in this collection.
string
Filter by product code to only show collections/frames compatible with your print product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_LIST_GALLERIESTool to list galleries setup in GeoGalleries.com for the user’s account. Use when you need to retrieve available galleries, filter by personal galleries, or get specific galleries by their IDs.

Input Parameters

boolean
When true, lists only the authenticated user’s personal galleries. When false or omitted, lists all accessible galleries.
string
User account for the request; only accepted for authorized accounts. Leave empty to list galleries for the authenticated user.
Filters results by specific gallery identifiers. Pass an array of gallery ID numbers to retrieve only those galleries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_LIST_GLAZINGRetrieve available glazing and glass options from FinerWorks. Use this to discover glazing choices (UV protection glass, acrylic, etc.) for framed prints. Call without parameters to list all glazing options, or pass a specific ID to filter results.

Input Parameters

integer
Filter results by specific glazing identifier. If omitted, all glazing options are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_LIST_IMAGESTool to retrieve a paginated list of image files uploaded to your FinerWorks account. Use this to browse your image inventory, search by filters, or get specific images by GUID. Supports pagination, sorting, date filtering, and gallery filtering.

Input Parameters

boolean
Filter by active/inactive status.
object
required
Object containing image location parameters (name, session_id, account_key, site_id).
integer
Results per page (default: 10, max: 50).
string ("id" | "title" | "file_name" | "file_size" | "date_updated" | "date_added")
Sort field options for listing images.
array
Filters by specific image unique identifiers (GUID).
integer
Pagination control - page number to retrieve.
boolean
Include virtual inventory products in response (default: false).
string
Filters by title or description text.
string ("DESC" | "ASC")
Sort direction options.
string
Filter by latest upload date (format: YYYY-MM-DD).
string
Filter by earliest upload date (format: YYYY-MM-DD).
Filters by public gallery IDs (numbers).
Filters by personal gallery IDs (numbers).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_LIST_MATSRetrieve available matting options from FinerWorks for framing products. Mats include specifications like dimensions, colors, thickness, and pricing. Use this to discover valid mat IDs and specifications before configuring framed prints.

Input Parameters

integer
Optional mat ID to filter results. If omitted, all available mats are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_LIST_MEDIA_TYPESRetrieve available print media types from FinerWorks. Media types represent printing substrates (e.g., canvas, paper, vinyl) and include associated product type and style information. Call without parameters to list all media types, or pass specific IDs to filter results.

Input Parameters

array
Optional list of media type IDs to filter the results. If omitted, all media types are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_LIST_ORDER_STATUS_DEFINITIONSList FinerWorks order status definitions and their IDs and labels. Use the order status ID for reference when labels are redundant or change wording.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_LIST_PRODUCT_TYPESRetrieve FinerWorks product types (print categories like Canvas Prints, Metal Prints, Posters, etc.). Use this to discover available printing options and their media IDs before placing orders. Returns all product types if no IDs specified, or filtered results for specific IDs.

Input Parameters

array
List of product type IDs to filter results. If empty, returns all product types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_LIST_SHIPPING_OPTIONS_MULTIPLERetrieve shipping options and rates for multiple orders in a batch request. Use this tool to get available shipping methods, rates, and estimated delivery times before submitting orders. Returns all available shipping options for each order with pricing breakdown including shipping rate, taxes, and total cost. The returned shipping_code values (e.g., ‘FL’, ‘GD’, ‘2A’) should be used when submitting the actual order via submit_orders. Supports both US domestic and international shipping destinations.

Input Parameters

array
required
One or more orders to rate (up to 50 orders per request). Each order must include recipient address, order items with SKU/quantity, and preferred shipping class code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_LIST_STYLE_TYPESRetrieves available print style types from FinerWorks. Style types define how prints are formatted (e.g., border sizes, canvas wraps, panel depths). Use this to discover valid style_type_id values needed when creating print orders or configuring products. Each style type includes sizing constraints, framing options, and border/bleed specifications.

Input Parameters

array
List of style type IDs to filter results. Pass an empty array [] to retrieve all style types. Pass specific IDs like [10, 11] to filter to those styles only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_LIST_VIRTUAL_INVENTORYTool to retrieve a user’s virtual inventory products from their FinerWorks account. Use when you need to list products with valid product codes, search by SKU or product code, or filter by creation date. Returns paginated results with product details including pricing, images, and stock information.

Input Parameters

integer
Number of results per page (default 10, maximum 50).
array
List of product SKUs to filter results (maximum 50 SKUs).
string
Field to sort results by. Valid options: id, title, file_name, file_size, updated, or date_added.
string
Account key for retrieving inventory from a specific account (only available to authorized users).
array
List of image GUIDs for filtering products by associated images.
integer
Page number for pagination (starts at 1).
string
Text search filter to match against product title or description.
string
Sort direction: DESC (descending, default) or ASC (ascending).
string
Filter products created on or before this date (ISO 8601 format).
string
Filter products created on or after this date (ISO 8601 format).
array
List of product codes to filter results (maximum 50 codes).
string
String search filter for third-party connection data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_SAVE_PENDING_ORDERSTool to save orders to temporary pending storage. Use when orders need review or modification before final submission.

Input Parameters

array
required
Array of order objects to save as pending
string
required
Platform origin (e.g., api_test, excel, shopify, etsy). Maximum 50 characters.
string
Assigns orders by account. Only accepted for authorized accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_SUBMIT_ORDERSTool to submit up to five new orders. Use after all customer and line-item details are finalized.

Input Parameters

array
required
Up to 5 orders to submit
boolean
If true, only validate payload; no submission

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_UPDATE_APP_DETAILSTool to update the details assigned to the app_key being used. Use when you need to modify app name, description, miscellaneous data, or live mode status.

Input Parameters

object
required
Details about the app that your app_key is assigned to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_UPDATE_FILE_SELECTIONTool to update a user’s currently selected image files using the selection key. Use when you need to replace the current set of files associated with a selection GUID after authentication.

Input Parameters

string
required
Master key (GUID) assigned to this group of selected files
array
required
List of file GUIDs to set as the current selection. Can be empty to clear the selection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_UPDATE_IMAGESUpdate image metadata by GUID, including titles, descriptions, visibility and gallery assignments; inventory-library images also have their assigned virtual inventory products removed. Omitted titles reset to the file name, omitted descriptions are cleared, and supplied gallery subcategory assignments replace prior assignments.

Input Parameters

array
required
List of images to update. Each image must have a ‘guid’ field and optional fields to modify.
string
Optional account identifier; requires proper permissions to update images on behalf of another account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_UPDATE_USERTool to update various features of a user’s account profile. Use when you need to modify billing/business info, logos, or payment profile after retrieving current account.

Input Parameters

string
Public URL of existing logo; omit to leave unchanged
string
Raw JPG bytes for logo; will be base64-encoded automatically; omit or null to leave unchanged
string
required
Account unique identifier (UUID). Required. Obtain from get_user action.
object
Billing address; omit or null to leave unchanged
object
Business address; omit or null to leave unchanged
string
Raw JPG bytes for portrait; will be base64-encoded automatically; omit or null to leave unchanged
string
Braintree customer ID for billing API orders

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_UPDATE_VIRTUAL_INVENTORYUpdate up to 50 existing virtual inventory items by SKU, including pricing, stock quantities, descriptions, and third-party integrations. Each update overwrites the item’s fields; omitted values can be cleared or reset, so provide the full record.

Input Parameters

string
Optional account key to update inventory for a specific account. Only accepted for authorized accounts; leave null if unauthorized.
array
required
Array of virtual inventory items to update. Update up to 50 items at a time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINERWORKS_VALIDATE_RECIPIENT_ADDRESSTool to validate and test a recipient address before submitting an order to ensure delivery accuracy. Use this to verify address correctness and get standardized formatting from the shipping carrier’s validation service.

Input Parameters

object
required
Recipient address details to validate before order submission

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not