replenishmentParameters

query · in the family Reading your records

What it does

The reorder maths per item — min/max, lead times, safety stock — that replenishment suggestions use.

The resolution DIAGNOSTIC for one (variant × LF): the effective parameter set + per-parameter provenance (config + the specificity trace) + every matched config. REFUSES VALIDATION/INVALID naming both configs, the parameter, and the cure when two equal-specificity configs set the same parameter (the season multi-membership residual — lean, no silent winner). Reads null when the variant or LF is missing/cross-tenant. Requires authentication.

What happens

Reads only.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Owner
System Administrator
Manager
Associate Manager
Warehouse Associate
Sales Associate
An API key whose scope allows api:replenishmentParameters

Arguments

Name	Type	Required	Notes
`variantId`	ID `ID!`	yes	No further notes.
`logicalFacilityId`	ID `ID!`	yes	No further notes.

Returns

ReplenishmentParameterResolution — The replenishmentParameters diagnostic result.

Example request

query ExampleReplenishmentParameters($variantId: ID!, $logicalFacilityId: ID!) {
  replenishmentParameters(variantId: $variantId, logicalFacilityId: $logicalFacilityId) {
    variantId
    logicalFacilityId
    organizationId
    matchedConfigIds
  }
}

Variables:

{
  "variantId": "01900000-0000-7000-8000-8415e73b0000",
  "logicalFacilityId": "01900000-0000-7000-8000-8026f71c0000"
}

Example response

{
  "data": {
    "replenishmentParameters": {
      "variantId": "01900000-0000-7000-8000-8415e73b0000",
      "logicalFacilityId": "01900000-0000-7000-8000-8026f71c0000",
      "organizationId": "01900000-0000-7000-8000-44b781470000",
      "matchedConfigIds": [
        "01900000-0000-7000-8000-f68ff4590000"
      ]
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "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)

Used in

Keep shelves replenished