API Reference
- Channels
- Orders
- Products
- POSTCreate single product to the store
- GETRetrieves List of Products based on filters provided
- GETGet Product
- PATCHUpdate a single product with Json Merge Patch functionality
- 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
- POST
- Inventory
- Receiving
- Returns
- Webhooks
- Locations
Products
Get Product
GET
/
2.0
/
product
/
{productId}
Copy
Ask AI
curl --request GET \
--url https://api.shipbob.com/2.0/product/{productId} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"category": {
"id": 0,
"name": "string"
},
"created_on": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"sub_category": {
"id": 0,
"name": "string"
},
"type": "string",
"updated_on": "2019-08-24T14:15:22Z",
"user_id": 0,
"variants": [
{
"associated_bundles": [
{
"product_id": 0,
"product_name": "string",
"quantity": 0,
"variant_id": 0,
"variant_sku": "string"
}
],
"barcode": "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,
"length": 0.1,
"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,
"lot_information": {
"is_lot": true,
"minimum_shelf_life_days": 0
},
"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"
}
},
"sku": "string",
"status": "string",
"upc": "string",
"updated_on": "2019-08-24T14:15:22Z",
"weight": {
"unit": "string",
"weight": 0.1
}
}
]
}
Authorizations
Authentication using Personal Access Token (PAT) token
Path Parameters
Response
200
application/json
Success
The response is of type object
.
Was this page helpful?
Previous
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.
Next
Copy
Ask AI
curl --request GET \
--url https://api.shipbob.com/2.0/product/{productId} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"category": {
"id": 0,
"name": "string"
},
"created_on": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"sub_category": {
"id": 0,
"name": "string"
},
"type": "string",
"updated_on": "2019-08-24T14:15:22Z",
"user_id": 0,
"variants": [
{
"associated_bundles": [
{
"product_id": 0,
"product_name": "string",
"quantity": 0,
"variant_id": 0,
"variant_sku": "string"
}
],
"barcode": "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,
"length": 0.1,
"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,
"lot_information": {
"is_lot": true,
"minimum_shelf_life_days": 0
},
"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"
}
},
"sku": "string",
"status": "string",
"upc": "string",
"updated_on": "2019-08-24T14:15:22Z",
"weight": {
"unit": "string",
"weight": 0.1
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.