List Fulfillments

The List Fulfillments API call obtains a list of fulfillments that match the specified criteria.

NOTE Orders that have been marked as shipped either through the UI or the API will appear in the response as they are considered fulfillments.

All of the available filters are optional. They do not need to be included in the URL. If you do include them, here's what the URL may look like:

URL format with filters:

fulfillments?fulfillmentId={fulfillmentId}
&orderId={orderId}
&orderNumber={orderNumber}
&trackingNumber={trackingNumber}
&recipientName={recipientName}
&createDateStart={createDateStart}
&createDateEnd={createDateEnd}
&shipDateStart={shipDateStart}
&shipDateEnd={shipDateEnd}
&sortBy={sortBy}
&sortDir={sortDir}
&page={page}
&pageSize={pageSize}

Name	Data Type	Description
`fulfillmentId`	number	Returns the fulfillment with the specified fulfillment ID. Optional
`orderId`	number	Returns fulfillments whose orders have the specified order ID. Optional
`orderNumber`	string	Returns fulfillments whose orders have the specified order number. Optional
`trackingNumber`	string	Returns fulfillments with the specified tracking number. Optional
`recipientName`	string	Returns fulfillments shipped to the specified recipient name. Optional
`createDateStart`	string	Returns fulfillments created on or after the specified `createDate`. Optional
`createDateEnd`	string	Returns fulfillments created on or before the specified `createDate`. Optional
`shipDateStart`	string	Returns fulfillments with the `shipDate` on or after the specified date. Optional
`shipDateEnd`	string	Returns fulfillments with the `shipDate` on or before the specified date. Optional
`sortBy`	string	Sort the responses by a set value. The response will be sorted based on the ascending dates (oldest to most current). Values: `ShipDate` `CreateDate` If left empty, the response will default to be sorted by ascending `createDate`. Optional
`sortDir`	string	Sets the direction of the sort order. Values: `ASC` `DESC` Optional
`page`	number	Page number. Optional
`pageSize`	number	Page size. Optional

Example Request

GET /fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize} HTTP/1.1
Host: ssapi.shipstation.com
Authorization: __YOUR_AUTH_HERE__

curl -iX GET 'https://ssapi.shipstation.com/fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}' \
-H 'Authorization: __YOUR_AUTH_HERE__' \

$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Host", "ssapi.shipstation.com")
$headers.Add("Authorization", "__YOUR_AUTH_HERE__")

$response = Invoke-RestMethod 'https://ssapi.shipstation.com/fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}' -Method 'GET' -Headers $headers -Body $body
$response | ConvertTo-Json

var myHeaders = new Headers();
myHeaders.append("Host", "ssapi.shipstation.com");
myHeaders.append("Authorization", "__YOUR_AUTH_HERE__");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://ssapi.shipstation.com/fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://ssapi.shipstation.com/fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}',
  'headers': {
    'Host': 'ssapi.shipstation.com',
    'Authorization': '__YOUR_AUTH_HERE__'
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://ssapi.shipstation.com/fulfillments?fulfillmentId=%7BfulfillmentId%7D&orderId=%7BorderId%7D&orderNumber=%7BorderNumber%7D&trackingNumber=%7BtrackingNumber%7D&recipientName=%7BrecipientName%7D&createDateStart=%7BcreateDateStart%7D&createDateEnd=%7BcreateDateEnd%7D&shipDateStart=%7BshipDateStart%7D&shipDateEnd=%7BshipDateEnd%7D&sortBy=%7BsortBy%7D&sortDir=%7BsortDir%7D&page=%7Bpage%7D&pageSize=%7BpageSize%7D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Host: ssapi.shipstation.com",
    "Authorization: __YOUR_AUTH_HERE__"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

url = "https://ssapi.shipstation.com/fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}"

payload = {}
headers = {
  'Host': 'ssapi.shipstation.com',
  'Authorization': '__YOUR_AUTH_HERE__'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))

require "uri"
require "net/http"

url = URI("https://ssapi.shipstation.com/fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Host"] = "ssapi.shipstation.com"
request["Authorization"] = "__YOUR_AUTH_HERE__"

response = https.request(request)
puts response.read_body

var client = new RestClient("https://ssapi.shipstation.com/fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Host", "ssapi.shipstation.com");
request.AddHeader("Authorization", "__YOUR_AUTH_HERE__");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://ssapi.shipstation.com/fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}")
  .method("GET", null)
  .addHeader("Host", "ssapi.shipstation.com")
  .addHeader("Authorization", "__YOUR_AUTH_HERE__")
  .build();
