Skip to content

Get Scenario

Request

Returns a sourcing scenario with its associated project, demands, and settings.

Project

A sourcing scenario is associated with a project, which is either an RFQ (Request for Quotation) or a Negotiation. The project field is a tagged object with a type field ("Rfq" or "Negotiation") and an id field containing the project's UUID.

Demands

Each demand item has a type field indicating its kind. Currently only "Assembly" demands are returned, each with:

  • id: the assembly's UUID
  • name: the human-readable assembly designator
  • quantity: the required quantity with unit of measurement (e.g., {"unit": "Pieces", "quantity": 1000.0})

Limitation: Part demands (for off-the-shelf parts and components/IPNs) are not yet included in this endpoint and will be added as new type values in a future update. Consumers should gracefully handle or ignore unknown demand types.

Currency and Exchange Rates

settings.currency.base_currency is the base currency used for all cost calculations in this sourcing scenario. All monetary values are converted to this currency.

settings.currency.exchange_rates maps each foreign currency code to its conversion rate. Rates are expressed as: 1 unit of base currency = rate units of foreign currency.

Each rate has an is_manual flag:

  • true: the rate was manually overridden by a user and takes precedence over the automatic rate
  • false: the rate was automatically fetched from a public exchange rate provider

The settings object is extensible — additional setting groups may be added alongside currency in the future.

Versioning

Note: A legacy v1 version of this endpoint is available by sending Accept: application/api.luminovo.sourcing-scenario-v1+json. It is deprecated and returns a less detailed response — it omits currency settings, assembly names, and project type information. All new integrations should use v2.

Security
BearerAuth
Path
idstringrequired

UUID of the sourcing scenario to retrieve.

Headers
Acceptstring(SourcingScenarioV2AcceptHeader)required

Set this to application/api.luminovo.sourcing-scenario-v2+json.

Value:"application/api.luminovo.sourcing-scenario-v2+json"
GET
/sourcing-scenarios/{id}
curl -i -X GET \
  'https://api.luminovo.com/sourcing-scenarios/{id}' \
  -H 'Accept: application/api.luminovo.sourcing-scenario-v2+json' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sourcing scenario with project, demands, and settings.

Bodyapplication/json
idstring, (uuid)required

Unique identifier of the sourcing scenario.

namestringrequired

Human-readable name of the sourcing scenario.

projectRfq (object) or Negotiation (object)(types.sourcing.sourcing_scenario.v2.ProjectDto)required
One of:

The sourcing scenario belongs to an RFQ.

demandsArray of any(types.sourcing.sourcing_scenario.v2.DemandDto)required

The demands associated with this sourcing scenario.

Each demand has a type field indicating its kind. Currently only "Assembly" demands are returned. Additional demand types (Part, Component) will be added in future versions. Consumers should gracefully handle or ignore unknown demand types.

settingsobject(types.sourcing.sourcing_scenario.v2.SourcingScenarioSettingsDto)required

Settings for this sourcing scenario, including currency and exchange rate configuration.

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "project": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "Rfq"
  },
  "demands": [
    { … }
  ],
  "settings": {
    "currency": { … }
  }
}