Skip to main content
PUT
Upsert multiple 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

update
string[]
required

Columns to overwrite when the row already exists. Repeat the parameter for each column: a single comma-separated value is read as one column name and fails at the database. Without the parameter the request is rejected with 400.

Body

application/json
name
string
required
id
string<uuid>

Optional client-supplied ID.

identifier
string
direction
enum<string>

Generic creation accepts inbound deliveries only.

Available options:
inbound
status
enum<string>

Generic creation accepts the initial expected status only.

Available options:
expected
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[]