Skip to main content
PATCH
Update matching deliveries

Authorizations

X-API-Key
string
header
required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Query Parameters

Full-text search across the resource's search columns. Append :col1,col2 to limit which columns are searched.

filter
string

AND/OR filter expression, for example type eq 'phase' and isArchived eq false. Simple equality can also be passed as plain field parameters.

Body

application/json
name
string
identifier
string
fromKind
string | null
fromLocationId
string<uuid> | null
fromVendorId
string<uuid> | null
fromAddress
string | null
toKind
string | null
toLocationId
string<uuid> | null
toAddress
string | null
actualStartAt
string<date-time> | null
actualEndAt
string<date-time> | null
poNumber
string | null
expectedDate
string<date-time> | null
truckId
string<uuid> | null
truck
string | null
trailerType
string | null
isOverDimension
boolean
carrierKind
enum<string> | null
Available options:
own,
third_party
receiverContactId
string<uuid> | null
driverContactId
string<uuid> | null
confirmationTemplateId
string<uuid> | null
data
object

Response

Successful response.

values
object[]