Skip to main content

Update Send Planner Settings

PUT 
/api/send-planner/settings

Update the account-wide send planner defaults. Send only the settings you want to change.

Required scope: send-plans:write

Grant 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 edit the send planner.

Body fields (all optional):

  • reserve_days (integer, 0-365)
  • protect_local (boolean)
  • include_inbound_days (integer, 0-180)
  • velocity_window_days (integer, 7-365)
  • stale_inventory_hours (integer, 1-720)
  • hold_ttl_hours (integer, 1-720)
  • rounding_mode (string): nearest | down | up | none
  • run_day_of_week (integer 0-6, or null to turn the weekly run off)
  • run_time (string, HH:MM)
  • run_auto_draft_clean_lines (boolean): turning it on needs permission to create send planner drafts (403 otherwise).
  • run_digest_user_ids (integer[], max 50): users of this account who receive the send run's exception digest.

Response: all settings after the update.

Settings:

  • reserve_days: days of self-fulfilled demand (orders you ship from your own warehouses: web store, eBay, Amazon FBM, wholesale…) kept back at the source warehouses.
  • protect_local: when false only open orders and backorders are protected, not forecast demand.
  • include_inbound_days: count open purchase / manufacturing orders arriving within this many days as sendable supply (0 = on hand only).
  • velocity_window_days: sales window used for velocity.
  • stale_inventory_hours: a network stock snapshot older than this fails the plan unless plan_anyway is set.
  • hold_ttl_hours: how long a stock hold lasts before it expires if not handed to a draft.
  • rounding_mode: nearest | down | up | none — default case-pack rounding.
  • run_day_of_week (0 = Sunday … 6 = Saturday, null = off) and run_time (HH:MM): the weekly send run.
  • run_auto_draft_clean_lines: on a send run, automatically draft lines with no exceptions.
  • run_digest_user_ids: users who receive the send run's exception digest.
  • transfer_destination_warehouse_ids: your own warehouses stocked by transfer (see Get Transfer Destinations).
  • next_run_at: when the next weekly send run starts (ISO 8601, UTC), or null when none is scheduled.

Request​

Responses​

OK

Response Headers
    Content-Type