Skip to main content

Recompute Send Plan Line Coverage

POST 

/api/send-plans/:sendPlan/lines/:line/coverage

Measure one line's regional coverage again now and store it, and refresh the plan's totals.coverage (the network summary that Get Send Plan, Plan Glance and Compare Scenarios read). Changes no quantity.

Required scope: send-plans:write

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

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 with the send-plans:write scope (it is a POST). The token's user needs permission to view the send planner.

No request body. Returns the line's full coverage object (same shape as coverage in Get Send Plan Coverage). Inbound arcs carry shipment_record_id, shipment_record_type, shipment_route and network, so a client can open the inbound shipment. When the measurement itself fails, the line is stored with status failed (its old figures are cleared) and that object is returned with 200 and a message that says so; reason on the object says what failed.

Rate limit: 20 recomputes per user per minute. Beyond that the endpoint answers 429 with a Retry-After header and a message.

Returns 404 when the line is not on this plan, and 422 when the line's network is not measured (for example Walmart WFS or Amazon AWD); the message gives the reason.

Request​

Responses​

OK

Response Headers
    Content-Type