Response response = client.newCall(request).execute();

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://ssapi.shipstation.com/fulfillments?fulfillmentId=%7BfulfillmentId%7D&orderId=%7BorderId%7D&orderNumber=%7BorderNumber%7D&trackingNumber=%7BtrackingNumber%7D&recipientName=%7BrecipientName%7D&createDateStart=%7BcreateDateStart%7D&createDateEnd=%7BcreateDateEnd%7D&shipDateStart=%7BshipDateStart%7D&shipDateEnd=%7BshipDateEnd%7D&sortBy=%7BsortBy%7D&sortDir=%7BsortDir%7D&page=%7Bpage%7D&pageSize=%7BpageSize%7D"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("Host", "ssapi.shipstation.com")
  req.Header.Add("Authorization", "__YOUR_AUTH_HERE__")

  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}

#import <Foundation/Foundation.h>

dispatch_semaphore_t sema = dispatch_semaphore_create(0);

NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://ssapi.shipstation.com/fulfillments?fulfillmentId=%7BfulfillmentId%7D&orderId=%7BorderId%7D&orderNumber=%7BorderNumber%7D&trackingNumber=%7BtrackingNumber%7D&recipientName=%7BrecipientName%7D&createDateStart=%7BcreateDateStart%7D&createDateEnd=%7BcreateDateEnd%7D&shipDateStart=%7BshipDateStart%7D&shipDateEnd=%7BshipDateEnd%7D&sortBy=%7BsortBy%7D&sortDir=%7BsortDir%7D&page=%7Bpage%7D&pageSize=%7BpageSize%7D"]
  cachePolicy:NSURLRequestUseProtocolCachePolicy
  timeoutInterval:10.0];
NSDictionary *headers = @{
  @"Host": @"ssapi.shipstation.com",
  @"Authorization": @"__YOUR_AUTH_HERE__"
};

[request setAllHTTPHeaderFields:headers];

[request setHTTPMethod:@"GET"];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
  if (error) {
    NSLog(@"%@", error);
  } else {
    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
    NSError *parseError = nil;
    NSDictionary *responseDictionary = [NSJSONSerialization JSONObjectWithData:data options:0 error:&parseError];
    NSLog(@"%@",responseDictionary);
    dispatch_semaphore_signal(sema);
  }
}];
[dataTask resume];
dispatch_semaphore_wait(sema, DISPATCH_TIME_FOREVER);

import Foundation

var semaphore = DispatchSemaphore (value: 0)

var request = URLRequest(url: URL(string: "https://ssapi.shipstation.com/fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}")!,timeoutInterval: Double.infinity)
request.addValue("ssapi.shipstation.com", forHTTPHeaderField: "Host")
request.addValue("__YOUR_AUTH_HERE__", forHTTPHeaderField: "Authorization")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
  semaphore.signal()
}

task.resume()
semaphore.wait()

Example Response

{
  "fulfillments": [
    {
      "fulfillmentId": 33974374,
      "orderId": 191759016,
      "orderNumber": "101",
      "userId": "c9f06d74-95de-4263-9b04-e87095cababf",
      "customerEmail": "[email protected]",
      "trackingNumber": "783408231234",
      "createDate": "2016-06-07T08:50:50.0670000",
      "shipDate": "2016-06-07T00:00:00.0000000",
      "voidDate": null,
      "deliveryDate": null,
      "carrierCode": "USPS",
      "fulfillmentProviderCode": null,
      "fulfillmentServiceCode": null,
      "fulfillmentFee": 0,
      "voidRequested": false,
      "voided": false,
      "marketplaceNotified": true,
      "notifyErrorMessage": null,
      "shipTo": {
        "name": "Yoda",
        "company": null,
        "street1": "3800 N Lamar Blvd # 220",
        "street2": null,
        "street3": null,
        "city": "AUSTIN",
        "state": "TX",
        "postalCode": "78756",
        "country": "US",
        "phone": "512-485-4282",
        "residential": null,
        "addressVerified": null
      }
    },
    {
      "fulfillmentId": 246310,
      "orderId": 193699927,
      "orderNumber": "101",
      "userId": "c9f06d74-95de-4263-9b04-e87095cababf",
      "customerEmail": "[email protected]",
      "trackingNumber": "664756278745",
      "createDate": "2016-06-08T12:54:53.3470000",
      "shipDate": "2016-06-08T00:00:00.0000000",
      "voidDate": null,
      "deliveryDate": null,
      "carrierCode": "FedEx",
      "sellerFillProviderId": 12345,
      "sellerFillProviderName": "Example Fulfillment Provider Name",
      "fulfillmentProviderCode": null,
      "fulfillmentServiceCode": null,
      "fulfillmentFee": 0,
      "voidRequested": false,
      "voided": false,
      "marketplaceNotified": true,
      "notifyErrorMessage": null,
      "shipTo": {
        "name": "Yoda",
        "company": null,
        "street1": "3800 N Lamar Blvd # 220",
        "street2": null,
        "street3": null,
        "city": "AUSTIN",
        "state": "TX",
        "postalCode": "78756",
        "country": "US",
        "phone": "512-485-4282",
        "residential": null,
        "addressVerified": null
      }
    }
  ],
  "total": 2,
  "page": 1,
  "pages": 0
}