cancelBidPriceRequest

Requires permission biddesk:cost_sheet:edit.

Withdraws a draft or sent price request; cancelling twice is refused; VERSION_CONFLICT when someone changed it first. Requires Bid Desk and permission to edit cost sheets.

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

mutation CancelBidPriceRequest($expectedVersion: Int!, $id: ID!) {
  cancelBidPriceRequest(expectedVersion: $expectedVersion, id: $id) {
    id
    number
    status
    bidId
    chosenVendorId
    closedAt
    vendors {
      id
      fileName
      vendorName
      status
      answeredAt
      contactEmail
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CancelBidPriceRequest($expectedVersion: Int!, $id: ID!) {\n  cancelBidPriceRequest(expectedVersion: $expectedVersion, id: $id) {\n    id\n    number\n    status\n    bidId\n    chosenVendorId\n    closedAt\n    vendors {\n      id\n      fileName\n      vendorName\n      status\n      answeredAt\n      contactEmail\n    }\n  }\n}",
  "variables": {
    "expectedVersion": 0,
    "id": "id"
  }
}
EOF

Variables:

{
  "expectedVersion": 0,
  "id": "id"
}

Response:

{
  "data": {
    "cancelBidPriceRequest": {
      "id": "id",
      "number": "string",
      "status": "CANCELLED",
      "bidId": "id",
      "chosenVendorId": "id",
      "closedAt": "2025-01-15T00:00:00Z",
      "vendors": [
        {
          "id": "id",
          "fileName": "string",
          "vendorName": "string",
          "status": "ANSWERED",
          "answeredAt": "2025-01-15T00:00:00Z",
          "contactEmail": "string"
        }
      ]
    }
  }
}

cancelBidPriceRequest(
  expectedVersion: Int!
  id: ID!
): BidPriceRequest!

Arguments

cancelBidPriceRequest.expectedVersion ● Int! non-null scalar

The version the change is based on.

cancelBidPriceRequest.id ● ID! non-null scalar

The price request.

Type

BidPriceRequest object

A request to vendors to quote an item, made from a bid. A draft sends nothing.