Details
        
            
                        
                            Test Connection
                        
                
        
        
            
    
    
                        
                            Test Connection
                        
                
 
    https://api.finerworks.com/v3/test_my_credentials
    
 GET
            
        
Use this for your first test and make sure your credentials are linked to your FinerWorks account information.            
        
        Details
        
            
                        
                            Production Status List
                        
                
        
        
            
    
    
                        
                            Production Status List
                        
                
 
    https://api.finerworks.com/v3/list_order_status_definitions
    
 GET
            
        
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 redundent or change wording in some cases.            
        
        Details
        
            
                        
                            List File Selection
                        
                
        
        
            
    
    
                        
                            List File Selection
                        
                
 
    https://api.finerworks.com/v3/list_file_selection?guid={guid}
    
 GET
            
        
Returns a list of currently selected files. The querystring paremeter guid is the mater key assigned to all files that are selected.            
        
        Details
        
            
                        
                            Get User Profile
                        
                
        
        
            
    
    
                        
                            Get User Profile
                        
                
 
    https://api.finerworks.com/v3/get_user?account_key={account_key}
    
 GET
            
        
Must be authorized to use this endpoint.            
        
        Details
        
            
                        
                            Update User Profile
                        
                
        
        
            
    
    
                        
                            Update User Profile
                        
                
 
    https://api.finerworks.com/v3/update_user
    
 PUT
            
        
Updates various features of a users account which can be useful.            
        
        Details
        
            
                        
                            Update Status
                        
                
        
        
            
    
    
                        
                            Update Status
                        
                
 
    https://api.finerworks.com/v3/update_order
    
 PUT
            
        
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.            
        
        Details
        
            
                        
                            Update Customer
                        
                
        
        
            
    
    
                        
                            Update Customer
                        
                
 
    https://api.finerworks.com/v3/update_customer
    
 PUT
            
        
Updates an existing order's customer (shipping information).            
        
        Details
        
            
                        
                            Update Image Files
                        
                
        
        
            
    
    
                        
                            Update Image Files
                        
                
 
    https://api.finerworks.com/v3/update_images
    
 PUT
            
        
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.            
        
        Details
        
            
                        
                            Update File Selection
                        
                
        
        
            
    
    
                        
                            Update File Selection
                        
                
 
    https://api.finerworks.com/v3/update_file_selection
    
 PUT
            
        
Updates a list of a users current selected image files based on the selection key.            
        
        Details
        
            
                        
                            Submit Orders
                        
                
        
        
            
    
    
                        
                            Submit Orders
                        
                
 
    https://api.finerworks.com/v3/submit_orders
    
 POST
            
        
