List Products

Obtains a list of products that match the specified criteria. 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:

/products?sku={sku}
&name={name}
&productCategoryId={productCategoryId}
&productTypeId={productTypeId}
&tagId={tagId}
&startDate={startDate}
&endDate={endDate}
&showInactive={showInactive}
&sortBy={sortBy}
&sortDir={sortDir}
&page={page}
&pageSize={pageSize}
&upc={upc_code}

Name	Data Type	Description
`sku`	string	Returns products that match the specified SKU. Optional
`name`	string	Returns products that match the specified product name. Optional
`productCategoryId`	string	Returns products that match the specified productCategoryId. Optional
`productTypeId`	string	Returns products that match the specified productTypeId. Optional
`tagId`	string	Returns products that match the specified tagId. Optional
`startDate`	string	Returns products that were created after the specified date. Optional
`endDate`	string	Returns products that were created before the specified date. Optional
`sortBy`	string	Sorts the order of the response based on the specified value. Values: `SKU` `ModifyDate` `CreateDate` Optional
`sortDir`	string	Sets the direction of the sort order. Values: `ASC` `DESC` Optional
`page`	string	Page number. Optional
`pageSize`	string	Requested page size. Max value is 500. Optional
`showInactive`	string	Specifies whether the list should include inactive products. Optional
`upc`	string	Return a product that matches the specified UPC code. Optional

Example Request

GET /products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&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/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&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/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&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/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&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/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&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/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&sortBy=sortBy&sortDir=sortDir&page=page&pageSize=pageSize",
  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/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&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/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&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/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&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/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&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/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&sortBy=sortBy&sortDir=sortDir&page=page&pageSize=pageSize"
  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/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&sortBy=sortBy&sortDir=sortDir&page=page&pageSize=pageSize"]
  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/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&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

{
  "products": [
    {
      "aliases": null,
      "productId": 7854008,
      "sku": "1004",
      "name": "Coffee Mug",
      "price": 26,
      "defaultCost": 0,
      "length": 3,
      "width": 3,
      "height": 3,
      "weightOz": 26,
      "internalNotes": null,
      "fulfillmentSku": "F1004",
      "createDate": "2014-09-04T09:18:01.293",
      "modifyDate": "2014-09-18T12:38:43.893",
      "active": true,
      "productCategory": {
        "categoryId": 9999,
        "name": "Door Closers"
      },
      "productType": null,
      "warehouseLocation": "Bin 22",
      "defaultCarrierCode": "fedex",
      "defaultServiceCode": "fedex_home_delivery",
      "defaultPackageCode": "package",
      "defaultIntlCarrierCode": "ups",
      "defaultIntlServiceCode": "ups_worldwide_saver",
      "defaultIntlPackageCode": "package",
      "defaultConfirmation": "direct_signature",
      "defaultIntlConfirmation": "adult_signature",
      "customsDescription": null,
      "customsValue": null,
      "customsTariffNo": null,
      "customsCountryCode": null,
      "noCustoms": null,
      "tags": [
        {
          "tagId": 9180,
          "name": "APItest"
        }
      ],
      "upc": "012345678905",
      "thumbnailURL": "url_to_thumbnail_image"
    },
    {
      "aliases": null,
      "productId": 7984482,
      "sku": "FirstSKU",
      "name": "Product Name 123",
      "price": 10,
      "defaultCost": null,
      "length": 2,
      "width": 3,
      "height": 4,
      "weightOz": 96,
      "internalNotes": null,
      "fulfillmentSku": "fSkuFill",
      "createDate": "2014-09-18T08:17:28.647",
      "modifyDate": "2014-09-18T12:32:40.257",
      "active": true,
      "productCategory": {
        "categoryId": 9690,
        "name": "Floor Matting"
      },
      "productType": null,
      "warehouseLocation": "Bin 100",
      "defaultCarrierCode": "ups",
      "defaultServiceCode": "ups_ground",
      "defaultPackageCode": "package",
      "defaultIntlCarrierCode": null,
      "defaultIntlServiceCode": null,
      "defaultIntlPackageCode": "package",
      "defaultConfirmation": "delivery",
      "defaultIntlConfirmation": null,
      "customsDescription": "customs declaration",
      "customsValue": 100,
      "customsTariffNo": "1234567",
      "customsCountryCode": "US",
      "noCustoms": null,
      "tags": [
        {
          "tagId": 9180,
          "name": "APItest"
        }
      ],
      "upc": "012345678905",
      "thumbnailURL": "url_to_thumbnail_image"
    }
  ],
  "total": 2,
  "page": 1,
  "pages": 0
}