Products

Add, edit, and delete anything related to products.

Product

product_id	integer The product ID for the item in WP EasyCart. Leave blank if adding new or updating a product.
sku	string The model number / SKU
post_id	integer The post ID in WordPress for this item.
active	boolean Is this item activated in your store.
is_main	boolean Should we show this product on the main store page
sort_position	integer The default sort order.
title	string The product title
description	string The full description for the product
short_description	string The short description for the product
specifications	string The full specs for the product
	object (Pricing)
	object (ProductQuantity)
	object (Images)
	object (ProductShipping)
	object (ProductTax)
	object (Seo)
	object (CustomerReviews)
	object (Manufacturer)
	object (Download)
	object (Variants)
	Array of objects (ModifiersArray)
	Array of objects (CategoriesArray)
	object (MenuLocations)
	object (FeaturedProducts)
	object (ProductSubscription)
	object (ProductOrderNotes)
role_id	integer Restrict this product to a specific user role id
is_giftcard	boolean Is this a giftcard item
is_donation	boolean Is this a donation item
is_special	boolean Is this item on the special widget
	object (ProductStats)
	object (QuickbooksProduct)
	object (ProductSeasonal)
	object (ProductInquiry)
	object (Deconetwork)
	object (ProductDisplay)
square_id	string The SquareUp ID for this product, used for syncing.
square_variation_id	string The variation ID for this product, which is sometimes applicable.

{"product_id": 0,
"sku": "string",
"post_id": 0,
"active": true,
"is_main": true,
"sort_position": 0,
"title": "string",
"description": "string",
"short_description": "string",
"specifications": "string",
"pricing": {"price": "string",
"list_price": 0,
"product_cost": 0,
"custom_price_range": {"enable": true,
"range_low": 0,
"range_high": 0
},
"restrict_pricing": {"enable": true,
"user_level": "string",
"display_label": "string"
},
"price_label": {"enable": true,
"replace": true,
"label": "string"
}
},
"quantity": {"enabled": true,
"enable_variant_tracking": true,
"stock_quantity": {"stock_quantity": 0,
"variant_stock": [{"item_id": 0,
"product_id": 0,
"optionitem_1": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_2": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_3": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_4": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_5": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"enabled": true,
"tracking_enabled": true,
"quantity": 0,
"sku": "string",
"price": 0,
"square_id": "string"
}
]
},
"min_allowed": 0,
"max_allowed": 0,
"allow_backorders": true,
"backorder_fill_date": "string"
},
"images": {"enable_option_images": true,
"images_use_modifier": true,
"product_images": [{"type": "string",
"value": null
}
],
"option_images": [{"optionitem_id": 0,
"product_id": 0,
"images": [{"type": "string",
"value": null
}
]
}
]
},
"shipping": {"enabled": true,
"exclude_from_calculation": true,
"dimensions": {"weight": 0,
"length": 0,
"width": 0,
"height": 0
},
"handling_price": 0,
"handling_price_each": 0,
"shipping_class_id": 0,
"ship_to_billing": true,
"zone_restriction_id": 0
},
"tax": {"enable_tax": true,
"enable_vat": true,
"tic": "string"
},
"seo": {"seo_description": "string",
"seo_keywords": "string",
"post_excerpt": "string"
},
"reviews": {"enable": true,
"reviews": [{"review_id": 0,
"product_id": 0,
"user_id": 0,
"approved": true,
"rating": 0,
"title": "string",
"review_description": "string",
"date_submitted": "string",
"reviewer_name": "string"
}
]
},
"manufacturer": {"manufacturer_id": 0,
"manufacturer_name": "string",
"clicks": 0,
"post_id": 0
},
"download": {"enabled": true,
"file_name": "string",
"max_downloads": 0,
"max_seconds": 0,
"is_amazon": true,
"amazon_key": "string"
},
"variants": {"option_1": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_2": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_3": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_4": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_5": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
}
},
"modifiers": [{"modifier_id": 0,
"modifier_name": "string",
"modifier_label": "string",
"modifier_type": "string",
"modifier_meta": {"number_min": 0,
"number_max": 0,
"number_step": 0,
"text_min_length": 0,
"text_max_length": 0,
"url_var": "string",
"swatch_size": 0
},
"modifier_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"swatch_icon": "string",
"default_selected": true,
"default_value": "string",
"price_adjustment": {"type": "string",
"adjustment": 0
},
"weight_adjustment": {"type": "string",
"adjustment": 0
},
"enable_custom_price_label": true,
"custom_price_label": "string",
"download_allowed": true,
"download_override_file": "string",
"download_additional_file": "string",
"block_shipping": true,
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
}
],
"categories": [{"category_id": 0,
"post_id": 0,
"parent_id": 0,
"enabled": true,
"featured": true,
"category_name": "string",
"short_description": "string",
"category_image": "string",
"priority": 0,
"square_id": "string"
}
],
"menu": {"menu1": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu2": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu3": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
}
},
"featured_products": {"featured_product_1": 0,
"featured_product_2": 0,
"featured_product_3": 0,
"featured_product_4": 0
},
"subscription": {"enabled": true,
"bill_length": 0,
"bill_period": "string",
"bill_duration": 0,
"email_recurring": true,
"shipping_recurring": true,
"trial_days": 0,
"subscription_plan": {"plan_id": 0,
"plan_title": "string",
"can_downgrade": true
},
"allow_multiple": true,
"membership_page": "string",
"signup_fee": 0,
"stripe_product_id": 0,
"stripe_default_price_id": 0,
"prorate": true
},
"order_notes": {"success_note": "string",
"email_note": "string",
"order_details_note": "string"
},
"role_id": 0,
"is_giftcard": true,
"is_donation": true,
"is_special": true,
"stats": {"views": 0,
"last_viewed": "string"
},
"quickbooks": {"list_id": "string",
"edit_sequence": "string",
"quickbooks_status": "string",
"income_account_ref": "string",
"cogs_account_ref": "string",
"asset_account_ref": "string",
"parent_name": "string",
"parent_list_id": "string"
},
"seasonal": {"enabled": true,
"phrase": "string"
},
"inquiry": {"enabled": true,
"url": "string"
},
"deconetwork": {"enabled": true,
"mode": "string",
"product_id": "string",
"size_id": "string",
"color_id": "string",
"design_id": "string"
},
"display": {"display_type": 0,
"image_effect": 0,
"hover_type": 0,
"tag_type": 0,
"tag_bg_color": "string",
"tag_text_color": "string",
"tag_text": "string"
},
"square_id": "string",
"square_variation_id": "string"
}

ProductListItem

product_id	integer The product ID for the item in WP EasyCart. Leave blank if adding new or updating a product.
sku	string The model number / SKU
post_id	integer The post ID in WordPress for this item.
active	boolean Is this item activated in your store.
is_main	boolean Should we show this product on the main store page
sort_position	integer The default sort order.
title	string The product title
description	string The full description for the product
short_description	string The short description for the product
specifications	string The full specs for the product
	object (Pricing)
	object (ProductQuantitySimple)
	object (ImagesSimple)
	object (ProductShipping)
	object (ProductTax)
	object (Seo)
