GetBidSheetCustomerResponse

columns object[]required

Array [

oneOf

nameNamerequired

The name of the bid sheet column.

Possible values: <= 255 characters

typeType

Constant value: item

Default value: item

isVisibleToSupplierIsvisibletosupplier

Constant value: true

Default value: true

]

bidOptions object[]required

Array [

labelLabelrequired

The unique label of the bid option.

Possible values: non-empty and <= 30 characters

description object

The description of the bid option.

anyOf

string
null

string

Possible values: non-empty and <= 200 characters

]

items object[]required

Array [

values objectrequired

Cell values keyed by bid sheet column name.

property name* CustomerColumnValue

anyOf

integer
number
CustomerStringCellValue
null

integer

]

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

GetBidSheetCustomerResponse
{
  "bidOptions": [
    {
      "description": "On specification",
      "label": "On-spec"
    },
    {
      "description": "Off specification",
      "label": "Off-spec"
    }
  ],
  "columns": [
    {
      "isVisibleToSupplier": true,
      "name": "Item",
      "type": "item"
    },
    {
      "isVisibleToSupplier": true,
      "name": "Volume",
      "type": "volume"
    },
    {
      "isVisibleToSupplier": true,
      "name": "Supplier",
      "type": "supplier"
    },
    {
      "bidOptions": [
        "On-spec",
        "Off-spec"
      ],
      "isRequired": false,
      "isVisibleToSupplier": true,
      "name": "Price",
      "type": "price"
    },
    {
      "calculation": "'Price' * 1.05",
      "isVisibleToSupplier": true,
      "name": "Price with VAT",
      "type": "formula"
    },
    {
      "calculation": "'Price with VAT' * 'Volume'",
      "isVisibleToSupplier": true,
      "name": "Total Cost",
      "type": "total_cost_formula"
    },
    {
      "isVisibleToSupplier": true,
      "name": "Buyer text",
      "type": "buyer_text"
    },
    {
      "bidOptions": [
        "On-spec",
        "Off-spec"
      ],
      "isRequired": false,
      "isVisibleToSupplier": true,
      "name": "Supplier text",
      "type": "supplier_text"
    },
    {
      "isVisibleToSupplier": true,
      "name": "Buyer number",
      "type": "buyer_number"
    },
    {
      "bidOptions": [
        "On-spec",
        "Off-spec"
      ],
      "isRequired": false,
      "isVisibleToSupplier": true,
      "name": "Supplier number",
      "type": "supplier_number"
    },
    {
      "isVisibleToSupplier": true,
      "name": "Buyer currency",
      "type": "buyer_currency"
    },
    {
      "isVisibleToSupplier": true,
      "name": "Supplier currency",
      "type": "supplier_currency"
    },
    {
      "bidOptions": [
        "On-spec",
        "Off-spec"
      ],
      "choices": [
        "Choice 1",
        "Choice 2",
        "Choice 3"
      ],
      "isRequired": false,
      "isVisibleToSupplier": true,
      "name": "Single select",
      "type": "single_select"
    },
    {
      "bidOptions": [
        "On-spec",
        "Off-spec"
      ],
      "isRequired": false,
      "isVisibleToSupplier": true,
      "name": "Volume - Capacity",
      "type": "capacity"
    }
  ],
  "items": [
    {
      "values": {
        "Buyer currency": "USD",
        "Buyer number": 100,
        "Buyer text": "Buyer note 1",
        "Item": "Item name 1",
        "Volume": 12
      }
    },
    {
      "values": {
        "Buyer currency": "EUR",
        "Buyer number": 200,
        "Buyer text": "Buyer note 2",
        "Item": "Item name 2",
        "Volume": 14
      }
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "eyJwcm9qZWN0IjoiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAwIiwib2Zmc2V0IjoxfQ==",
    "total": 3
  }
}