Enter order
In the tebio platform, an order bundles the products, options, discounts and payment data that a customer orders. The most important concept is: A subscription is not created in isolation in the standard processes. It is usually the result of a successfully recorded and completed order.
When do I need this function?
Section titled “When do I need this function?”You use the manual entry of an order in the portal when you act on behalf of the customer. This is typical for:
- Telesales and B2B sales: You accept orders by telephone or on the basis of a contract and enter them manually in the system.
- Support Scenarios: You set up a new service for an existing customer.
- Individual offers: You put together an individual package (with special discounts or different start dates) that is not displayed in this form on the automated hosted pages.
For automated e-commerce sales, you instead use hosted pages through which customers can enter their orders themselves.
Requirements
Section titled “Requirements”Since an order must always be assigned to a buyer, the workflow in the portal always starts from the customer detail view.
The following requirements must be met:
- The Customer has been created in the system.
- At least one Subscription product has been configured and is currently released for sale.
- A Payment method (e.g. SEPA direct debit or invoice) that is permitted for manual portal completion has been set up.
Step-by-step instructions
Section titled “Step-by-step instructions”1. Open customers
Section titled “1. Open customers”Navigate to Customers in the top menu and find the customer record for which the order should be recorded. Open the customer detail view.
2. Start the ordering process
Section titled “2. Start the ordering process”In the customer view, go to the Orders tab and click on the New Order button.
3. Configure product and options
Section titled “3. Configure product and options”- Select the subscription product you want from the overview.
- In the detailed view of the product you can now add additional options (e.g. more storage space) or add-ons - if configured on the product.
- If available, you can add discounts.
4. Adjust details
Section titled “4. Adjust details”During the ordering process you have the opportunity to make advanced settings for the subsequent subscription:
- Properties: Assign metadata based on your configured properties.
- Desired date: Set a different start date for activation in the future.
- Different billing cycle: Adjustment of the billing cycle configured by default on the product for this customer.
5. Choose payment method and complete
Section titled “5. Choose payment method and complete”Finally, select a payment method and click Submit Order.
Since you act on behalf of the customer in the business portal and cannot ask the customer for interactive approval, only payment methods are generally available here that do not require active customer approval, for example SEPA direct debit or bank transfer.
Result
Section titled “Result”The order is created in the system. Depending on the configuration, a subscription is created immediately or at a later start date.
Notes and typical errors
Section titled “Notes and typical errors”- Missing payment methods: Payment methods that require active authorization from the buyer (e.g. credit card, PayPal) cannot be used when manually entered in the portal without active approval from the customer. In this case, refer the customer to the relevant hosted page.
- Different start date (desired date): If you choose a start date in the future, only the order will initially be noted in the system. The actual subscription (and any associated customer user accounts) will only be generated and activated on the defined date.
API Notes
Section titled “API Notes”Extensive order endpoints are available for integrating order processes from external systems (such as your own checkout or an ERP). You can also use the API to create subscriptions that are independent of an order (direct creation).
| End point | Method | Description | OperationId |
|---|---|---|---|
/v1/order | GET | Search orders | searchOrder |
/v1/order/{uuid} | GET | Retrieve order | getOrder |
/v1/order/{uuid}/cancel | POST | Cancel order | cancelOrder |
/v1/order/new-subscription | POST | Create order for new subscription | createNewSubscriptionOrder |
/v1/order/new-subscription/{uuid} | PATCH | Update order for new subscription | updateNewSubscriptionOrder |
/v1/order/change-subscription | POST | Create order for subscription change | createChangeSubscriptionOrder |