List Draft Plans
GET/api/amazon/:integrationInstance/draft-inbound-plans/list
Paginated Drafts-tab listing for the list view.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Scope: in-progress drafts that have NOT yet been submitted to Amazon (no linked Amazon plan) — plus ABORTED drafts regardless of submission, so a plan voided on Amazon (e.g. via Cancel & Create Draft) stays visible as history. Live submitted drafts appear on the Inbound Plans tab instead.
Response includes unfiltered_total (for the export modal) and status_counts (total / in_progress / finalized / aborted, powering the metric cards).
Requires Bearer token.
Aborted rows additionally carry aborted_at / aborted_by (from the status-transition activity log) for the Cancelled column.
source_mode is derived from the plan's source warehouse: purchase_order when the warehouse belongs to a supplier (then supplier_id and supplier_name are set), otherwise warehouse_transfer. source_mode_label is the display form.
Default status (U5): the list defaults to the In Progress bucket (every draft not yet finalized or aborted) when the request says nothing about status — no filter[status], no filter[status.<operator>], no filter[status_group], and no status condition in filter_groups. Any explicit status stands, including the sentinels filter[status]=all (everything) and filter[status]=in_progress (the default bucket, named explicitly). This mirrors the Drafts tab's Status chip, which shows "In Progress" by default and sends "All" / "Aborted" as explicit status is … conditions. status_counts and unfiltered_total always describe the whole tab, regardless of the status in effect.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.