Ready Shipper

1. Overview

The ReadyShipper Integration in XoroERP connects your order management and fulfillment workflows with ReadyShipper, a shipping and label-generation tool.

Using this integration, XoroERP can:

  • Export eligible orders from selected stores to ReadyShipper.

  • Apply weight and dimension units compatible with ReadyShipper.

  • Control which orders, ship methods, SKUs, and customers participate in the export flow.

  • Use mapped carrier and ship services to avoid failures during shipping.

  • Align transaction dates using the ship date from ReadyShipper.

  • Automate import/export runs and receive detailed error notifications.

Overall, the integration is designed to streamline shipping operations, reduce manual data handling, and provide clear operational visibility through the Operations Page in XoroERP.

2. Installation

2.1 Access ReadyShipper Integration

  1. Log in to your XoroERP account.

  2. Navigate to the Apps module from the main dashboard.

  3. Go to the 3PL Connections or Integrations section.

  4. Click Add 3PL Connection.

  5. Select ReadyShipper from the list of available integrations.

2.2 Install the Integration

  1. Click Install to add the ReadyShipper integration to your XoroERP instance.

  2. Once installed, the ReadyShipper integration will appear in your list of active 3PL or shipping integrations.

3. Configuration Settings

Data Export Settings

The following accounts and configuration will be used in XoroERP for the ReadyShipper integration. These settings can be modified later as needed.


Export Orders to ReadyShipper

Export orders to ReadyShipper (Checkbox) When this option is enabled, eligible orders from XoroERP will be exported to ReadyShipper.

  • Only orders created in the selected store(s) will be considered.

  • Export behavior is also influenced by ship method, blocked SKUs, allowed customers, filters, and other settings defined below.


Drop Order(s) from the Following Store(s)

Drop order(s) from the following store(s) Select one or more XoroERP stores from which orders should be exported to ReadyShipper.

  • Only orders belonging to the selected stores will be dropped to ReadyShipper.

  • Orders from non-selected stores will not be included in the ReadyShipper export flow.

This gives you store-level control over which orders participate in the integration.


Block Waves Created via QuickShip

Block waves created via QuickShip in Xoro from flowing into ReadyShipper (Checkbox)

When enabled:

  • Waves created through QuickShip in XoroERP will not be exported to ReadyShipper.

  • This is useful if QuickShip is used for internal testing, local shipments, or scenarios that should not go through ReadyShipper’s processing.

When disabled:

  • QuickShip-created waves will be treated like any other eligible waves and can be exported to ReadyShipper based on other configuration rules.


Third Party Weight UOM Code

Third Party Weight UOM Code Defines the weight unit of measure (UOM) that will be used when exporting orders to ReadyShipper.

Available options include:

  • pounds

  • grams

  • ounces

The selected UOM ensures that all weight values passed to ReadyShipper are in a consistent, expected format, preventing discrepancies in shipping label creation or rate calculations.


Third Party Dimension UOM Code

Third Party Dimension UOM Code Defines the dimension unit of measure (UOM) that will be used when exporting orders to ReadyShipper.

  • The chosen dimension UOM (such as inches, centimeters, or any configured unit) will be applied to package length, width, and height values sent to ReadyShipper.

  • This ensures that dimensional data is interpreted correctly by ReadyShipper for packing, rating, and label generation.


Ship Method Name(s)

Ship Method Name(s) Specifies the set of shipping methods that should not be exported to ReadyShipper.

  • The ship method(s) listed here will not be dropped to ReadyShipper.

  • Orders using these ship methods are excluded from the ReadyShipper integration, even if they meet other criteria such as store or customer filters.

This allows you to filter out methods like local pickup, in-store delivery, or any carrier/service combinations that should be handled outside ReadyShipper.


Blocked SKU(s)

Blocked SKU(s) Defines item numbers that should be excluded from the ReadyShipper workflow.

  • The item number(s) listed here will not be dropped to ReadyShipper.

  • Orders containing these SKUs can be restricted from export or these SKUs can be omitted from fulfillment logic, depending on your integration behavior.

This is typically used to block non-physical items, charges, or SKUs that are not intended to be shipped through ReadyShipper.


Allowed Customer(s)

Allowed Customer(s) Restricts the ReadyShipper integration to specific customers only.

  • Only orders from this customer (or the customers specified) will be dropped to ReadyShipper.

  • If left blank, all customers are eligible, subject to other filters and conditions.

This is useful for limiting ReadyShipper usage to selected key accounts or channels.


Disable Multishipment

Disable multishipment (Checkbox)

