Channels
Receiving
Inventories
Products
- 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
- POSTCreate a new Channel Metadata Entry for a given Variant
- POSTMigrates existing variants to a new product
- GETGets Packaging Requirement
- GETGets Taxonomy by Id
- GETGets Taxonomy
- POSTMigrates variants to existing product
- POSTAdd new product variants to a product
- GETGets Product by Id
- DELDeletes Bundle and removes associations to related products
- PATCHUpdate a single product with Json Merge Patch functionality
- POSTUsed to merge two or more variants together
- GETGets Taxonomy Parent
- GETGets multiple product variants
- POSTAdds new product variants to a product
- PATCHUpdates multiple product variants
- GETRetrieves List of Products based on filters provided
- POSTCreate single product to the store
Products
Gets multiple product variants
Products
Gets multiple product variants
GET
/
product
/
{productId}
/
variants
curl --request GET \
--url https://api.shipbob.com/experimental/product/{productId}/variants \
--header 'Authorization: <api-key>'
[
{
"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"
}
],
"barcodes": [
{
"sticker_url": "string",
"value": "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 id
Response
200
application/json
Success
Was this page helpful?
curl --request GET \
--url https://api.shipbob.com/experimental/product/{productId}/variants \
--header 'Authorization: <api-key>'
[
{
"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"
}
],
"barcodes": [
{
"sticker_url": "string",
"value": "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
}
}
]