FinerWorks

Delete App Key via DELETE /v3/delete_app_key. Permanently deletes an app_key from your account. This cannot be undone. This manages FinerWorks app keys, one of which is the credential this connection uses: deleting that key breaks the connection, and switching it between test and live changes whether orders placed through it are billed.

Delete Gallery via DELETE /v3/delete_gallery_collection. Delete a personal gallery collection in GeoGalleries.com.

Delete Image Files via DELETE /v3/delete_images. Deletes a list of image files based on their unique id. Note if the image is assigned to the inventory library, this will also remove any virtual inventory products assigned to those images.

Delete Virtual Inventory via DELETE /v3/delete_virtual_inventory. Deletes virtual inventory products. Note that if any of these items are synced with products on a 3rd party platform, those products will no longer be connected to FinerWorks.

Get Company Info via GET /v3/get_company_info. Use this to get essential information about FinerWorks.

Get Order via GET /v3/get_order. Retrieves a specific orders.

Get User Payment Tokens via GET /v3/get_payment_tokens. Get associated payment tokens of the user that can ONLY be used at FinerWorks for submitting orders.

Get Shipping Option IDs via GET /v3/get_shipping_options_ids. Lists all available shipping option ids. This does not return shipping rates but provides the ids for various shipping methods that can be used for cross reference purposes. Sites should periodically check and update this data i case new shipping methods or added or deleted.

Get User Profile via GET /v3/get_user. Must be authorized to use this endpoint. FinerWorks restricts this endpoint to specially authorized accounts: an ordinary account's keys are refused here by permission, not because the credential is wrong.

List File Selection via GET /v3/list_file_selection. Returns a list of currently selected files. The querystring parameter guid is the master key assigned to all files that are selected.

Production Status List via GET /v3/list_order_status_definitions. Lists all available production status an order can have once it has completed. Use the id number for reference purposes since the descriptive value can be redundant or change wording in some cases.

Test Connection via GET /v3/test_my_credentials. Use this for your first test and make sure your credentials are linked to your FinerWorks account information.

Add Event Log via POST /v3/add_event. Creates an event log entry that can be reviewed later for debugging purposes. This endpoint requires special permission to use. FinerWorks restricts this endpoint to specially authorized accounts: an ordinary account's keys are refused here by permission, not because the credential is wrong.

Add Images Files via POST /v3/add_images. Allows the user to add images to a library.

Add / Update App Keys via POST /v3/add_update_app_key. Creates a new app_key for your account, or updates an existing app_key's name, description, and live/test mode when an app_key is provided. This manages FinerWorks app keys, one of which is the credential this connection uses: deleting that key breaks the connection, and switching it between test and live changes whether orders placed through it are billed.

Add / Update Personal Galleries via POST /v3/add_update_gallery_collection. Add or update personal gallery collections setup in GeoGalleries.com.

Build Product Code via POST /v3/build_product_code. Create a product code based on a list of material ids. This is used for the product builder to build a product code that can be added to the cart. Note this endpoint does not check if the materials are active or valid for use, it simply builds a code based on the ids provided.

Buy Account Credits via POST /v3/buy_account_credits. This does not automatically create an account credit in one's account.This adds it to one's shopping cart for later checkout. Only authorized accounts may use this endpoint. FinerWorks restricts this endpoint to specially authorized accounts: an ordinary account's keys are refused here by permission, not because the credential is wrong.

Create Template via POST /v3/create_template. Creates a template object from a product.

Credit Transaction via POST /v3/credit_transaction. Creates a credit transaction record for users in the account credits ledger. Only available to authorized users. FinerWorks restricts this endpoint to specially authorized accounts: an ordinary account's keys are refused here by permission, not because the credential is wrong.

Delete Pending Orders via POST /v3/delete_pending_orders. Removes orders from the temporary storage table.

Get Order Status via POST /v3/fetch_order_status. Retrieves an order's current "production" status. If an order is not found, no status will be returned.

Find Promo Code via POST /v3/find_promo_code. Used to get both gift cards balances and promo details. Only authorized accounts may use this endpoint. FinerWorks restricts this endpoint to specially authorized accounts: an ordinary account's keys are refused here by permission, not because the credential is wrong.

Frame Builder via POST /v3/frame_builder. This allows you to submit details to validate a framing option, get pricing and info as well as return base64 data you can use to display your frame package.

Frame Details via POST /v3/frame_details. List the prints currently setup in your inventory.

Get Price List via POST /v3/get_prices. Returns a list of prices and their breakdown based on a list of product codes or virtual inventory skus. Request as few as 1 or as many as 50 in the body of the request.

Product Details via POST /v3/get_product_details. Request details and pricing (up to 25 skus at a time) based on sku and quantity. Additional response parameters may be added in the future as requested.

List Frame Collections via POST /v3/list_collections. List all available frame categories .

List Event Logs via POST /v3/list_event_logs. Provides a list of event logs. Requires special permissions to be able to use this endpoint. FinerWorks restricts this endpoint to specially authorized accounts: an ordinary account's keys are refused here by permission, not because the credential is wrong.

