GET/v1/postbatches/{id}/quote

Quote of a Postbatch

The number of items that will be sent, the unit price from your pricing on that quantity, totals excluding and including VAT, the next run with its cutoff and delivery window and the later planned runs you may pick at approval. Locked once approved.

Scope items.read

Path parameters

idstringrequired

Returns

20 fields of the 200 answer

postbatchIdstringrequired

statusenumrequired

DRAFTIMPORTINGVALIDATEDPENDING_APPROVALAPPROVEDSCHEDULED_FOR_RUNIN_PRODUCTIONCOMPLETEDCANCELLED

quantityintegerrequired

needsAttentionintegerrequired

suppressedintegerrequired

duplicatesintegerrequired

currencystringrequired

unitPriceCentsinteger or nullrequired

listUnitPriceCentsinteger or nullrequired

discountPercentnumber or nullrequired

tierobject or nullrequired

3 fields

basisstringrequired

minQuantityintegerrequired

basisQuantityintegerrequired

totalExclVatCentsinteger or nullrequired

vatTreatmentstring or nullrequired

vatRateinteger or nullrequired

vatCentsinteger or nullrequired

totalInclVatCentsinteger or nullrequired

pricedbooleanrequired

nextRunone of or nullrequired

plannedRunsarray of objectsrequired

3 fields

idstringrequired

cutoffAtdate-timerequired

handoverWeekstringrequired

lockedbooleanrequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

404Not found

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

otherError (RFC 9457 problem details)

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.postbatches.quote('pb_01J9Y2K8QF4T6W8Z0B2D4F6H8K');

{ "postbatchId": "pb_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "status": "COMPLETED", "quantity": 1, "needsAttention": 1, "suppressed": 1, "duplicates": 1, "currency": "EUR", "unitPriceCents": 1250, "listUnitPriceCents": 1250, "discountPercent": 3, "tier": { "basis": "postbatch", "minQuantity": 1, "basisQuantity": 1 }, "totalExclVatCents": 1250, "vatTreatment": "Example", "vatRate": 1, "vatCents": 1250, "totalInclVatCents": 1250, "priced": false, "nextRun": { "productGroup": "Example", "run": { "id": "run_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "cutoffAt": "2026-10-16T09:14:02.000Z", "handoverWeek": "Example", "handoverMonday": "2026-11-02" }, "carrierLeadTimeDays": 1, "processingDays": 1, "leadTimeDays": 1, "expectedDeliveryFrom": "2026-11-02" }, "plannedRuns": [ { "id": "run_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "cutoffAt": "2026-10-16T09:14:02.000Z", "handoverWeek": "Example" } ], "locked": false }