createReplenishmentConfig

mutation · in the family Replenishment config

What it does

Create a new replenishment settings — how reorder suggestions are computed for a scope at your organization.

Create a ReplenishmentConfig — one cell of the planning parameter matrix; requires the unrestricted capability.

Who may call it

Capability area: Inventory operations — Receiving, counting, transferring and moving stock.

• Owner
• Manager
• Associate Manager
• Warehouse Associate
• An API key whose scope allows api:createReplenishmentConfig

Arguments

Returns

ReplenishmentConfig ReplenishmentConfig! — A replenishment config — ONE cell of the multi-axis planning parameter matrix: a set of AXES naming a scope (absent = all — the sparse matrix; Location = organizationId XOR logicalFacilityId · Merchandise = categoryId XOR styleId · seasonId · brandId, each SINGULAR) + a SPARSE block of parameters (at least one — the substance rule). Group-scoped like a Brand (parent = the org group). The AXES are the cell identity — IMMUTABLE at birth (re-target = create + doom); parameter VALUES stay editable (nothing clears — removing a parameter = doom + create). the collision rule: an ACTIVE sibling with the SAME normalized axis tuple AND an intersecting SET-parameter set refuses CONFLICT/IDENTITY_TAKEN naming the holder + the intersecting parameters (same-tuple DISJOINT-parameter cells are legal — per-parameter semantics; an inactive cell neither resolves nor collides, so REACTIVATE re-runs the gate). Specificity (the.2 per-parameter resolution): count of set axes, then the locked axis order Location > Merchandise > Season > Brand. A NON-doomed cell blocks its axis targets dooms (LF/Organization/Category/Style/Season/Brand); deactivate stays FREE.

Example request

mutation ExampleCreateReplenishmentConfig($input: NewReplenishmentConfigInput!) {
  createReplenishmentConfig(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    organizationId
    logicalFacilityId
    categoryId
    styleId
    seasonId
    brandId
    replenishEnabled
    minUnits
    maxUnits
    daysOfSupplyTarget
    safetyStockUnits
    reorderMultipleUnits
    reviewCadenceDays
    abcClassOverride
    reserveFloorUnits
    transferableExcess
    allocationWeight
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createReplenishmentConfig": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "RP-EXMP-0000-000F",
      "type": "ReplenishmentConfig",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "organizationId": "01900000-0000-7000-8000-44b781470000",
      "logicalFacilityId": "01900000-0000-7000-8000-8026f71c0000",
      "categoryId": "01900000-0000-7000-8000-786111a40000",
      "styleId": "01900000-0000-7000-8000-2f797c8b0000",
      "seasonId": "01900000-0000-7000-8000-45de25e50000",
      "brandId": "01900000-0000-7000-8000-4067736b0000",
      "replenishEnabled": true,
      "minUnits": "<min units>",
      "maxUnits": "<max units>",
      "daysOfSupplyTarget": 1,
      "safetyStockUnits": "<safety stock units>",
      "reorderMultipleUnits": "<reorder multiple units>",
      "reviewCadenceDays": 1,
      "abcClassOverride": "A",
      "reserveFloorUnits": "<reserve floor units>",
      "transferableExcess": true,
      "allocationWeight": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

• VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
• AUTHN/REQUIRED — Sign in to do this. (AUTHN)
• AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
• RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
• NOT_FOUND/* — That record could not be found. (NOT_FOUND)
• CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
• VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.

Used in

• Keep shelves replenished