products

List products

get/v2/products

Request

  • Base URL: https://api.shipstation.com
  • URL: https://api.shipstation.com/v2/products
  • Auth: API key in header api-key

Query parameters

skustring

Filter products by SKU

namestring

Filter products by name

activeboolean

Filter products by active status

page_sizeinteger

The number of results to return per page

pageinteger

The page number to return

Response

List of products

totalinteger

Total number of products

pageinteger

Current page number

pagesinteger

Total number of pages

Example response

{
  "products": [
    {
      "product_id": 10736794,
      "sku": "K1",
      "name": "Test Product",
      "upc": "123-4",
      "thumbnail_url": "www.image.com",
      "price": {
        "currency": "usd",
        "amount": 88
      },
      "dimensions": {
        "unit": "inch",
        "length": 9,
        "width": 5,
        "height": 7
      },
      "weight": {
        "value": 99.2,
        "unit": "ounce"
      },
      "internal_notes": "Describe your item",
      "fulfillment_sku": "widget-2",
      "create_date": "2025-07-07T20:10:02.13Z",
      "modify_date": "2025-07-07T20:10:02.13Z",
      "active": true,
      "product_category": {
        "product_category_id": 26663,
        "name": "Example-category"
      },
      "preset_group": "Default",
      "warehouse_location": "BIN 43-6",
      "default_carrier_code": "stamps_com",
      "default_service_code": "usps_first_class_mail",
      "default_package_code": "large_flat_rate_box",
      "default_intl_carrier_code": "stamps_com",
      "default_intl_service_code": "usps_priority_mail_international",
      "default_intl_package_code": "package",
      "default_confirmation": "none",
      "default_intl_confirmation": "delivery",
      "customs_description": "An object going internationally",
      "customs_value": 20,
      "customs_tariff_no": "0245.56.13",
      "customs_country_code": "US",
      "tags": [
        {
          "tag_id": 21121,
          "name": "Sample Tag",
          "color": "#800080"
        }
      ],
      "aliases": [
        {
          "store_id": 2095811,
          "sku_alias": "alt-sku"
        }
      ],
      "product_type": "standalone",
      "should_override_name": true,
      "is_bundle": true,
      "bundle_components": [
        {
          "bundle_product_id": 10736791,
          "component_product_id": 10408926,
          "sku": "New-SKU",
          "quantity": 3,
          "active": true
        }
      ],
      "auto_split_option": "do_not_split",
      "auto_split_custom_quantity": 3
    }
  ],
  "total": 510,
  "page": 5,
  "pages": 6,
  "links": {
    "first": {
      "href": "https://api.shipstation.com/v2/products?page=1&page_size=100"
    },
    "last": {
      "href": "https://api.shipstation.com/v2/products?page=6&page_size=100"
    },
    "prev": {
      "href": "https://api.shipstation.com/v2/products?page=4&page_size=100"
    },
    "next": {
      "href": "https://api.shipstation.com/v2/products?page=6&page_size=100"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.