reviews_enabled	boolean Are customer reviews enabled
manufacturer_id	integer The manufacturer ID for this product
	object (Download)
	object (VariantsSimple)
	object (MenuLocations)
	object (FeaturedProducts)
	object (ProductSubscription)
	object (ProductOrderNotes)
role_id	integer Restrict this product to a specific user role id
is_giftcard	boolean Is this a giftcard item
is_donation	boolean Is this a donation item
is_special	boolean Is this item on the special widget
	object (ProductStats)
	object (QuickbooksProduct)
	object (ProductSeasonal)
	object (ProductInquiry)
	object (Deconetwork)
	object (ProductDisplay)
square_id	string The SquareUp ID for this product, used for syncing.
square_variation_id	string The variation ID for this product, which is sometimes applicable.

{"product_id": 0,
"sku": "string",
"post_id": 0,
"active": true,
"is_main": true,
"sort_position": 0,
"title": "string",
"description": "string",
"short_description": "string",
"specifications": "string",
"pricing": {"price": "string",
"list_price": 0,
"product_cost": 0,
"custom_price_range": {"enable": true,
"range_low": 0,
"range_high": 0
},
"restrict_pricing": {"enable": true,
"user_level": "string",
"display_label": "string"
},
"price_label": {"enable": true,
"replace": true,
"label": "string"
}
},
"quantity": {"enabled": true,
"enable_variant_tracking": true,
"stock_quantity_total": 0,
"min_allowed": 0,
"max_allowed": 0,
"allow_backorders": true,
"backorder_fill_date": "string"
},
"images": {"enable_option_images": true,
"images_use_modifier": true,
"product_images": [{"type": "string",
"value": null
}
]
},
"shipping": {"enabled": true,
"exclude_from_calculation": true,
"dimensions": {"weight": 0,
"length": 0,
"width": 0,
"height": 0
},
"handling_price": 0,
"handling_price_each": 0,
"shipping_class_id": 0,
"ship_to_billing": true,
"zone_restriction_id": 0
},
"tax": {"enable_tax": true,
"enable_vat": true,
"tic": "string"
},
"seo": {"seo_description": "string",
"seo_keywords": "string",
"post_excerpt": "string"
},
"reviews_enabled": true,
"manufacturer_id": 0,
"download": {"enabled": true,
"file_name": "string",
"max_downloads": 0,
"max_seconds": 0,
"is_amazon": true,
"amazon_key": "string"
},
"variants": {"option_1_id": 0,
"option_2_id": 0,
"option_3_id": 0,
"option_4_id": 0,
"option_5_id": 0
},
"menu": {"menu1": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu2": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu3": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
}
},
"featured_products": {"featured_product_1": 0,
"featured_product_2": 0,
"featured_product_3": 0,
"featured_product_4": 0
},
"subscription": {"enabled": true,
"bill_length": 0,
"bill_period": "string",
"bill_duration": 0,
"email_recurring": true,
"shipping_recurring": true,
"trial_days": 0,
"subscription_plan": {"plan_id": 0,
"plan_title": "string",
"can_downgrade": true
},
"allow_multiple": true,
"membership_page": "string",
"signup_fee": 0,
"stripe_product_id": 0,
"stripe_default_price_id": 0,
"prorate": true
},
"order_notes": {"success_note": "string",
"email_note": "string",
"order_details_note": "string"
},
"role_id": 0,
"is_giftcard": true,
"is_donation": true,
"is_special": true,
"stats": {"views": 0,
"last_viewed": "string"
},
"quickbooks": {"list_id": "string",
"edit_sequence": "string",
"quickbooks_status": "string",
"income_account_ref": "string",
"cogs_account_ref": "string",
"asset_account_ref": "string",
"parent_name": "string",
"parent_list_id": "string"
},
"seasonal": {"enabled": true,
"phrase": "string"
},
"inquiry": {"enabled": true,
"url": "string"
},
"deconetwork": {"enabled": true,
"mode": "string",
"product_id": "string",
"size_id": "string",
"color_id": "string",
"design_id": "string"
},
"display": {"display_type": 0,
"image_effect": 0,
"hover_type": 0,
"tag_type": 0,
"tag_bg_color": "string",
"tag_text_color": "string",
"tag_text": "string"
},
"square_id": "string",
"square_variation_id": "string"
}

ProductAdd

sku	string The model number / SKU
active	boolean Is this item activated in your store.
is_main	boolean Should we show this product on the main store page
sort_position	integer The default sort order.
title	string The product title
description	string The full description for the product
short_description	string The short description for the product
specifications	string The full specs for the product
	object (Pricing)
	object (ProductQuantity)
	object (Images)
	object (ProductShipping)
	object (ProductTax)
	object (Seo)
reviews_enabled	boolean Are customer reviews enabled
manufacturer_id	integer Manufacturer ID for product.
	object (Download)
	object (VariantsSimple)
	Array of objects (ModifiersArray)
	Array of objects (CategoriesArray)
	object (MenuLocations)
	object (FeaturedProducts)
	object (ProductSubscriptionAdd)
	object (ProductOrderNotes)
role_id	integer Restrict this product to a specific user role id
is_giftcard	boolean Is this a giftcard item
is_donation	boolean Is this a donation item
is_special	boolean Is this item on the special widget
	object (ProductStats)
	object (QuickbooksProduct)
	object (ProductSeasonal)
	object (ProductInquiry)
	object (Deconetwork)
	object (ProductDisplay)
square_id	string The SquareUp ID for this product, used for syncing.
square_variation_id	string The variation ID for this product, which is sometimes applicable.

