Skip to main content

Get Send Plan Coverage

GET 

/api/send-plans/:sendPlan/coverage

Regional coverage for a plan: every network with its reach before and after the plan, the coverage object for the selection (one product, or the velocity-weighted network when product_id is omitted), the best place for a new warehouse and the progress of any history backfill.

Required scope: send-plans:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Response fields:

  • networks[]: key, label, destination_warehouse_id, country, supported, unsupported_reason, before_pct, after_pct.
  • coverage: status (ok, no_data, no_demand_data, failed, unsupported), before_pct / after_pct (whole percent, null when not measured), target_pct, radius_miles, unit, as_of, stale, stale_days, low_confidence, placement / demand sources, demand_orders, regions[] (demand share, stock share, days of cover, covered share and status before and after), admin1[] (state / province tints), nodes[] (fulfillment centers or warehouses with units before and after), arcs[] (planned sends and inbound shipments, capped; arcs_total is the full count), origins[], unplaced (units at nodes with no known location), send_more_to, thin_regions, dtc_warning, remote_demand, reason, and products_measured for a network-wide view.
  • best_new_node: only for network=warehouse — the postal area where one more warehouse would raise reach the most {area_code, admin1, region, label, lat, lng, before_pct, after_pct}; null otherwise.
  • backfill: {running, progress (0–1), job_id} while history is being loaded, else null.

network=all returns {networks, layers: [{network, destination_warehouse_id, label, color_key, country, nodes}], as_of}: every network's nodes on one map, with no combined percentage (a marketplace node can not ship another channel's orders).

For a network that is listed but not measured (for example Walmart WFS or Amazon AWD), coverage.status is unsupported with the reason, and the other keys are null.

All figures are estimates: the share of a product's buyers (by order postal area) within estimated 2-day ground reach (great-circle distance ≤ the radius) of a fulfillment center or warehouse holding sellable stock. They are not the marketplace's delivery promise; every response carries as_of and the radius.

Authentication: a Personal Access Token in the Authorization header with the send-plans:read scope. The token's user also needs permission to view the send planner.

Returns 422 for an unknown network or mode, an unknown product or destination, or a network/destination that has no regional coverage on this plan.

Request​

Responses​

OK

Response Headers
    Content-Type