{"templateId":"markdown","versions":[{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/shipstation-v2/docs/models/product","default":true,"active":false,"folderId":"58c9a61d"},{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/models/product","default":false,"active":false,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/models/product","default":false,"active":true,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Product Model","keywords":"shipping, labels, shipstation, documentation, api","siteUrl":"https://docs.shipstation.com","lang":"en-US","llmstxt":{"hide":false,"title":"ShipStation API LLM Docs","description":"Find links and references to all markdown documentation for use with LLMs","excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"product-model","__idx":0},"children":["Product Model"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Data Type"},"children":["Data Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["productId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The system-generated identifier for the product. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Read Only"]}," field."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sku"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Stock Keeping Unit (SKU). A user-defined value for a product to help identify the product. We suggest that each product should contain a unique SKU."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name or description of the product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["price"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The unit price of the product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultCost"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The seller's cost for this product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["length"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The length of the product. Unit of Measurement (UOM) is User Interface (UI)-dependent. No conversions will be made from one UOM to another. See our ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://help.shipstation.com/hc/en-us/articles/360025870012#UUID-fd4ba8eb-073f-8b57-d044-047d386b2e97_UUID-cf5e5c25-f8d2-3022-0d9d-aea7d774a07d"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["knowledge base article about the Shipping tab under Product Details here"]}]}," for more details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["width"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The width of the product. Unit of Measurement (UOM) is User Interface (UI)-dependent. No conversions will be made from one UOM to another. See our ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://help.shipstation.com/hc/en-us/articles/360025870012#UUID-fd4ba8eb-073f-8b57-d044-047d386b2e97_UUID-cf5e5c25-f8d2-3022-0d9d-aea7d774a07d"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["knowledge base article about the Shipping tab under Product Details here"]}]}," for more details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["height"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The height of the product. Unit of Measurement (UOM) is User Interface (UI)-dependent. No conversions will be made from one UOM to another. See our ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://help.shipstation.com/hc/en-us/articles/360025870012#UUID-fd4ba8eb-073f-8b57-d044-047d386b2e97_UUID-cf5e5c25-f8d2-3022-0d9d-aea7d774a07d"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["knowledge base article about the Shipping tab under Product Details here"]}]}," for more details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["weightOz"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The weight of a single item in ounces."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["internalNotes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Seller's private notes for the product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fulfillmentSku"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Stock Keeping Unit (SKU) for the fulfillment of that product by a 3rd party."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The timestamp for when the product record was created in ShipStation's database. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Read Only"]}," field."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifyDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The timestamp for when the product record was modified in ShipStation. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Read Only"]}," field."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies whether or not the product is an active record."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["productCategory"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of number and string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipstation-v1/docs/models/product-category"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ProductCategory"]}]}," used to organize and report on similar products. See our ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://help.shipstation.com/hc/en-us/articles/360025870332-Product-Categories"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["knowledge base article about Product Categories"]}]}," for more information."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["productType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the product type. See our ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://help.shipstation.com/hc/en-us/articles/360026158491-Product-Types"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["knowledge base article about Product Types"]}]}," for more information."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warehouseLocation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The warehouse location associated with the product record. Learn more in the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://help.shipstation.com/hc/en-us/articles/360026158531-Set-Up-ShipStation-s-Internal-Inventory#UUID-c3573229-712e-6978-d209-1bc552b2fd04"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Link Inventory Warehouse to Ship From Locaton"]}]}," section of our ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://help.shipstation.com/hc/en-us/articles/360026158531-Set-Up-ShipStation-s-Internal-Inventory"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Set Up Internal Inventory"]}]}," article."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultCarrierCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The default domestic shipping carrier for this product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultServiceCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The default domestic shipping service for this product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultPackageCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The default domestic ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["packageType"]}," for this product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultIntlCarrierCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The default international shipping carrier for this product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultIntlServiceCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The default international shipping service for this product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultIntlPackageCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The default international ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["packageType"]}," for this product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultConfirmation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The default domestic Confirmation type for this Product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultIntlConfirmation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The default international Confirmation type for this Product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customsDescription"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The default customs Description for the product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customsValue"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The default customs Declared Value for the product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customsTariffNo"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The default Harmonized Code for the Product. Learn more about Harmonizaton Codes under ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://help.shipstation.com/hc/en-us/articles/360035991611-ShipStation-s-International-Settings#UUID-391c67e1-e7bc-9df2-b2e4-d7cc758590c5"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Product Default Custom Settings in our International Settings article."]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customsCountryCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The default ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://www.nationsonline.org/oneworld/country_code_list.htm"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["two-letter ISO Origin Country code"]}]}," for the Product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["noCustoms"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", this product will not be included on international customs forms."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of number and string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipstation-v1/docs/models/product-tag"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ProductTag"]}]}," helps to organize and visually identify products. See our knowledge base ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://help.shipstation.com/hc/en-us/articles/360029962851-Product-Automation-Defaults"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["article on Product Automation Defaults"]}]}," and this ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://help.shipstation.com/hc/en-us/articles/360026156931-Order-Tags"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["article about Order Tags"]}]},"."]}]}]}]}]}]},"headings":[{"value":"Product Model","id":"product-model","depth":1}],"frontmatter":{"seo":{"title":"Product Model"}},"lastModified":"2026-04-08T10:47:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/shipstation-v1/docs/models/product","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}