Search order
The central order overview in the tebio business portal allows you to search recorded orders in a structured manner. Regardless of whether an order was created manually in the portal, via a hosted page or via API, it is displayed in the order overview.
When do I need this function?
Section titled “When do I need this function?”Use the search function for orders whenever you:
- You want to check the current processing or payment status of a specific order.
- You want to find out which orders were created on a specific day or during a specific time period.
- You want to find orders that require manual approval.
- You want to check whether documents or attachments have been uploaded to an order.
Requirements
Section titled “Requirements”- You need the necessary permissions in the business portal for this process.
Step-by-step instructions
Section titled “Step-by-step instructions”- Navigate to the Orders section in the main menu of the portal.
- You will land directly on the Orders tab.
- Enter your desired filter criteria in the upper area.
- The table shows the matching records.
- Clicking on a line in the table opens the Detailed view of the order.
Available filters
Section titled “Available filters”The search offers standard filters and advanced filters via more filters to help you narrow down orders:
- Customer/Partner and name search: In the first dropdown, select whether the orderer is a customer or a distribution partner. You can then search specifically for the name in the field next to it.
- Order ID: Searches for the order’s unique reference number.
- Status: Filter by the current status of the order (e.g. Payment pending, Successfully completed or Finally failed).
- Date from / Date to: Limit the recording period using a calendar.
Under more filters you will also find:
- Search by product: Displays orders in which a specific subscription product was ordered.
- Search by Distributor: Filters orders that are assigned to a specific distributor, agent or reseller.
- Fulfillment Status: Allows you to search for delivery or staging status.
- Approval Required: Filters for orders that still require manual approval due to their configuration.
The order overview (table)
Section titled “The order overview (table)”The search results are displayed in a table. You can customize the table columns using the Edit Columns button (top right).
By default you see the following columns:
- Order ID: Unique identifier of the order.
- Date: Time of order entry.
- Orderer: The name of the customer or partner.
- Product: The main product ordered.
- Status: Status of the order.
- Fulfillment Status: The delivery status.
- Total one-time fees: Total of the one-time fees for this order, for example setup fees.
[!TIP] The paperclip icon (attachments) If you see a small paperclip symbol next to the order ID, tebio is indicating that documents (attachments) exist for this order. This may include, for example, credentials or other documents that you request as part of the order for a product.
Result
Section titled “Result”The order overview shows the appropriate orders. You can then open an order to view details, documents, payments or events.
API Notes
Section titled “API Notes”If you want to read or synchronize orders system-controlled (e.g. in your ERP system), use the search endpoint. This supports pagination and filter parameters.
| End point | Method | Description | OperationId |
|---|---|---|---|
/v1/order | GET | Search or list orders | searchOrder |