> For the complete documentation index, see [llms.txt](https://docs.stoqapp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stoqapp.com/preorders-api/send-shipping-update-email.md).

# Send shipping update email

## Send shipping update emails to multiple orders

> Send shipping update emails to multiple preorders. You can specify orders using either:\
> \- STOQ internal order IDs (UUIDs) via \`order\_ids\`\
> \- Shopify order IDs via \`shopify\_order\_ids\`\
> \
> You must provide one or the other, but not both.<br>

```json
{"openapi":"3.0.3","info":{"title":"Preorders API","version":"1.0.0"},"servers":[{"url":"https://app.stoqapp.com/api/v1/external","description":"Production server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-Auth-Token"}}},"paths":{"/preorders/send_shipping_update":{"post":{"summary":"Send shipping update emails to multiple orders","description":"Send shipping update emails to multiple preorders. You can specify orders using either:\n- STOQ internal order IDs (UUIDs) via `order_ids`\n- Shopify order IDs via `shopify_order_ids`\n\nYou must provide one or the other, but not both.\n","tags":["Preorders"],"parameters":[{"in":"header","name":"X-Auth-Token","required":true,"schema":{"type":"string"},"description":"API key for authentication"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"order_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Array of STOQ internal order UUIDs to send shipping updates to (mutually exclusive with shopify_order_ids)"},"shopify_order_ids":{"type":"array","items":{"type":"integer"},"description":"Array of Shopify order IDs to send shipping updates to (mutually exclusive with order_ids)"},"subject":{"type":"string","description":"Email subject line"},"header":{"type":"string","description":"Email header text"},"description":{"type":"string","description":"Email body description"}},"required":["subject","header","description"]}}}},"responses":{"200":{"description":"Shipping update emails queued successfully","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"orders_count":{"type":"integer","description":"Number of orders that will receive the shipping update"}}}}}},"400":{"description":"Bad request - missing required parameters or invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"401":{"description":"Unauthorized"},"404":{"description":"No valid orders found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.stoqapp.com/preorders-api/send-shipping-update-email.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.