Bids

Create bid line item

post/bids/{id}/line-items

Request

  • Base URL: https://app.buildworkpro.com/api/v1
  • URL: https://app.buildworkpro.com/api/v1/bids/{id}/line-items
  • Auth: HTTP bearer

Path parameters

idinteger required

Headers

Idempotency-Keystring uuid

Idempotent retry key for mutating operations. The first request with a given key executes normally and BuildWorkPro caches the response. Replaying the same key with the same request body (method + path + JSON body, SHA-256 hashed) returns the cached response without re-executing the mutation. Replaying with a DIFFERENT body returns 409 idempotency_key_reused. The cache TTL is 24 hours; after expiry the key is treated as a new operation. Keys are tenant-scoped. Recommended: a fresh UUID v4 per logical operation.

Request body

productIdinteger nullable
markNamestring nullable
descriptionstring required
quantitystring nullable
widthstring nullable
heightstring nullable
depthstring nullable
areastring nullable
perimeterLfstring nullable
volumeCfstring nullable
buyTaxPercentstring nullable

Purchase-tax rate on the cost. A percent, not a fraction: 7 means 7% (send 7, not 0.07). 0-100, at most 3 decimal places.

sellTaxPercentstring nullable

Sales-tax rate for this line. null inherits the bid rate, 0 exempts. A percent, not a fraction: 7 means 7% (send 7, not 0.07). 0-100, at most 3 decimal places.

kind'item' | 'section' | 'note'

item = priced line; section = header grouping the rows after it; note = customer-visible text.

isOptionalboolean

An optional (alternate) priced line, quoted outside the bid total.

orderinteger nullable
unitPricestring

Pre-markup direct cost per unit for a flat line with no sublines. Not the customer price — read customerUnitPrice. Ignored once the line has sublines.

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.