Welcome to our current iteration of our REST API. While we encourage you to upgrade to v2.0 we will continue support for our SOAP API.

Versioning

The Fulfillment.com (FDC) REST API is version controlled and backwards compatible. We have many future APIs scheduled for publication within our v2.0 spec so please be prepared for us to add data nodes in our responses, however, we will not remove knowledge from previously published APIs.

A Current Response

{
  id: 123
}

A Potential Future Response

{
  id: 123,
  reason: "More Knowledge"
}

Getting Started

We use OAuth v2.0 to authenticate clients, you can choose implicit or password grant type. To obtain an OAuth client_id and client_secret contact your account executive.

Tip: Generate an additional login and use those credentials for your integration so that changes are accredited to that “user”.

You are now ready to make requests to our other APIs by filling your Authorization header with Bearer {access_token}.

Perpetuating Access

Perpetuating access to FDC without storing your password locally can be achieved using the refresh_token returned by POST /oauth/access_token.

A simple concept to achieve this is outlined below.

1. Your application/script will ask you for your username and password, your client_id and client_secret will be accessible via a DB or ENV.
2. Request an access_token

• Your function should be capable of formatting your request for both a grant_type of "password" (step 1) and "refresh_token" (step 4).

3. Store the access_token and refresh_token so future requests can skip step 1
4. When the access_token expires request anew using your refresh_token, replace both tokens in local storage.

• If this fails you will have to revert to step 1.

Alternatively if you choose for your application/script to have access to your username and password you can skip step 4.

In all scenarios we recommend storing all credentials outside your codebase.

Date Time Definitions

We will report all date-time stamps using the ISO 8601 standard. When using listing API’s where fromDate and toDate are available note that both dates are inclusive while requiring the fromDate to be before or at the toDate.

The Fulfillment Process

Many steps are required to fulfill your order we report back to you three fundamental milestones inside the orders model.

• recordedOn When we received your order. This will never change.

• dispatchDate When the current iteration of your order was scheduled for fulfillment. This may change however it is an indicator that the physical process of fulfillment has begun and a tracking number has been assigned to your order. The tracking number MAY CHANGE. You will not be able to cancel an order once it has been dispatched. If you need to recall an order that has been dispatched please contact your account executive.

• departDate When we recorded your order passing our final inspection and placed with the carrier. At this point it is safe to inform the consignee of the tracking number as it will not change.

Evaluating Error Responses

We currently return two different error models, with and without context. All errors will include a message node while errors with context will include additional information designed to save you time when encountering highly probable errors. For example, when you send us a request to create a duplicate order, we will reject your request and the context will include the FDC order id so that you may record it for your records.

Without Context

New order with missing required fields.

{    
  "message": "Invalid request body"
}

With Context

New order with duplicate merchantOrderId.

{
  "message": "Duplicate Order",
  "context": {
    "id": 123
  }
}

Status Codes

Codes are a concatenation of State, Stage, and Detail.

^([0-9]{2})([0-9]{2})([0-9]{2})$

Use this page to mock Fulfillment.com APIv2 in your testing and development.

Run our mock API sample using the open source WireMock library, or in the free edition of WireMock Cloud. You'll have a working API server simulating the behavior of Fulfillment.com APIv2, which will allow you to keep building and testing even if the actual API you isn't currently available.