eCommerce API Endpoints

Routes

Products

GET dbtech-ecommerce/ GET dbtech-ecommerce/purchased GET dbtech-ecommerce/{id}/ POST dbtech-ecommerce/{id}/ DELETE dbtech-ecommerce/{id}/ GET dbtech-ecommerce/{id}/downloads GET dbtech-ecommerce/{id}/latest-version GET dbtech-ecommerce/{id}/reviews

Categories

GET dbtech-ecommerce/categories/ POST dbtech-ecommerce/categories/ GET dbtech-ecommerce/categories/flattened GET dbtech-ecommerce/categories/{id}/ POST dbtech-ecommerce/categories/{id}/ DELETE dbtech-ecommerce/categories/{id}/ GET dbtech-ecommerce/categories/{id}/products

Downloads

POST dbtech-ecommerce/downloads/ GET dbtech-ecommerce/downloads/{id}/ POST dbtech-ecommerce/downloads/{id}/ DELETE dbtech-ecommerce/downloads/{id}/ GET dbtech-ecommerce/downloads/{id}/download

Licenses

GET dbtech-ecommerce/licenses/ GET dbtech-ecommerce/licenses/{license_key}/

Reviews

GET dbtech-ecommerce/reviews/ POST dbtech-ecommerce/reviews/ GET dbtech-ecommerce/reviews/{id}/ DELETE dbtech-ecommerce/reviews/{id}/ POST dbtech-ecommerce/reviews/{id}/author-reply DELETE dbtech-ecommerce/reviews/{id}/author-reply

Data types

LicenseField DownloadVersion License ProductPrefix Category ProductField Download ProductRating OrderField Product

GET dbtech-ecommerce/
Gets the list of products.

Parameters

Input Type Description
page integer  
all bool Whether to fetch all products on a single page.
platforms array Only fetch products matching these platforms.

Response

Output Type Description
products Product[] Products on this page
pagination pagination Pagination information

GET dbtech-ecommerce/purchased
Gets the list of purchased products.

Parameters

Input Type Description
category_ids array Only fetch products within these categories.
platforms array Only fetch products matching these platforms.

Response

Output Type Description
products Product[] All purchased products

Errors

Error key Description
you_have_not_purchased_any_licenses_yet Triggered if the user has not purchased any licenses.

GET dbtech-ecommerce/{id}/
Gets information about the specified product

Parameters

Input Type Description
None.

Response

Output Type Description
product Product  

POST dbtech-ecommerce/{id}/
Updates the specified product

Parameters

Input Type Description
title string  
is_discountable bool Whether this product can be discounted by automatic discounts.
license_prefix string A string that'll be used for the prefix for generated license keys.
has_demo bool Whether this product has a "demo" download.
thread_node_id integer  
thread_prefix_id integer  
branding_free integer The product ID for the Branding Free product.
global_branding_free integer The product ID for the Global Branding Free product.
prefix_id integer  
tagline string  
description string A short description that'll be displayed next to the product images.
description_full string The full description to be displayed in the "Overview" tab.
product_specification string The list of specifications for the product to be displayed in the "Specifications" tab.
copyright_info string The list of copyright info for the product to be displayed in the "Copyright" tab.
requirements string Comma-separated list of requirements.
product_fields array  
add_tags array  
remove_tags array  
available_filters array  
available_fields array  
shipping_zones array  
extra_group_ids array User group changes that will persist even after a license expires.
temporary_extra_group_ids array User group changes that will expire when a license expires.
author_alert bool  
author_alert_reason string  
attachment_key string API attachment key to upload screenshots. Attachment key context type must be dbtech_ecommerce_product with context[product_id] set to this product ID.

Response

Output Type Description
product Product The updated product information

DELETE dbtech-ecommerce/{id}/
Deletes the specified product. Defaults to soft deletion.

Parameters

Input Type Description
hard_delete bool  
reason string  
author_alert bool  
author_alert_reason string  

Response

Output Type Description
success bool  

