Skip to main content

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 and delivers the mail (CC honoured), then marks the initial-stage documents and the packet Sent. The recipient check runs immediately (422 when none is configured); the send itself runs in the background because building the attachments can take a while. The response returns the fulfillment packet as it stood when the send was queued, plus tracked_job_log_id for following the background job; fetch the packet again once the job completes to see the Sent status.

Not yet available to API tokens

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.

Returns 404 when the inbound plan (or a shipment, box, option or item nested under it) in the path belongs to a different Amazon account than the one in the URL.

Request​

Responses​

OK

Response Headers
    Content-Type