Skip to main content
Omnitracs Knowledge Base

Create Delivery


Creates a new delivery for a list of vehicles identified by id and or list of MMS group names.

Upon successful creation the method returns the delivery Id of the newly created delivery in the response.
In case of failure a delivery Id of "-1" and a list of errors are returned to the client.

In case of where one or more vehicles or groups cannot be validated, the delivery will be created using only the valid  vehicles and groups, which will include the vehicles and/or groups that did not validate.

If the sendImmediate is true, the delivery is sent and individual vehicles will report status of the delivery via T.8.01.0 ESS transactions.


CreateDeliveryResponse createDelivery(CreateDeliveryRequest request)


Elements of CreateDeliveryRequest:

  • fileName: The name of the file uploaded into the system. Required for creating a new delivery.
  • vehicleIds: Zero or more vehicles to send the file to. At least one vehicleId or groupName is required.
  • groupNames: Zero or more groups to send the file to. At least one vehicleId or groupName is required.
  • sender: who is sending the file. Required.
  • subject: The subject of the delivery. Required.
  • deliveryOption: One of WIFI, TERR or SCHEDULE
    • WIFI: Delivery will only be delivered when WiFi is available
    • TERR: Delivery will be delivered by any means possible.
    • SCHEDULE: Delivery will be delivered according to a schedule. Try Wifi for some interval, then deliver via any means possible.
  • deliverySchedule: The period of time to wait before trying to deliver via terrestrial. Required when deliveryOption = SCHEDULE
    • interval: The number of units to wait.
    • units: Which units to specify the interval. One of: MINUTES, HOURS, DAYS
  • expireDateTime: If specified, when the file should be removed from the vehicles.
  • availableDateTime: If specified, when the file should be visible to the end user. The file is still sent immediately, it will not be visible until the specified time. If not specified, the file will be available as soon as it is delivered.
  • description: An option description of the delivery.
  • sendImmediately: If set to true, the delivery is initiated immediately. If not, the client must call sendDelivery in order for the delivery to be initiated.


Sample XML Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

  <ns2:createDeliveryRequest xmlns:ns2="">
    <ns2:sender>test sender</ns2:sender>
    <ns2:subject>test banner</ns2:subject>
    <ns2:description>test descr</ns2:description>

Sample XML Response

The response will contain information about the delivery.


Success Response

  <ns2:createDeliveryResponse xmlns:ns2="">


Sample Failed Response

    <ns1:reason>Sender allowed characters limit of 80</ns1:reason>
    <ns1:reason>Both vehicleIds and group names cannot be empty</ns1:reason>


Sample Exception Response

    <faultstring xml:lang="en">  - Invalid Create Delivery Request</faultstring>


Error and Warning Messages 

The following one or more error/warning messages will be sent in "DeliveryStatuses" element in the response body. 
These are in additions to the common error messages described in main page.                 

Error Code




No file was provided in this delivery request

The fileName is required for createDelivery.


No valid file is sent in this delivery request

The provided fileName was not found.


Description exceeds allowed characters limit of 255



Sender is required.



Sender exceeds allowed characters limit of 80



Subject cannot be null



Subject exceeds allowed characters limit of 64



Both vehicle IDs and group names are empty

You must provide at least one vehicle or group.


Expiration Time cannot be in the past.



Expiration Time cannot be before Available Time.



These group names were not found: <comma delimited un-matched group names>

Success with warning: The groups that were found are associated in delivery.


This group contains no vehicles. It will not be added to the delivery.



These vehicles were not found: <comma delimited un-matched vehicle ids.>

Success with warning: The vehicles that were found are associated in delivery.


No valid groups or devices found.

Must have at least on valid group or vehicle. A valid group must exist and have at least one vehicle in it.


No schedule provided for 'SCHEDULE' Delivery Option.

Client to provide Schedule ( interval and Unit) for this delivery option.


Missing or invalid units or interval. Both unit and interval values are required for 'SCHEDULE' type Delivery Option.



Invalid delivery Unit option. Should be MINUTES, HOURS or DAYS.



Delivery Interval cannot be less than 15 minutes.



Invalid Delivery option. Valid options are WIFI, TERR or SCHEDULE



  • Was this article helpful?