Submits a list of new orders (up to 5 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 que.            
        
        Details
        
            
                        
                            Create Note
                        
                
        
        
            
    
    
                        
                            Create Note
                        
                
 
    https://api.finerworks.com/v3/submit_note
    
 POST
            
        
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.            
        
        Details
        
            
                        
                            Get Order Status
                        
                
        
        
            
    
    
                        
                            Get Order Status
                        
                
 
    https://api.finerworks.com/v3/fetch_order_status
    
 POST
            
        
Retrieves an order's current "production" status. If an order is not found, no status will be returned.            
        
        Details
        
            
                        
                            Shipping Options
                        
                
        
        
            
    
    
                        
                            Shipping Options
                        
                
 
    https://api.finerworks.com/v3/list_shipping_options
    
 POST
            
        
Provides a list of available shipping options with the required shipping_code to be used when submitting an order.            
        
        Details
        
            
                        
                            Shipping Options Multiple
                        
                
        
        
            
    
    
                        
                            Shipping Options Multiple
                        
                
 
    https://api.finerworks.com/v3/list_shipping_options_multiple
    
 POST
            
        
Submit a list of orders to get a list of available shipping options with the required shipping_code to be used when submitting an order for each order.            
        
        Details
        
            
                        
                            Address Validation
                        
                
        
        
            
    
    
                        
                            Address Validation
                        
                
 
    https://api.finerworks.com/v3/validate_recipient_address
    
 POST
            
        
Can be used to validate and test an address such as an order's recipient.            
        
        Details
        
            
                        
                            Get Price List
                        
                
        
        
            
    
    
                        
                            Get Price List
                        
                
 
    https://api.finerworks.com/v3/get_prices
    
 POST
            
        
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.            
        
        Details
        
            
                        
                            Product Details
                        
                
        
        
            
    
    
                        
                            Product Details
                        
                
 
    https://api.finerworks.com/v3/get_product_details
    
 POST
            
        
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.            
        
        Details
        
            
                        
                            List Image Files
                        
                
        
        
            
    
    
                        
                            List Image Files
                        
                
 
    https://api.finerworks.com/v3/list_images
    
 POST
            
        
Provides a list of image files you have uploaded and any virtual inventory items assigned to them.            
        
        Details
        
            
                        
                            Add Images Files
                        
                
        
        
            
    
    
                        
                            Add Images Files
                        
                
 
    https://api.finerworks.com/v3/add_images
    
 POST
            
        
Allows the user to add images to a library.            
        
        Details
        
            
                        
                            List Event Logs
                        
                
        
        
            
    
    
                        
                            List Event Logs
                        
                
 
    https://api.finerworks.com/v3/list_event_logs
    
 POST
            
        
Provides a list of event logs. Requires special permissions to be able to use this endpoint.            
        
        Details
        
            
                        
                            Add Event Log
                        
                
        
        
            
    
    
                        
                            Add Event Log
                        
                
 
    https://api.finerworks.com/v3/add_event
    
 POST
            
        
Creates an event log entry that can be reviewed later for debugging purposes. This endpoint requires special permission to use.            
        
        Details
        
            
                        
                            List Product Types
                        
                
        
        
            
    
    
                        
                            List Product Types
                        
                
 
    https://api.finerworks.com/v3/list_product_types
    
 POST
            
        
Get a list of product types available at FinerWorks.            
        
        Details
        
            
                        
                            List Media Types
                        
                
        
        
            
    
    
                        
                            List Media Types
                        
                
 
    https://api.finerworks.com/v3/list_media_types
    
 POST
            
        
Get a list of media types available at FinerWorks.            
        
        Details
        
            
                        
                            List Style Types
                        
                
        
        
            
    
    
                        
                            List Style Types
                        
                
 
    https://api.finerworks.com/v3/list_style_types
    
 POST
            
        
Get a list of style types available at FinerWorks.            
        
        Details
        
            
                        
                            List Frame Collections
                        
                
        
        
            
    
    
                        
                            List Frame Collections
                        
                
 
    https://api.finerworks.com/v3/list_collections
    
 POST
            
        
List all available frame categories .            
        
        Details
        
            
                        
                            Frame Details
                        
                
        
        
            
    
    
    
                        
                            Frame Details
                        
                
 
    https://api.finerworks.com/v3/frame_details
    
 POST
            
        
List the prints currently setup in your inventory.            
        
        Details
        
            
                        
                            Glazing
                        
                
        
        
            
    
    
                        
                            Glazing
                        
                
 
    https://api.finerworks.com/v3/list_glazing
    
 POST
            
        
Lists the avialable glazing / glass.            
        
        Details
        
            
                        
                            Frame Builder
                        
                
        
        
            
    
    
                        
                            Frame Builder
                        
                
 
    https://api.finerworks.com/v3/frame_builder
    
 POST
            
        
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.            
        
        Details
        
            
                        
                            Deletes Image Files
                        
                
        
        
            
    
    
                        
                            Deletes Image Files
                        
                
 
    https://api.finerworks.com/v3/delete_images
    
 DELETE
            
        
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.            
        
        Details
        
            
                
        
        
            
    
                
 
    https://api.finerworks.com/api/Order?property_to_validate={property_to_validate}
    
 POST
            
        
No documentation available.