Checkout Optionals

Optionals are add-on services on a quote — vault shipping, instant payout, overnight label. Each quote includes optionals[]. Select them with selectedOptionalIds on create, refresh, and execute. Shared quote flow: Execution.

Fields

Field	Meaning
`id`	Value to pass in `selectedOptionalIds`
`title` / `description`	Display copy
`fee`	Cents. On sell, negative (reduces payout)
`selected`	Currently selected on this quote
`enabled`	Eligible to select
`disabledReason`	Why `enabled` is false
`disclaimer`	Optional `{ label, url }`

When enabled is false, use disabledReason — do not guess.

Built-in

`vault_shipping` — buy

Ship to your Pure vault instead of a street address. When selected and eligible, standard shipping is waived and shipping is optional on execute. Requires vault shipping enabled on the org, a small line-item count, and non-silver products.

`instant_payout` — sell

Immediate payout; fee reduces the total. Needs enough credit on GET /execution/payout-methods/v1 and a minimum subtotal. Insufficient credit at execute: 422 instant_payout_insufficient_credit.

`overnight_label` — sell

Insured overnight label to Pure. Fee may be waived on high-value subtotals — trust enabled and fee on the quote.

Catalog

Side	Endpoint
Buy	`GET /execution/v2/buy/quotes/:quoteId/optionals`
Sell	`GET /execution/v2/sell/quotes/:quoteId/optionals`

Same optionals[] as the quote, plus partial (a resolver failed) and errors[]. Use this when you want the catalog without refreshing the full quote.

Selecting

curl -X POST https://api.collectpure.com/execution/v2/buy/quotes \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [{ "listingId": "LISTING_UUID", "quantity": 1 }],
    "paymentMethod": "pm_XXXXX",
    "selectedOptionalIds": ["vault_shipping"]
  }'

On GET refresh, repeat the query param — do not comma-join on v2:

curl "https://api.collectpure.com/execution/v2/sell/quotes/QUOTE_ID?selectedOptionalIds=instant_payout&selectedOptionalIds=overnight_label" \
  -H "x-api-key: YOUR_API_KEY"

Pass the same ids on execute. Sell execute also needs expectedOptionalFees (optional id → fee in cents from the quote). Drift is 422 optional_fee_mismatch. Buy does not require that map. Errors: Execution errors.

Get Started

Authentication

Execution

Rate Limiting

Fields

Built-in

`vault_shipping` — buy

`instant_payout` — sell

`overnight_label` — sell

Catalog

Selecting

​Fields

​Built-in

​vault_shipping — buy

​instant_payout — sell

​overnight_label — sell

​Catalog

​Selecting

Fields

Built-in

`vault_shipping` — buy

`instant_payout` — sell

`overnight_label` — sell

Catalog

Selecting