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}
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

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__

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"
        }
      ]
    },
    {
      "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"
        }
      ]
    }
  ],
  "total": 2,
  "page": 1,
  "pages": 0
}