Update a single product with Json Merge Patch functionality

PATCH

/2025-07/product/:productId

PATCH

/2025-07/product/:productId

1 import requests
2 
3 url = "https://api.shipbob.com/2025-07/product/productId"
4 
5 payload = {
6     "id": 0,
7     "name": "string",
8     "taxonomy_id": 0,
9     "type_id": 0,
10     "variants": [
11         {
12             "additional_hazmat_attributes": {
13                 "charge_state_percentage": 0.1,
14                 "container_type": "string",
15                 "lithium_battery_packaging": "string",
16                 "lithium_battery_type": "string",
17                 "magnet": True,
18                 "net_volume": 0.1,
19                 "net_weight": 0.1,
20                 "container_metal": True
21             },
22             "barcodes": [
23                 {
24                     "sticker_url": "string",
25                     "value": "string"
26                 }
27             ],
28             "bundle_definition": [
29                 {
30                     "quantity": 0,
31                     "variant_id": 0
32                 }
33             ],
34             "channel_metadata": [
35                 {
36                     "asin": "string",
37                     "fnsku": "string",
38                     "fulfillment_channel": "string",
39                     "channel_id": 0,
40                     "currency": "string",
41                     "id": 0,
42                     "is_inventory_sync_enabled": True,
43                     "legacy_product_id": 0,
44                     "platform": "string",
45                     "platform_identifier": "string",
46                     "platform_inventory_item_id": "string",
47                     "price": 0.1,
48                     "seller_sku": "string"
49                 }
50             ],
51             "customs": {
52                 "country_code_of_origin": "string",
53                 "description": "string",
54                 "hs_tariff_code": "string",
55                 "is321_eligible": True,
56                 "value": 0
57             },
58             "dimension": {
59                 "height": 0.1,
60                 "length": 0.1,
61                 "width": 0.1
62             },
63             "fulfillment_settings": {
64                 "dangerous_goods": True,
65                 "is_bpm_parcel": True,
66                 "is_case_pick": True,
67                 "msds_url": "string",
68                 "requires_prop65": True,
69                 "serial_scan": {
70                     "exact_character_length": 0,
71                     "is_enabled": True,
72                     "prefix": "string",
73                     "suffix": "string"
74                 }
75             },
76             "gtin": "string",
77             "id": 0,
78             "is_digital": True,
79             "lot_information": {
80                 "is_lot": True,
81                 "minimum_shelf_life_days": 0
82             },
83             "name": "string",
84             "packaging_material_type_id": 0,
85             "packaging_requirement_id": 0,
86             "return_preferences": {
87                 "backup_action_id": 0,
88                 "instructions": "string",
89                 "primary_action_id": 0,
90                 "return_to_sender_backup_action_id": 0,
91                 "return_to_sender_primary_action_id": 0
92             },
93             "sku": "string",
94             "status_id": 0,
95             "upc": "string",
96             "weight": 0.1
97         }
98     ]
99 }
100 headers = {
101     "Authorization": "Bearer <token>",
102     "Content-Type": "application/json"
103 }
104 
105 response = requests.patch(url, json=payload, headers=headers)
106 
107 print(response.json())

200Products_updateASingleProductWithJsonMergePatchFunctionality_example