{"sku": "string",
"active": true,
"is_main": true,
"sort_position": 0,
"title": "string",
"description": "string",
"short_description": "string",
"specifications": "string",
"pricing": {"price": "string",
"list_price": 0,
"product_cost": 0,
"custom_price_range": {"enable": true,
"range_low": 0,
"range_high": 0
},
"restrict_pricing": {"enable": true,
"user_level": "string",
"display_label": "string"
},
"price_label": {"enable": true,
"replace": true,
"label": "string"
}
},
"quantity": {"enabled": true,
"enable_variant_tracking": true,
"stock_quantity": {"stock_quantity": 0,
"variant_stock": [{"item_id": 0,
"product_id": 0,
"optionitem_1": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_2": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_3": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_4": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_5": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"enabled": true,
"tracking_enabled": true,
"quantity": 0,
"sku": "string",
"price": 0,
"square_id": "string"
}
]
},
"min_allowed": 0,
"max_allowed": 0,
"allow_backorders": true,
"backorder_fill_date": "string"
},
"images": {"enable_option_images": true,
"images_use_modifier": true,
"product_images": [{"type": "string",
"value": null
}
],
"option_images": [{"optionitem_id": 0,
"product_id": 0,
"images": [{"type": "string",
"value": null
}
]
}
]
},
"shipping": {"enabled": true,
"exclude_from_calculation": true,
"dimensions": {"weight": 0,
"length": 0,
"width": 0,
"height": 0
},
"handling_price": 0,
"handling_price_each": 0,
"shipping_class_id": 0,
"ship_to_billing": true,
"zone_restriction_id": 0
},
"tax": {"enable_tax": true,
"enable_vat": true,
"tic": "string"
},
"seo": {"seo_description": "string",
"seo_keywords": "string",
"post_excerpt": "string"
},
"reviews_enabled": true,
"manufacturer_id": 0,
"download": {"enabled": true,
"file_name": "string",
"max_downloads": 0,
"max_seconds": 0,
"is_amazon": true,
"amazon_key": "string"
},
"variants": {"option_1_id": 0,
"option_2_id": 0,
"option_3_id": 0,
"option_4_id": 0,
"option_5_id": 0
},
"modifiers": [{"modifier_id": 0,
"modifier_name": "string",
"modifier_label": "string",
"modifier_type": "string",
"modifier_meta": {"number_min": 0,
"number_max": 0,
"number_step": 0,
"text_min_length": 0,
"text_max_length": 0,
"url_var": "string",
"swatch_size": 0
},
"modifier_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"swatch_icon": "string",
"default_selected": true,
"default_value": "string",
"price_adjustment": {"type": "string",
"adjustment": 0
},
"weight_adjustment": {"type": "string",
"adjustment": 0
},
"enable_custom_price_label": true,
"custom_price_label": "string",
"download_allowed": true,
"download_override_file": "string",
"download_additional_file": "string",
"block_shipping": true,
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
}
],
"categories": [{"category_id": 0,
"post_id": 0,
"parent_id": 0,
"enabled": true,
"featured": true,
"category_name": "string",
"short_description": "string",
"category_image": "string",
"priority": 0,
"square_id": "string"
}
],
"menu": {"menu1": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu2": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu3": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
}
},
"featured_products": {"featured_product_1": 0,
"featured_product_2": 0,
"featured_product_3": 0,
"featured_product_4": 0
},
"subscription": {"enabled": true,
"bill_length": 0,
"bill_period": "string",
"bill_duration": 0,
"email_recurring": true,
"shipping_recurring": true,
"trial_days": 0,
"subscription_plan_id": 0,
"allow_multiple": true,
"membership_page": "string",
"signup_fee": 0,
"stripe_product_id": 0,
"stripe_default_price_id": 0,
"prorate": true
},
"order_notes": {"success_note": "string",
"email_note": "string",
"order_details_note": "string"
},
"role_id": 0,
"is_giftcard": true,
"is_donation": true,
"is_special": true,
"stats": {"views": 0,
"last_viewed": "string"
},
"quickbooks": {"list_id": "string",
"edit_sequence": "string",
"quickbooks_status": "string",
"income_account_ref": "string",
"cogs_account_ref": "string",
"asset_account_ref": "string",
"parent_name": "string",
"parent_list_id": "string"
},
"seasonal": {"enabled": true,
"phrase": "string"
},
"inquiry": {"enabled": true,
"url": "string"
},
"deconetwork": {"enabled": true,
"mode": "string",
"product_id": "string",
"size_id": "string",
"color_id": "string",
"design_id": "string"
},
"display": {"display_type": 0,
"image_effect": 0,
"hover_type": 0,
"tag_type": 0,
"tag_bg_color": "string",
"tag_text_color": "string",
"tag_text": "string"
},
"square_id": "string",
"square_variation_id": "string"
}

Gets a list of products

This allows you to get a list of products

SecuritybearerAuth or basicAuth

Request

query Parameters

page	integer <int64> Page number starting at 1
perpage	integer <int64> Number of items per page
sortby	string Sort results by term
sortdir	string Sort results ASC or DESC
search	string Filter orders by a search term

Responses

200

Successful operation

400

Unauthorized

get/products

Request samples

curl
Node.js
JavaScript
PHP
Python

Response samples

application/json

[{"product_id": 0,
"sku": "string",
"post_id": 0,
"active": true,
"is_main": true,
"sort_position": 0,
"title": "string",
"description": "string",
"short_description": "string",
"specifications": "string",
"pricing": {"price": "string",
"list_price": 0,
"product_cost": 0,
"custom_price_range": {"enable": true,
"range_low": 0,
"range_high": 0
},
"restrict_pricing": {"enable": true,
"user_level": "string",
"display_label": "string"
},
"price_label": {"enable": true,
"replace": true,
"label": "string"
}
},
"quantity": {"enabled": true,
"enable_variant_tracking": true,
"stock_quantity_total": 0,
"min_allowed": 0,
"max_allowed": 0,
"allow_backorders": true,
"backorder_fill_date": "string"
},
"images": {"enable_option_images": true,
"images_use_modifier": true,
"product_images": [{"type": "string",
"value": null
}
]
},
"shipping": {"enabled": true,
"exclude_from_calculation": true,
"dimensions": {"weight": 0,
"length": 0,
"width": 0,
"height": 0
},
"handling_price": 0,
"handling_price_each": 0,
"shipping_class_id": 0,
"ship_to_billing": true,
"zone_restriction_id": 0
},
"tax": {"enable_tax": true,
"enable_vat": true,
"tic": "string"
},
"seo": {"seo_description": "string",
"seo_keywords": "string",
"post_excerpt": "string"
},
"reviews_enabled": true,
"manufacturer_id": 0,
"download": {"enabled": true,
"file_name": "string",
"max_downloads": 0,
"max_seconds": 0,
"is_amazon": true,
"amazon_key": "string"
},
"variants": {"option_1_id": 0,
"option_2_id": 0,
"option_3_id": 0,
"option_4_id": 0,
"option_5_id": 0
},
"menu": {"menu1": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu2": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu3": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
}
},
"featured_products": {"featured_product_1": 0,
"featured_product_2": 0,
"featured_product_3": 0,
"featured_product_4": 0
},
"subscription": {"enabled": true,
"bill_length": 0,
"bill_period": "string",
"bill_duration": 0,
"email_recurring": true,
"shipping_recurring": true,
"trial_days": 0,
"subscription_plan": {"plan_id": 0,
"plan_title": "string",
"can_downgrade": true
},
"allow_multiple": true,
"membership_page": "string",
"signup_fee": 0,
"stripe_product_id": 0,
"stripe_default_price_id": 0,
"prorate": true
},
"order_notes": {"success_note": "string",
"email_note": "string",
"order_details_note": "string"
},
"role_id": 0,
"is_giftcard": true,
"is_donation": true,
"is_special": true,
"stats": {"views": 0,
"last_viewed": "string"
},
"quickbooks": {"list_id": "string",
"edit_sequence": "string",
"quickbooks_status": "string",
"income_account_ref": "string",
"cogs_account_ref": "string",
"asset_account_ref": "string",
"parent_name": "string",
"parent_list_id": "string"
},
"seasonal": {"enabled": true,
"phrase": "string"
},
"inquiry": {"enabled": true,
"url": "string"
},
"deconetwork": {"enabled": true,
"mode": "string",
"product_id": "string",
"size_id": "string",
"color_id": "string",
"design_id": "string"
},
"display": {"display_type": 0,
"image_effect": 0,
"hover_type": 0,
"tag_type": 0,
"tag_bg_color": "string",
"tag_text_color": "string",
"tag_text": "string"
},
"square_id": "string",
"square_variation_id": "string"
}
]

