List Customers

Obtains a list of customers that match the specified criteria.

Name	Data Type	Description
`stateCode`	string, optional	Returns customers that reside in the specified stateCode.
`countryCode`	string, optional	Returns customers that reside in the specified countryCode. Use the two-letter ISO Origin Country code.
`marketplaceId`	number, optional	Returns customers that purchased items from the specified marketplaceId.
`tagId`	number, optional	Returns customers that have been tagged with the specified tagId.
`sortBy`	string, optional Values: `Name` `ModifyDate` `CreateDate`	Sorts the order of the response based off the specified value.
`sortDir`	string, optional Values: `ASC` `DESC`	Sets the direction of the sort order.
`page`	number, optional	Page number.
`pageSize`	number, optional	Requested page size. Max value is 500.

Example Request

GET /customers?stateCode={stateCode}&countryCode={countryCode}&tagId={tagId}&marketplaceId={marketplaceId}&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/customers?stateCode={stateCode}&countryCode={countryCode}&tagId={tagId}&marketplaceId={marketplaceId}&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/customers?stateCode={stateCode}&countryCode={countryCode}&tagId={tagId}&marketplaceId={marketplaceId}&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/customers?stateCode={stateCode}&countryCode={countryCode}&tagId={tagId}&marketplaceId={marketplaceId}&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/customers?stateCode={stateCode}&countryCode={countryCode}&tagId={tagId}&marketplaceId={marketplaceId}&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/customers?stateCode=%7BstateCode%7D&countryCode=%7BcountryCode%7D&tagId=%7BtagId%7D&marketplaceId=%7BmarketplaceId%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/customers?stateCode={stateCode}&countryCode={countryCode}&tagId={tagId}&marketplaceId={marketplaceId}&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/customers?stateCode={stateCode}&countryCode={countryCode}&tagId={tagId}&marketplaceId={marketplaceId}&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/customers?stateCode={stateCode}&countryCode={countryCode}&tagId={tagId}&marketplaceId={marketplaceId}&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/customers?stateCode={stateCode}&countryCode={countryCode}&tagId={tagId}&marketplaceId={marketplaceId}&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/customers?stateCode=%7BstateCode%7D&countryCode=%7BcountryCode%7D&tagId=%7BtagId%7D&marketplaceId=%7BmarketplaceId%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/customers?stateCode=%7BstateCode%7D&countryCode=%7BcountryCode%7D&tagId=%7BtagId%7D&marketplaceId=%7BmarketplaceId%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/customers?stateCode={stateCode}&countryCode={countryCode}&tagId={tagId}&marketplaceId={marketplaceId}&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


{
  "customers": [
    {
      "customerId": 12345678,
      "createDate": "2014-11-18T10:33:01.1900000",
      "modifyDate": "2014-11-18T10:33:01.1900000",
      "name": "Cam Newton",
      "company": "Test Company",
      "street1": "123 War Eagle Lane",
      "street2": "",
      "city": "Auburn",
      "state": "AL",
      "postalCode": "36830",
      "countryCode": "US",
      "phone": "555-555-5555",
      "email": "[email protected]",
      "addressVerified": "Verified",
      "marketplaceUsernames": [
        {
          "customerUserId": 67195020,
          "customerId": 12345678,
          "createDate": "2015-04-27T12:35:03.8300000",
          "modifyDate": "2015-05-14T08:16:15.2700000",
          "marketplaceId": 0,
          "marketplace": "ShipStation",
          "username": "[email protected]"
        },
        {
          "customerUserId": 37568588,
          "customerId": 12345678,
          "createDate": "2014-11-18T10:33:01.1970000",
          "modifyDate": "2014-11-18T10:33:01.1970000",
          "marketplaceId": 36,
          "marketplace": "WooCommerce",
          "username": "[email protected]"
        },
        {
          "customerUserId": 46038940,
          "customerId": 12345678,
          "createDate": null,
          "modifyDate": null,
          "marketplaceId": 67,
          "marketplace": "TradeGecko",
          "username": "[email protected]"
        }
      ],
      "tags": [
        {
          "tagId": 1234,
          "name": "Expedited"
        },
        {
          "tagId": 9725,
          "name": "00 BULK ORDERED"
        }
      ]
    },
    {
      "customerId": 87654321,
      "createDate": "2015-06-21T12:48:07.5400000",
      "name": "Bo Jackson",
      "company": "Test Company",
      "street1": "456 Heisman Ave",
      "street2": "",
      "city": "Auburn",
      "state": "AL",
      "postalCode": "36830",
      "countryCode": "US",
      "phone": "555-555-5555",
      "email": "[email protected]",
      "addressVerified": "Verified",
      "marketplaceUsernames": [
        {
          "customerUserId": 77215410,
          "customerId": 87654321,
          "createDate": "2015-08-27T14:36:05.7500000",
          "modifyDate": "2015-09-01T09:18:25.3100000",
          "marketplaceId": 0,
          "marketplace": "ShipStation",
          "username": "[email protected]"
        },
        {
          "customerUserId": 43759100,
          "customerId": 87654321,
          "createDate": "2015-07-05T11:38:01.1970000",
          "modifyDate": "2015-07-05T11:38:01.1970000",
          "marketplaceId": 36,
          "marketplace": "WooCommerce",
          "username": "[email protected]"
        },
        {
          "customerUserId": 81565241,
          "customerId": 87654321,
          "createDate": null,
          "modifyDate": null,
          "marketplaceId": 67,
          "marketplace": "TradeGecko",
          "username": "[email protected]"
        }
      ],
      "tags": [
        {
          "tagId": 1234,
          "name": "Expedited"
        },
        {
          "tagId": 9725,
          "name": "00 BULK ORDERED"
        }
      ]
    }
  ],
  "total": 2,
  "page": 1,
  "pages": 1
}