Send shipping update email

Send shipping update emails to multiple orders

post

Authorizations

Header parameters

X-Auth-TokenstringRequired

API key for authentication

Body

order_idsinteger[]Required

Array of order IDs to send shipping updates to

subjectstringRequired

Email subject line

headerstringRequired

Email header text

descriptionstringRequired

Email body description

Responses

200

Shipping update emails queued successfully

application/json

400

Bad request - missing required parameters

application/json

401

Unauthorized

404

No valid orders found

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/external/preorders/send_shipping_update HTTP/1.1
Host: app.stoqapp.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "order_ids": [
    1
  ],
  "subject": "text",
  "header": "text",
  "description": "text"
}

{
  "success": true,
  "message": "text",
  "orders_count": 1
}