Add a product

This allows you to add a new product

SecuritybearerAuth

Request

Request Body schema: application/json
required

Submit any or all elements to add a new product.

sku required	string The model number / SKU
active	boolean Is this item activated in your store.
is_main	boolean Should we show this product on the main store page
sort_position	integer The default sort order.
title required	string The product title
description	string The full description for the product
short_description	string The short description for the product
specifications	string The full specs for the product
	object (Pricing)
	object (ProductQuantity)
	object (Images)
	object (ProductShipping)
	object (ProductTax)
	object (Seo)
reviews_enabled	boolean Are customer reviews enabled
manufacturer_id	integer Manufacturer ID for product.
	object (Download)
	object (VariantsSimple)
	Array of objects (ModifiersArray)
	Array of objects (CategoriesArray)
	object (MenuLocations)
	object (FeaturedProducts)
	object (ProductSubscriptionAdd)
	object (ProductOrderNotes)
role_id	integer Restrict this product to a specific user role id
is_giftcard	boolean Is this a giftcard item
is_donation	boolean Is this a donation item
is_special	boolean Is this item on the special widget
	object (ProductStats)
	object (QuickbooksProduct)
	object (ProductSeasonal)
	object (ProductInquiry)
	object (Deconetwork)
	object (ProductDisplay)
square_id	string The SquareUp ID for this product, used for syncing.
square_variation_id	string The variation ID for this product, which is sometimes applicable.

Responses

200

Successful operation

400

Unauthorized

post/products

Request samples

application/json

{"sku": "string",
"active": true,
"is_main": true,
"sort_position": 0,
"title": "string",
"description": "string",
"short_description": "string",
"specifications": "string",
"pricing": {"price": "string",
"list_price": 0,
"product_cost": 0,
"custom_price_range": {"enable": true,
"range_low": 0,
"range_high": 0
},
"restrict_pricing": {"enable": true,
"user_level": "string",
"display_label": "string"
},
"price_label": {"enable": true,
"replace": true,
"label": "string"
}
},
"quantity": {"enabled": true,
"enable_variant_tracking": true,
"stock_quantity": {"stock_quantity": 0,
"variant_stock": [{"item_id": 0,
"product_id": 0,
"optionitem_1": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_2": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_3": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_4": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_5": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"enabled": true,
"tracking_enabled": true,
"quantity": 0,
"sku": "string",
"price": 0,
"square_id": "string"
}
]
},
"min_allowed": 0,
"max_allowed": 0,
"allow_backorders": true,
"backorder_fill_date": "string"
},
"images": {"enable_option_images": true,
"images_use_modifier": true,
"product_images": [{"type": "string",
"value": null
}
],
"option_images": [{"optionitem_id": 0,
"product_id": 0,
"images": [{"type": "string",
"value": null
}
]
}
]
},
"shipping": {"enabled": true,
"exclude_from_calculation": true,
"dimensions": {"weight": 0,
"length": 0,
"width": 0,
"height": 0
},
"handling_price": 0,
"handling_price_each": 0,
"shipping_class_id": 0,
"ship_to_billing": true,
"zone_restriction_id": 0
},
"tax": {"enable_tax": true,
"enable_vat": true,
"tic": "string"
},
"seo": {"seo_description": "string",
"seo_keywords": "string",
"post_excerpt": "string"
},
"reviews_enabled": true,
"manufacturer_id": 0,
"download": {"enabled": true,
"file_name": "string",
"max_downloads": 0,
"max_seconds": 0,
"is_amazon": true,
"amazon_key": "string"
},
"variants": {"option_1_id": 0,
"option_2_id": 0,
"option_3_id": 0,
"option_4_id": 0,
"option_5_id": 0
},
"modifiers": [{"modifier_id": 0,
"modifier_name": "string",
"modifier_label": "string",
"modifier_type": "string",
"modifier_meta": {"number_min": 0,
"number_max": 0,
"number_step": 0,
"text_min_length": 0,
"text_max_length": 0,
"url_var": "string",
"swatch_size": 0
},
"modifier_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"swatch_icon": "string",
"default_selected": true,
"default_value": "string",
"price_adjustment": {"type": "string",
"adjustment": 0
},
"weight_adjustment": {"type": "string",
"adjustment": 0
},
"enable_custom_price_label": true,
"custom_price_label": "string",
"download_allowed": true,
"download_override_file": "string",
"download_additional_file": "string",
"block_shipping": true,
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
}
],
"categories": [{"category_id": 0,
"post_id": 0,
"parent_id": 0,
"enabled": true,
"featured": true,
"category_name": "string",
"short_description": "string",
"category_image": "string",
"priority": 0,
"square_id": "string"
}
],
"menu": {"menu1": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu2": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu3": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
}
},
"featured_products": {"featured_product_1": 0,
"featured_product_2": 0,
"featured_product_3": 0,
"featured_product_4": 0
},
"subscription": {"enabled": true,
"bill_length": 0,
"bill_period": "string",
"bill_duration": 0,
"email_recurring": true,
"shipping_recurring": true,
"trial_days": 0,
"subscription_plan_id": 0,
"allow_multiple": true,
"membership_page": "string",
"signup_fee": 0,
"stripe_product_id": 0,
"stripe_default_price_id": 0,
"prorate": true
},
"order_notes": {"success_note": "string",
"email_note": "string",
"order_details_note": "string"
},
"role_id": 0,
"is_giftcard": true,
"is_donation": true,
"is_special": true,
"stats": {"views": 0,
"last_viewed": "string"
},
"quickbooks": {"list_id": "string",
"edit_sequence": "string",
"quickbooks_status": "string",
"income_account_ref": "string",
"cogs_account_ref": "string",
"asset_account_ref": "string",
"parent_name": "string",
"parent_list_id": "string"
},
"seasonal": {"enabled": true,
"phrase": "string"
},
"inquiry": {"enabled": true,
"url": "string"
},
"deconetwork": {"enabled": true,
"mode": "string",
"product_id": "string",
"size_id": "string",
"color_id": "string",
"design_id": "string"
},
"display": {"display_type": 0,
"image_effect": 0,
"hover_type": 0,
"tag_type": 0,
"tag_bg_color": "string",
"tag_text_color": "string",
"tag_text": "string"
},
"square_id": "string",
"square_variation_id": "string"
}

Response samples

application/json

