On this page
transferLane
query · in the family Transfer lane
What it does
Look up one record — a transfer lane — a named sender→receiver route stock moves along.
A TransferLane by id, within the caller's OWN org-group family; requires authentication. A cross-tenant id reads as null (not-found) AND trips the rootId tripwire server-side.
What happens
Reads only — changes nothing.
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:transferLane
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
id | ID ID! | yes | The id of the record. |
Returns
TransferLane — A transfer lane — ONE DIRECTED source→destination LF pair the operator has declared: never (a standing prohibition), always (the preferred donor class), or ranked (an explicit ordering). Group-scoped like a Brand (parent = the org group). THE MATRIX IS SPARSE + the geo seed is VIRTUAL: an ABSENT pair ranks by geodistance (LF→PF→PFL.geo) AT READ — no seeder materializes derivable rows; overriding the default = creating the specific lane. The PAIR is IMMUTABLE at birth (re-route = create + doom; src == dest refused) and UNIQUE per group (the ordered-pair marker — a LIVE duplicate is CONFLICT/IDENTITY_TAKEN naming the holder; a doomed holder is taken over). rank is REQUIRED iff mode is ranked and REFUSED otherwise (strict both ways; a mode moving OFF ranked DROPS the stored rank — the merged-record law). ⚠ INACTIVE = ABSENT, not never: deactivating returns the pair to the sparse geodistance default — a standing prohibition must stay ACTIVE never. A NON-doomed lane blocks BOTH its LFs dooms; deactivate stays FREE. Money reuses the MoneyEntry SDL (declared on the Product entry).
Example request
query ExampleTransferLane($id: ID!) {
transferLane(id: $id) {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
sourceLfId
destinationLfId
mode
rank
typicalLeadTimeDays
weightClass
}
}
Variables:
{
"id": "01900000-0000-7000-8000-37386ae00000"
}
Example response
{
"data": {
"transferLane": {
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "TL-EXMP-0000-000F",
"type": "TransferLane",
"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",
"sourceLfId": "01900000-0000-7000-8000-366bfb930000",
"destinationLfId": "01900000-0000-7000-8000-7bd4ce680000",
"mode": "never",
"rank": 1,
"typicalLeadTimeDays": 1,
"weightClass": "light"
}
},
"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)