Outbound Shipments
Get Outbound Shipment
Retrieve a single outbound shipment
GET
/
outbound-shipments
/
{id}
cURL
curl --request GET \
--url https://api.beachdepository.com/v1/outbound-shipments/jd7abc123xyz \
--header 'Authorization: Bearer <token>'
const response = await fetch("https://api.beachdepository.com/v1/outbound-shipments/jd7abc123xyz", {
method: "GET",
headers: {
Authorization: "Bearer <token>",
},
})
const data = await response.json()
import requests
response = requests.get(
"https://api.beachdepository.com/v1/outbound-shipments/jd7abc123xyz",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/outbound-shipments/jd7abc123xyz"
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,
"destinationAddress": {
"firstName": "Jane",
"lastName": "Doe",
"name": "Jane Doe",
"street1": "123 Main St",
"city": "Dallas",
"state": "TX",
"zip": "75001",
"country": "US"
},
"shipping": {
"service": "cheapest",
"quote": {
"carrier": "FedEx",
"service": "FedEx Ground",
"serviceCode": "FEDEX_GROUND",
"quotedCents": "4168",
"currency": "USD",
"quotedAt": "2024-06-15T09:00:00.000Z",
"insuredValueCents": "250000",
"weightGrams": 907
}
},
"packages": [
{
"carrier": "FedEx",
"trackingNumber": "794658123456",
"trackingUrl": "https://www.fedex.com/fedextrack/?trknbr=794658123456",
"shippedAt": "2025-05-12T10:00:00.000Z"
}
],
"items": [
{
"id": "j970item123",
"outboundShipmentId": "jd7abc123xyz",
"productId": "jh7prod123",
"inventoryItemId": "jk7inv456",
"createdAt": "2025-06-15T09:00:00Z"
}
],
"shippedAt": "2025-05-12T10:00:00.000Z",
"createdAt": "2025-05-11T16:00:00Z"
}
}
Returns one outbound shipment by ID, including the destination address, the shipping preference, and
packages. Tracking lives on each package. items is present only when includeLineItems=true.
Authorizations
string
required
Send
Bearer <token> in this header. The key needs outbound_shipments:read.Path Parameters
string
required
Query Parameters
boolean
default:"false"
When
true, the shipment includes items (inventoryItemId, productId, outboundShipmentId).cURL
curl --request GET \
--url https://api.beachdepository.com/v1/outbound-shipments/jd7abc123xyz \
--header 'Authorization: Bearer <token>'
const response = await fetch("https://api.beachdepository.com/v1/outbound-shipments/jd7abc123xyz", {
method: "GET",
headers: {
Authorization: "Bearer <token>",
},
})
const data = await response.json()
import requests
response = requests.get(
"https://api.beachdepository.com/v1/outbound-shipments/jd7abc123xyz",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/outbound-shipments/jd7abc123xyz"
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,
"destinationAddress": {
"firstName": "Jane",
"lastName": "Doe",
"name": "Jane Doe",
"street1": "123 Main St",
"city": "Dallas",
"state": "TX",
"zip": "75001",
"country": "US"
},
"shipping": {
"service": "cheapest",
"quote": {
"carrier": "FedEx",
"service": "FedEx Ground",
"serviceCode": "FEDEX_GROUND",
"quotedCents": "4168",
"currency": "USD",
"quotedAt": "2024-06-15T09:00:00.000Z",
"insuredValueCents": "250000",
"weightGrams": 907
}
},
"packages": [
{
"carrier": "FedEx",
"trackingNumber": "794658123456",
"trackingUrl": "https://www.fedex.com/fedextrack/?trknbr=794658123456",
"shippedAt": "2025-05-12T10:00:00.000Z"
}
],
"items": [
{
"id": "j970item123",
"outboundShipmentId": "jd7abc123xyz",
"productId": "jh7prod123",
"inventoryItemId": "jk7inv456",
"createdAt": "2025-06-15T09:00:00Z"
}
],
"shippedAt": "2025-05-12T10:00:00.000Z",
"createdAt": "2025-05-11T16:00:00Z"
}
}
⌘I
cURL
curl --request GET \
--url https://api.beachdepository.com/v1/outbound-shipments/jd7abc123xyz \
--header 'Authorization: Bearer <token>'
const response = await fetch("https://api.beachdepository.com/v1/outbound-shipments/jd7abc123xyz", {
method: "GET",
headers: {
Authorization: "Bearer <token>",
},
})
const data = await response.json()
import requests
response = requests.get(
"https://api.beachdepository.com/v1/outbound-shipments/jd7abc123xyz",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/outbound-shipments/jd7abc123xyz"
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,
"destinationAddress": {
"firstName": "Jane",
"lastName": "Doe",
"name": "Jane Doe",
"street1": "123 Main St",
"city": "Dallas",
"state": "TX",
"zip": "75001",
"country": "US"
},
"shipping": {
"service": "cheapest",
"quote": {
"carrier": "FedEx",
"service": "FedEx Ground",
"serviceCode": "FEDEX_GROUND",
"quotedCents": "4168",
"currency": "USD",
"quotedAt": "2024-06-15T09:00:00.000Z",
"insuredValueCents": "250000",
"weightGrams": 907
}
},
"packages": [
{
"carrier": "FedEx",
"trackingNumber": "794658123456",
"trackingUrl": "https://www.fedex.com/fedextrack/?trknbr=794658123456",
"shippedAt": "2025-05-12T10:00:00.000Z"
}
],
"items": [
{
"id": "j970item123",
"outboundShipmentId": "jd7abc123xyz",
"productId": "jh7prod123",
"inventoryItemId": "jk7inv456",
"createdAt": "2025-06-15T09:00:00Z"
}
],
"shippedAt": "2025-05-12T10:00:00.000Z",
"createdAt": "2025-05-11T16:00:00Z"
}
}