products

List products

<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>
get/v2/products

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

Changed in 1 of the 6 revisions of this API.12

    • added the new freight_connection_inactive enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400

      response-property-enum-value-added

    • added the new freight_connection_inactive enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404

      response-property-enum-value-added

    • added the new freight_provider_id_required enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400

      response-property-enum-value-added

    • added the new freight_provider_id_required enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404

      response-property-enum-value-added

    • added the new freight_shipment_not_batchable enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400

      response-property-enum-value-added

    • added the new freight_shipment_not_batchable enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404

      response-property-enum-value-added

    • added the new freight_shipment_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400

      response-property-enum-value-added

    • added the new freight_shipment_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404

      response-property-enum-value-added

    • added the new freight_tracking_not_available enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400

      response-property-enum-value-added

    • added the new freight_tracking_not_available enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404

      response-property-enum-value-added

    • added the new freight_tracking_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400

      response-property-enum-value-added

    • added the new freight_tracking_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404

      response-property-enum-value-added