GET dbtech-ecommerce/{id}/downloads
Gets downloads belonging to the specified product.

Parameters

Input Type Description
page integer  
product_version string Which product version you want to get downloads for.
product_version_type string Which product version type you want to get downloads for ("demo" or "full").

Response

Output Type Description
downloads Download[] Downloads on this page
pagination pagination Pagination information

Errors

Error key Description
no_downloadable_version_found Triggered if no download version exist matching the search parameters.

GET dbtech-ecommerce/{id}/latest-version
Gets the latest download matching the search terms.

Parameters

Input Type Description
product_version string Which product version you want to get the latest version for.
product_version_type string Which product version type you want to get the latest version for ("demo" or "full").

Response

Output Type Description
latestVersion Download Information about the specified download

Errors

Error key Description
no_downloadable_version_found Triggered if no download version exist matching the search parameters.

GET dbtech-ecommerce/{id}/reviews
Gets reviews belonging to the specified product.

Parameters

Input Type Description
page integer  

Response

Output Type Description
reviews ProductRating[] Reviews on this page
pagination pagination Pagination information

GET dbtech-ecommerce/categories/
Gets the category tree.

Parameters

Input Type Description
None.

Response

Output Type Description
tree_map array A mapping that connects category parent IDs to a list of their child category IDs
categories Category[] List of all categories

POST dbtech-ecommerce/categories/
Creates a new category

Parameters

Input Type Description
category[title] string
category[description] string  
category[parent_node_id] integer  
category[display_order] integer  
category[parent_category_id] integer

Response

Output Type Description
category Category Information about the created category

GET dbtech-ecommerce/categories/flattened
Gets a flattened category tree. Traversing this will return a list of categories in the expected order.

Parameters

Input Type Description
None.

Response

Output Type Description
categories_flat array An array. Each entry contains keys of "category" and "depth"

GET dbtech-ecommerce/categories/{id}/
Gets information about the specified category

Parameters

Input Type Description
None.

Response

Output Type Description
category Category  

POST dbtech-ecommerce/categories/{id}/
Updates the specified category

Parameters

Input Type Description
category[title] string  
category[description] string  
category[parent_node_id] integer  
category[display_order] integer  

Response

Output Type Description
category Category The updated category information

DELETE dbtech-ecommerce/categories/{id}/
Deletes the specified category.

Parameters

Input Type Description
delete_children bool If true, child categories will be deleted. Otherwise, they will be connected to this category's parent.

Response

Output Type Description
success bool  

GET dbtech-ecommerce/categories/{id}/products
Gets a page of products from the specified category.

Parameters

Input Type Description
page integer  

Response

Output Type Description
products Product[] Products on this page
pagination pagination Pagination information

POST dbtech-ecommerce/downloads/
Creates a new download

Parameters

Input Type Description
change_log string The change log entry for this download.
release_notes string The release notes for this download. If this is omitted, a release thread / post will not be generated.
handler_data array An array of information needed by the specified download handler. This should be inferred by the templates.
change_log_attachment_key string API attachment key to upload files. Attachment key context type must be dbtech_download_download with context[download_id] set to this download ID.
release_notes_attachment_key string API attachment key to upload files. Attachment key context type must be dbtech_download_download with context[download_id] set to this download ID.
version_string string
has_new_features bool  
has_changed_features bool  
has_bug_fixes bool  
is_unstable bool  
product_id string
download_type string One of (currently) three download types; "dbtech_ecommerce_autogen", "dbtech_ecommerce_attachment" or "dbtech_ecommerce_external"

Response

Output Type Description
download Download Information about the created download

GET dbtech-ecommerce/downloads/{id}/
Gets information about the specified download

Parameters

Input Type Description
None.

Response

Output Type Description
download Download  

POST dbtech-ecommerce/downloads/{id}/
Updates the specified download

Parameters

