On this page
transferRequest
query · in the family Transfer request
What it does
Look up one record — a stock-transfer request between your locations.
A TransferRequest 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:transferRequest
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
id | ID ID! | yes | The id of the record. |
Returns
TransferRequest — A stock transfer request: a requesting LF asks variants x quantities of the group (open sourcing) or of ONE targeted source LF. Lines are EMBEDDED, VARIANT-keyed + birth-fixed (max 24 — TR-o); cancelled is the ONE doomed terminal (lists filter it); fulfilled/closed_short are IMMUTABLE non-doomed history — a write there refuses CONFLICT/IMMUTABLE.
Example request
query ExampleTransferRequest($id: ID!) {
transferRequest(id: $id) {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
requestingOrganizationId
targetLogicalFacilityId
neededBy
priority
}
}
Variables:
{
"id": "01900000-0000-7000-8000-37386ae00000"
}
Example response
{
"data": {
"transferRequest": {
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "TR-EXMP-0000-000F",
"type": "TransferRequest",
"caption": "Blue jeans",
"status": "draft",
"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",
"requestingOrganizationId": "01900000-0000-7000-8000-93bd40d40000",
"targetLogicalFacilityId": "01900000-0000-7000-8000-2938ce830000",
"neededBy": "<needed by>",
"priority": "low"
}
},
"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)