products
Create 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>post/v2/products/create
Request body
Example request
{
"products": [
{
"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",
"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
}
],
"aliases": [
{
"store_id": 2095811,
"sku_alias": "alt-sku"
}
],
"should_override_name": true,
"auto_split_option": "do_not_split",
"auto_split_custom_quantity": 3
}
]
}Response
The products were created successfully
Example response
{
"created_product_ids": [
10736794
],
"request_id": "35e75c12-cb26-4d58-9fa1-b0047480acc1",
"errors": [
{
"error_source": "shipstation",
"error_type": "validation",
"error_code": "field_value_required",
"message": "sku is required.",
"field_name": "sku"
}
]
}