Preview Send Plan Drafts
POST/api/send-plans/:sendPlan/drafts/preview
Preview the draft groups a Create Send Plan Drafts request would make, without creating anything: one group per destination network and source warehouse, with its lines and units, and the options that network's own create flow offers. Pass the chosen options back in Create Send Plan Drafts groups.
send-plans:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Bearer Personal Access Token with the send-plans:write scope. The token's user also needs permission to create send planner drafts.
Body fields (all optional):
- line_ids (integer[], max 20000): lines to draft. Omit for every line with units to send.
- networks (string[]): only these networks (amazon_fba, amazon_awd, walmart_wfs, tiktok_fbt, warehouse_transfer).
Lines already waiting in a draft that is being created are left out.
Each group: key (destination:source), network, destination_warehouse_id, source_warehouse_id, lines (line_id, product_id, sku, name, quantity, case_pack), units, and options (null when the network offers none): default_name and name_max_length for the draft name, open_drafts (id, name, status, items_count, route) the lines can be added to, and listings — keyed by product ID, only for products with more than one listing on the network — each with sku, label, fulfillable, suppressed and recommended.
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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.