POST/v1/quotes

Quote a price

The organisation's unit price for a product, finish and destination at a quantity, with the totals excluding and including VAT, the tier that applied and whether a pricing agreement was used. Postbatches quote at their own quantity; a Postflow item is priced at the organisation's rolling 30-day volume (basis rolling30d).

Scope billing.read

Body

productIdstringrequiredmin length 1

finishstringrequiredmin length 1max length 40

destinationstringmin length 2max length 2default "NL"

quantityintegerrequiredmin 1max 10000000

basisenumdefault "postbatch"

postbatchrolling30d

Returns

15 fields of the 200 answer

productIdstringrequired

finishstringrequired

destinationstringrequired

quantityintegerrequired

currencystringrequired

unitPriceCentsintegerrequired

listUnitPriceCentsintegerrequired

discountPercentnumber or nullrequired

agreementAppliedbooleanrequired

tierobjectrequired

3 fields

basisenumrequired

postbatchrolling30d

minQuantityintegerrequired

basisQuantityintegerrequired

totalExclVatCentsintegerrequired

vatCentsintegerrequired

totalInclVatCentsintegerrequired

vatTreatmentenumrequired

NL_STANDARDEU_REVERSE_CHARGENON_EU

vatRateintegerrequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

422Validation failed

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

curl -X POST https://api.postbuddy.nl/v1/quotes \ -H "Authorization: Bearer $POSTBUDDY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "productId": "prd_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "finish": "silk", "quantity": 1 }'

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.pricing.quote({ body: { productId: 'prd_01J9Y2K8QF4T6W8Z0B2D4F6H8K', finish: 'silk', quantity: 1, }, });

import os from postbuddy import Client client = Client(os.environ["POSTBUDDY_API_KEY"]) result = client.pricing.quote({ "productId": "prd_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "finish": "silk", "quantity": 1, })

{ "productId": "prd_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "finish": "silk", "destination": "Example", "quantity": 1, "currency": "EUR", "unitPriceCents": 1250, "listUnitPriceCents": 1250, "discountPercent": 3, "agreementApplied": false, "tier": { "basis": "postbatch", "minQuantity": 1, "basisQuantity": 1 }, "totalExclVatCents": 1250, "vatCents": 1250, "totalInclVatCents": 1250, "vatTreatment": "NL_STANDARD", "vatRate": 1 }

{ "type": "https://docs.postbuddy.nl/errors/validation_failed", "title": "Validation failed", "status": 422, "code": "validation_failed", "detail": "Validation failed", "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "errors": [ { "field": "recipient.postalCode", "code": "invalid_string", "message": "Invalid postal code" } ] }