Send 3PL Email
POST/api/amazon/:integrationInstance/draft-inbound-plans/:draft_inbound_plan/fulfillment/email
Send the operator-composed "Email the 3PL" portal invitation: resolves the 3PL/supplier recipient, substitutes the email tokens — {{reference}}, {{portal_link}}, {{instructions}}, and the per-shipment {{shipment_id}}, {{ship_to}}, {{ship_from}}, {{carrier}}, {{method}}, {{notes}} and {{attachments_list}}, attaches the selected documents, marks the initial-stage documents and the packet Sent, and delivers the mail (CC honoured). Returns the updated fulfillment packet.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body: subject (required, max 255), body (required HTML string), cc (optional array of email addresses).
Attachment flags (all boolean, optional, default true). Each is honoured only when the document actually exists — the matching email_will_attach_* flag on the packet tells you which are available, so the compose dialog never offers an attachment that cannot be produced:
attach_fnsku_labels— FNSKU item-label PDF. When no durable label file exists yet, labels are generated at send time for every seller-labelled item at its plan quantity (best-effort — a generation failure never blocks the email).attach_prep_sheet— prep & pack sheet (XLSX): unit mix, prep requirements and kitting instructions.attach_packing_list— packing list (XLSX): every box with its unit mix, dimensions and weight. Available once box contents are known.attach_box_labels— Amazon box labels (PDF), one per box. Available once generated.attach_pallet_labels— Amazon pallet labels (PDF), four per pallet. Freight shipments only.attach_bol— bill of lading (PDF). Freight shipments only, issued close to the pickup date.
from_mode (string, optional, one of merchant or system): which sender identity to send as for this one email. merchant uses the store's own address (requires SPF/DKIM on that domain); system uses the always-deliverable system identity. Defaults to the packet's email_from_default_mode.
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.