bidPricingTerms

Requires permission biddesk:bid:read.

A bid's pricing terms, or null before they are set. The markup and prices are null without permission to view margins. 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 BidPricingTerms($bidId: ID!) {
  bidPricingTerms(bidId: $bidId) {
    id
    bidId
    competitivePrice
    markupPct
    mode
    reason
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidPricingTerms($bidId: ID!) {\n  bidPricingTerms(bidId: $bidId) {\n    id\n    bidId\n    competitivePrice\n    markupPct\n    mode\n    reason\n  }\n}",
  "variables": {
    "bidId": "id"
  }
}
EOF

Variables:

{
  "bidId": "id"
}

Response:

{
  "data": {
    "bidPricingTerms": {
      "id": "id",
      "bidId": "id",
      "competitivePrice": "string",
      "markupPct": "string",
      "mode": "COMPETITIVE",
      "reason": "string"
    }
  }
}

bidPricingTerms(
  bidId: ID!
): BidPricingTerms

Arguments

bidPricingTerms.bidId ● ID! non-null scalar

The bid.

Type

BidPricingTerms object

How a bid is priced, and why: cost-plus with a markup, a target price or a competitive price. Exactly one of markupPct, targetPrice and competitivePrice is set, per mode.