DeliveryBookingModel

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

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!"

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.

Packages included in the delivery

Job Capacity Name Size pair included in the delivery

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.

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

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

Address and other details for the delivery destination

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 )

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

External customer ID. This can be used to record which customer a job was delivered to, using a customer ID in your internal systems.

The tax amount

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

The tax amount

Percentage of the CustomerFee that the driver should be paid

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

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

If a Driver Match Code has a single match, the job will auto accept

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

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.

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

Use a template