Configuring Edit Services Order Module

The Edit Services order module changes services that the client already has. It does not add new services. The changes come from the edit_packs data of the order. You add this data when you create the order with the API.

The module has no configuration options.

Add the Edit Services action

1. Go to the order queue. Click edit on the order queue to open Manage Order Queue.
2. Find the step for the action. Click add action.
3. In English(USA) Name, type a name for the action, for example Edit Services.
4. In Module, select Edit Services.
5. Set Automatic:

• YES: Ubersmith changes the services when the order gets to the action.
• NO: A staff member clicks Process on the order to change the services.

1. Click Save.

For more information about order queues, refer to the article "Adding Order Queues".

Add the service changes to the order

Create the order with the order.create API method. Put the changes in the info parameter, in the edit_packs array. For more information, refer to the article "Using the Ubersmith API".

• Use one entry in edit_packs for each service.
• In each entry, set packid to the ID of the service. If you do not set packid, Ubersmith uses the key of the entry as the service ID.
• Add only the fields that you want to change, for example desserv, price, period, start, renewdate, or options. Ubersmith does not change the other fields. The fields are the same as for the client.service_update API method.
• Optional: Set device_id to assign a device to the service.

The order must have a client. Set client_id on the order.

Example

Client 1001 has two services:

• Service 412 must renew every 3 months for $300.
• Service 308 must renew every month for $50, with the description Development.

Send these parameters to order.create:

client_id=1001
info[edit_packs][1][packid]=412
info[edit_packs][1][period]=3
info[edit_packs][1][price]=300
info[edit_packs][2][packid]=308
info[edit_packs][2][period]=1
info[edit_packs][2][price]=50
info[edit_packs][2][desserv]=Development

When the action runs

For each entry in edit_packs, Ubersmith changes the service in the same way as when a staff member edits it, and logs the change in the same way. Ubersmith also links the service to the order.

• If the order has no client, the action fails with the message "Invalid Client ID specified".
• If the order has no edit_packs data, the action completes and does not change any service.
• If a change fails, the action stops and shows the error. The services before it in the list are already changed.