NameDescriptionTypeAdditional information
Reference

Your internal reference id for this delivery. If the reference is not provided, a new reference number will be assigned.

string

Max length: 50

DeliveryInstructions

Instructions for the driver, for example: "Ring when you get to the street", "The nearest cross street is High St", or "Watch out for the dog!"

string

Max length: 2000

ItemsRequirePurchase

Some merchants may need to use our payment in store service. Set this to true if you require the driver to pay for items. Please arrange with us in advance if you require this service. We recommend setting this to false unless you really need it.

boolean

None.

Items

Packages included in the delivery

Collection of DeliveryBookingItemModel

None.

PickupTime

For pre-order bookings, this specifies a specific time when delivery items should be picked up. Date should comply with ISO_8601 format, see http://en.wikipedia.org/wiki/ISO_8601#UTC for more details. If this date is not supplied, we will assume that the delivery should take place immediately, nearby drivers will be notified straight away.

date

None.

PickupDetail

Address and other details for the delivery origin. This is not required for service based merchants.

DeliveryBookingLocationModel

None.

DropoffWindow

The window of time required for the delivery to be completed. If not supplied, we will deliver as soon as possible.

TimeFrameModel

None.

DropoffDetail

Address and other details for the delivery destination

DeliveryBookingLocationModel

Required

CustomerFee

Delivery or job fee charge to the end customer. If this value is provided it will override the calculated price (based on values set in the merchant API settings )

decimal number

None.

CustomerReference

External customer reference. Use this (for example) to match the origin of a job for your internal accounting

string

Max length: 50

Tax

The tax amount

decimal number

None.

TaxInclusivePrice

Specifies whether or not the price includes taxes. Set to true or false.

boolean

None.

Tip

The tax amount

decimal number

None.

DriverFeePercentage

Percentage of the CustomerFee that the driver should be paid

decimal number

None.

DriverMatchCode

A code used to notify a specific driver (see Driver/Job Match Key screen)

string

None.

DeliverySequence

Used to sequence deliveries in the order they should be completed by a particular driver. This order is reflected in the driver's app

integer

None.

Constraints

Job requirement constraints so only particular drivers matching the required constraints will be notified.

Collection of JobConstraintModel

None.

DeliveryRouteIdentifier

Used to distinguish deliveries from separate routes but the same delivery sequence number. This order is reflected in the driver's app and on the dispatcher map.

string

None.

Webhooks

Allows URLs to be called when various events occur in GetSwift. (see the webhooks documentation for specific event name)

Collection of DeliveryEventWebhookModel

None.

Template

Use a template

string

None.

OrderPrice

decimal number

None.

Payments

Collection of OrderPaymentModel

None.