Controls how shipment confirmations from ReadyShipper affect XoroERP wave lines:

  • When enabled:

    • The first ship confirmation received from ReadyShipper is treated as the final confirmation.

    • All wave lines are closed upon confirmation.

    • Any remaining unshipped order quantities (if any) are unallocated.

  • When disabled:

    • Multiple shipping confirmations can be processed.

    • Wave lines remain open until the full order quantity has been shipped.

This setting determines whether partial shipments are allowed or whether ReadyShipper’s confirmation should finalize the order immediately.


Filter Name / Operator / Value

Filter Name – Operator – Value

This set of fields allows you to define filters that limit which orders are exported to ReadyShipper.

  • Filter Name – The field or attribute you want to filter on (e.g., source, tag, country, etc., depending on implementation).

  • Operator – The logical operator used (such as “Contains”, “Equals”, “Starts With”, “Greater Than”, etc.).

  • Value – The value or keyword used for comparison.

By setting one or more filters, you can precisely control which subset of orders flows into ReadyShipper based on your business rules.


Default SKU

Default SKU (Text field)

Defines a fallback SKU used in fulfillment when no SKU is provided or recognized for a particular order line.

  • If ReadyShipper or intermediary data does not include an item identifier, this default SKU will be used.

  • This helps avoid errors in order processing due to missing SKU values.


Shipping Markup

Shipping Markup (Text field)

Specifies a percentage-based markup applied to the shipping cost.

  • The value entered represents the percentage by which the shipping cost will be increased.

  • For example, entering 10 would indicate a 10% markup on the shipping cost.

This can be used to recover handling costs, packaging expenses, or overhead associated with shipping.


Shipping Markup Order Type

Shipping Markup Order Type (Text field)

Defines which order types the shipping markup should apply to.

  • If one or more order types are specified, the markup will only be applied to those order types.

  • If the field is left blank, the markup applies to all orders processed through ReadyShipper.

This gives you fine control over which transactions should bear additional shipping-related charges.


Ship Service Name / Third Party Ship Service Name

Ship Service Name Defines the ship service in XoroERP, such as:

  • Example: FedEx Ground

Third Party Ship Service Name Defines the corresponding service name used in ReadyShipper.

Together, these two fields create a mapping between XoroERP’s ship services and ReadyShipper’s ship service codes or names, ensuring that:

  • The correct service is used when labels are generated.

  • There are no mismatches between internal and external service codes.


Use Ship Date as Transaction Date

Use Ship Date as Transaction Date (Checkbox)

When this option is enabled:

  • The ship date received via ReadyShipper (or determined during shipping) is used as the transaction date in XoroERP.

This helps align accounting, reporting, and operational logs with the actual shipping date instead of, for example, the order date or system processing date.


Import/Export Settings

You can schedule data import/export for ReadyShipper and configure email notifications for errors and logs.


Time Zone

Time Zone

Defines the time zone used to schedule ReadyShipper-related import and export jobs.

  • All scheduled tasks such as recurring exports, imports, and sync processes will follow this time zone.


Enable Auto Import/Export

Enable auto import/export (Checkbox)

When this option is enabled:

  • XoroERP will automatically run ReadyShipper import/export processes according to the defined schedule.

  • You can choose whether the jobs run:

    • Recurring, or

    • Once per day

Enabling this checkbox reveals the following scheduling fields:

  • Integration Start Date – The date from which integration jobs should start running.

  • Hour – The hour of the day at which the job should start or repeat.

  • Min – The minute offset at which the job should start or repeat.

  • Auto Import Start Time Offset – Adds a negative offset (in minutes) to the auto-import start time.

    • This allows the system to begin fetching or processing a few minutes earlier than the defined interval, if needed.

If this option is disabled, import/export tasks must be triggered manually from the relevant operations interface.


Receive Import Error Notifications by Email

Receive import error notifications by email (Checkbox)

When this option is selected, XoroERP will send email alerts for import errors related to the ReadyShipper integration.

Enabling this option opens the following fields:

  • Instant Error Email(s)

    • Enter one or more email addresses to receive immediate error notifications.

    • Multiple email addresses should be separated by commas (,).


Send Daily Error Email

Send daily error email (Checkbox)

When enabled:

  • XoroERP sends a summary email once per day, containing error information related to ReadyShipper import/export activities.

  • The daily summary will respect the Exclude Logs filters so you only see relevant error categories.

    Exclude Logs

    • Enter comma-separated keywords to exclude certain log entries from email notifications.

    • You can use an asterisk (*) as a wildcard for partial matches.

    • This helps reduce noise by filtering out less important or known log patterns.

4. Operations Page

