Transfers
Get Transfer
Retrieve a single transfer
GET
/
transfers
/
{id}
cURL
curl --request GET \
--url https://api.beachdepository.com/v1/transfers/jx7transfer123 \
--header 'Authorization: Bearer <token>'
const response = await fetch("https://api.beachdepository.com/v1/transfers/jx7transfer123", {
method: "GET",
headers: {
Authorization: "Bearer <token>",
},
})
const data = await response.json()
import requests
response = requests.get(
"https://api.beachdepository.com/v1/transfers/jx7transfer123",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/transfers/jx7transfer123"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
{
"data": {
"id": "jx7transfer123",
"fromFboAccountId": "m97fbo456",
"toFboAccountId": "m97fbo789",
"organizationId": "k57orgxyz",
"status": "completed",
"initiatedBy": "customer",
"totalItems": 1,
"items": [
{
"inventoryItemId": "k57item123",
"reason": "rebalance"
}
],
"approvedBySystem": true,
"notes": "Quarterly rebalance",
"completedAt": "2025-05-20T10:55:00.000Z",
"createdAt": "2025-05-20T11:00:00Z"
}
}
Returns one transfer by ID, including
items. Each entry has inventoryItemId and reason. List Transfers omits items. initiatedBy is customer for API creates, or vault when Beach staff creates the transfer. approvedBySystem is true when the API approves it, on create with approve: true or on Confirm Transfer. A missing id returns 404 NOT_FOUND with message Transfer batch not found.
Authorizations
string
required
Send
Bearer <token> in this header. The key needs transfer_batches:read.Path Parameters
string
required
cURL
curl --request GET \
--url https://api.beachdepository.com/v1/transfers/jx7transfer123 \
--header 'Authorization: Bearer <token>'
const response = await fetch("https://api.beachdepository.com/v1/transfers/jx7transfer123", {
method: "GET",
headers: {
Authorization: "Bearer <token>",
},
})
const data = await response.json()
import requests
response = requests.get(
"https://api.beachdepository.com/v1/transfers/jx7transfer123",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/transfers/jx7transfer123"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
{
"data": {
"id": "jx7transfer123",
"fromFboAccountId": "m97fbo456",
"toFboAccountId": "m97fbo789",
"organizationId": "k57orgxyz",
"status": "completed",
"initiatedBy": "customer",
"totalItems": 1,
"items": [
{
"inventoryItemId": "k57item123",
"reason": "rebalance"
}
],
"approvedBySystem": true,
"notes": "Quarterly rebalance",
"completedAt": "2025-05-20T10:55:00.000Z",
"createdAt": "2025-05-20T11:00:00Z"
}
}
⌘I
cURL
curl --request GET \
--url https://api.beachdepository.com/v1/transfers/jx7transfer123 \
--header 'Authorization: Bearer <token>'
const response = await fetch("https://api.beachdepository.com/v1/transfers/jx7transfer123", {
method: "GET",
headers: {
Authorization: "Bearer <token>",
},
})
const data = await response.json()
import requests
response = requests.get(
"https://api.beachdepository.com/v1/transfers/jx7transfer123",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/transfers/jx7transfer123"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
{
"data": {
"id": "jx7transfer123",
"fromFboAccountId": "m97fbo456",
"toFboAccountId": "m97fbo789",
"organizationId": "k57orgxyz",
"status": "completed",
"initiatedBy": "customer",
"totalItems": 1,
"items": [
{
"inventoryItemId": "k57item123",
"reason": "rebalance"
}
],
"approvedBySystem": true,
"notes": "Quarterly rebalance",
"completedAt": "2025-05-20T10:55:00.000Z",
"createdAt": "2025-05-20T11:00:00Z"
}
}