FBO account

An FBO account is the holder whose inventory sits in the vault. Shipments, inventory items, and outbound requests take fboAccountId.

Each organization has one primary account (isPrimary: true). The vault ID is what you put on a package so the dock can match it to this account.

string

required

organizationId

string

required

firstName

string

required

lastName

string

required

string

required

isPrimary

boolean

required

True for the one account created with the organization.

createdAt

string<date-time>

required

phone

string

businessName

string

vaultId

string

Vault ID assigned by Beach, formatted PV-######.

maxInsuredValueCents

string

Insured-value ceiling for this account, in cents.

{
  "id": "<string>",
  "organizationId": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "isPrimary": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "phone": "<string>",
  "businessName": "<string>",
  "vaultId": "<string>",
  "maxInsuredValueCents": "<string>"
}

Overview

Entities

Organizations

FBO Accounts

Products

Inventory

Inbound Shipments

Transfers

Outbound Requests

Outbound Shipments

Statements