Skip to main content
GET
Retrieve deliveries

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Scopes

deliveries.readonly

Read deliveries

deliveries

Read and write deliveries

Headers

spacebring-network-id
string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

createDate[gte]
string

Filter deliveries added on or after this date (ISO 8601). Use with createDate[lte] for a range.

createDate[lte]
string

Filter deliveries added on or before this date (ISO 8601). Use with createDate[gte] for a range.

customerRef
string<uuid>

UUID of the customer, a person's or a company's, whose deliveries to list. Cannot be combined with userRef.

limit
integer

Maximum number of deliveries per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

Required range: 1 <= x <= 100
locationRef
string<uuid>

UUID of the location whose deliveries to list. Omit to list deliveries across every location of the network.

nextPageToken
string

Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.

status
string

Filter by status. Defaults to every status. Comma-separated, one or more of: pending, pickedUp.

userRef
string<uuid>

UUID of the user whose deliveries to list: those for the user and for the companies the user manages. Users can list their own; administrators see those in the locations they manage.

Response

OK

deliveries
object[]
required

List of deliveries, the most recently added first.

nextPageToken
string

Pagination token to fetch the next page of results.

searchQueryNext
string

Search query parameters for the next page of results. Includes all filters used to fetch the current page.