Skip to main content
New to Corsair? See API access, authentication, and error handling.

Account

getCompanyInfo

account.getCompanyInfo Get FinerWorks’ site identifier, company address and business hours Risk: read
Input: empty object Output

getUser

account.getUser Get the authenticated FinerWorks account profile, including billing and business addresses Risk: read
Input Output

updateAppDetails

account.updateAppDetails Update the calling application’s name, description and live mode Risk: write
Input
Output

updateUser

account.updateUser Update the FinerWorks account profile, including billing and payment information Risk: write
Input
Output

Framing

getFrameDetails

framing.getFrameDetails Get dimensions, pricing, materials and imagery for a specific frame Risk: read
Input Output

listCollections

framing.listCollections List available frame collections and categories Risk: read
Input Output

listGlazing

framing.listGlazing List available glazing and glass options Risk: read
Input Output

listMats

framing.listMats List matting specifications, colours and pricing Risk: read
Input Output

Galleries

addOrUpdateCollection

galleries.addOrUpdateCollection Create a personal gallery collection, or update one by supplying its id Risk: write
Input Output

list

galleries.list List GeoGalleries.com galleries, with optional filtering Risk: read
Input Output

listThemes

galleries.listThemes List the theme options available for gallery customisation Risk: read
Input Output

Images

add

images.add Add up to five prepared images to a FinerWorks library Risk: write
Input
Output

delete

images.delete Delete image files by GUID, along with any virtual inventory products assigned to them Risk: destructive · Irreversible
Input
Output

list

images.list List image files uploaded to the FinerWorks account, with pagination Risk: read
Input
Output

listFileSelection

images.listFileSelection List the image GUIDs grouped under a file-selection key Risk: read
Input Output

update

images.update Update image metadata by GUID Risk: write
Input
Output

updateFileSelection

images.updateFileSelection Replace the image files held under a selection GUID Risk: write
Input Output

Inventory

delete

inventory.delete Delete virtual inventory products by SKU and disconnect their third-party sync Risk: destructive · Irreversible
Input Output

disconnect

inventory.disconnect Disconnect every virtual inventory item from a third-party platform Risk: write
Input Output

list

inventory.list List the virtual inventory products on the account, with pagination Risk: read
Input Output

update

inventory.update Update virtual inventory pricing, stock and third-party integrations Risk: write
Input
Output

Orders

deletePending

orders.deletePending Remove orders that were saved as pending Risk: destructive · Irreversible
Input Output

fetchStatus

orders.fetchStatus Get production status and tracking information for orders Risk: read
Input Output

listStatusDefinitions

orders.listStatusDefinitions List every production status an order can have Risk: read
Input: empty object Output

savePending

orders.savePending Save orders to temporary storage for review before submission Risk: write
Input
Output

submit

orders.submit Submit up to five new orders for production Risk: write
Input
Output

validateRecipientAddress

orders.validateRecipientAddress Validate a recipient address before submitting an order Risk: read
Input
Output

Products

getPrices

products.getPrices Get pricing for a set of FinerWorks product SKUs Risk: read
Input
Output

listMediaTypes

products.listMediaTypes List printing substrates (canvas, paper, vinyl) and their product information Risk: read
Input Output

listProductTypes

products.listProductTypes List printing categories such as Canvas Prints and Metal Prints Risk: read
Input Output

listStyleTypes

products.listStyleTypes List print formatting options including borders and canvas wraps Risk: read
Input Output

Shipping

getOptionIds

shipping.getOptionIds List shipping method identifiers for cross-reference Risk: read
Input Output

listOptionsMultiple

shipping.listOptionsMultiple Get shipping options and rates for a batch of orders Risk: read
Input
Output