Create Transfer

POST

transfers

cURL

curl --request POST \
  --url https://api.beachdepository.com/v1/transfers \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "fromFboAccountId": "m97fbo456",
  "toFboAccountId": "m97fbo789",
  "items": [
    {
      "inventoryItemId": "k57item123",
      "reason": "trade"
    }
  ]
}'

const response = await fetch("https://api.beachdepository.com/v1/transfers", {
  method: "POST",
  headers: {
    Authorization: "Bearer <token>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    fromFboAccountId: "m97fbo456",
    toFboAccountId: "m97fbo789",
    items: [
      {
        inventoryItemId: "k57item123",
        reason: "trade",
      },
    ],
  }),
})

const data = await response.json()

import requests

response = requests.post(
    "https://api.beachdepository.com/v1/transfers",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "fromFboAccountId": "m97fbo456",
        "toFboAccountId": "m97fbo789",
        "items": [
            {
                "inventoryItemId": "k57item123",
                "reason": "trade",
            },
        ],
    },
)

package main

import (
  "fmt"
  "io"
  "net/http"
  "strings"
)

func main() {
  url := "https://api.beachdepository.com/v1/transfers"
  payload := strings.NewReader(`{
  "fromFboAccountId": "m97fbo456",
  "toFboAccountId": "m97fbo789",
  "items": [
    {
      "inventoryItemId": "k57item123",
      "reason": "trade"
    }
  ]
}`)
  req, _ := http.NewRequest("POST", url, payload)
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)
  fmt.Println(string(body))
}

Both FBO accounts must belong to this organization. Every item must be in_vault on the source account. Create checks every item before it writes the transfer. One failed item rejects the request. The items never leave the vault. Save the returned id. Omit approve and the transfer starts at pending_approval. The items stay in_vault.

Authorizations

string

required

Send Bearer <token> in this header. The key needs transfer_batches:create.

Body

string

required

string

required

Must differ from fromFboAccountId.

string

boolean

Omit the field, or set false, to start at pending_approval. Confirm that transfer later with Confirm Transfer. The response includes items.

array

required

The inventory items to transfer — at least one. Each entry contains:

inventoryItemId (string, required) — ID of the inventory item to transfer.
reason (string, required) — One of request, trade, or rebalance. Use trade for a sale or swap, rebalance when reallocating holdings, and request when the destination account asked for the item. It does not collect payment.

inventoryItemId values must be unique within the request.

This endpoint supports the Idempotency-Key header.

cURL

curl --request POST \
  --url https://api.beachdepository.com/v1/transfers \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "fromFboAccountId": "m97fbo456",
  "toFboAccountId": "m97fbo789",
  "items": [
    {
      "inventoryItemId": "k57item123",
      "reason": "trade"
    }
  ]
}'

const response = await fetch("https://api.beachdepository.com/v1/transfers", {
  method: "POST",
  headers: {
    Authorization: "Bearer <token>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    fromFboAccountId: "m97fbo456",
    toFboAccountId: "m97fbo789",
    items: [
      {
        inventoryItemId: "k57item123",
        reason: "trade",
      },
    ],
  }),
})

const data = await response.json()

import requests

response = requests.post(
    "https://api.beachdepository.com/v1/transfers",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "fromFboAccountId": "m97fbo456",
        "toFboAccountId": "m97fbo789",
        "items": [
            {
                "inventoryItemId": "k57item123",
                "reason": "trade",
            },
        ],
    },
)

package main

import (
  "fmt"
  "io"
  "net/http"
  "strings"
)

func main() {
  url := "https://api.beachdepository.com/v1/transfers"
  payload := strings.NewReader(`{
  "fromFboAccountId": "m97fbo456",
  "toFboAccountId": "m97fbo789",
  "items": [
    {
      "inventoryItemId": "k57item123",
      "reason": "trade"
    }
  ]
}`)
  req, _ := http.NewRequest("POST", url, payload)
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)
  fmt.Println(string(body))
}

Errors

A schema failure is 400 BAD_REQUEST. The message is body/<field> <reason>.

`message`
`body/toFboAccountId fromFboAccountId and toFboAccountId cannot be the same`
`body/items items must contain at least one item`
`body/items items cannot contain duplicate inventoryItemId values`

These checks are 422 VALIDATION_ERROR. Branch on message. {label} is the item serial number, or the item id when it has no serial. An item that does not exist and one that belongs to another organization both return Inventory item not found.

`message`
`Source FBO account not found in this organization`
`Destination FBO account not found in this organization`
`Inventory item not found`
`Item {label} does not belong to the account you are transferring from`
`Item {label} can't be transferred while it is {status}`
`Item {label} is already on another transfer request`
`Item {label} is already on an open outbound request`
`Invalid request parameters`

{status} is the item’s current status with spaces instead of underscores.

cURL

curl --request POST \
  --url https://api.beachdepository.com/v1/transfers \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "fromFboAccountId": "m97fbo456",
  "toFboAccountId": "m97fbo789",
  "items": [
    {
      "inventoryItemId": "k57item123",
      "reason": "trade"
    }
  ]
}'

const response = await fetch("https://api.beachdepository.com/v1/transfers", {
  method: "POST",
  headers: {
    Authorization: "Bearer <token>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    fromFboAccountId: "m97fbo456",
    toFboAccountId: "m97fbo789",
    items: [
      {
        inventoryItemId: "k57item123",
        reason: "trade",
      },
    ],
  }),
})

const data = await response.json()

import requests

response = requests.post(
    "https://api.beachdepository.com/v1/transfers",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "fromFboAccountId": "m97fbo456",
        "toFboAccountId": "m97fbo789",
        "items": [
            {
                "inventoryItemId": "k57item123",
                "reason": "trade",
            },
        ],
    },
)

package main

import (
  "fmt"
  "io"
  "net/http"
  "strings"
)

func main() {
  url := "https://api.beachdepository.com/v1/transfers"
  payload := strings.NewReader(`{
  "fromFboAccountId": "m97fbo456",
  "toFboAccountId": "m97fbo789",
  "items": [
    {
      "inventoryItemId": "k57item123",
      "reason": "trade"
    }
  ]
}`)
  req, _ := http.NewRequest("POST", url, payload)
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)
  fmt.Println(string(body))
}

Overview

Organizations

FBO Accounts

Products

Inventory

Inbound Shipments

Transfers

Outbound Shipments

Webhooks

Statements

Authorizations

Body

Errors

​Authorizations

​Body

​Errors

Authorizations

Body

Errors