Products

Update Product

Update a product by ID

Important behavior for array fields (bundle_components, assembly_components):

  • If omitted: Existing components are preserved
  • If empty array []: All components are removed
  • If array with items: All existing components are replaced
PATCH
/shipos/products/{product_id}
x-access-token<token>

In: header

Path Parameters

product_id*string

The ID of the product to be updated

Request Body

application/json

The new values for the product

The new values for the product

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/shipos/products/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "is_hazmat": true,  "subcategory": "string",  "category": "string",  "virtual_bundle_component_count": 0.1,  "product_listing_variant_count": {    "SHOPIFY": 0.1,    "MAGENTO2": 0.1,    "BIGCOMMERCE": 0.1,    "MANUAL": 0.1,    "WOOCOMMERCE": 0.1,    "WIX": 0.1,    "TIKTOK": 0.1  },  "pick_fee_override": 0,  "printed_commodity_identifier": "string",  "eccn": "string",  "manufacturer": "string",  "updated_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "config": {    "replenishment_source_strategy": "FIFO",    "replenishment_increment_level": 0,    "replenishment_maximum_level": 0,    "replenishment_minimum_level": 0  },  "first_article_inspection_completed_at": "2019-08-24T14:15:22Z",  "customs_value_currency": "string",  "customs_value": 0,  "customs_description": "string",  "country_of_origin": "string",  "hs_code": "string",  "mpn": "string",  "image_url": "string",  "measurement_unit": "MM",  "height": 0.1,  "width": 0.1,  "length": 0.1,  "weight_unit": "G",  "weight": 0,  "cost_currency": "string",  "cost_price": 0,  "sku": "string",  "description": "string",  "type": "STANDARD",  "name": "string",  "team_name": "string",  "team_id": "string",  "fulfiller_team_name": "string",  "fulfiller_team_id": "string",  "merchant_team_name": "string",  "merchant_team_id": "string",  "id": "string",  "available": 0.1,  "on_hand": 0.1,  "committed": 0.1,  "unavailable": 0.1,  "on_order": 0.1,  "inventory_by_warehouse": [    {      "on_order": {        "operations": [          {            "count": 0.1,            "label": "string"          }        ],        "count": 0.1      },      "unavailable": {        "operations": [          {            "count": 0.1,            "label": "string"          }        ],        "count": 0.1      },      "committed": {        "operations": [          {            "count": 0.1,            "label": "string"          }        ],        "count": 0.1      },      "on_hand": {        "operations": [          {            "count": 0.1,            "label": "string"          }        ],        "count": 0.1      },      "available": {        "operations": [          {            "count": 0.1,            "label": "string"          }        ],        "count": 0.1      },      "warehouse_name": "string",      "warehouse_id": "string"    }  ],  "virtual_bundle_products": [    {      "component_product_image_url": "string",      "component_product_sku": "string",      "component_product_name": "string",      "component_product_id": "string",      "virtual_bundle_product_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "component_quantity": 0.1,      "id": "string"    }  ],  "assembly_products": [    {      "component_product_image_url": "string",      "component_product_sku": "string",      "component_product_name": "string",      "component_product_id": "string",      "assembly_product_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "component_quantity": 0.1,      "id": "string"    }  ],  "product_listing_variants": [    {      "shop_slug": "string",      "shop_name": "string",      "shop_type": "SHOPIFY",      "remote_shopify_inventory_item_id": "string",      "shop_id": "string",      "weight_unit": "G",      "weight": 0,      "sku": "string",      "team_name": "string",      "team_id": "string",      "fulfiller_team_name": "string",      "fulfiller_team_id": "string",      "merchant_team_name": "string",      "merchant_team_id": "string",      "product_listing_name": "string",      "product_listing_id": "string",      "product_type": "STANDARD",      "product_id": "string",      "image_url": "string",      "country_of_origin": "string",      "currency": "string",      "price": 0.1,      "hs_code": "string",      "barcode": "string",      "name": "string",      "synced_at": "2019-08-24T14:15:22Z",      "remote_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "id": "string"    }  ],  "increment_level": 0.1,  "maximum_level": 0.1,  "minimum_level": 0.1,  "barcode": "string"}