List inbound shipments

GET /api/v1/inbound-shipments read:inventory

Lists your inbound shipments, newest first by created_at. That includes any package that arrived unannounced and was logged against your account at the door (source "warehouse"). Poll ?status=EXPECTED to see what we are still waiting for, or consume inbound_shipment.received from your activity log instead of polling. Paged like every other list: read pagination.has_more and pass pagination.next_offset back as ?offset.

Try it GET /api/v1/inbound-shipments?limit=10

These inputs are shared across all docs pages, so an id entered here carries over.

response

Not run yet. Press Run to make a live call against https://service.rip.fun (through this demo's server-side proxy; the API key never reaches the browser).

curl (tracks the inputs above)
curl -X GET 'https://service.rip.fun/api/v1/inbound-shipments?limit=10' \
  -H 'X-API-Key: rip_…'

Request fields

FieldTypeRequiredDescription
statusquery string—EXPECTED | RECEIVED | CANCELLED — matched exactly; an unrecognized value returns 400
tracking_numberquery string—Find a package by its tracking number, matched the same forgiving way as on create
sitequery string—Only packages addressed to this site code — any site, including one that has since stopped receiving, so older packages stay findable. An unknown code returns 400
sub_accountquery string—Same values as GET /cards: all (default — every package), main (packages for your own inventory), or a sub-account slug (packages you said were for it, retired ones included). An unknown slug returns 400 naming the valid values, never an empty page
limit / offsetquery int—limit 1..100 default 50; offset 0..10_000 default 0. Non-integer values are a 400 (invalid_pagination). The response carries a pagination object { limit, offset, has_more, next_offset } beside the array

Response fields (data)

FieldDescription
inbound_shipments[]Same row shape as POST /inbound-shipments, attachments included — a page of 100 boxes with documents is a large response; use GET /inbound-shipments/:id/attachments when you only need fresh download links

Errors

StatusCodeWhen
400invalid statusstatus is not one of the accepted values
400invalid sub_accountsub_account is not main, all, or one of your slugs

See Errors for the response envelope and the full code list.