Send a quote by email

Renders the quote PDF and emails it to a recipient while logging the delivery result.

POST/api/orders/{orderId}/send-quote

Renders the quote PDF and emails it to a recipient while logging the delivery result.

Path Parameters

orderId*string

Order identifier.

Example"ord_123"

Request Body

application/json

Request payload for Send a quote by email.

TypeScript Definitions

Use the request body type in TypeScript.

orderId*string

Order identifier whose quote will be sent.

Example"ord_123"

recipientEmails*array<string>

Recipient email addresses for the quote. The client can map comma-separated input into this array.

Example

[  "buyer@acme.test",  "purchasing@acme.test"]

ccEmails?array<string>|

Optional explicit CC recipient list. When supplied, it replaces server-generated CC defaults.

replyToEmail?|

Optional reply-to address for the quote email.

subject?|

Optional email subject. When omitted, the server generates a default quote subject.

body?|

Optional custom message body shown in the email above the quote summary.

footerHtml?|

Optional formatted personal footer. The server sanitizes it to the supported email-safe rich-text subset.

sendCopyToSender?|

Whether the current sender should be added in copy (CC) when their email is available.

emailAccountId?|

Optional linked email account id to send through. Omit to use the default transactional sender.

additionalAttachments?array<>|

Optional additional workspace documents to attach to the quote email.

config?|

config.

Response Body

`application/json`

curl -X POST "https://example.com/api/orders/ord_123/send-quote" \  -H "Content-Type: application/json" \  -d '{    "orderId": "ord_123",    "recipientEmails": [      "buyer@acme.test",      "purchasing@acme.test"    ]  }'

{  "success": true,  "emailId": "string",  "logId": "string"}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Send a quote by email

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`