The ReadyShipper Operations Page in XoroERP provides a centralized control panel to monitor and manage all data flows between XoroERP and ReadyShipper. It enables you to:

  • Manually trigger exports.

  • Monitor order-level and batch-level status.

  • Review and resolve errors.

  • Inspect detailed logs for troubleshooting.

4.1 Accessing the Operations Page

  1. In XoroERP, go to the Apps module.

  2. Open 3PL Connections or the list of integrations.

  3. Select the ReadyShipper integration.

  4. Click on Operations to open the ReadyShipper Operations Page.

4.2 Header Options

At the top of the Operations Page, you have access to key actions for managing the ReadyShipper integration:

  • Add Account Add a new ReadyShipper account to your XoroERP instance. This allows multiple accounts for different stores, regions, or environments.

  • Change Account Switch between multiple ReadyShipper accounts or update credentials for an existing account.

  • Remove Account Disconnect a ReadyShipper account from XoroERP. All associated data exports will cease until another account is selected.

  • Settings Opens the configuration panel where you can adjust Data Export Settings and Import/Export Settings, including stores, filters, ship methods, email notifications, and scheduling.

These header options allow you to move between account-level configuration and operational monitoring without leaving the integration context.


4.3 Sync Xoro Data to ReadyShipper

This section controls how and when orders are synchronized from XoroERP to ReadyShipper.

Typical components include:

  • Run / Execute Export Manually initiates export of eligible orders to ReadyShipper, based on the current configuration:

    • Only orders from selected stores.

    • Excluding blocked ship methods and blocked SKUs.

    • Restricted by allowed customer(s) and filter rules.

  • Date Range or Filter Inputs (if available) Allows focusing the export on a specific period, such as:

    • Orders created between selected dates.

    • Orders matching certain criteria (e.g., specific tags, sources, or references).

This section is particularly useful when:

  • Running a first-time export after enabling the integration.

  • Reprocessing orders after modifying configuration.

  • Handling backlogged orders that were not previously exported.


4.4 Orders

The Orders (or Export Queue) tab provides detailed visibility into each order being processed through ReadyShipper:

Typical columns and actions may include:

  • Order # / Reference The unique order identifier from XoroERP.

  • Last Execution Date The timestamp of the last export attempt for that order.

  • Status / Message Shows whether the export succeeded, failed, or is pending, including error messages or notes where applicable.

Actions:

  • Run Manually attempts export for selected orders. Useful if an order previously failed due to configuration or connectivity issues and needs to be reprocessed.

  • Mark as Resolved Marks successful or already handled records as resolved, removing them from the active error/pending view.

  • Mark as Unresolved Reopens records that need further attention or reprocessing.

Filters:

  • Hide Resolved Hides resolved entries so you can focus only on pending or problematic orders.

  • Show Errors Only Limits the view to orders that encountered errors during export, simplifying troubleshooting.

This tab is the main operational workspace for ensuring that all orders intended for ReadyShipper are successfully exported.

4.5 Ship Confirmations

If ReadyShipper sends ship confirmations back to XoroERP, the corresponding tab (e.g., Ship Confirmations) allows monitoring and controlling how shipment updates are processed:

  • Ship Confirmation # / Reference The external reference for the shipment.

  • Last Execution Date The last time the confirmation was processed.

  • Message Shows success or error messages from processing the confirmation.

The behavior of this area is influenced by:

  • Disable multishipment (Checkbox)

    • If enabled: The first confirmation is treated as final; all wave lines are closed, and unshipped quantities are unallocated.

    • If disabled: Multiple confirmations can be processed until quantities are fully shipped.

This section ensures alignment between ReadyShipper shipments and XoroERP order status.


4.6 Logs Tab

The Logs tab provides an audit trail of all integration activities between XoroERP and ReadyShipper, including:

  • Export attempts.

  • Any import processes, if applicable.

  • Scheduling triggers and actions.

  • Errors and warnings.

Typical columns:

  • Export/Import Date When the integration process ran.

  • Type Indicates the process type, such as order export, ship confirmation handling, etc.

  • Keyword / Reference Often shows order numbers, shipment numbers, or other identifiers.

  • Message Displays the status or error message for each operation.

The log contents align with your email notification settings:

  • Receive import error notifications by email

    • Instant error emails are sent based on Instant Error Email(s).

    • Exclude Logs lets you filter out less relevant logs from notifications.

  • Send daily error email

    • Sends a summary of all integration errors, consolidated on a daily basis.

The Logs tab is your primary source for diagnosing issues, verifying that scheduled jobs are running, and confirming that ReadyShipper-related operations are behaving as expected.

Last updated

Was this helpful?