Input Type Description
change_log string The change log entry for this download.
release_notes string The release notes for this download. If this is omitted, a release thread / post will not be generated.
handler_data array An array of information needed by the specified download handler. This should be inferred by the templates.
author_alert bool  
author_alert_reason string  
change_log_attachment_key string API attachment key to upload files. Attachment key context type must be dbtech_ecommerce_download with context[download_id] set to this download ID.
release_notes_attachment_key string API attachment key to upload files. Attachment key context type must be dbtech_ecommerce_download with context[download_id] set to this download ID.
version_string string  
has_new_features bool  
has_changed_features bool  
has_bug_fixes bool  
is_unstable bool  

Response

Output Type Description
download Download The updated download information

DELETE dbtech-ecommerce/downloads/{id}/
Deletes the specified download. Defaults to soft deletion.

Parameters

Input Type Description
hard_delete bool  
reason string  
author_alert bool  
author_alert_reason string  

Response

Output Type Description
success bool  

GET dbtech-ecommerce/downloads/{id}/download
Gets the data that makes up the specified download. The output is the raw binary data.

Parameters

Input Type Description
product_version string Which product version you want to download
product_version_type string Which product version type you want to download ("demo" or "full")

Response

Output Type Description
data binary The binary data is output directly, not JSON.

Errors

Error key Description
you_have_not_purchased_any_licenses_yet Triggered if requesting the full download, and no licenses match the search parameters.
license_does_not_permit_download Triggered if requesting the full download, and the license does not permit the download (f.ex. expired).

GET dbtech-ecommerce/licenses/
Gets the list of licenses owned by the current user.

Parameters

Input Type Description
category_ids array Only fetch licenses belonging to products within these categories.
platforms array Only fetch licenses belonging to products matching these platforms.

Response

Output Type Description
licenses License[] List of all owned licenses.

Errors

Error key Description
you_have_not_purchased_any_licenses_yet Triggered if no licenses match the search parameters.

GET dbtech-ecommerce/licenses/{license_key}/
Gets information about the specified license.

Parameters

Input Type Description
None.

Response

Output Type Description
license License  

GET dbtech-ecommerce/reviews/
Gets a list of all reviews.

Parameters

Input Type Description
page integer  

Response

Output Type Description
reviews ProductRating[] Reviews on this page
pagination pagination Pagination information

POST dbtech-ecommerce/reviews/
Reviews a specified product

Parameters

Input Type Description
product_id integer Which product version you want to review.
rating integer The star rating you wish to give this product.
message string The text of the review.
is_anonymous bool Whether the review should be left anonymously. Depends on permissions.

Response

Output Type Description
review ProductRating The review information.

GET dbtech-ecommerce/reviews/{id}/
Gets information about the specified review

Parameters

Input Type Description
None.

Response

Output Type Description
review ProductRating  

DELETE dbtech-ecommerce/reviews/{id}/
Deletes the specified product. Defaults to soft deletion.

Parameters

Input Type Description
hard_delete bool  
reason string  
author_alert bool  
author_alert_reason string  

Response

Output Type Description
success bool  

POST dbtech-ecommerce/reviews/{id}/author-reply
Leaves an author response to the specified review.

Parameters

Input Type Description
message string The text of the reply.

Response

Output Type Description
review ProductRating The review information.

DELETE dbtech-ecommerce/reviews/{id}/author-reply
Deletes an author reply from the specified review.

Parameters

Input Type Description
None.

Response

Output Type Description
success bool  

Data type: LicenseField

Column Type Description
field_id string  
title string  
description string  
display_order integer  
field_type string  
field_choices object For choice types, an ordered list of choices, with "option" and "name" keys for each.
match_type string  
match_params array  
max_length integer  
required bool  
display_group string If this field type supports grouping, the group this field belongs to.

Data type: DownloadVersion

Column Type Description
can_download bool  
download_version_id integer  
download_id integer  
product_id integer  
product_version string  
product_version_type string  
directories string  
download_url string  

Data type: License

Column Type Description
username string  
product Product If the "with_product" option is passed to the API Result generation.
license_fields array  
license_id integer  
product_id integer  
user_id integer  
purchase_date integer  
expiry_date integer  
latest_download_id integer  
license_key string  
license_state string  

