Type reference for the Vault API. GraphQL notation: ! means non-null, [...] is a list; a field without ! can be null.
FacilityItem
The placement — where one of your units physically sits. One-to-one with its inventory line item.
| Field | Type | Description |
|---|
id | UUID! | Placement id |
lineItemId | UUID | The inventory line item this placement belongs to — the stable identifier every operation takes |
facilityId | UUID! | Where the unit is held |
state | FacilityItemState! | See enum below |
externalUserId | String | Your end-user reference, when assigned |
expiresAt | DateTime | Placement expiry, when set |
createdAt | DateTime! | When the placement was created |
updatedAt | DateTime! | Last state movement |
Facility
Public-safe facility identity — no address, hours, or operator internals.
| Field | Type | Description |
|---|
id | ID! | Facility id |
name | String! | Display name |
type | String! | VAULT, PROCESSING, GRADING, or AUTHENTICATION |
isPartnerOperated | Boolean! | True when a partner operates this facility rather than Tradepost |
FacilityMovementRequest
An outtake request. One per facility the selection spans.
| Field | Type | Description |
|---|
id | ID! | Request id |
accountId | ID! | Owning account |
facilityId | ID! | The facility this request ships from |
movementType | String! | Movement kind; outtakes read OUTTAKE |
status | String! | See FacilityMovementRequestStatus below |
cancelBy | DateTime | Hard cancellation cutoff. Null means no deadline, not a deadline of now |
completeBy | DateTime | When the facility commits to complete by |
isCancellable | Boolean! | Whether cancellation is possible right now — time-dependent, goes stale the moment cancelBy passes |
data | JSON | Request extras |
items | [FacilityMovementRequestItem!]! | Per-unit rows |
facility | Facility | Present on account list/detail reads; null on payloads that don't load it |
productSummaries | [OuttakeProductSummary!] | Per-product rollups; present only when includeProductInfo was requested |
outtakeQuote | OuttakeQuote | What you agreed to pay at request time. Null on older requests |
chargedTotalCents | Int | What packing actually assessed. Null before packing — show the quote until then |
shipTo | OuttakeShipTo | Destination as captured at request time |
notes | String | Handling notes you left for the facility |
preferredCarrier / preferredSpeed / preferredInsurance | String / String / Boolean | Shipping preferences captured at request time. Preferences, not the label bought |
createdAt | DateTime! | Creation time |
updatedAt | DateTime! | Last status movement |
OuttakeQuote
| Field | Type | Description |
|---|
handlingCents | Int! | Handling at the quoted mode |
shippingCents | Int | Null when shipping wasn't quoted |
totalCents | Int | Null when shipping wasn't quoted — never present handlingCents alone as the total |
mode | String! | Fulfilment mode the quote priced |
quotedAt | DateTime! | When it was quoted |
OuttakeShipTo
name, street1, street2, city, state, zip, country, phone — all String, nullable — plus savedAddressId: ID, the saved address it was copied from.
FacilityMovementRequestItem
| Field | Type | Description |
|---|
id | ID! | Item row id |
facilityMovementRequestId | ID! | Parent request |
lineItemId | ID | The unit this row tracks |
itemId | ID | Legacy item reference |
status | String! | Per-unit progress within the request |
releasedAt | DateTime | When the unit left the vault |
data | JSON | Row extras |
createdAt | DateTime! | Creation time |
updatedAt | DateTime! | Last movement |
OuttakeProductSummary
One product's rollup within a movement request. assetConfiguration is the same full type the catalog sections use — name, primaryImageUrl, displayData, everything.
| Field | Type | Description |
|---|
assetConfiguration | AssetConfiguration | The product |
keyId | ID | Graded/condition key |
unitCount | Int! | Units of this product in the request |
lineItemCount | Int! | Line items of this product in the request |
unitCostBasisCents | BigInt | Your moving-average cost per unit for this product. Null means no recorded cost — unknown, not zero |
totalCostBasisCents | BigInt | unitCostBasisCents × unitCount. Null whenever the unit basis is |
Fee preview types
OuttakeFacilityFeePreview
One per facility the selection spans — fees are charged per facility group, so they're previewed per group.
| Field | Type | Description |
|---|
facilityId | ID! | The facility this preview prices |
itemCount | Int! | Units at this facility |
handling | OuttakeHandlingPreview | What you pay to have the group handled. Null when no policy prices it |
shipping | OuttakeShippingPreview | What you pay to ship it. Null without a savedAddressId, or when the policy doesn't bill shipping |
dwell | OuttakeDwellPreview | Storage-time estimate |
totalCents | Int | Handling + shipping + dwell as one figure. Null whenever any part is unresolved |
OuttakeHandlingPreview
| Field | Type | Description |
|---|
totalCents | Int! | Handling charge |
isComplete | Boolean! | False when the mode prices per pallet or carton, whose counts only exist at packing. An incomplete total understates the bill — don't show it as the price |
OuttakeShippingPreview
| Field | Type | Description |
|---|
pending | Boolean! | True when a quote was just enqueued. Poll again — totalCents is null while pending, so zero never reads as free |
carrier / service | String | The quoted lane |
totalCents | Int | What you'd be charged |
parcelCount | Int | Parcels in the plan |
unquotableConfigurationIds | [ID!]! | Products the packer had no plan for; their shipping is not in totalCents |
OuttakeDwellPreview
| Field | Type | Description |
|---|
storagePerUnitDayCents | Int! | Storage rate per unit-day beyond the free period |
freeDays | Int! | Grace period before storage accrues |
unitCount | Int! | Units the estimate covers |
billableUnitDaysAsOf | Int! | Accrued unit-days as of asOf — keeps growing until the outtake is packed |
estimatedCents | Int! | Estimated dwell charge as of asOf |
asOf | DateTime! | When the estimate was computed |
Enums
FacilityItemState
A unit is vaulted when its placement is VAULTED. Nothing else means vaulted, and only VAULTED allows outtake.
| Value | Meaning |
|---|
VAULTED | Held at the facility |
OUTTAKING | Outtake in flight, physically leaving |
UNVAULTED | Removed from the facility |
SOLD | Sold while at the facility |
TRANSFERRED | Moved to another facility |
CONSIGNED | Held, being sold on consignment |
LOANED | Temporarily loaned out |
HELD | Held for authentication or verification |
DAMAGED | Damaged while at the facility |
FacilityMovementRequestStatus
| Value | Meaning |
|---|
REQUESTED | Created. Units are gated and can't be sold |
PROCESSING | The facility is working the request |
IN_TRANSIT | Labels are scanning |
PARTIALLY_COMPLETED | Some items released, some still pending |
COMPLETED | Every label delivered. Units have left the vault |
CANCELLED | Cancelled before the window closed. Units back in the vault |
OuttakeFulfillmentMode
| Value | Meaning |
|---|
PARCEL | Shipped as individual parcels |
PALLETIZED | Repacked onto pallets — requires the request's allowPalletization consent |