latestOpenAPI 3.1.0MIT2026-08-221643491.4 MB

d3d8c21cd227

products

Get product

<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/{product_id}

Response

The product was retrieved successfully

product_idinteger

Unique identifier for the product

skustring

Stock Keeping Unit identifier

namestring

Product name

upcstring nullable

Universal Product Code

thumbnail_urlstring nullable

URL to product thumbnail image

internal_notesstring nullable

Internal notes about the product

fulfillment_skustring nullable

Fulfillment SKU

create_datestring date-time

Date when product was created

modify_datestring date-time

Date when product was last modified

activeboolean

Whether the product is active

preset_groupstring nullable

Preset group

warehouse_locationstring nullable

Warehouse location

default_carrier_codestring nullable

Default carrier code

default_service_codestring nullable

Default service code

default_package_codestring nullable

Default package code

default_intl_carrier_codestring nullable

Default international carrier code

default_intl_service_codestring nullable

Default international service code

default_intl_package_codestring nullable

Default international package code

default_confirmationstring nullable

Default confirmation type

default_intl_confirmationstring nullable

Default international confirmation type

customs_descriptionstring nullable

Customs description

customs_valuenumber nullable

Customs value

customs_tariff_nostring nullable

Customs tariff number

customs_country_codestring nullable

Customs country code

no_customsboolean nullable

Whether customs is required

product_typestring nullable

Product type

is_returnableboolean

Whether the product is returnable

should_override_nameboolean nullable

Whether to override the product name

is_bundleboolean nullable

Whether the product is a bundle

auto_split_optionstring

Auto split option

auto_split_custom_quantityinteger nullable

Auto split custom quantity

Example response

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