Send shipping update email

Send shipping update emails to multiple orders

post

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.

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Header parameters

X-Auth-TokenstringRequired

API key for authentication

Body

application/json

order_idsstring · uuid[]Optional

Array of STOQ internal order UUIDs to send shipping updates to (mutually exclusive with shopify_order_ids)

shopify_order_idsinteger[]Optional

Array of Shopify order IDs to send shipping updates to (mutually exclusive with order_ids)

subjectstringRequired

Email subject line

headerstringRequired

Email header text

descriptionstringRequired

Email body description

Responses

200

Shipping update emails queued successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Shipping update emails will be sent

orders_countintegerOptional

Number of orders that will receive the shipping update

Example: 2

400

Bad request - missing required parameters or invalid input

application/json

401

Unauthorized

404

No valid orders found

application/json

post

/preorders/send_shipping_update

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: 242

{
  "order_ids": [
    "550e8400-e29b-41d4-a716-446655440000",
    "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  ],
  "subject": "Shipping Update",
  "header": "Your order is on its way!",
  "description": "We wanted to let you know that your preorder will be shipping soon."
}

Using STOQ internal order IDsUsing Shopify order IDs

{
  "success": true,
  "message": "Shipping update emails will be sent",
  "orders_count": 2
}