Skip to main content

Types

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.

FieldTypeDescription
idUUID!Placement id
lineItemIdUUIDThe inventory line item this placement belongs to — the stable identifier every operation takes
facilityIdUUID!Where the unit is held
stateFacilityItemState!See enum below
externalUserIdStringYour end-user reference, when assigned
expiresAtDateTimePlacement expiry, when set
createdAtDateTime!When the placement was created
updatedAtDateTime!Last state movement

Facility

Public-safe facility identity — no address, hours, or operator internals.

FieldTypeDescription
idID!Facility id
nameString!Display name
typeString!VAULT, PROCESSING, GRADING, or AUTHENTICATION
isPartnerOperatedBoolean!True when a partner operates this facility rather than Tradepost

FacilityMovementRequest

An outtake request. One per facility the selection spans.

FieldTypeDescription
idID!Request id
accountIdID!Owning account
facilityIdID!The facility this request ships from
movementTypeString!Movement kind; outtakes read OUTTAKE
statusString!See FacilityMovementRequestStatus below
cancelByDateTimeHard cancellation cutoff. Null means no deadline, not a deadline of now
completeByDateTimeWhen the facility commits to complete by
isCancellableBoolean!Whether cancellation is possible right now — time-dependent, goes stale the moment cancelBy passes
dataJSONRequest extras
items[FacilityMovementRequestItem!]!Per-unit rows
facilityFacilityPresent on account list/detail reads; null on payloads that don't load it
productSummaries[OuttakeProductSummary!]Per-product rollups; present only when includeProductInfo was requested
outtakeQuoteOuttakeQuoteWhat you agreed to pay at request time. Null on older requests
chargedTotalCentsIntWhat packing actually assessed. Null before packing — show the quote until then
shipToOuttakeShipToDestination as captured at request time
notesStringHandling notes you left for the facility
preferredCarrier / preferredSpeed / preferredInsuranceString / String / BooleanShipping preferences captured at request time. Preferences, not the label bought
createdAtDateTime!Creation time
updatedAtDateTime!Last status movement

OuttakeQuote

FieldTypeDescription
handlingCentsInt!Handling at the quoted mode
shippingCentsIntNull when shipping wasn't quoted
totalCentsIntNull when shipping wasn't quoted — never present handlingCents alone as the total
modeString!Fulfilment mode the quote priced
quotedAtDateTime!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

FieldTypeDescription
idID!Item row id
facilityMovementRequestIdID!Parent request
lineItemIdIDThe unit this row tracks
itemIdIDLegacy item reference
statusString!Per-unit progress within the request
releasedAtDateTimeWhen the unit left the vault
dataJSONRow extras
createdAtDateTime!Creation time
updatedAtDateTime!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.

FieldTypeDescription
assetConfigurationAssetConfigurationThe product
keyIdIDGraded/condition key
unitCountInt!Units of this product in the request
lineItemCountInt!Line items of this product in the request
unitCostBasisCentsBigIntYour moving-average cost per unit for this product. Null means no recorded cost — unknown, not zero
totalCostBasisCentsBigIntunitCostBasisCents × 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.

FieldTypeDescription
facilityIdID!The facility this preview prices
itemCountInt!Units at this facility
handlingOuttakeHandlingPreviewWhat you pay to have the group handled. Null when no policy prices it
shippingOuttakeShippingPreviewWhat you pay to ship it. Null without a savedAddressId, or when the policy doesn't bill shipping
dwellOuttakeDwellPreviewStorage-time estimate
totalCentsIntHandling + shipping + dwell as one figure. Null whenever any part is unresolved

OuttakeHandlingPreview

FieldTypeDescription
totalCentsInt!Handling charge
isCompleteBoolean!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

FieldTypeDescription
pendingBoolean!True when a quote was just enqueued. Poll again — totalCents is null while pending, so zero never reads as free
carrier / serviceStringThe quoted lane
totalCentsIntWhat you'd be charged
parcelCountIntParcels in the plan
unquotableConfigurationIds[ID!]!Products the packer had no plan for; their shipping is not in totalCents

OuttakeDwellPreview

FieldTypeDescription
storagePerUnitDayCentsInt!Storage rate per unit-day beyond the free period
freeDaysInt!Grace period before storage accrues
unitCountInt!Units the estimate covers
billableUnitDaysAsOfInt!Accrued unit-days as of asOf — keeps growing until the outtake is packed
estimatedCentsInt!Estimated dwell charge as of asOf
asOfDateTime!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.

ValueMeaning
VAULTEDHeld at the facility
OUTTAKINGOuttake in flight, physically leaving
UNVAULTEDRemoved from the facility
SOLDSold while at the facility
TRANSFERREDMoved to another facility
CONSIGNEDHeld, being sold on consignment
LOANEDTemporarily loaned out
HELDHeld for authentication or verification
DAMAGEDDamaged while at the facility

FacilityMovementRequestStatus

ValueMeaning
REQUESTEDCreated. Units are gated and can't be sold
PROCESSINGThe facility is working the request
IN_TRANSITLabels are scanning
PARTIALLY_COMPLETEDSome items released, some still pending
COMPLETEDEvery label delivered. Units have left the vault
CANCELLEDCancelled before the window closed. Units back in the vault

OuttakeFulfillmentMode

ValueMeaning
PARCELShipped as individual parcels
PALLETIZEDRepacked onto pallets — requires the request's allowPalletization consent