Skip to main content
POST
Create Replenishment Task

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.

Headers

Idempotency-Key
string
required

Caller-generated retry identity unique within the Warehouse.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._:-]+$

Path Parameters

id
integer<int32>
required

Warehouse identity.

Body

application/json
product_id
integer
required

Product to replenish.

Required range: x >= 1
lane_id
integer
required

Active Replenishment Lane whose destination Profile owns the task.

Required range: x >= 1
policy_id
integer
required

Active Policy belonging to the selected Lane and Product Merchant.

Required range: x >= 1
qty_required
number
required

Requested quantity in replenished Product units before feasibility reduction. Must be a whole number of the Product's current confirmed move units.

Required range: 0 < x <= 99999999.9999Must be a multiple of 0.0001
reason
string
required

Operator reason retained in the immutable task snapshot.

Required string length: 1 - 255

Response

Created manual Replenishment task with locked snapshots and scheduled feasibility evaluation.

resource
ReplenishmentTask · object

Durable, read-only snapshot of Replenishment work. Quantity fields are expressed in the replenished Product's units. In Product quanta at the applicable LCM, qty_planned_total equals the sum of unpicked, custody, placed, canceled, short/exception, and externally satisfied quantities. Independently rounded decimal fields may not sum exactly. Mutations use the task_revision and claim_lease_version compare-and-swap values.

included
object

Empty relationship expansion dictionary.

meta
object

Additional metadata pertaining to the response.