{"product_id": 0,
"sku": "string",
"post_id": 0,
"active": true,
"is_main": true,
"sort_position": 0,
"title": "string",
"description": "string",
"short_description": "string",
"specifications": "string",
"pricing": {"price": "string",
"list_price": 0,
"product_cost": 0,
"custom_price_range": {"enable": true,
"range_low": 0,
"range_high": 0
},
"restrict_pricing": {"enable": true,
"user_level": "string",
"display_label": "string"
},
"price_label": {"enable": true,
"replace": true,
"label": "string"
}
},
"quantity": {"enabled": true,
"enable_variant_tracking": true,
"stock_quantity": {"stock_quantity": 0,
"variant_stock": [{"item_id": 0,
"product_id": 0,
"optionitem_1": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_2": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_3": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_4": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_5": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"enabled": true,
"tracking_enabled": true,
"quantity": 0,
"sku": "string",
"price": 0,
"square_id": "string"
}
]
},
"min_allowed": 0,
"max_allowed": 0,
"allow_backorders": true,
"backorder_fill_date": "string"
},
"images": {"enable_option_images": true,
"images_use_modifier": true,
"product_images": [{"type": "string",
"value": null
}
],
"option_images": [{"optionitem_id": 0,
"product_id": 0,
"images": [{"type": "string",
"value": null
}
]
}
]
},
"shipping": {"enabled": true,
"exclude_from_calculation": true,
"dimensions": {"weight": 0,
"length": 0,
"width": 0,
"height": 0
},
"handling_price": 0,
"handling_price_each": 0,
"shipping_class_id": 0,
"ship_to_billing": true,
"zone_restriction_id": 0
},
"tax": {"enable_tax": true,
"enable_vat": true,
"tic": "string"
},
"seo": {"seo_description": "string",
"seo_keywords": "string",
"post_excerpt": "string"
},
"reviews": {"enable": true,
"reviews": [{"review_id": 0,
"product_id": 0,
"user_id": 0,
"approved": true,
"rating": 0,
"title": "string",
"review_description": "string",
"date_submitted": "string",
"reviewer_name": "string"
}
]
},
"manufacturer": {"manufacturer_id": 0,
"manufacturer_name": "string",
"clicks": 0,
"post_id": 0
},
"download": {"enabled": true,
"file_name": "string",
"max_downloads": 0,
"max_seconds": 0,
"is_amazon": true,
"amazon_key": "string"
},
"variants": {"option_1": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_2": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_3": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_4": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_5": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
}
},
"modifiers": [{"modifier_id": 0,
"modifier_name": "string",
"modifier_label": "string",
"modifier_type": "string",
"modifier_meta": {"number_min": 0,
"number_max": 0,
"number_step": 0,
"text_min_length": 0,
"text_max_length": 0,
"url_var": "string",
"swatch_size": 0
},
"modifier_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"swatch_icon": "string",
"default_selected": true,
"default_value": "string",
"price_adjustment": {"type": "string",
"adjustment": 0
},
"weight_adjustment": {"type": "string",
"adjustment": 0
},
"enable_custom_price_label": true,
"custom_price_label": "string",
"download_allowed": true,
"download_override_file": "string",
"download_additional_file": "string",
"block_shipping": true,
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
}
],
"categories": [{"category_id": 0,
"post_id": 0,
"parent_id": 0,
"enabled": true,
"featured": true,
"category_name": "string",
"short_description": "string",
"category_image": "string",
"priority": 0,
"square_id": "string"
}
],
"menu": {"menu1": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu2": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu3": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
}
},
"featured_products": {"featured_product_1": 0,
"featured_product_2": 0,
"featured_product_3": 0,
"featured_product_4": 0
},
"subscription": {"enabled": true,
"bill_length": 0,
"bill_period": "string",
"bill_duration": 0,
"email_recurring": true,
"shipping_recurring": true,
"trial_days": 0,
"subscription_plan": {"plan_id": 0,
"plan_title": "string",
"can_downgrade": true
},
"allow_multiple": true,
"membership_page": "string",
"signup_fee": 0,
"stripe_product_id": 0,
"stripe_default_price_id": 0,
"prorate": true
},
"order_notes": {"success_note": "string",
"email_note": "string",
"order_details_note": "string"
},
"role_id": 0,
"is_giftcard": true,
"is_donation": true,
"is_special": true,
"stats": {"views": 0,
"last_viewed": "string"
},
"quickbooks": {"list_id": "string",
"edit_sequence": "string",
"quickbooks_status": "string",
"income_account_ref": "string",
"cogs_account_ref": "string",
"asset_account_ref": "string",
"parent_name": "string",
"parent_list_id": "string"
},
"seasonal": {"enabled": true,
"phrase": "string"
},
"inquiry": {"enabled": true,
"url": "string"
},
"deconetwork": {"enabled": true,
"mode": "string",
"product_id": "string",
"size_id": "string",
"color_id": "string",
"design_id": "string"
},
"display": {"display_type": 0,
"image_effect": 0,
"hover_type": 0,
"tag_type": 0,
"tag_bg_color": "string",
"tag_text_color": "string",
"tag_text": "string"
},
"square_id": "string",
"square_variation_id": "string"
}

Gets a product by ID

This allows you to get an product from your store by Product ID

SecuritybearerAuth or basicAuth

Request

path Parameters

product_id

required

integer <int64>

Product ID

Responses

200

Successful operation

400

Unauthorized

get/products/{product_id}

Request samples

curl
Node.js
JavaScript
PHP
Python

Response samples

application/json

