CreateDeliveryInput

key

Type

Required

Description

pickupPlace

DeliveryPlace

NOTE: required if pickupAddressID is not provided

A DeliveryPlace object representing the pick-up location

pickupAddressID

string

NOTE: required if pickupPlace is not provided

The ID of the address representing the pick-up location

dropoffPlace

DeliveryPlace

NOTE: required if dropoffAddressID is not provided

A DeliveryPlace object representing the drop-off location

dropoffAddressID

string

NOTE: required if dropoffPlace is not provided

The ID of the address representing the drop-off location

cashOnDeliveryAmount

number

✔️

The amount of cash collected at dropoff. 0 will be used if no cash have to be collected.

weightKg

number

✔️

The total weight of the delivery in kilograms. 0 will be used if this information is not available or used.

externalRefCode

string

An ID that's used internally by the client (ex: orderID). If it is sent it is present in the delivery admin and reports. It can be used for reffering to this delivery along the BeeFast generated ID and delivery number.

scheduledAtTimestamp

number

Timestamp (in seconds) for the moment in time when the delivery should be processed. Untill this moment the delivery is not shown in the delivery company dispatch system. If this value is not sent, the delivery is processed immediately.

Last updated