UPS WorldShip Integration

Owned by Jonathan Pugsley
Last updated: Oct 04, 2024
3 min read

Rx-Universe 7.73 and Rx-Xplore 1.23 add integration with UPS WorldShip software to Rx-Universe. This can be used to purchase shipping labels.

Initial setup is done in two places.

First, go to the System Settings screen (Shipping tab) and enter the desired configuration details for the WorldShip Interface.

image-20240926-184213.png

  • WorldShip interface activated engages the integration. If it is unchecked then no UPS shipping records will be created and the sync program will not send data.

  • WorldShip (Rx-Xplore) uses HTTPS needs to match the equivalent setting on your Rx-Xplore install

    image-20240927-112522.png

  • WorldShip (Rx-Xplore) server needs to match the equivalent setting on your Rx-Xplore install

     

  • WorldShip (Rx-Xplore) port needs to match the equivalent setting on your Rx-Xplore install

     

  • Days to keep WorldShip triggers is the number of days to keep (unsynced) WorldShip data. Outgoing orders that have not been sent in this many days will be discarded.

Next go to Rx-Hub and ensure you have the Rx-Xplore permission WorldShip Configuration

Then go to the WorldShip Settings page in Rx-Xplore

  • Origin Address is the Ship From information you would like to provide to WorldShip for each order

  • Delivery Options is the package delivery options you would like to provide to WorldShip for each order

  • Package Data is the package information you would like to provide to WorldShip for each order

Now create a scheduled task using the following arguments: w -c omics.cfg -y xmlif.dll -y OMICS6 WORLDSHIP_SYNC ACTION=SYNC

  • This will send information to WorldShip (to purchase shipping labels) as well as retrieve information from WorldShip (to set tracking numbers). If you wish to perform these tasks at different times of day create two scheduled tasks instead with ACTION=POST (to send information) and ACTION=GET(to retrieve tracking numbers) instead.

You will also need to install the appropriate ODBC driver for your database manager - Postgres or SQL Server (note - at this time WorldShip only appears to support 32 bit drivers)

You can now configure WorldShip Batch Import and Batch Export procedures.

  • The Batch Import should import from the table world_ship_outgoing_orders

    • Rows are added to this table when you ship an order using a UPS shipping method

    • Rows are removed from this table when tracking information has been received from WorldShip or an order has been cancelled/deleted

    • One of order_number or po_number must be the package identifier

  • The Batch Export should write to the table world_ship_confirmed_orders

    • Rows are added to this table by WorldShip

    • Rows are removed from this table when they have been processed by the scheduled task

    • order_identifier can be the invoice number or po number

    • postal_service_tracking_id will be set as the order’s tracking number

    • mail_manifest_id will be added to the order VCA overrides as _MAILMANID

Â