Inbound Shipments
Get Inbound Shipment
Retrieve a single inbound shipment
GET
/
inbound-shipments
/
{id}
cURL
curl --request GET \
--url https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123 \
--header 'Authorization: Bearer <token>'
const response = await fetch("https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123", {
method: "GET",
headers: {
Authorization: "Bearer <token>",
},
})
const data = await response.json()
import requests
response = requests.get(
"https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123"
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": "jn7shipin123",
"fboAccountId": "m97fbo456",
"organizationId": "k57orgxyz",
"status": "accepted",
"shipmentNotes": "1 oz Gold Eagle",
"trackingNumber": "794658123456",
"carrier": "FedEx",
"receivedAt": "2025-04-10T09:30:00.000Z",
"createdAt": "2025-04-05T16:00:00Z",
"label": {
"purchaseId": "lblpur_abc123",
"carrier": "FedEx",
"service": "FedEx Ground",
"trackingNumber": "794658123456",
"labelUrl": "https://files.beachdepository.com/labels/lblpur_abc123.pdf",
"purchasedAt": "2025-04-05T16:00:05.000Z"
},
"packingSlipUrl": "https://files.beachdepository.com/slips/ship_in_abc123.pdf",
"lineItems": [
{
"id": "jn7line123",
"productId": "jh7prod123",
"quantityDeclared": 1,
"quantityAccepted": 1,
"quantityRejected": 0,
"inventoryItemIds": ["k57item123"],
"createdAt": "2025-04-05T16:00:00Z"
}
]
}
}
Returns a single inbound shipment by ID. Line quantities are omitted unless you pass
includeLineItems=true.
Authorizations
string
required
Send
Bearer <token> in this header. The key needs inbound_shipments:read.Path Parameters
string
required
Query Parameters
boolean
default:"false"
When
true, the shipment includes lineItems. Create sends these as lines. The response key is
lineItems.cURL
curl --request GET \
--url https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123 \
--header 'Authorization: Bearer <token>'
const response = await fetch("https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123", {
method: "GET",
headers: {
Authorization: "Bearer <token>",
},
})
const data = await response.json()
import requests
response = requests.get(
"https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123"
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": "jn7shipin123",
"fboAccountId": "m97fbo456",
"organizationId": "k57orgxyz",
"status": "accepted",
"shipmentNotes": "1 oz Gold Eagle",
"trackingNumber": "794658123456",
"carrier": "FedEx",
"receivedAt": "2025-04-10T09:30:00.000Z",
"createdAt": "2025-04-05T16:00:00Z",
"label": {
"purchaseId": "lblpur_abc123",
"carrier": "FedEx",
"service": "FedEx Ground",
"trackingNumber": "794658123456",
"labelUrl": "https://files.beachdepository.com/labels/lblpur_abc123.pdf",
"purchasedAt": "2025-04-05T16:00:05.000Z"
},
"packingSlipUrl": "https://files.beachdepository.com/slips/ship_in_abc123.pdf",
"lineItems": [
{
"id": "jn7line123",
"productId": "jh7prod123",
"quantityDeclared": 1,
"quantityAccepted": 1,
"quantityRejected": 0,
"inventoryItemIds": ["k57item123"],
"createdAt": "2025-04-05T16:00:00Z"
}
]
}
}
lineItems is present only when includeLineItems=true. quantityAccepted, quantityRejected, and inventoryItemIds reconcile what was vaulted. Shipment status is accepted or rejected for the whole shipment.
label.labelUrl downloads the purchased shipping label. packingSlipUrl downloads the packing slip.⌘I
cURL
curl --request GET \
--url https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123 \
--header 'Authorization: Bearer <token>'
const response = await fetch("https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123", {
method: "GET",
headers: {
Authorization: "Bearer <token>",
},
})
const data = await response.json()
import requests
response = requests.get(
"https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123",
headers={
"Authorization": "Bearer <token>",
},
)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.beachdepository.com/v1/inbound-shipments/jn7shipin123"
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": "jn7shipin123",
"fboAccountId": "m97fbo456",
"organizationId": "k57orgxyz",
"status": "accepted",
"shipmentNotes": "1 oz Gold Eagle",
"trackingNumber": "794658123456",
"carrier": "FedEx",
"receivedAt": "2025-04-10T09:30:00.000Z",
"createdAt": "2025-04-05T16:00:00Z",
"label": {
"purchaseId": "lblpur_abc123",
"carrier": "FedEx",
"service": "FedEx Ground",
"trackingNumber": "794658123456",
"labelUrl": "https://files.beachdepository.com/labels/lblpur_abc123.pdf",
"purchasedAt": "2025-04-05T16:00:05.000Z"
},
"packingSlipUrl": "https://files.beachdepository.com/slips/ship_in_abc123.pdf",
"lineItems": [
{
"id": "jn7line123",
"productId": "jh7prod123",
"quantityDeclared": 1,
"quantityAccepted": 1,
"quantityRejected": 0,
"inventoryItemIds": ["k57item123"],
"createdAt": "2025-04-05T16:00:00Z"
}
]
}
}