Outbound Shipments
List Outbound Shipments
List outbound shipments
GET
/
outbound-shipments
cURL
curl --request GET \
--url https://api.beachdepository.com/v1/outbound-shipments?page=1&limit=25 \
--header 'Authorization: Bearer <token>'
const response = await fetch(
"https://api.beachdepository.com/v1/outbound-shipments?page=1&limit=25",
{
method: "GET",
headers: {
Authorization: "Bearer <token>",
},
}
)
const data = await response.json()
import requests
response = requests.get(
"https://api.beachdepository.com/v1/outbound-shipments?page=1&limit=25",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/outbound-shipments?page=1&limit=25"
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": "jd7abc123xyz",
"fboAccountId": "m97fbo456",
"organizationId": "k57orgxyz",
"status": "shipped",
"totalItems": 1,
"packages": [
{
"carrier": "FedEx",
"trackingNumber": "794658123456",
"trackingUrl": "https://www.fedex.com/fedextrack/?trknbr=794658123456",
"shippedAt": "2025-05-12T10:00:00.000Z"
}
],
"shippedAt": "2025-05-12T10:00:00.000Z",
"createdAt": "2025-05-11T16:00:00Z"
}
],
"pagination": {
"page": 1,
"hasMore": false
}
}
Returns a paginated list of outbound shipments for the organization.
Authorizations
string
required
Send
Bearer <token> in this header. The key needs outbound_shipments:read.Query Parameters
number
default:"1"
number
default:"25"
string
Without
status, cancelled shipments are omitted. Pass status=cancelled to list them. Get by id
still returns a cancelled shipment.string
boolean
default:"false"
When
true, each shipment includes items. Each item has productId, inventoryItemId, and
outboundShipmentId.cURL
curl --request GET \
--url https://api.beachdepository.com/v1/outbound-shipments?page=1&limit=25 \
--header 'Authorization: Bearer <token>'
const response = await fetch(
"https://api.beachdepository.com/v1/outbound-shipments?page=1&limit=25",
{
method: "GET",
headers: {
Authorization: "Bearer <token>",
},
}
)
const data = await response.json()
import requests
response = requests.get(
"https://api.beachdepository.com/v1/outbound-shipments?page=1&limit=25",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/outbound-shipments?page=1&limit=25"
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": "jd7abc123xyz",
"fboAccountId": "m97fbo456",
"organizationId": "k57orgxyz",
"status": "shipped",
"totalItems": 1,
"packages": [
{
"carrier": "FedEx",
"trackingNumber": "794658123456",
"trackingUrl": "https://www.fedex.com/fedextrack/?trknbr=794658123456",
"shippedAt": "2025-05-12T10:00:00.000Z"
}
],
"shippedAt": "2025-05-12T10:00:00.000Z",
"createdAt": "2025-05-11T16:00:00Z"
}
],
"pagination": {
"page": 1,
"hasMore": false
}
}
⌘I
cURL
curl --request GET \
--url https://api.beachdepository.com/v1/outbound-shipments?page=1&limit=25 \
--header 'Authorization: Bearer <token>'
const response = await fetch(
"https://api.beachdepository.com/v1/outbound-shipments?page=1&limit=25",
{
method: "GET",
headers: {
Authorization: "Bearer <token>",
},
}
)
const data = await response.json()
import requests
response = requests.get(
"https://api.beachdepository.com/v1/outbound-shipments?page=1&limit=25",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/outbound-shipments?page=1&limit=25"
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": "jd7abc123xyz",
"fboAccountId": "m97fbo456",
"organizationId": "k57orgxyz",
"status": "shipped",
"totalItems": 1,
"packages": [
{
"carrier": "FedEx",
"trackingNumber": "794658123456",
"trackingUrl": "https://www.fedex.com/fedextrack/?trknbr=794658123456",
"shippedAt": "2025-05-12T10:00:00.000Z"
}
],
"shippedAt": "2025-05-12T10:00:00.000Z",
"createdAt": "2025-05-11T16:00:00Z"
}
],
"pagination": {
"page": 1,
"hasMore": false
}
}