Skip to main content
POST
Rebuild Replenishment Index

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

id
integer<int32>
required

The id of the referenced Warehouse.

Body

application/json

Rebuild request for one Warehouse's Replenishment Index.

mode
enum<string>
required

soft coalesces into the pending generation and lets a build already in progress finish and publish. force additionally marks a running build superseded, so its result is never published and the fresh generation recomputes everything from scratch — repeated force requests at intervals shorter than a full build defer publication indefinitely. Both request a new generation when none is pending. force is for an explicit operator-initiated full recalculation; automation should default to soft.

Available options:
soft,
force

Response

Accepted - The rebuild request was durably recorded. requested_generation is this caller's completion predicate: the rebuild is complete once the status endpoint's published_generation (also the report's meta.published_generation) is greater than or equal to it. The comparison is exact — a superseded generation never publishes, and any successor publishes with a higher number computed from data read after this request.

requested_generation
integer<int64>
required

The pending generation this request coalesced into. Repeated requests made before the build completes return the same number.

Required range: x >= 1
meta
object
required