Introduction

The FinerWorks Order API allows developers to build applications that enable them to utilize the FinerWorks production services for their print on demand and order fulfillment needs. Developers can submit requests to the FinerWorks api service in a JSON format for the following purposes:

  • Place Orders
  • Get Order Status
  • Cancel Orders
  • Update Orders
  • Calculate Shipping
  • Get Product Detail and Pricing

Requirements

A knowledge of how to submit JSON requests via either GET or POST.

A web_api_key – Must be included as a querystring paraemter in the request uri (available within your FinerWorks account).

A secret app_key – Must be included as a querystring paraemter in the request uri (assigned once you register your app).

Steps to Get Started

Step 1: Getting Your Authentication Credentials

To get started you will need to retrieve your web api key and app key. Both can be found when you login to your FinerWorks account.

Step 2: Build Your App

You can build on the platform of your choice. FinerWorks does not provide direct programming support so will not be able to tell you how to “code”. If programming code is beyond your abilities, you will need to find someone with experience in building apps. Things they should know is how to submit JSON requests in the body of a http request.

Step 3: Test Your App

While you are building and testing your app, your app will be registered as being in test mode. While in test mode orders will not be processed.

Step 4: Go Live

When you have completed testing and are ready to go live, contact your account executive at FinerWorks who will update your app to a live status. At that point any orders you place will be processed unless you cancel or place an order on hold.

Testing

Before your app has been made live by your account executive, it will be in test mode. While in test mode nothing will be processed or billed from orders originating from that particular app. All responses will be valid and simulate what you receive in a live environment so you can build your app accordingly.

End Points

You are responsible for insuring the privacy of your customer's data when being submitted therefore SSL is recommended however at this time is not required. View the Help page for the full list of endpoint and method combinations.

http(s)://api.finerworks.com/v3/{{Method_Name}}

Click here for a list of methods and examples.

ShippingCodes

Below are available generic shipping codes however you can choose more specific shipping codes by retrieving them via a method.

shipping_codedescriptionTransit Time AvgNotes
ECEconomy3-7 daysGoes the least expensive method
SDStandard2-5 daysUsually goes via UPS ground or USPS Priority
EXExpress2-3 daysUsually goes via UPS 2 day or Pruirity Mail (which ever is estimated faster)
ONOvernight1-2 daysUsually goes via Next Day Air or Express Mail. May not be available for some orders in which case the fastest method will be selected.

Future Development and Changes

Overtime FinerWorks will offer additional options and make structural changes based on products and services being offered. Structural changes should not create any disruption to existing applications.

Billing Policy

There is no fee to develop or use the API however once you go live and submit valid orders, you will be required to have a credit card on file in which we will bill you for all pending orders submitted prior to noon of that day. In the advent that a card is declined for any reason you will be notified by email so that appropriate arrangements can be made to update your account with either a new card. We will attempt to rebill the following business day for those orders and any new orders. If after a 3rd attempt or no response after the 4th business day, any pending orders will be cancelled and need to be resubmitted.