Preview 3PL Email
POST/api/amazon/:integrationInstance/draft-inbound-plans/:draft_inbound_plan/fulfillment/email/preview
Preview the "Email the 3PL" compose dialog: substitutes the email tokens in the supplied subject/body server-side and returns the rendered result (no email is sent). Available tokens: {{reference}}, {{portal_link}}, {{instructions}}, plus the per-shipment {{shipment_id}}, {{ship_to}}, {{ship_from}}, {{carrier}}, {{method}}, {{notes}} and {{attachments_list}} — resolved against the first confirmed shipment for the preview; the shipping-details send re-resolves them per shipment. Body: subject (required, max 255), body (required HTML string), cc (optional array of email addresses).
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.