Skip to main content
Omnitracs Knowledge Base

Modify Delivery


Modifies an existing delivery. The validation rules and workflow is similar to creation of a new delivery request.
The client is required to send the delivery Id and all other elements required for creating a new Delivery except for the filename.

If a user chooses to modify the delivery, they can add or remove vehicles, add or remove groups, change the delivery meta-data and delivery options.
The delivery's file cannot changed, and it is an error to provide a filename to this method.
When the call is made, the delivery is modified and the changes are pushed out to the vehicles.

sendImmediate is ignored for modifyDelivery. If an unsent delivery is modified, the client must call sendDelivery to initiate the delivery.


ModifyDeliveryResponse modifyDelivery(ModifyDeliveryRequest request)

Elements of ModifyDeliveryRequest:

  • deliveryId: The delivery Id to modify. Returned from createDelivery.
  • 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 optional description of the delivery.


Sample XML Request

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

  <ns2:modifyDeliveryRequest xmlns:ns2="">
    <ns2:sender>test sender2</ns2:sender>
    <ns2:subject>test banner2</ns2:subject>
    <ns2:description>test descr</ns2:description>
    <ns2:groupNames>WEBTEST GROUP</ns2:groupNames>
    <ns2:groupNames>WEBTEST GROUP2</ns2:groupNames>


Sample XML Response

The response will contain information about the delivery.

Success Response

  <ns2:modifyDeliveryResponse xmlns:ns2="">


Sample Failed Response

  <ns2:modifyDeliveryResponse xmlns:ns2="">
      <ns2:reason>Description exceeds allowed characters limit of 255</ns2:reason>
      <ns2:reason>Sender allowed characters limit of 80</ns2:reason>
      <ns2:reason>Subject exceeds allowed characters limit of 10</ns2:reason>


Sample Exception Response

    <faultstring xml:lang="en">error.result.request - Unable to locate delivery</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



Delivery is in process.

Delivery is still being processed. Please try again later.


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



When both vehicleIds and group names are empty

You must provide at least one vehicle or group.


Filename is not allowed when modifying delivery



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.


These vehicles were not found: <comma delimited missing vehicle ids.>

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


No matching 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 or Missing Delivery option. Valid options are WIFI, TERR or SCHEDULE




  • Was this article helpful?