Details
Test Connection
Test Connection
https://api.finerworks.com/v3/test_my_credentials
POST
Use this for your first test and make sure your credentials are linked to your FinerWorks account information.
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
Update Status
Update Status
https://api.finerworks.com/v3/update_order
POST
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
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
Production Status List
Production Status List
https://api.finerworks.com/v3/list_order_status_definitions
POST
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
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
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
Update Customer
Update Customer
https://api.finerworks.com/v3/update_customer
POST
Updates an existing order's customer (shipping information).
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
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.