Inventory API
Products

Create Digital Product

This API endpoint (POST) creates a digital product. If the request succeeds it returns a Product Object otherwise it will return an error. Permissions: products.create Webhook event: product-created

Body Parameters

tax_category string * The tax category of the product.



pricing_model array of objects * An array of objects, each representing a pricing model associated with the product.

JSON

  • currency * string Currency Code The currency of the pricing model.
  • price * integer The price of the item for this pricing model
  • recommended_seller_price integer The recommended price set by the merchant for the product in this currency.
  • acquisition_price integer The base purchase price of the product in this currency.


languages object * The titles, subtitles, seo descriptions, seo titles and long descriptions of the product in all supported languages. The minimum information required is a title in at least one language. The object's keys are a Language Codes while the values are also objects with the content of the product.

Note: A language has to be activated on your account before it can be used.

Exampe



delivery_type string * Determines how the digital product and its associated files will be delivered to the customer. The possible values are file and url.



digital_files array of strings Each string in the array must be an Asset Object id. Required if the delivery_type is set to file.



delivery_url string The URL where the file can be downloaded after a successful purchase. Required if delivery_type is set to url.



license_type string The licensing method of the digital product. The possible values are list, autogenerated and none. The default value is none.



licenses array of strings An array of strings each representing a license code. Required if license_type is set to list. Note that if a license list is provided the unlimited_stock parameter will be ignored and the stock will be determined from the number of licenses in this array. The maximum allowed in a single request is 1000.



unlimited_stock boolean The default value is false. Required if stock is not present.



stock integer The available stock for this product. You can ignore this parameter if unlimited_stock is set to true.



stock_limit_warning integer If the product stock falls below this value, an email notification will be sent to you. Not supported for services with unlimited_stock is set to true.



number_of_downloads integer Determines how many times a customer can download the digital files associated with this product. Supported for items with delivery_type set to file.



max_units integer The maximum amount of stock that can be purchased in a single order.



min_units integer The minimum amount of stock that can be purchased in a single order.



buyable boolean This attribute shows if the product is available for sale.



on_sale boolean This attribute shows if there is a specific sale or promotion active currently active.



discount_allowed boolean Determines if the product can have any discounts applied to it. The default value is true.



reviews_allowed boolean This attribute shows if customers can leave reviews for this item. The default value is false.



shown boolean Determines if the product is currently visible in external assets. The default value is true.



exclude_from_feed boolean Determines if the product will be included in third-party feeds and product search engines.



new_from date-format The date the product was launched for sale as a brand new item.



new_to date-format After this date, the product will not be considered a brand-new item.



expiry_date date-format After this date, the product will not be available for sale.



release_date date-format The date that the product will be released for sale.



gallery array of strings Each string in the array must be an Asset id.



related_products array of strings An array of product IDs, each representing a related product.



whitelist array of strings An array of ISO country codes. Only customers from these countries can purchase this product.



custom_attributes array of objects An array of objects each corresponding to a custom attribute configured on the product.

JSON

  • language string The language of the custom attribute.
  • name string This name of the custom attribute.
  • value string The value of the custom attribute.


custom_fields array of objects An array of objects each corresponding to a custom field configured on the product.

JSON

  • language string The language of the custom field.
  • name string This name of the custom field.
  • type string This type of the custom field. The possible values are size, checkboxes, textfield, textarea, date-picker.
  • values array of strings An array of strings, each represtive a value for the custom field. Available for custom fields with type "checkboxes".
  • range_from timestamp The starting range for the custom fields. Available for custom fields with type "range_from".
  • range_to string The starting range for the custom fields. Available for custom fields with type "range_to".