Data type: ProductPrefix

Column Type Description
prefix_id integer  
title string  
is_usable bool True if the acting user can use (select) this prefix.
prefix_group_id integer  
display_order integer  
materialized_order integer Effective order, taking group ordering into account.

Data type: Category

Column Type Description
prefixes string  
product_fields array  
can_add bool  
can_upload_images bool  
category_id integer  
title string  
description string  
product_count integer  
last_update integer  
last_product_title string  
last_product_id integer  
min_tags integer  
parent_category_id integer  
display_order integer  

Data type: ProductField

Column Type Description
field_id string  
title string  
description string  
display_order integer  
field_type string  
field_choices object For choice types, an ordered list of choices, with "option" and "name" keys for each.
match_type string  
match_params array  
max_length integer  
required bool  
display_group string If this field type supports grouping, the group this field belongs to.

Data type: Download

Column Type Description
is_reacted_to bool True if the viewing user has reacted to this content
visitor_reaction_id integer If the viewer reacted, the ID of the reaction they used
product Product If the "with_product" option is passed to the API Result generation.
can_edit bool  
can_soft_delete bool  
can_hard_delete bool  
can_react bool  
can_download bool  
download_id integer  
product_id integer  
download_state string  
version_string string  
release_date integer  
change_log string  
has_new_features bool  
has_changed_features bool  
has_bug_fixes bool  
is_unstable bool  
release_notes string  
download_type string  
download_count integer  
full_download_count integer  
attach_count integer  
warning_message string  
reaction_score integer  

Data type: ProductRating

Column Type Description
product Product If the "with_product" option is passed to the API Result generation.
can_soft_delete bool  
can_hard_delete bool  
can_author_reply bool  
AnonymousUser User If this review was anonymous, this is the exposed user record. Only available with permission.
anonymous_user_id integer If this review was anonymous, this is the exposed user ID. Only available with permission.
User User If this review was not anonymous, this is the user record. Only available for public reviews.
user_id integer If this review was not anonymous, this is the user ID. Only available for public reviews.
product_rating_id integer  
product_id integer  
rating integer  
rating_date integer  
message string  
version_string string  
author_response string  
rating_state string  
is_anonymous bool  

Data type: OrderField

Column Type Description
field_id string  
title string  
description string  
display_order integer  
field_type string  
field_choices object For choice types, an ordered list of choices, with "option" and "name" keys for each.
match_type string  
match_params array  
max_length integer  
required bool  
display_group string If this field type supports grouping, the group this field belongs to.

Data type: Product

Column Type Description
is_reacted_to bool True if the viewing user has reacted to this content
visitor_reaction_id integer If the viewer reacted, the ID of the reaction they used
username string  
release_count integer  
review_count integer  
is_watching bool  
Category Category If the "skip_category" option is not passed to the API Result generation.
LatestVersion Download If the "with_latest_version" option is passed to the API Result generation.
User User The user who owns the product
icon_url string  
full_title string  
tagline string  
product_fields array  
tags array  
prefix string  
can_edit bool  
can_edit_tags bool  
can_edit_icon bool  
can_soft_delete bool  
can_hard_delete bool  
can_react bool  
can_download bool  
can_view_product_images bool  
product_page_url string Link to the product's page in the store.
product_versions array Key-value pair of product versions.
product_id integer  
title string  
parent_product_id integer  
product_category_id integer  
product_state string  
creation_date integer  
last_update integer  
is_paid bool  
is_discountable bool  
user_id integer  
warning_message string  
requirements array  
description_full string  
product_specification string  
copyright_info string  
product_type string  
license_prefix string  
has_demo bool  
download_count integer  
full_download_count integer  
rating_count integer  
rating_avg float  
rating_weighted float  
license_count integer  
prefix_id integer  
global_branding_free integer  
branding_free integer  
reaction_score integer  
  • Published
    Jan 25, 2019
  • Page views
    3,857
Back
Top