createLogicalFacility

mutation · in the family Logical facility

What it does

Create a new logical facility — a sellable/working unit inside a building (the shop floor, the back room) at your organization.

Create a LogicalFacility in the caller's org group; requires the unrestricted capability.

Who may call it

Capability area: Organization structure — Opening and closing organizations and facilities — the legal and physical structure of your group.

Owner
System Administrator
An API key whose scope allows api:createLogicalFacility

Arguments

Name	Type	Required	Notes
`input`	NewLogicalFacilityInput `NewLogicalFacilityInput!`	yes	No further notes.

Returns

LogicalFacility LogicalFacility! — A logical facility — where transactions actually occur (sales, purchasing, receiving, transfers); inventory is maintained at LF level. Parent = its PhysicalFacility (NOT the family root). A policy level.

Example request

mutation ExampleCreateLogicalFacility($input: NewLogicalFacilityInput!) {
  createLogicalFacility(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    organizationId
    classification
    geographicDivisionId
    code
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "physicalFacilityId": "01900000-0000-7000-8000-6ecd4f980000",
    "classification": "<classification>"
  }
}

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

Example response

{
  "data": {
    "createLogicalFacility": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "LF-EXMP-0000-000F",
      "type": "LogicalFacility",
      "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",
      "classification": "<classification>",
      "geographicDivisionId": "01900000-0000-7000-8000-478b5d0c0000",
      "code": "BJ-001"
    }
  },
  "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

Open a new location