Transfers
Cancel Transfer
Cancel a pending transfer
POST
/
transfers
/
{id}
/
cancel
cURL
curl --request POST \
--url https://api.beachdepository.com/v1/transfers/jx7transfer123/cancel \
--header 'Authorization: Bearer <token>'
const response = await fetch("https://api.beachdepository.com/v1/transfers/jx7transfer123/cancel", {
method: "POST",
headers: {
Authorization: "Bearer <token>",
},
})
const data = await response.json()
import requests
response = requests.post(
"https://api.beachdepository.com/v1/transfers/jx7transfer123/cancel",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/transfers/jx7transfer123/cancel"
req, _ := http.NewRequest("POST", 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": "cancelled",
"initiatedBy": "customer",
"totalItems": 1,
"items": [
{
"inventoryItemId": "k57item123",
"reason": "rebalance"
}
],
"approvedBySystem": false,
"notes": "Quarterly rebalance",
"createdAt": "2025-05-20T11:00:00Z"
}
}
Once an item has started moving, the response
code is VALIDATION_ERROR and the message is This transfer has already started moving items and can no longer be cancelled. The response includes items.
Authorizations
string
required
Send
Bearer <token> in this header. The key needs transfer_batches:update.Path Parameters
string
required
Body
string
cURL
curl --request POST \
--url https://api.beachdepository.com/v1/transfers/jx7transfer123/cancel \
--header 'Authorization: Bearer <token>'
const response = await fetch("https://api.beachdepository.com/v1/transfers/jx7transfer123/cancel", {
method: "POST",
headers: {
Authorization: "Bearer <token>",
},
})
const data = await response.json()
import requests
response = requests.post(
"https://api.beachdepository.com/v1/transfers/jx7transfer123/cancel",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/transfers/jx7transfer123/cancel"
req, _ := http.NewRequest("POST", 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": "cancelled",
"initiatedBy": "customer",
"totalItems": 1,
"items": [
{
"inventoryItemId": "k57item123",
"reason": "rebalance"
}
],
"approvedBySystem": false,
"notes": "Quarterly rebalance",
"createdAt": "2025-05-20T11:00:00Z"
}
}
⌘I
cURL
curl --request POST \
--url https://api.beachdepository.com/v1/transfers/jx7transfer123/cancel \
--header 'Authorization: Bearer <token>'
const response = await fetch("https://api.beachdepository.com/v1/transfers/jx7transfer123/cancel", {
method: "POST",
headers: {
Authorization: "Bearer <token>",
},
})
const data = await response.json()
import requests
response = requests.post(
"https://api.beachdepository.com/v1/transfers/jx7transfer123/cancel",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/transfers/jx7transfer123/cancel"
req, _ := http.NewRequest("POST", 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": "cancelled",
"initiatedBy": "customer",
"totalItems": 1,
"items": [
{
"inventoryItemId": "k57item123",
"reason": "rebalance"
}
],
"approvedBySystem": false,
"notes": "Quarterly rebalance",
"createdAt": "2025-05-20T11:00:00Z"
}
}