{"product_id": 0,
"sku": "string",
"post_id": 0,
"active": true,
"is_main": true,
"sort_position": 0,
"title": "string",
"description": "string",
"short_description": "string",
"specifications": "string",
"pricing": {"price": "string",
"list_price": 0,
"product_cost": 0,
"custom_price_range": {"enable": true,
"range_low": 0,
"range_high": 0
},
"restrict_pricing": {"enable": true,
"user_level": "string",
"display_label": "string"
},
"price_label": {"enable": true,
"replace": true,
"label": "string"
}
},
"quantity": {"enabled": true,
"enable_variant_tracking": true,
"stock_quantity": {"stock_quantity": 0,
"variant_stock": [{"item_id": 0,
"product_id": 0,
"optionitem_1": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_2": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_3": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_4": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_5": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"enabled": true,
"tracking_enabled": true,
"quantity": 0,
"sku": "string",
"price": 0,
"square_id": "string"
}
]
},
"min_allowed": 0,
"max_allowed": 0,
"allow_backorders": true,
"backorder_fill_date": "string"
},
"images": {"enable_option_images": true,
"images_use_modifier": true,
"product_images": [{"type": "string",
"value": null
}
],
"option_images": [{"optionitem_id": 0,
"product_id": 0,
"images": [{"type": "string",
"value": null
}
]
}
]
},
"shipping": {"enabled": true,
"exclude_from_calculation": true,
"dimensions": {"weight": 0,
"length": 0,
"width": 0,
"height": 0
},
"handling_price": 0,
"handling_price_each": 0,
"shipping_class_id": 0,
"ship_to_billing": true,
"zone_restriction_id": 0
},
"tax": {"enable_tax": true,
"enable_vat": true,
"tic": "string"
},
"seo": {"seo_description": "string",
"seo_keywords": "string",
"post_excerpt": "string"
},
"reviews": {"enable": true,
"reviews": [{"review_id": 0,
"product_id": 0,
"user_id": 0,
"approved": true,
"rating": 0,
"title": "string",
"review_description": "string",
"date_submitted": "string",
"reviewer_name": "string"
}
]
},
"manufacturer": {"manufacturer_id": 0,
"manufacturer_name": "string",
"clicks": 0,
"post_id": 0
},
"download": {"enabled": true,
"file_name": "string",
"max_downloads": 0,
"max_seconds": 0,
"is_amazon": true,
"amazon_key": "string"
},
"variants": {"option_1": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_2": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_3": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_4": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_5": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
}
},
"modifiers": [{"modifier_id": 0,
"modifier_name": "string",
"modifier_label": "string",
"modifier_type": "string",
"modifier_meta": {"number_min": 0,
"number_max": 0,
"number_step": 0,
"text_min_length": 0,
"text_max_length": 0,
"url_var": "string",
"swatch_size": 0
},
"modifier_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"swatch_icon": "string",
"default_selected": true,
"default_value": "string",
"price_adjustment": {"type": "string",
"adjustment": 0
},
"weight_adjustment": {"type": "string",
"adjustment": 0
},
"enable_custom_price_label": true,
"custom_price_label": "string",
"download_allowed": true,
"download_override_file": "string",
"download_additional_file": "string",
"block_shipping": true,
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
}
],
"categories": [{"category_id": 0,
"post_id": 0,
"parent_id": 0,
"enabled": true,
"featured": true,
"category_name": "string",
"short_description": "string",
"category_image": "string",
"priority": 0,
"square_id": "string"
}
],
"menu": {"menu1": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu2": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu3": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
}
},
"featured_products": {"featured_product_1": 0,
"featured_product_2": 0,
"featured_product_3": 0,
"featured_product_4": 0
},
"subscription": {"enabled": true,
"bill_length": 0,
"bill_period": "string",
"bill_duration": 0,
"email_recurring": true,
"shipping_recurring": true,
"trial_days": 0,
"subscription_plan": {"plan_id": 0,
"plan_title": "string",
"can_downgrade": true
},
"allow_multiple": true,
"membership_page": "string",
"signup_fee": 0,
"stripe_product_id": 0,
"stripe_default_price_id": 0,
"prorate": true
},
"order_notes": {"success_note": "string",
"email_note": "string",
"order_details_note": "string"
},
"role_id": 0,
"is_giftcard": true,
"is_donation": true,
"is_special": true,
"stats": {"views": 0,
"last_viewed": "string"
},
"quickbooks": {"list_id": "string",
"edit_sequence": "string",
"quickbooks_status": "string",
"income_account_ref": "string",
"cogs_account_ref": "string",
"asset_account_ref": "string",
"parent_name": "string",
"parent_list_id": "string"
},
"seasonal": {"enabled": true,
"phrase": "string"
},
"inquiry": {"enabled": true,
"url": "string"
},
"deconetwork": {"enabled": true,
"mode": "string",
"product_id": "string",
"size_id": "string",
"color_id": "string",
"design_id": "string"
},
"display": {"display_type": 0,
"image_effect": 0,
"hover_type": 0,
"tag_type": 0,
"tag_bg_color": "string",
"tag_text_color": "string",
"tag_text": "string"
},
"square_id": "string",
"square_variation_id": "string"
}

Updates a product by ID

This allows you to update a product by Product ID

SecuritybearerAuth

Request

path Parameters

product_id

required

integer <int64>

Product ID

Request Body schema: application/json
required

Submit any or all elements to update the product by ID.

sku	string The model number / SKU
active	boolean Is this item activated in your store.
is_main	boolean Should we show this product on the main store page
sort_position	integer The default sort order.
title	string The product title
description	string The full description for the product
short_description	string The short description for the product
specifications	string The full specs for the product
	object (Pricing)
	object (ProductQuantity)
	object (Images)
	object (ProductShipping)
	object (ProductTax)
	object (Seo)
reviews_enabled	boolean Are customer reviews enabled
manufacturer_id	integer Manufacturer ID for product.
	object (Download)
	object (VariantsSimple)
	Array of objects (ModifiersArray)
	Array of objects (CategoriesArray)
	object (MenuLocations)
	object (FeaturedProducts)
	object (ProductSubscriptionAdd)
	object (ProductOrderNotes)
role_id	integer Restrict this product to a specific user role id
is_giftcard	boolean Is this a giftcard item
is_donation	boolean Is this a donation item
is_special	boolean Is this item on the special widget
	object (ProductStats)
	object (QuickbooksProduct)
	object (ProductSeasonal)
	object (ProductInquiry)
	object (Deconetwork)
	object (ProductDisplay)
square_id	string The SquareUp ID for this product, used for syncing.
square_variation_id	string The variation ID for this product, which is sometimes applicable.

Responses

200

Successful operation

400

Unauthorized

patch/products/{product_id}

Request samples

application/json

{"sku": "string",
"active": true,
"is_main": true,
"sort_position": 0,
"title": "string",
"description": "string",
"short_description": "string",
"specifications": "string",
"pricing": {"price": "string",
"list_price": 0,
"product_cost": 0,
"custom_price_range": {"enable": true,
"range_low": 0,
"range_high": 0
},
"restrict_pricing": {"enable": true,
"user_level": "string",
"display_label": "string"
},
"price_label": {"enable": true,
"replace": true,
"label": "string"
}
},
"quantity": {"enabled": true,
"enable_variant_tracking": true,
"stock_quantity": {"stock_quantity": 0,
"variant_stock": [{"item_id": 0,
"product_id": 0,
"optionitem_1": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_2": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_3": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_4": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_5": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"enabled": true,
"tracking_enabled": true,
"quantity": 0,
"sku": "string",
"price": 0,
"square_id": "string"
}
]
},
"min_allowed": 0,
"max_allowed": 0,
"allow_backorders": true,
"backorder_fill_date": "string"
},
"images": {"enable_option_images": true,
"images_use_modifier": true,
"product_images": [{"type": "string",
"value": null
}
],
"option_images": [{"optionitem_id": 0,
"product_id": 0,
"images": [{"type": "string",
"value": null
}
]
}
]
},
"shipping": {"enabled": true,
"exclude_from_calculation": true,
"dimensions": {"weight": 0,
"length": 0,
"width": 0,
"height": 0
},
"handling_price": 0,
"handling_price_each": 0,
"shipping_class_id": 0,
"ship_to_billing": true,
"zone_restriction_id": 0
},
"tax": {"enable_tax": true,
"enable_vat": true,
"tic": "string"
},
"seo": {"seo_description": "string",
"seo_keywords": "string",
"post_excerpt": "string"
},
"reviews_enabled": true,
"manufacturer_id": 0,
"download": {"enabled": true,
"file_name": "string",
"max_downloads": 0,
"max_seconds": 0,
"is_amazon": true,
"amazon_key": "string"
},
"variants": {"option_1_id": 0,
"option_2_id": 0,
"option_3_id": 0,
"option_4_id": 0,
"option_5_id": 0
},
"modifiers": [{"modifier_id": 0,
"modifier_name": "string",
"modifier_label": "string",
"modifier_type": "string",
"modifier_meta": {"number_min": 0,
"number_max": 0,
"number_step": 0,
"text_min_length": 0,
"text_max_length": 0,
"url_var": "string",
"swatch_size": 0
},
"modifier_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"swatch_icon": "string",
"default_selected": true,
"default_value": "string",
"price_adjustment": {"type": "string",
"adjustment": 0
},
"weight_adjustment": {"type": "string",
"adjustment": 0
},
"enable_custom_price_label": true,
"custom_price_label": "string",
"download_allowed": true,
"download_override_file": "string",
"download_additional_file": "string",
"block_shipping": true,
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
}
],
"categories": [{"category_id": 0,
"post_id": 0,
"parent_id": 0,
"enabled": true,
"featured": true,
"category_name": "string",
"short_description": "string",
"category_image": "string",
"priority": 0,
"square_id": "string"
}
],
"menu": {"menu1": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu2": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu3": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
}
},
"featured_products": {"featured_product_1": 0,
"featured_product_2": 0,
"featured_product_3": 0,
"featured_product_4": 0
},
"subscription": {"enabled": true,
"bill_length": 0,
"bill_period": "string",
"bill_duration": 0,
"email_recurring": true,
"shipping_recurring": true,
"trial_days": 0,
"subscription_plan_id": 0,
"allow_multiple": true,
"membership_page": "string",
"signup_fee": 0,
"stripe_product_id": 0,
"stripe_default_price_id": 0,
"prorate": true
},
"order_notes": {"success_note": "string",
"email_note": "string",
"order_details_note": "string"
},
"role_id": 0,
"is_giftcard": true,
"is_donation": true,
"is_special": true,
"stats": {"views": 0,
"last_viewed": "string"
},
"quickbooks": {"list_id": "string",
"edit_sequence": "string",
"quickbooks_status": "string",
"income_account_ref": "string",
"cogs_account_ref": "string",
"asset_account_ref": "string",
"parent_name": "string",
"parent_list_id": "string"
},
"seasonal": {"enabled": true,
"phrase": "string"
},
"inquiry": {"enabled": true,
"url": "string"
},
"deconetwork": {"enabled": true,
"mode": "string",
"product_id": "string",
"size_id": "string",
"color_id": "string",
"design_id": "string"
},
"display": {"display_type": 0,
"image_effect": 0,
"hover_type": 0,
"tag_type": 0,
"tag_bg_color": "string",
"tag_text_color": "string",
"tag_text": "string"
},
"square_id": "string",
"square_variation_id": "string"
}

