Create Outbound Request
curl --request POST \
--url https://api.beachdepository.com/v1/outbound-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fboAccountId": "<string>",
"notes": "<string>",
"items": [
{}
]
}
'import requests
url = "https://api.beachdepository.com/v1/outbound-requests"
payload = {
"fboAccountId": "<string>",
"notes": "<string>",
"items": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({fboAccountId: '<string>', notes: '<string>', items: [{}]})
};
fetch('https://api.beachdepository.com/v1/outbound-requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.beachdepository.com/v1/outbound-requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fboAccountId' => '<string>',
'notes' => '<string>',
'items' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.beachdepository.com/v1/outbound-requests"
payload := strings.NewReader("{\n \"fboAccountId\": \"<string>\",\n \"notes\": \"<string>\",\n \"items\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.beachdepository.com/v1/outbound-requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fboAccountId\": \"<string>\",\n \"notes\": \"<string>\",\n \"items\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beachdepository.com/v1/outbound-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fboAccountId\": \"<string>\",\n \"notes\": \"<string>\",\n \"items\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_bodyOutbound Requests
Create Outbound Request
Create an outbound request with inventory items
POST
/
outbound-requests
Create Outbound Request
curl --request POST \
--url https://api.beachdepository.com/v1/outbound-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fboAccountId": "<string>",
"notes": "<string>",
"items": [
{}
]
}
'import requests
url = "https://api.beachdepository.com/v1/outbound-requests"
payload = {
"fboAccountId": "<string>",
"notes": "<string>",
"items": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({fboAccountId: '<string>', notes: '<string>', items: [{}]})
};
fetch('https://api.beachdepository.com/v1/outbound-requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.beachdepository.com/v1/outbound-requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fboAccountId' => '<string>',
'notes' => '<string>',
'items' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.beachdepository.com/v1/outbound-requests"
payload := strings.NewReader("{\n \"fboAccountId\": \"<string>\",\n \"notes\": \"<string>\",\n \"items\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.beachdepository.com/v1/outbound-requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fboAccountId\": \"<string>\",\n \"notes\": \"<string>\",\n \"items\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beachdepository.com/v1/outbound-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fboAccountId\": \"<string>\",\n \"notes\": \"<string>\",\n \"items\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_bodyCreates an outbound request to ship one or more inventory items out of vault for an FBO account.
Every item must currently belong to the FBO account and be in an
in_vault status. The request is
created with a pending status and awaits vault staff approval.
Permission: outbound_requests:create
Request body
string
required
ID of the FBO account requesting the outbound shipment.
string
Optional free-text note describing the request.
array
required
The inventory items to include — at least one. Each entry contains:
inventoryItemId(string, required) — ID of the inventory item to ship out.
inventoryItemId values must be unique within the request.Response
Returns the created outbound request with its line items.{
"data": {
"id": "jd7abc123xyz",
"fboAccountId": "m97fbo456",
"organizationId": "k57orgxyz",
"status": "pending",
"totalItems": 2,
"approvedBySystem": false,
"notes": "Ship to primary address",
"items": [
{
"id": "j970item123",
"outboundRequestId": "jd7abc123xyz",
"productId": "jh7prod123",
"inventoryItemId": "jk7inv456",
"createdAt": "2025-06-15T09:00:00Z"
}
],
"createdAt": "2025-06-15T09:00:00Z"
}
}
⌘I