Syntax

createOrderform( data )

Creates an order form on Digistore24.

Access rights

Full access required.

Parameters

data – Property fields of the product. Possible values are:

  • name: string[63]
  • layout:
    • widget – the order form is embedded onto your own sales page default
    • legacy
    • Note: the layout “responsive” is not supported by the API
  • background_style
    • white
    • blue
  • step_count
    • 1 = Order form with one step (i.e. there are no tabs)
    • 2 = Order form with two steps (i.e. there are two tabs)
    • 3 = Order form with three steps (i.e. there are three tabs)
  • shipping_position
    • after_cart = select product first, then request contact details
    • before_cart = request contact details first, then select product
    • summary_positions: Positions for purchase order summaries. Set with these elements, i.e. several positions are separated by commas:
    • before_playplan = before payment plan
    • after_payplan = after payment plan
    • before_checkout = before payment providers
    • before_pay_button = between payment providers and payment button
    • after_pay_button = after payment button
  • flex_elements_order:Request of order bumper, order summary and revocation check box (if these occur at one position)
    • order_bumper,order_summary,refund_waiver
    • order_bumper,refund_waiver,order_summary
    • order_summary,order_bumper,refund_waiver
    • order_summary,refund_waiver,order_bumper
    • refund_waiver,order_bumper,order_summary
    • refund_waiver,order_summary,order_bumper
  • tab_style
    • bigtabs = Tabs with text (see tabtext…-fields)
    • image = Tabs with images that the user uploaded (see tab_image_N_ID-fields)
    • image_url = Tabs with external images (see tab_imgar_N_URL fields)
  • for tab_style == bigtabs
    • tab_text_1_hl = Title of the first tab
    • tab_text_1_sl = Subtitle of the first tab
    • tab_text_2_hl = Title of the second tab
    • tab_text_2_sl = Subtitle of the second tab
    • tab_text_3_hl = Title of the third tab
    • tab_text_3_sl = Subtitle of the third tab
  • für tab_style == image
    • tab_image_1_id = Image ID for all three tabs, if the first tab is selected
    • tab_image_2_id = Image ID for all three tabs, if the second tab is selected
    • tab_image_3_id = Image ID for all three tabs, if the third tab is selected

Images can be uploaded with createImage. With listImages() you get a list of your images.

Image size: 400 x 80 pixels (width x height)

  • für tab_style == image_url
    • tab_image_1_url = Image URL for all three tabs, if the first tab is selected
    • tab_image_2_url = Image URL for all three tabs, if the second tab is selected
    • tab_image_3_url = Image URL for all three tabs, if the third tab is selected

Image size: 400 x 80 pixels (width x height)

  • order_bump_style
    • none = no order bump is displayed
    • dashed = An order bump with a dashed frame is displayed
  • orderbump_product_id = Product for the order bump. The product must be added to the main product as an add-on.
  • orderbump_headline = Headline for the order bump. See below for placeholder.
  • orderbump_html = Text for the order bump. See below for placeholder.
  • orderbump_position
    • before_playplan = before payment plans
    • after_payplan = after payment plans
    • before_checkout = before payment providers
    • before_pay_button = between payment providers and payment button after_pay_button = after payment button
  • refund_waiver_position
    • before_playplan = before payment plans
    • after_payplan = after payment plans
    • before_checkout = before payment providers
    • before_pay_button = between payment providers and payment button after_pay_button = after payment button
  • custom_css

Return data

Array (
    [orderform_id] => 1234
)