Response samples

application/json

{"product_id": 0,
"sku": "string",
"post_id": 0,
"active": true,
"is_main": true,
"sort_position": 0,
"title": "string",
"description": "string",
"short_description": "string",
"specifications": "string",
"pricing": {"price": "string",
"list_price": 0,
"product_cost": 0,
"custom_price_range": {"enable": true,
"range_low": 0,
"range_high": 0
},
"restrict_pricing": {"enable": true,
"user_level": "string",
"display_label": "string"
},
"price_label": {"enable": true,
"replace": true,
"label": "string"
}
},
"quantity": {"enabled": true,
"enable_variant_tracking": true,
"stock_quantity": {"stock_quantity": 0,
"variant_stock": [{"item_id": 0,
"product_id": 0,
"optionitem_1": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_2": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_3": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_4": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_5": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"enabled": true,
"tracking_enabled": true,
"quantity": 0,
"sku": "string",
"price": 0,
"square_id": "string"
}
]
},
"min_allowed": 0,
"max_allowed": 0,
"allow_backorders": true,
"backorder_fill_date": "string"
},
"images": {"enable_option_images": true,
"images_use_modifier": true,
"product_images": [{"type": "string",
"value": null
}
],
"option_images": [{"optionitem_id": 0,
"product_id": 0,
"images": [{"type": "string",
"value": null
}
]
}
]
},
"shipping": {"enabled": true,
"exclude_from_calculation": true,
"dimensions": {"weight": 0,
"length": 0,
"width": 0,
"height": 0
},
"handling_price": 0,
"handling_price_each": 0,
"shipping_class_id": 0,
"ship_to_billing": true,
"zone_restriction_id": 0
},
"tax": {"enable_tax": true,
"enable_vat": true,
"tic": "string"
},
"seo": {"seo_description": "string",
"seo_keywords": "string",
"post_excerpt": "string"
},
"reviews": {"enable": true,
"reviews": [{"review_id": 0,
"product_id": 0,
"user_id": 0,
"approved": true,
"rating": 0,
"title": "string",
"review_description": "string",
"date_submitted": "string",
"reviewer_name": "string"
}
]
},
"manufacturer": {"manufacturer_id": 0,
"manufacturer_name": "string",
"clicks": 0,
"post_id": 0
},
"download": {"enabled": true,
"file_name": "string",
"max_downloads": 0,
"max_seconds": 0,
"is_amazon": true,
"amazon_key": "string"
},
"variants": {"option_1": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_2": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_3": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_4": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_5": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
}
},
"modifiers": [{"modifier_id": 0,
"modifier_name": "string",
"modifier_label": "string",
"modifier_type": "string",
"modifier_meta": {"number_min": 0,
"number_max": 0,
"number_step": 0,
"text_min_length": 0,
"text_max_length": 0,
"url_var": "string",
"swatch_size": 0
},
"modifier_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"swatch_icon": "string",
"default_selected": true,
"default_value": "string",
"price_adjustment": {"type": "string",
"adjustment": 0
},
"weight_adjustment": {"type": "string",
"adjustment": 0
},
"enable_custom_price_label": true,
"custom_price_label": "string",
"download_allowed": true,
"download_override_file": "string",
"download_additional_file": "string",
"block_shipping": true,
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
}
],
"categories": [{"category_id": 0,
"post_id": 0,
"parent_id": 0,
"enabled": true,
"featured": true,
"category_name": "string",
"short_description": "string",
"category_image": "string",
"priority": 0,
"square_id": "string"
}
],
"menu": {"menu1": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu2": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu3": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
}
},
"featured_products": {"featured_product_1": 0,
"featured_product_2": 0,
"featured_product_3": 0,
"featured_product_4": 0
},
"subscription": {"enabled": true,
"bill_length": 0,
"bill_period": "string",
"bill_duration": 0,
"email_recurring": true,
"shipping_recurring": true,
"trial_days": 0,
"subscription_plan": {"plan_id": 0,
"plan_title": "string",
"can_downgrade": true
},
"allow_multiple": true,
"membership_page": "string",
"signup_fee": 0,
"stripe_product_id": 0,
"stripe_default_price_id": 0,
"prorate": true
},
"order_notes": {"success_note": "string",
"email_note": "string",
"order_details_note": "string"
},
"role_id": 0,
"is_giftcard": true,
"is_donation": true,
"is_special": true,
"stats": {"views": 0,
"last_viewed": "string"
},
"quickbooks": {"list_id": "string",
"edit_sequence": "string",
"quickbooks_status": "string",
"income_account_ref": "string",
"cogs_account_ref": "string",
"asset_account_ref": "string",
"parent_name": "string",
"parent_list_id": "string"
},
"seasonal": {"enabled": true,
"phrase": "string"
},
"inquiry": {"enabled": true,
"url": "string"
},
"deconetwork": {"enabled": true,
"mode": "string",
"product_id": "string",
"size_id": "string",
"color_id": "string",
"design_id": "string"
},
"display": {"display_type": 0,
"image_effect": 0,
"hover_type": 0,
"tag_type": 0,
"tag_bg_color": "string",
"tag_text_color": "string",
"tag_text": "string"
},
"square_id": "string",
"square_variation_id": "string"
}

