ScenarioItemsCustomerResponse

data object[]required

Item allocations in the scenario. Items without allocations are still shown, but have an empty allocations list.

Array [

itemstringrequired

The name of the item.

buyerColumns object

Buyer bid sheet column values for this item. Included only when requested via the fields query parameter.

anyOf

• ScenarioBuyerColumnsCustomer
• null

Buyer bid sheet column values for a scenario item.

values objectrequired

Cell values keyed by bid sheet column name.

property name* CustomerColumnValue

anyOf

• integer
• number
• CustomerStringCellValue
• null

integer

requestedVolumenumberrequired

The total volume requested by the buyer for this item.

allocations object[]required

Supplier allocations for this item.

Array [

supplierIdstring<uuid>required

The ID of the supplier.

supplierstringrequired

The name of the supplier.

bidOption object

The bid option to which this allocation refers to.

anyOf

• string
• null

string

supplierColumns object

Supplier bid sheet column values for this allocation. Included only when requested via the fields query parameter.

anyOf

• ScenarioSupplierColumnsCustomer
• null

Supplier bid sheet column values for a scenario allocation.

values objectrequired

Cell values keyed by bid sheet column name.

property name* CustomerColumnValue

anyOf

• integer
• number
• CustomerStringCellValue
• null

integer

volumenumberrequired

The volume allocated to this supplier.

totalCostnumberrequired

The total cost of the allocation to this supplier for the allocated volume, including any applied scenario discounts. Amounts are expressed in the project currency; see the project's currencyCode.

]

]

pagination objectrequired

nextCursor objectrequired

A cursor used to fetch the next page of results. It is null if there is no next page. Use the value as cursor parameter to fetch the next page.

oneOf

• string
• null

string

hasMorebooleanrequired

Indicates whether there are more results available. Keep calling the API with the provided nextCursor until hasMore is false to retrieve all results.

totalnumberrequired

The total number of results available.

Example: 42

ScenarioItemsCustomerResponse

{
  "data": [
    {
      "item": "string",
      "buyerColumns": {
        "values": {
          "Buyer text": "Buyer note 1",
          "Item": "Item name 1",
          "Volume": 32
        }
      },
      "requestedVolume": 0,
      "allocations": [
        {
          "supplierId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "supplier": "string",
          "bidOption": "string",
          "supplierColumns": {
            "values": {
              "Price": 1.2,
              "Supplier text": "On time delivery"
            }
          },
          "volume": 0,
          "totalCost": 0
        }
      ]
    }
  ],
  "pagination": {
    "nextCursor": "MjAyNS0wMS0wMSAxNzoyOTo1OS4yNwo=",
    "hasMore": true,
    "total": 42
  }
}