SDKs - Beach Depository

Official SDKs

The TypeScript SDK is published as @beach-depository/sdk.

Installation

npm install @beach-depository/sdk

Quick start

import { BeachApiClient, BeachApiEnvironment } from "@beach-depository/sdk"

const token = process.env.BEACH_API_KEY
if (!token) throw new Error("Set BEACH_API_KEY to a pv_sandbox_ or pv_live_ key")

const client = new BeachApiClient({
  token,
  environment: BeachApiEnvironment.Sandbox,
})

const page = await client.fboAccounts.list({ page: 1, limit: 25 })

token is the same Bearer key from Getting Started. BeachApiEnvironment.Sandbox is https://sandbox.api.beachdepository.com. For live, pass baseUrl: "https://api.beachdepository.com". The client appends /v1. Calls are grouped by resource:

Client	What it covers
`client.organization`	Organization profile and members
`client.fboAccounts`	FBO accounts, including `addresses` and `aliases`
`client.products`	Products
`client.inventory`	Inventory items
`client.inboundShipments`	Inbound shipments
`client.outboundRequests`	Outbound requests
`client.outboundShipments`	Outbound shipments
`client.transfers`	Transfers
`client.statements`	Statements
`client.labels`	Label rates
`client.webhooks`	Webhook endpoints

A non-success response throws BeachApiError, with statusCode, message, and body.

Idempotency

Creates for FBO accounts, addresses, aliases, inbound shipments, outbound requests, transfers, and webhooks take an optional idempotencyKey. The client sends it as the Idempotency-Key header. Cancel and label rates do not accept the option.

const account = await client.fboAccounts.create(
  {
    firstName: "Jane",
    lastName: "Smith",
    email: "jane@example.com",
    phone: "+15551234567",
  },
  { idempotencyKey: "64099353-b48b-4dcd-98b7-74df1cc57933" },
)

Retrying that call with the same key within 24 hours returns the original response. The replayed response includes Idempotency-Replayed: true.