POST

Send a sales order by email

Scope: inventory:sales-orders.write https://api.alladdin.com/api/v2/sales-orders/{salesOrderId}/send

Sends the sales order by email to the contact using the template configured in your account settings.
You can optionally specify recipient email addresses, subject, and message body.

Parameters

Path parameters

salesOrderId string required

Sales Order ID (24-char hex ObjectId)

Request body

object emails[] string[] required

List of recipient email addresses

subject string | null optional

Custom email subject line

message string | null optional

Custom email body message

mail_template_id string | null optional

Identifier of the email template to use

cc[] string[] | null optional

List of CC email addresses

bcc[] string[] | null optional

List of BCC email addresses

Request

python

import requests

url = "https://api.alladdin.com/api/v2/sales-orders/{salesOrderId}/send"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

payload = {
    "emails": [
        "string"
    ],
    "subject": "string",
    "message": "string",
    "mail_template_id": "string",
    "cc": [
        "string"
    ],
    "bcc": [
        "string"
    ]
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

Responses

Success responses

200 Sales order sent

Error responses

400 Bad request application/json 401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Sales order not found application/json

← PreviousAttach a file to a sales order →

Next →Ship all items in a sales order →

Alladdin