addedOutput schema / properties
Added value: +{
+ "blocking": {
+ "anyOf": [
+ {
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "What stops the quote from being ready: {item_id, state, detail}",
+ "title": "Blocking"
+ },
+ "contact_email": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Email for receipts and order updates",
+ "title": "Contact Email"
+ },
+ "created_at": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "ISO 8601",
+ "title": "Created At"
+ },
+ "expires_at": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "ISO 8601. Prices hold until then; a later read re-prices at live rates",
+ "title": "Expires At"
+ },
+ "free_shipping_remaining": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Dollars more to reach free shipping (0 when reached)",
+ "title": "Free Shipping Remaining"
+ },
+ "id": {
+ "description": "Quote id (qt_...)",
+ "title": "Id",
+ "type": "string"
+ },
+ "items": {
+ "description": "Lines: {id, position, part, config, quantity, notes, review_status, review_note, pricing, snapshot_url, action_needed?}",
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "title": "Items",
+ "type": "array"
+ },
+ "min_order": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Order minimum in dollars",
+ "title": "Min Order"
+ },
+ "needs_review": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "True while a part waits for manual review; payment is blocked until then",
+ "title": "Needs Review"
+ },
+ "next_steps": {
+ "description": "Plain-English instructions for what to do next",
+ "items": {
+ "type": "string"
+ },
+ "title": "Next Steps",
+ "type": "array"
+ },
+ "number": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Quote number shown on the PDF and the website",
+ "title": "Number"
+ },
+ "po_number": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Your purchase order number",
+ "title": "Po Number"
+ },
+ "rate_set_version": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Version of the price list the quote was priced with",
+ "title": "Rate Set Version"
+ },
+ "ready": {
+ "description": "True when the quote can be paid",
+ "title": "Ready",
+ "type": "boolean"
+ },
+ "share_token": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Token of the quote's share link, {base}/quotes/share/{share_token}",
+ "title": "Share Token"
+ },
+ "ship_to": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Shipping address {name, company?, line1, line2?, city, state, postal_code, country, phone?}",
+ "title": "Ship To"
+ },
+ "shipping_choice": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Id of the chosen shipping option",
+ "title": "Shipping Choice"
+ },
+ "shipping_options": {
+ "anyOf": [
+ {
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Carrier options for ship_to; choose one with shipping_option",
+ "title": "Shipping Options"
+ },
+ "speed": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Chosen production speed: economy, standard, fast, faster or fastest",
+ "title": "Speed"
+ },
+ "status": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "open, ordered or expired (discarded or past its date)",
+ "title": "Status"
+ },
+ "tax_note": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Sales tax is added at checkout",
+ "title": "Tax Note"
+ },
+ "tiers": {
+ "anyOf": [
+ {
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "One entry per speed: price, ship-by and arrive-by dates, eligibility",
+ "title": "Tiers"
+ },
+ "totals": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Totals for the chosen speed, including total_before_tax",
+ "title": "Totals"
+ }
+}