Products
Get Products
Retreives the products.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalpageintegerperPageintegerMust be at least 1. Must not be greater than 100.
orderColumnstring"id" | "name" | "price" | "stock" | "products_sold"orderDirectionstring"asc" | "desc"typestring"variant" | "addon"idsarray<integer>pathsarray<string>namestringvariant_namestringvisibilitiesarray<string>group_idsarray<integer>group_nullbooleanbadge_textstringstatus_textstringdeliverablestringdeliverables_typestringallstringPath Parameters
shopIdRequiredintegerThe shop ID.
Create Product
Creates a new product.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredtypeRequiredstring"variant" | "addon"nameRequiredstringpathstringMust match the regex /^[a-z0-9-]+$/.
category_idstringdescriptionstringMust not be greater than 65535 characters.
meta_titlestringMust not be greater than 255 characters.
meta_descriptionstringMust not be greater than 65535 characters.
meta_image_idstringmeta_twitter_cardstring"summary" | "summary_large_image"instructionsstringMust not be greater than 65535 characters.
out_of_stock_messagestringMust not be greater than 65535 characters.
currencyRequiredstringtax_inclusivebooleandeliverables_typestring"serials" | "service" | "dynamic"group_idstringimage_idsarray<string>visibilityRequiredstring"public" | "unlisted" | "private" | "on_hold"discord_requiredbooleanblock_vpnbooleanhide_stock_countbooleanaffiliate_percentagenumberMust be at least 0. Must not be greater than 100.
status_colorstringstatus_textstringshow_views_countbooleanshow_sales_countbooleanshow_sales_notificationsbooleansales_count_hoursnumberfeedback_coupon_idstringfeedback_coupon_min_ratingnumberMust be at least 1. Must not be greater than 5.
deliverables_labelstringMust not be greater than 255 characters.
is_mandatorybooleancustom_field_idsarray<string>product_tabsarray<string>Must not have more than 10 items.
product_badgesarray<string>Must not have more than 10 items.
product_addonsRequiredarray<string>product_upsellsRequiredarray<string>variantsarray<string>This field is required when type is variant. Must have at least 1 items.
Path Parameters
shopIdRequiredintegerThe shop ID.
Update Product and Group Order
Updates the order of products and groups.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredsortedIdsRequiredarray<integer>Path Parameters
shopIdRequiredintegerThe shop ID.
Get Product
Retrieves a product.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
productIdRequiredintegerThe product ID.
Delete Product
Deletes a product.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
productIdRequiredintegerThe product ID.
Update Product
Updates a product.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredtypeRequiredstring"variant" | "addon"nameRequiredstringpathstringMust match the regex /^[a-z0-9-]+$/.
category_idstringdescriptionstringMust not be greater than 65535 characters.
meta_titlestringMust not be greater than 255 characters.
meta_descriptionstringMust not be greater than 65535 characters.
meta_image_idstringmeta_twitter_cardstring"summary" | "summary_large_image"instructionsstringMust not be greater than 65535 characters.
out_of_stock_messagestringMust not be greater than 65535 characters.
currencyRequiredstringtax_inclusivebooleandeliverables_typestring"serials" | "service" | "dynamic"group_idstringimage_idsarray<string>visibilityRequiredstring"public" | "unlisted" | "private" | "on_hold"discord_requiredbooleanblock_vpnbooleanhide_stock_countbooleanaffiliate_percentagenumberMust be at least 0. Must not be greater than 100.
status_colorstringstatus_textstringshow_views_countbooleanshow_sales_countbooleanshow_sales_notificationsbooleansales_count_hoursnumberfeedback_coupon_idstringfeedback_coupon_min_ratingnumberMust be at least 1. Must not be greater than 5.
deliverables_labelstringMust not be greater than 255 characters.
is_mandatorybooleancustom_field_idsarray<string>product_tabsarray<string>Must not have more than 10 items.
product_badgesarray<string>Must not have more than 10 items.
product_addonsRequiredarray<string>product_upsellsRequiredarray<string>variantsarray<string>This field is required when type is variant. Must have at least 1 items.
Path Parameters
shopIdRequiredintegerThe shop ID.
productIdRequiredintegerThe product ID.
Clone Product
Clones a product.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
productIdRequiredintegerUpdate Stock
Updates the stock count of a service or dynamic product variant.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
productIdRequiredintegerThe product ID.
variantIdRequiredintegerThe variant ID.
Get Deliverables
Retrieves the deliverables for a product or variant.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
productIdRequiredintegerThe product ID.
variantIdRequiredintegerThe variant ID.
Append Deliverables
Appends deliverables to a product or variant.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
productIdRequiredintegerThe product ID.
variantIdRequiredintegerThe variant ID.
Overwrite Deliverables
Overwrites deliverables for a product or variant.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
productIdRequiredintegerThe product ID.
variantIdRequiredintegerThe variant ID.
Bulk Update Disabled Payment Methods
Bulk updates disabled payment methods for products.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalproduct_idsobjectdisabled_payment_method_idsarray<string>Path Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Custom Fields
Bulk updates custom fields for products.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalproduct_idsobjectcustom_field_idsarray<string>Path Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Addons
Bulk updates addons for products.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalproduct_idsobjectproduct_addonsobjectPath Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Upsells
Bulk updates upsells for products.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalproduct_idsobjectproduct_upsellsobjectPath Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Discord Integration
Bulk updates Discord integration for products.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalproduct_idsobjectdiscord_requiredbooleandiscord_rolesarray<string>Must not have more than 10 items.
Path Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Description
Bulk updates product descriptions.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredproduct_idsobjecttypeRequiredstring"overwrite" | "append" | "prepend"descriptionstringPath Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Instructions
Bulk updates product instructions.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalproduct_idsobjectinstructionsstringMust not be greater than 65535 characters.
Path Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Out of Stock Message
Bulk updates product out of stock message.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalproduct_idsobjectout_of_stock_messagestringMust not be greater than 65535 characters.
Path Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Security
Bulk updates product security settings.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalproduct_idsobjectblock_vpnbooleanPath Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Badges
Bulk updates product badges.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredproduct_idsobjecttypeRequiredstring"overwrite" | "append" | "prepend"product_badgesarray<string>Must not have more than 10 items.
Path Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Status
Bulk updates product status.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalproduct_idsobjectstatus_colorstringstatus_textstringPath Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Visibility
Bulk updates product visibility.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredproduct_idsobjectvisibilityRequiredstring"public" | "unlisted" | "private" | "on_hold"Path Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Live Stats
Bulk updates product live stats.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalproduct_idsobjectshow_views_countbooleanshow_sales_countbooleanshow_sales_notificationsbooleansales_count_hoursnumberPath Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Feedback Coupon
Bulk updates product feedback coupon.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalproduct_idsobjectfeedback_coupon_idstringfeedback_coupon_min_ratingnumberMust be at least 1. Must not be greater than 5.
Path Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Volume Discounts
Bulk updates product volume discounts.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalproduct_idsobjectvolume_discountsarray<number>Must not have more than 10 items.
disable_volume_discounts_if_couponbooleanPath Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Redirect URL
Bulk updates product redirect URL.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalproduct_idsobjectredirect_urlstringMust start with one of https Must not be greater than 2048 characters.
Path Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Deliverables Type
Bulk updates product deliverables label.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalproduct_idsobjectdeliverables_typestring"serials" | "service" | "dynamic"Path Parameters
shopIdRequiredintegerThe shop ID.
Bulk Update Deliverables Label
Bulk updates product deliverables label.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredproduct_idsobjectdeliverables_labelRequiredstringMust not be greater than 255 characters.
Path Parameters
shopIdRequiredintegerThe shop ID.