Sourcing options endpoint

If you would like to use these functionalities, contact our Support team for more information and activation support.

The Sourcing options endpoint is designed to evaluate possible fulfillment options for a potential order. When a request is made, the routing engine processes the order to determine the best sourcing options.

More sourcing options API information can be found in the REST API documentation – Sourcing options.

This process includes:

• Applying routing fences and rating mechanisms

• Returning the top results as defined in the request

The endpoint supports Routing strategies, enabling evaluation based on different criteria, like:

• Cost-focused: Returns the most cost-effective option(s)

• Speed-focused: Returns the fastest delivery route(s)

• Weighted approach: Balances cost and delivery time

Because the full routing engine is used, response times may be longer than other shop endpoints, especially for complex routing scenarios.

Key characteristics

• Use case: Primarily used toward the end of the customer journey (for example, during checkout) to determine the best supplier options for a specific order.

• Nature of the request:

  • Simulation only: The request doesn't create a routing plan or any operational entity in the platform.

  • What-if evaluation: Allows assessment of sourcing strategies without committing to execution.

• Integration with orders: The selected sourcing option can be passed into the actual order-creation process to maintain consistency between the simulated decision and the actual routing execution.

Request

The request structure is identical to the Order Create request, allowing for the inclusion of all routing-relevant information. This also includes custom properties such as tags and customAttributes.

Additionally, a resourceInvestment parameter (value between 0 and 1) must be specified. This parameter controls how much time and computational resources the routing engine should spend optimizing the decision:

• Lower values (for example, 0.1) → Faster response, less optimization

• Higher values (for example, 0.9) → Longer response time, more thorough optimization

The number of desired sourcing options can also be defined in the request by setting the requestedResultCount. If this value is set to 1, only the best sourcing option, based on the ratings, will be returned. If the value is set to 3, for example, the second and third best sourcing options will also be included in the response.

Response

Each sourcing option includes:

• Identification and metadata Unique IDs for the sourcing run and options, enabling traceability and consistent reference in subsequent order submissions.

• Commercial information Total costs, detailed cost breakdown (transport, packaging, penalties), sales prices, and discounts considered in the decision. All monetary values respect the defined currency rules.

• Inventory and source details Which facilities or suppliers can fulfill the order, what quantity is available, and the pricing conditions per article.

• Routing and logistics information The full sourcing path with all nodes (facilities, suppliers, customers), transfers between them, carriers used, and calculated packaging configurations. This includes associated transport and packaging costs.

• Delivery commitments Estimated delivery dates and the time limits by which an order must be placed to guarantee those delivery promises.

• Optimization and ratings Any penalties applied based on rating rules (for example, geo distance, transport costs, delivery time, and so on), influencing the ranking of sourcing options.