List Galleries via POST /v3/list_galleries. List galleries setup in GeoGalleries.com.

List Themes via POST /v3/list_gallery_themes. Returns a list of themes used in GeoGalleries.

Glazing via POST /v3/list_glazing. Lists the available glazing / glass.

List Image Files via POST /v3/list_images. Provides a list of image files you have uploaded and any virtual inventory items assigned to them.

List Invoices via POST /v3/list_invoices. Retrieves a list of invoices by month.

Matting via POST /v3/list_mats. Lists the available mats.

List Media Types via POST /v3/list_media_types. Get a list of media types available at FinerWorks. Send `ids: []` for the full list: FinerWorks answers a body without `ids` with HTTP 500, although the field is documented as optional.

List Orders via POST /v3/list_orders. Retrieves a list of orders.

List payments via POST /v3/list_payments. Retrieves a list of payments by month.

List Pending Orders via POST /v3/list_pending_orders. Returns a list of orders being held in a pending status before being submitted.

List Printables via POST /v3/list_printables. Get a list of printable products available at FinerWorks.

List Product Types via POST /v3/list_product_types. Get a list of product types available at FinerWorks.

List Products via POST /v3/list_products. Returns a list of products assigned to a particular order or cart.

Shipping Options Multiple via POST /v3/list_shipping_options_multiple. Submit a list of orders to get a list of available shipping options with the required shipping_code needed when submitting an order for each order. This endpoint should be requested under the following conditions. Any changes to the recipient of an order, a product is added or deleted from an order, the quantity of the any product changes. Test vs live is a property of the app_key in the FinerWorks dashboard: with a LIVE app_key an order submitted here is real, produced and billed. Send `validate_only: true` to pre-check without submitting, and set each order's `test_mode: true` unless a real order is intended.

List Static Products via POST /v3/list_static_products. Returns a list of non-dynamic products. These are generally accessory products.

List Style Types via POST /v3/list_style_types. Get a list of style types available at FinerWorks. Send `ids: []` for the full list: FinerWorks answers a body without `ids` with HTTP 500, although the field is documented as optional.

List Virtual Inventory via POST /v3/list_virtual_inventory. Provides a list of a user's virtual inventory (products) stored in their account with valid product codes.

Save Pending Orders via POST /v3/save_pending_orders. Saves pending orders to a temporary storage table. This is useful if you want to make changes before final submission of an order. Test vs live is a property of the app_key in the FinerWorks dashboard: with a LIVE app_key an order submitted here is real, produced and billed. Send `validate_only: true` to pre-check without submitting, and set each order's `test_mode: true` unless a real order is intended.

Create Note via POST /v3/submit_note. Adds a note an order's log. Notes are for back reference purposes only and are NOT used for outside communication instructions to the production department or customer service.

Submit Orders V2 via POST /v3/submit_orders_v2. Submits a list of new orders (up to 50 at a time) which includes customer details (sender and recipient) as well as line item details and optional display fields for the packing slip. Once an order is successfully submitted it will return a confirmation (order reference id) and place the order into an accepted status and ultimately in our production queue. Test vs live is a property of the app_key in the FinerWorks dashboard: with a LIVE app_key an order submitted here is real, produced and billed. Send `validate_only: true` to pre-check without submitting, and set each order's `test_mode: true` unless a real order is intended.

Submit Product via POST /v3/submit_product. Adds a new product to virtual inventory or even to an existing shopping cart.

Validate Product via POST /v3/validate_product. Used to validate a product to make sure the sku or product code is valid.

Address Validation via POST /v3/validate_recipient_address. Can be used to validate and test an address such as an order's recipient.

Disconnect Virtual Inventory via PUT /v3/disconnect_virtual_inventory. Updates ALL virtual inventory items by removing the 3rd party platform data specified in the request. To update SINGLE virtual inventory items, use the update_virtual_inventory endpoint instead.

Update Credits via PUT /v3/update_account_credits. Used to get and add account credits to an account. Only authorized accounts may use this endpoint. FinerWorks restricts this endpoint to specially authorized accounts: an ordinary account's keys are refused here by permission, not because the credential is wrong.

Update App Details via PUT /v3/update_app_details. Updates the details assigned to the app_key being used. This manages FinerWorks app keys, one of which is the credential this connection uses: deleting that key breaks the connection, and switching it between test and live changes whether orders placed through it are billed.

Update Customer via PUT /v3/update_customer. Updates an existing order's customer (shipping information).

Update File Selection via PUT /v3/update_file_selection. Updates a list of a users current selected image files based on the selection key.

Update Image Files via PUT /v3/update_images. Updates a list of image files based on their unique id. Note if the image is assigned to the inventory library, this will also remove any virtual inventory products assigned to those images.

Update Status via PUT /v3/update_order. Updates an existing submission order's status (note this is different than the production status). You can change the submission status of an order with the api prior to it being placed in production. Once an order is in production you will need to contact our customer support team to make any further updates.

Update User Profile via PUT /v3/update_user. Updates various features of a users account which can be useful.

Update Virtual Inventory via PUT /v3/update_virtual_inventory. Updates virtual inventory items within a user's account.