bidConfiguration

Requires permission biddesk:bid:read.

One configuration of a bid. Requires Bid Desk and permission to read bids.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query BidConfiguration($id: ID!) {
  bidConfiguration(id: $id) {
    id
    name
    status
    createdAt
    baseBomVersionId
    bidId
    changes {
      id
      componentProductId
      configurationId
      kind
      lineKind
      note
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidConfiguration($id: ID!) {\n  bidConfiguration(id: $id) {\n    id\n    name\n    status\n    createdAt\n    baseBomVersionId\n    bidId\n    changes {\n      id\n      componentProductId\n      configurationId\n      kind\n      lineKind\n      note\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "bidConfiguration": {
      "id": "id",
      "name": "string",
      "status": "DRAFT",
      "createdAt": "2025-01-15T00:00:00Z",
      "baseBomVersionId": "id",
      "bidId": "id",
      "changes": [
        {
          "id": "id",
          "componentProductId": "id",
          "configurationId": "id",
          "kind": "ADD",
          "lineKind": "string",
          "note": "string"
        }
      ]
    }
  }
}

bidConfiguration(
  id: ID!
): BidConfiguration!

Arguments

bidConfiguration.id ● ID! non-null scalar

The configuration.

Type

BidConfiguration object

One configuration of a bid: a released base assembly version, a quantity, option selections and bid-specific changes.