Webhooks
Orders
- POSTCancel one Shipment by Order Id and Shipment Id
- POSTEstimate Fulfillment Cost For Order
- GETGet shipping methods
- GETGet one Shipment by Order Id and Shipment Id
- GETGet Orders
- POSTCreate Order
- POSTCancel single Order by Order ID
- GETGet all Shipments for Order
- POSTCancel one Shipment by Shipment Id
- GETGet Order Store Json
- POSTSave the Store Order Json
- GETGet one Shipment by Shipment Id
- PUTUpdate a Shipment
- GETGet logs for one Shipment by Shipment Id
- POSTCancel multiple Shipments by Shipment Id
- GETGet one Shipment's status timeline by Order Id and Shipment Id
- GETGet Order
- GETGet one Shipment's status timeline by Shipment Id
- GETGet logs for one Shipment by Order Id and Shipment Id
- POSTUpdate Tracking Uploaded Status for Multiple Shipments by Shipment Id
Locations
Receiving
Returns
Products
- GETGet Product
- PATCHUpdate a single product with Json Merge Patch functionality
- GETRetrieves List of Products based on filters provided
- POSTCreate single product to the store
- PUTUpdate specific channel metadata record from a variant by channel metadata ID
- DELUsed to delete a specific channel metadata record from a variant by channel metadata ID
- GETGet Taxonomy Parent by Id
- GETGet Taxonomies
- GETGet Taxonomy by Id
- GETGet Packaging Requirement
- POSTUsed to Create a new Channel Metadata Entry for a given Variant
Channels
Inventory
Products
Update a single product with Json Merge Patch functionality
Products
Update a single product with Json Merge Patch functionality
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.
PATCH
/
product
/
{productId}
curl --request PATCH \
--url https://api.shipbob.com/2.0/product/{productId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"category_id": 0,
"name": "string",
"sub_category_id": 0,
"taxonomy_id": 0,
"type_id": 0,
"variants": [
{
"additional_hazmat_attributes": {
"charge_state_percentage": 0.1,
"container_metal": true,
"lithium_battery_packaging": "string",
"lithium_battery_type": "string",
"magnet": true,
"net_volume": 0.1,
"net_weight": 0.1
},
"barcode": "string",
"barcode_sticker_url": "string",
"bundle_definition": [
{
"quantity": 0,
"variant_id": 0
}
],
"channel_metadata": [
{
"asin": "string",
"channel_id": 0,
"currency": "string",
"fnsku": "string",
"fulfillment_channel": "string",
"id": 0,
"is_inventory_sync_enabled": true,
"legacy_product_id": 0,
"platform": "string",
"platform_identifier": "string",
"platform_inventory_item_id": "string",
"price": 0.1,
"seller_sku": "string"
}
],
"customs": {
"country_code_of_origin": "string",
"description": "string",
"hs_tariff_code": "string",
"is321_eligible": true,
"value": 0
},
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"fulfillment_settings": {
"dangerous_goods": true,
"is_bpm_parcel": true,
"is_case_pick": true,
"msds_url": "string",
"requires_prop65": true,
"serial_scan": {
"exact_character_length": 0,
"is_enabled": true,
"prefix": "string",
"suffix": "string"
}
},
"gtin": "string",
"id": 0,
"is_digital": true,
"lot_information": {
"is_lot": true,
"minimum_shelf_life_days": 0
},
"name": "string",
"packaging_material_type_id": 0,
"packaging_requirement_id": 0,
"return_preferences": {
"backup_action_id": 0,
"instructions": "string",
"primary_action_id": 0,
"return_to_sender_backup_action_id": 0,
"return_to_sender_primary_action_id": 0
},
"sku": "string",
"status_id": 0,
"upc": "string",
"weight": 0.1
}
]
}'
{
"category": {
"id": 0,
"name": "string"
},
"created_on": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"sub_category": {
"id": 0,
"name": "string"
},
"taxonomy": {
"id": 0,
"name": "string",
"parent_id": 0,
"parent_name": "string",
"path": "string"
},
"type": "string",
"updated_on": "2019-08-24T14:15:22Z",
"user_id": 0,
"variants": [
{
"additional_hazmat_attributes": {
"charge_state_percentage": 0.1,
"container_metal": true,
"lithium_battery_packaging": "string",
"lithium_battery_type": "string",
"magnet": true,
"net_volume": 0.1,
"net_weight": 0.1
},
"associated_bundles": [
{
"product_id": 0,
"product_name": "string",
"quantity": 0,
"variant_id": 0,
"variant_sku": "string"
}
],
"barcode": "string",
"barcode_sticker_url": "string",
"bundle_definition": [
{
"product_id": 0,
"quantity": 0,
"variant_id": 0,
"variant_name": "string",
"variant_sku": "string"
}
],
"channel_metadata": [
{
"channel_id": 0,
"channel_name": "string",
"currency": "string",
"id": 0,
"is_inventory_sync_enabled": true,
"legacy_product_id": 0,
"platform": "string",
"platform_identifier": "string",
"platform_inventory_item_id": "string",
"price": 0.1,
"seller_sku": "string"
}
],
"created_on": "2019-08-24T14:15:22Z",
"customs": {
"country_code_of_origin": "string",
"currency": "string",
"description": "string",
"hs_tariff_code": "string",
"is321_eligible": true,
"value": 0
},
"dimension": {
"height": 0.1,
"is_locked": true,
"length": 0.1,
"source": "string",
"unit": "string",
"width": 0.1
},
"fulfillment_settings": {
"dangerous_goods": true,
"is_bpm_parcel": true,
"is_case_pick": true,
"msds_url": "string",
"requires_prop65": true,
"serial_scan": {
"exact_character_length": 0,
"is_enabled": true,
"prefix": "string",
"suffix": "string"
}
},
"gtin": "string",
"id": 0,
"inventory": {
"inventory_id": 0,
"on_hand_qty": 0
},
"is_digital": true,
"is_image_uploaded": true,
"lot_information": {
"is_lot": true,
"minimum_shelf_life_days": 0
},
"merge_children": [
{
"channel_ids": [
0
],
"completed_at": "2019-08-24T14:15:22Z",
"inventory_id": 0,
"variant_id": 0,
"variant_name": "string"
}
],
"name": "string",
"packaging_material_type": {
"id": 0,
"name": "string"
},
"packaging_requirement": {
"id": 0,
"name": "string"
},
"return_preferences": {
"backup_action": {
"id": 0,
"name": "string"
},
"instructions": "string",
"primary_action": {
"id": 0,
"name": "string"
},
"return_to_sender_backup_action": {
"id": 0,
"name": "string"
},
"return_to_sender_primary_action": {
"id": 0,
"name": "string"
}
},
"reviews_pending": [
"string"
],
"sku": "string",
"status": "string",
"upc": "string",
"updated_on": "2019-08-24T14:15:22Z",
"weight": {
"unit": "string",
"weight": 0.1
}
}
]
}
Authorizations
Provide your personal access token in the format 'Bearer {your_personal_access_token}'
Path Parameters
The product identifier
Body
application/json
The product to update
Amazon Sales Channel Information with custom Amazon Fields
Response
200 - application/json
Success
Was this page helpful?
curl --request PATCH \
--url https://api.shipbob.com/2.0/product/{productId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"category_id": 0,
"name": "string",
"sub_category_id": 0,
"taxonomy_id": 0,
"type_id": 0,
"variants": [
{
"additional_hazmat_attributes": {
"charge_state_percentage": 0.1,
"container_metal": true,
"lithium_battery_packaging": "string",
"lithium_battery_type": "string",
"magnet": true,
"net_volume": 0.1,
"net_weight": 0.1
},
"barcode": "string",
"barcode_sticker_url": "string",
"bundle_definition": [
{
"quantity": 0,
"variant_id": 0
}
],
"channel_metadata": [
{
"asin": "string",
"channel_id": 0,
"currency": "string",
"fnsku": "string",
"fulfillment_channel": "string",
"id": 0,
"is_inventory_sync_enabled": true,
"legacy_product_id": 0,
"platform": "string",
"platform_identifier": "string",
"platform_inventory_item_id": "string",
"price": 0.1,
"seller_sku": "string"
}
],
"customs": {
"country_code_of_origin": "string",
"description": "string",
"hs_tariff_code": "string",
"is321_eligible": true,
"value": 0
},
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"fulfillment_settings": {
"dangerous_goods": true,
"is_bpm_parcel": true,
"is_case_pick": true,
"msds_url": "string",
"requires_prop65": true,
"serial_scan": {
"exact_character_length": 0,
"is_enabled": true,
"prefix": "string",
"suffix": "string"
}
},
"gtin": "string",
"id": 0,
"is_digital": true,
"lot_information": {
"is_lot": true,
"minimum_shelf_life_days": 0
},
"name": "string",
"packaging_material_type_id": 0,
"packaging_requirement_id": 0,
"return_preferences": {
"backup_action_id": 0,
"instructions": "string",
"primary_action_id": 0,
"return_to_sender_backup_action_id": 0,
"return_to_sender_primary_action_id": 0
},
"sku": "string",
"status_id": 0,
"upc": "string",
"weight": 0.1
}
]
}'
{
"category": {
"id": 0,
"name": "string"
},
"created_on": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"sub_category": {
"id": 0,
"name": "string"
},
"taxonomy": {
"id": 0,
"name": "string",
"parent_id": 0,
"parent_name": "string",
"path": "string"
},
"type": "string",
"updated_on": "2019-08-24T14:15:22Z",
"user_id": 0,
"variants": [
{
"additional_hazmat_attributes": {
"charge_state_percentage": 0.1,
"container_metal": true,
"lithium_battery_packaging": "string",
"lithium_battery_type": "string",
"magnet": true,
"net_volume": 0.1,
"net_weight": 0.1
},
"associated_bundles": [
{
"product_id": 0,
"product_name": "string",
"quantity": 0,
"variant_id": 0,
"variant_sku": "string"
}
],
"barcode": "string",
"barcode_sticker_url": "string",
"bundle_definition": [
{
"product_id": 0,
"quantity": 0,
"variant_id": 0,
"variant_name": "string",
"variant_sku": "string"
}
],
"channel_metadata": [
{
"channel_id": 0,
"channel_name": "string",
"currency": "string",
"id": 0,
"is_inventory_sync_enabled": true,
"legacy_product_id": 0,
"platform": "string",
"platform_identifier": "string",
"platform_inventory_item_id": "string",
"price": 0.1,
"seller_sku": "string"
}
],
"created_on": "2019-08-24T14:15:22Z",
"customs": {
"country_code_of_origin": "string",
"currency": "string",
"description": "string",
"hs_tariff_code": "string",
"is321_eligible": true,
"value": 0
},
"dimension": {
"height": 0.1,
"is_locked": true,
"length": 0.1,
"source": "string",
"unit": "string",
"width": 0.1
},
"fulfillment_settings": {
"dangerous_goods": true,
"is_bpm_parcel": true,
"is_case_pick": true,
"msds_url": "string",
"requires_prop65": true,
"serial_scan": {
"exact_character_length": 0,
"is_enabled": true,
"prefix": "string",
"suffix": "string"
}
},
"gtin": "string",
"id": 0,
"inventory": {
"inventory_id": 0,
"on_hand_qty": 0
},
"is_digital": true,
"is_image_uploaded": true,
"lot_information": {
"is_lot": true,
"minimum_shelf_life_days": 0
},
"merge_children": [
{
"channel_ids": [
0
],
"completed_at": "2019-08-24T14:15:22Z",
"inventory_id": 0,
"variant_id": 0,
"variant_name": "string"
}
],
"name": "string",
"packaging_material_type": {
"id": 0,
"name": "string"
},
"packaging_requirement": {
"id": 0,
"name": "string"
},
"return_preferences": {
"backup_action": {
"id": 0,
"name": "string"
},
"instructions": "string",
"primary_action": {
"id": 0,
"name": "string"
},
"return_to_sender_backup_action": {
"id": 0,
"name": "string"
},
"return_to_sender_primary_action": {
"id": 0,
"name": "string"
}
},
"reviews_pending": [
"string"
],
"sku": "string",
"status": "string",
"upc": "string",
"updated_on": "2019-08-24T14:15:22Z",
"weight": {
"unit": "string",
"weight": 0.1
}
}
]
}