1 {
2   "created_on": "2019-08-24T14:15:22Z",
3   "id": 0,
4   "name": "string",
5   "taxonomy": {
6     "id": 0,
7     "name": "string",
8     "parent_id": 0,
9     "parent_name": "string",
10     "path": "string"
11   },
12   "type": "string",
13   "updated_on": "2019-08-24T14:15:22Z",
14   "user_id": 0,
15   "variants": [
16     {
17       "barcodes": [
18         {
19           "sticker_url": "string",
20           "value": "string"
21         }
22       ],
23       "channel_metadata": [
24         {
25           "channel_id": 0,
26           "channel_name": "string",
27           "currency": "string",
28           "id": 0,
29           "is_inventory_sync_enabled": true,
30           "legacy_product_id": 0,
31           "platform": "string",
32           "platform_identifier": "string",
33           "platform_inventory_item_id": "string",
34           "price": 0.1,
35           "seller_sku": "string"
36         }
37       ],
38       "additional_hazmat_attributes": {
39         "charge_state_percentage": 0.1,
40         "container_metal": true,
41         "container_type": "string",
42         "lithium_battery_packaging": "string",
43         "lithium_battery_type": "string",
44         "magnet": true,
45         "net_volume": 0.1,
46         "net_weight": 0.1
47       },
48       "associated_bundles": [
49         {
50           "product_id": 0,
51           "product_name": "string",
52           "quantity": 0,
53           "variant_id": 0,
54           "variant_sku": "string"
55         }
56       ],
57       "bundle_definition": [
58         {
59           "product_id": 0,
60           "quantity": 0,
61           "variant_id": 0,
62           "variant_name": "string",
63           "variant_sku": "string"
64         }
65       ],
66       "created_on": "2019-08-24T14:15:22Z",
67       "customs": {
68         "country_code_of_origin": "string",
69         "currency": "string",
70         "description": "string",
71         "hs_tariff_code": "string",
72         "is321_eligible": true,
73         "value": 0
74       },
75       "dimension": {
76         "height": 0.1,
77         "is_locked": true,
78         "length": 0.1,
79         "source": "string",
80         "unit": "string",
81         "width": 0.1
82       },
83       "fulfillment_settings": {
84         "dangerous_goods": true,
85         "is_bpm_parcel": true,
86         "is_case_pick": true,
87         "msds_url": "string",
88         "requires_prop65": true,
89         "serial_scan": {
90           "exact_character_length": 0,
91           "is_enabled": true,
92           "prefix": "string",
93           "suffix": "string"
94         }
95       },
96       "gtin": "string",
97       "id": 0,
98       "inventory": {
99         "inventory_id": 0,
100         "on_hand_qty": 0
101       },
102       "is_digital": true,
103       "is_image_uploaded": true,
104       "lot_information": {
105         "is_lot": true,
106         "minimum_shelf_life_days": 0
107       },
108       "merge_children": [
109         {
110           "channel_ids": [
111             0
112           ],
113           "completed_at": "2019-08-24T14:15:22Z",
114           "inventory_id": 0,
115           "variant_id": 0,
116           "variant_name": "string"
117         }
118       ],
119       "name": "string",
120       "packaging_material_type": {
121         "id": 0,
122         "name": "string"
123       },
124       "packaging_requirement": {
125         "id": 0,
126         "name": "string"
127       },
128       "return_preferences": {
129         "backup_action": {
130           "id": 0,
131           "name": "string"
132         },
133         "instructions": "string",
134         "primary_action": {
135           "id": 0,
136           "name": "string"
137         },
138         "return_to_sender_backup_action": {
139           "id": 0,
140           "name": "string"
141         },
142         "return_to_sender_primary_action": {
143           "id": 0,
144           "name": "string"
145         }
146       },
147       "reviews_pending": [
148         "string"
149       ],
150       "sku": "string",
151       "status": "string",
152       "upc": "string",
153       "updated_on": "2019-08-24T14:15:22Z",
154       "weight": {
155         "unit": "string",
156         "weight": 0.1
157       }
158     }
159   ]
160 }

Updates a single product. This endpoint supports Json Merge Patch functionality, which allows partial updates to be made to the product. The endpoint will only update the fields that are provided in the request. For updating variants, you mnust include the ID of the variant that you would like to update.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Path parameters

productIdstringRequiredformat: "int64"

The product identifier

Request

This endpoint expects an object.

idlongOptional

Unique reference ID for the product

namestring or nullOptional

taxonomy_idinteger or nullOptional

type_idintegerOptional

variantslist of objects or nullOptional

Response

Success

created_ondatetime or null

idlong or null

namestring or null

taxonomyobject or null

typestring or null

updated_ondatetime or null

user_idlong or null

variantslist of objects or null