Deletes a product by ID

This allows you to delete a product from your store by Product ID

SecuritybearerAuth

Request

path Parameters

product_id

required

integer <int64>

Product ID

Responses

200

Successful operation

400

Unauthorized

delete/products/{product_id}

Request samples

curl
Node.js
JavaScript
PHP
Python

Response samples

application/json

{"product_id": 0,
"sku": "string",
"post_id": 0,
"active": true,
"is_main": true,
"sort_position": 0,
"title": "string",
"description": "string",
"short_description": "string",
"specifications": "string",
"pricing": {"price": "string",
"list_price": 0,
"product_cost": 0,
"custom_price_range": {"enable": true,
"range_low": 0,
"range_high": 0
},
"restrict_pricing": {"enable": true,
"user_level": "string",
"display_label": "string"
},
"price_label": {"enable": true,
"replace": true,
"label": "string"
}
},
"quantity": {"enabled": true,
"enable_variant_tracking": true,
"stock_quantity": {"stock_quantity": 0,
"variant_stock": [{"item_id": 0,
"product_id": 0,
"optionitem_1": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_2": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_3": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_4": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"optionitem_5": {"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
},
"enabled": true,
"tracking_enabled": true,
"quantity": 0,
"sku": "string",
"price": 0,
"square_id": "string"
}
]
},
"min_allowed": 0,
"max_allowed": 0,
"allow_backorders": true,
"backorder_fill_date": "string"
},
"images": {"enable_option_images": true,
"images_use_modifier": true,
"product_images": [{"type": "string",
"value": null
}
],
"option_images": [{"optionitem_id": 0,
"product_id": 0,
"images": [{"type": "string",
"value": null
}
]
}
]
},
"shipping": {"enabled": true,
"exclude_from_calculation": true,
"dimensions": {"weight": 0,
"length": 0,
"width": 0,
"height": 0
},
"handling_price": 0,
"handling_price_each": 0,
"shipping_class_id": 0,
"ship_to_billing": true,
"zone_restriction_id": 0
},
"tax": {"enable_tax": true,
"enable_vat": true,
"tic": "string"
},
"seo": {"seo_description": "string",
"seo_keywords": "string",
"post_excerpt": "string"
},
"reviews": {"enable": true,
"reviews": [{"review_id": 0,
"product_id": 0,
"user_id": 0,
"approved": true,
"rating": 0,
"title": "string",
"review_description": "string",
"date_submitted": "string",
"reviewer_name": "string"
}
]
},
"manufacturer": {"manufacturer_id": 0,
"manufacturer_name": "string",
"clicks": 0,
"post_id": 0
},
"download": {"enabled": true,
"file_name": "string",
"max_downloads": 0,
"max_seconds": 0,
"is_amazon": true,
"amazon_key": "string"
},
"variants": {"option_1": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_2": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_3": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_4": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
},
"option_5": {"variant_id": 0,
"variant_name": "string",
"variant_label": "string",
"variant_type": "string",
"variant_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"price_adjustment": 0,
"weight_adjustment": 0,
"enable_custom_price_label": true,
"custom_price_label": "string",
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
}
},
"modifiers": [{"modifier_id": 0,
"modifier_name": "string",
"modifier_label": "string",
"modifier_type": "string",
"modifier_meta": {"number_min": 0,
"number_max": 0,
"number_step": 0,
"text_min_length": 0,
"text_max_length": 0,
"url_var": "string",
"swatch_size": 0
},
"modifier_items": [{"optionitem_id": 0,
"option_id": 0,
"item_name": "string",
"sort_order": 0,
"sku_extension": "string",
"swatch_icon": "string",
"default_selected": true,
"default_value": "string",
"price_adjustment": {"type": "string",
"adjustment": 0
},
"weight_adjustment": {"type": "string",
"adjustment": 0
},
"enable_custom_price_label": true,
"custom_price_label": "string",
"download_allowed": true,
"download_override_file": "string",
"download_additional_file": "string",
"block_shipping": true,
"square_id": "string",
"stripe_plan_id": "string"
}
],
"is_required": true,
"error_message": "string",
"square_id": "string"
}
],
"categories": [{"category_id": 0,
"post_id": 0,
"parent_id": 0,
"enabled": true,
"featured": true,
"category_name": "string",
"short_description": "string",
"category_image": "string",
"priority": 0,
"square_id": "string"
}
],
"menu": {"menu1": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu2": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
},
"menu3": {"level_1": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_2": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
},
"level_3": {"level": 0,
"menu_id": 0,
"post_id": 0,
"menu_name": "string",
"sort_order": 0,
"clicks": 0,
"banner_image": "string",
"seo_description": "string",
"seo_keywords": "string"
}
}
},
"featured_products": {"featured_product_1": 0,
"featured_product_2": 0,
"featured_product_3": 0,
"featured_product_4": 0
},
"subscription": {"enabled": true,
"bill_length": 0,
"bill_period": "string",
"bill_duration": 0,
"email_recurring": true,
"shipping_recurring": true,
"trial_days": 0,
"subscription_plan": {"plan_id": 0,
"plan_title": "string",
"can_downgrade": true
},
"allow_multiple": true,
"membership_page": "string",
"signup_fee": 0,
"stripe_product_id": 0,
"stripe_default_price_id": 0,
"prorate": true
},
"order_notes": {"success_note": "string",
"email_note": "string",
"order_details_note": "string"
},
"role_id": 0,
"is_giftcard": true,
"is_donation": true,
"is_special": true,
"stats": {"views": 0,
"last_viewed": "string"
},
"quickbooks": {"list_id": "string",
"edit_sequence": "string",
"quickbooks_status": "string",
"income_account_ref": "string",
"cogs_account_ref": "string",
"asset_account_ref": "string",
"parent_name": "string",
"parent_list_id": "string"
},
"seasonal": {"enabled": true,
"phrase": "string"
},
"inquiry": {"enabled": true,
"url": "string"
},
"deconetwork": {"enabled": true,
"mode": "string",
"product_id": "string",
"size_id": "string",
"color_id": "string",
"design_id": "string"
},
"display": {"display_type": 0,
"image_effect": 0,
"hover_type": 0,
"tag_type": 0,
"tag_bg_color": "string",
"tag_text_color": "string",
"tag_text": "string"
},
"square_id": "string",
"square_variation_id": "string"
}

➔ Next to Promotions

Products

Product

ProductListItem

ProductAdd

Gets a list of products

query Parameters

Add a product

Request Body schema: application/jsonrequired

Gets a product by ID

path Parameters

Updates a product by ID

path Parameters

Request Body schema: application/jsonrequired

Deletes a product by ID

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required