Inbound Shipments
Cancel Inbound Shipment
Cancel an inbound shipment before the carrier scans it
POST
/
inbound-shipments
/
{id}
/
cancel
cURL
curl --request POST \
--url https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123/cancel \
--header 'Authorization: Bearer <token>'
const response = await fetch(
"https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123/cancel",
{
method: "POST",
headers: {
Authorization: "Bearer <token>",
},
}
)
const data = await response.json()
import requests
response = requests.post(
"https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123/cancel",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123/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": "jn7shipin123",
"fboAccountId": "m97fbo456",
"organizationId": "k57orgxyz",
"status": "cancelled",
"shipmentNotes": "10x 1oz Gold Eagles",
"trackingNumber": "1Z999AA10123456784",
"carrier": "UPS",
"createdAt": "2025-04-05T16:00:00Z"
}
}
See the inbound lifecycle.
Authorizations
string
required
Send
Bearer <token> in this header. The key needs inbound_shipments:update.Path Parameters
string
required
Body
string
cURL
curl --request POST \
--url https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123/cancel \
--header 'Authorization: Bearer <token>'
const response = await fetch(
"https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123/cancel",
{
method: "POST",
headers: {
Authorization: "Bearer <token>",
},
}
)
const data = await response.json()
import requests
response = requests.post(
"https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123/cancel",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123/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": "jn7shipin123",
"fboAccountId": "m97fbo456",
"organizationId": "k57orgxyz",
"status": "cancelled",
"shipmentNotes": "10x 1oz Gold Eagles",
"trackingNumber": "1Z999AA10123456784",
"carrier": "UPS",
"createdAt": "2025-04-05T16:00:00Z"
}
}
⌘I
cURL
curl --request POST \
--url https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123/cancel \
--header 'Authorization: Bearer <token>'
const response = await fetch(
"https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123/cancel",
{
method: "POST",
headers: {
Authorization: "Bearer <token>",
},
}
)
const data = await response.json()
import requests
response = requests.post(
"https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123/cancel",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123/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": "jn7shipin123",
"fboAccountId": "m97fbo456",
"organizationId": "k57orgxyz",
"status": "cancelled",
"shipmentNotes": "10x 1oz Gold Eagles",
"trackingNumber": "1Z999AA10123456784",
"carrier": "UPS",
"createdAt": "2025-04-05T16:00:00Z"
}
}