releaseBidHandover

Requires permission biddesk:proposal:release.

Hands a won bid over, once. The hand-over approval rules (handover.release) run first; then, with sales orders on the plan, the released quote is converted into a sales order (quoted prices honoured), else the frozen hand-over package is recorded for export. Either way the decision is logged against the package hash. If the conversion fails after the hand-over was recorded, calling this again retries only the conversion. Refused with HANDOVER_BID_NOT_WON, HANDOVER_NEEDS_DEBRIEF, HANDOVER_NO_RELEASED_QUOTE, HANDOVER_DONE or VERSION_CONFLICT. Requires Bid Desk and permission to release proposals.

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 ReleaseBidHandover($bidId: ID!, $expectedVersion: Int!) {
  releaseBidHandover(bidId: $bidId, expectedVersion: $expectedVersion) {
    orderNumber
    outcome
    packageHash
    salesOrderId
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation ReleaseBidHandover($bidId: ID!, $expectedVersion: Int!) {\n  releaseBidHandover(bidId: $bidId, expectedVersion: $expectedVersion) {\n    orderNumber\n    outcome\n    packageHash\n    salesOrderId\n  }\n}",
  "variables": {
    "bidId": "id",
    "expectedVersion": 0
  }
}
EOF

Variables:

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

Response:

{
  "data": {
    "releaseBidHandover": {
      "orderNumber": "string",
      "outcome": "string",
      "packageHash": "string",
      "salesOrderId": "id"
    }
  }
}

releaseBidHandover(
  bidId: ID!
  expectedVersion: Int!
  warehouseId: ID
): BidHandoverResult!

Arguments

releaseBidHandover.bidId ● ID! non-null scalar

The won bid to hand over.

releaseBidHandover.expectedVersion ● Int! non-null scalar

The bid's version as last loaded.

releaseBidHandover.warehouseId ● ID scalar

The warehouse the sales order ships from; omit for the default. Ignored for an export.

Type

BidHandoverResult object

What handing a won bid over did.